fincalc 0.0.1

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/fincalc

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+

data/lib/fincalc.rb

@@ -0,0 +1,73 @@
+# FinCalc is a class with methods to perform basic financial operations
+# It works inspired in the HP-12 financial calclulator.  Feel free to
+# add more financial operations as needed
+# Author:  Hernan Velasquez
+class FinCalc
+  # Interest rate
+  attr_writer :i
+  # Number of periods
+  attr_writer :n  
+  # Ammount of a constant payment in a cash flow
+  attr_writer :pmt
+  # Ammount of the i-esm paymanent in a no-constant cash flow 
+  attr_writer :cfi
+  # To be used to calculate the NPV of a cash flow.  The internalo period counter
+  attr_reader :periodCounter
+  
+  # Class constructor.  Clear the calculator
+  def initialize
+    clear
+  end
+
+  # Method to clear the calculator.  Set all variables in their defaults
+  def clear
+    @i = 0
+    @n = 0
+    @pmt = 0
+    @periodCounter = 1
+    @cfi = Array.new
+    @cfi[0] = 0
+  end
+  
+  # Set the cashflow value for period 0
+  def cfPeriod0 (pValue)
+    @cfi[0] = pValue
+  end
+
+  # Set the cashflow value for period i
+  def cfiPeriodi (pValue)
+    @cfi[@periodCounter] = pValue
+    @periodCounter = @periodCounter + 1
+  end
+
+  # Calculate the present value of an annuity based on the attributes values already set
+  def calculateAnnuity
+    rate = @i /100.0
+    @pmt*((1 - (1 / ((1 + rate)**@n))) / rate)
+  end
+
+  # Calculates the present value of a perpetuity taking the attribute's values
+  def calculatePerpetuityPV
+    return @pmt / (@i / 100.0)
+  end
+  
+  # Static method to calculate the present value of a perpetuity taking the attribute's values
+  def self.calculatePerpetuityPV (pPaymentValue, pInterestRate)
+    i = (pInterestRate / 100.0)
+    return pPaymentValue / i
+  end
+  
+  # Calculates the Net Present Value of a cashflow
+  def NPV 
+    npv = 0;
+    rate = @i / 100.0;
+    j = 0
+    while j < @periodCounter
+      val = @cfi[j]  / (1+rate)**j
+      npv = npv + val
+      j = j+1
+    end
+    return npv
+  end
+  
+end

data/test/test_fincalc.rb

@@ -0,0 +1,59 @@
+require 'test/unit'
+require 'fincalc'
+
+class FinCalcTest < Test::Unit::TestCase
+
+  def test_perpetuity_static
+    assert_equal 10000.0, FinCalc.calculatePerpetuityPV(100, 1)
+  end
+
+  def test_perpetuity_nostatic
+    f = FinCalc.new
+    f.pmt = 100
+    f.i = 1
+    assert_equal 10000.0, f.calculatePerpetuityPV
+  end
+
+  def test_npv_2periods
+    f = FinCalc.new
+    f.i = 10
+    f.cfPeriod0 -50.0
+    f.cfiPeriodi 100
+    assert_equal 40.90909090909091, f.NPV
+  end
+  
+  def test_npv_5periods
+    f = FinCalc.new
+    f.i = 10
+    f.cfPeriod0 -50.0
+    f.cfiPeriodi 60
+    f.cfiPeriodi -30
+    f.cfiPeriodi 10
+    f.cfiPeriodi 20
+    assert_equal 0.925483232019662, f.NPV
+  end
+  
+  def test_clear
+    f = FinCalc.new
+    f.i = 10
+    f.cfPeriod0 -50.0
+    f.cfiPeriodi 100
+    assert_equal 40.90909090909091, f.NPV
+    f.clear  
+    f.i = 10
+    f.cfPeriod0 -50.0
+    f.cfiPeriodi 60
+    f.cfiPeriodi -30
+    f.cfiPeriodi 10
+    f.cfiPeriodi 20
+    assert_equal 0.925483232019662, f.NPV
+  end
+  
+  def test_annuity
+    f = FinCalc.new
+    f.i = 10.0
+    f.pmt = 500
+    f.n = 12
+    assert_equal 3406.8459114482175, f.calculateAnnuity
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: fincalc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hernan Velasquez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies: []
+description: A simple financial calculator
+email: hernamvel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/fincalc.rb
+- bin/fincalc
+- test/test_fincalc.rb
+homepage: http://rubygems.org/gems/fincalc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This is a small financial calculator.  You can calculate the NPV of a cashflows
+  over the time!
+test_files:
+- test/test_fincalc.rb