Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A library for financial calculations in Ruby
Ruby
Tag: v0.1.0

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
COPYING
COPYING.LESSER
MANIFEST
README
Rakefile
finance.gemspec

README

_finance_ - a library for financial calculations in Ruby.

= INSTALL

	$ sudo gem install finance

= OVERVIEW

== GETTING STARTED

	>> require 'finance'

== AMORTIZATION

You are interested in borrowing $250,000 under a 30 year, fixed-rate loan with a 4.25% APR.

	>> rate = Rate.new(0.0425, :apr, :duration => 30.years)
	>> amortization = 250000.amortize(rate)

Find the standard monthly payment:

	>> amortization.payment
	=> DecNum('-1229.91')

Find the total cost of the loan:

	>> amortization.payments.sum
	=> DecNum('-442766.55')

How much will you pay in interest?

	>> amortization.interest.sum
	=> DecNum('192766.55')

How much interest in the first six months?

	>> amortization.interest[0,6].sum
	=> DecNum('5294.62')

= ABOUT

I began developing _finance_ while writing a Ruby script for analyzing
mortgages.  I couldn't find an existing resource for these tools, I am
hoping to save other folks some time by releasing what I have as a gem.

If you have used _finance_ and find it useful, I would enjoy hearing
about it!

= FEATURES

Currently implemented features include:

* Fixed-rate mortgage amortization (30/360).
* Interest rates
* Various cash flow computations, such as NPV, IRR, and sum.

Planned features include:

* Adjustable rate mortgage amortization.
* Payment modifications (i.e., how does paying an additional $75 per
month affect the amortization?)
* Balloon payments.
* Support for amortization methods other than 30/360.

= RESOURCES

This gem and related documentation is available through
RubyGems[https://rubygems.org/gems/finance].

Source code and bug tracking is available via
github[http://github.com/wkranec/finance].

= COPYRIGHT

This library is released under the terms of the LGPL license.

Copyright (c) 2011, William Kranec.
All rights reserved.

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.
Something went wrong with that request. Please try again.