finance 0.0.1

data/README

@@ -0,0 +1,47 @@
+= ABOUT
+
+The goal of the _finance_ library is to provide Ruby implementations
+of common financial formulas, with a function syntax similar to most
+modern spreadsheet programs.  As the project matures, consideration will
+also be given to providing useful, but more advanced functions, which
+may not be suitable for a spreadsheet environment but are useful when
+programming.
+
+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.
+
+= EXAMPLES
+
+
+
+= INSTALL
+
++ $ sudo gem install finance +
+
+= RESOURCES
+
+Source code and bug tracking is available via github:
+
+Project Page:: + http://github.com/wkranec/finance +
+Repository:: + git://github.com/wkranec/finance.git +
+
+= 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/>.

data/lib/finance.rb

@@ -0,0 +1,93 @@
+# The *Finance* module adheres to the following conventions for
+# financial calculations:
+#
+#  * Positive values represent cash inflows (money received); negative
+#    values represent cash outflows (payments).
+#  * *principal* represents the outstanding balance of a loan or annuity.
+#  * *rate* represents the interest rate _per period_.
+module Finance
+
+	# Return the internal rate of return for a given sequence of cashflows.
+	#
+	# References:
+	#  * http://en.wikipedia.org/wiki/Internal_rate_of_return
+	def Finance.irr(cashflows, iterations=100)
+		rate = 1.0
+		investment = cashflows[0]
+		for i in 1..iterations+1
+			rate = rate * (1 - npv(rate, cashflows) / investment)
+		end
+		rate
+	end
+
+	def Finance.payments(principal, rates)
+		p_total = rates.inject(0) { |sum, n| sum + n[0] }
+		p_current = 0
+		payments = []
+
+		rates.each do |periods, rate|
+			payment = Finance.pmt(principal, rate, p_total-p_current)
+
+			begin
+				payment = payment.round(2)
+			rescue ArgumentError
+				payment = (payment * 100.0).round / 100.0
+			end
+
+			if block_given?
+				payment = yield(payment)
+			end
+
+			periods.times do
+				interest = principal * rate
+
+				if payment > principal + interest
+					payment = principal + interest
+				end
+
+				principal = principal + interest - payment
+
+				begin
+					principal = principal.round(2)
+				rescue ArgumentError
+					principal = (principal * 100.0).round / 100.0
+				end
+
+				payments << payment
+				break if principal == 0
+				
+				p_current = p_current + 1
+			end
+		end
+
+		payments
+	end
+
+  # Return the periodic payment due on a loan, based on the amortization
+  # process.
+	#
+	# References:
+	#  * http://en.wikipedia.org/wiki/Amortization_calculator
+	def Finance.pmt(principal, rate, periods)
+		principal * (rate + (rate / ((1 + rate) ** periods - 1)))
+	end
+
+	# Return the net present value of a sequence of cash flows given
+	# the discount rate _rate_.
+	#
+	# References:
+	#  * http://en.wikipedia.org/wiki/Net_present_value
+	def Finance.npv(rate, cashflows)
+		total = 0.0
+		cashflows.each_with_index do |cashflow, index|
+			total = total + cashflow / (1+rate) ** index
+		end
+		total
+	end
+
+	# Return the number of periods needed to pay off a loan with the
+	# given payment.
+	def Finance.nper(payment, rate, principal)
+		-(Math.log(1-((principal/payment)*rate))) / Math.log(1+rate)
+	end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: finance
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bill Kranec
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-15 00:00:00 Z
+dependencies: []
+
+description: The goal of the finance library is to provide Ruby implementations of common financial formulas, with a function syntax similar to most modern spreadsheet programs.
+email: wkranec@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/finance.rb
+- README
+homepage: http://finance.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: finance
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Ruby implementations of common financial formulas.
+test_files: []
+