finance_math 0.0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f49354650ef84948e84ed7c9b779c7ccc14caa14
-  data.tar.gz: 84b0ecbe335d4dbe1473e8042b8b54cfa1e1dbaa
+  metadata.gz: cbdffc4856090cc7d1e509ba4e9d0489017a7e44
+  data.tar.gz: 577779f78950688be481d7446c4fda4135f4e027
 SHA512:
-  metadata.gz: 1acd89e12dbb9083724014b867385f04723a07266274e5c0a6dd2716488a53b143594f6c5646f6b8d604f7638ab49f1f01024f97f4e27701d3e0b4f0f01a0ad2
-  data.tar.gz: ee94a8f06ee93ca2d47f7363a6294e02cfd4b85cd7fdb29b01c00112c2cbeb878e10a2bc86d1bfae7940fd3d7cc721545e212ef941eda0a9d598090de29ba254
+  metadata.gz: 6c12c0a09ab26a16c7e8a7ef3bfa2b7964e3a284f1b371607fe7552dfc0fd90230c2b911cff9c3956534fd7ce7993b4012c820ccb03bed40d2617fd73814e26e
+  data.tar.gz: d31f8f44e884db52c0ac328391fdf9eadcc36f33222bdab02352b079441b16186b616c0c277db5abd7027f5b2a5496ac44e2afece6741294ae13930fbd1eb2d6

data/README.md

@@ -1,5 +1,6 @@
 ![Gem Version](https://img.shields.io/badge/finance_math-0.2-blue.svg)
-![Build Status](https://img.shields.io/badge/build-passing-green.svg)
+[![Build Status](https://semaphoreapp.com/api/v1/projects/869d7630-55d3-46e5-9dc2-03d0d1cfecfe/363108/shields_badge.svg)](https://semaphoreapp.com/kolosek/finance_math)
+[![Code Climate](https://codeclimate.com/github/kolosek/finance_math/badges/gpa.svg)](https://codeclimate.com/github/kolosek/finance_math)
 
 
 ## What is FinanceMath?
@@ -41,6 +42,17 @@ loan = Loan.new(10.5, 12, 15000)
 loan.pmt
 ```
 
+## APR
+
+Calculates the Annual Percentage Rate.
+
+```ruby
+
+loan = Loan.new(10.5, 12, 15000)
+
+loan.apr
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/kolosek/finance_math/fork )
@@ -60,3 +72,5 @@ MIT License. See LICENSE for details.
 ## Copyright
 
 Copyright (c) 2014-2015 Nebojsa Zoric, and Kolosek, Inc. (http://kolosek.com)
+
+For any Ruby on Rails related work, please contact directly via form on http://kolosek.com

data/finance_math.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nebojsa Zoric"]
   spec.email         = ["office@kolosek.com"]
   spec.summary       = %q{Finance library for Ruby.}
-  spec.description   = %q{Implementation of Excel functions in Ruby language}
+  spec.description   = %q{Implementation of Loan/Mortgage functions in Ruby language}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/finance_math/loan.rb

@@ -18,6 +18,18 @@ module FinanceMath
     # @api public
     attr_reader :monthly_rate
 
+    # @return [DecNum] the currency protection
+    # @api public
+    attr_reader :currency_protection  
+
+    # @return [DecNum] the fee for the bank/market
+    # @api public
+    attr_reader :structure_fee    
+
+    # @return [DecNum] P principal
+    # @api public
+    attr_reader :principal    
+
 
 
     # create a new Loan instance
@@ -25,13 +37,16 @@ module FinanceMath
     # @param [Numeric] decimal value of the interest rate
     # @param [Integer] Duration of the loan period
     # @param [Float] Loan amount
+    # @param [Float] structure fee - fee for the market in percentages
+    # @param [Float] currency protection - Protection for currency changes - usually 3%, default to 0%
     # @example create a 10.5% Nominal rate
     #   Loan.new(10.5, 12, 1000)
     # @see http://en.wikipedia.org/wiki/Nominal_interest_rate
     # @api public
 
-    def initialize(nominal_rate, duration, amount)
-      @nominal_rate, @amount, @duration = nominal_rate.to_f, amount, duration
+    def initialize(nominal_rate, duration, amount, structure_fee=5, currency_protection=3)
+      @nominal_rate, @amount, @duration, @structure_fee, @currency_protection = nominal_rate.to_f, amount, duration, structure_fee.to_f, currency_protection.to_f
+      @principal = principal_calculation
       @monthly_rate = @nominal_rate / 100 / 12
     end
 
@@ -39,6 +54,38 @@ module FinanceMath
       ((@amount * interest(@monthly_rate, @duration) - future_value ) / ((1.0 + @monthly_rate * type) * fvifa(@monthly_rate, duration)))
     end
 
+    def apr
+      pmt_base = pmt
+      n = duration.to_f / 12
+      q = (duration > 12) ? 12 : duration
+      i = pmt_base * n * q / principal - 1
+      #puts "n: #{n} q: #{q} i: #{i} pmt: #{pmt_base}"
+      find(pmt_base, n, q, i)
+    end
+
+    def principal_base(m, n, q, i)
+      m * ( 1 - ( 1 + ( i / q ) ) ** (- n * q) ) * q / i
+    end
+
+    def near(a, b)
+      r = 0.1
+      return ((a - r) < b && (a + r) > b) || ((b - r) < a && (b + r) > a)
+    end
+
+    def find(pmt_base, n, q, i)
+      p = principal_base(pmt_base, n, q, i)
+
+      return i if near(p, principal)
+      
+      if p < principal
+        i -= 0.00001
+      elsif p > principal
+        i += 0.00001
+      end
+      
+      find(pmt_base, n, q, i)
+    end
+
     protected
 
       def pow1pm1(x, y)
@@ -56,5 +103,11 @@ module FinanceMath
       def fvifa(monthly_rate, duration)
         (monthly_rate == 0) ? duration : pow1pm1(monthly_rate, duration) / monthly_rate
       end
+
+    private
+
+      def principal_calculation
+        amount * (1 - currency_protection/100 - structure_fee / 100 )
+      end
   end
 end

data/lib/finance_math/version.rb

@@ -1,3 +1,3 @@
 module FinanceMath
-  VERSION = "0.0.1"
+  VERSION = "0.2"
 end

data/spec/lib/loan_spec.rb

@@ -27,5 +27,43 @@ describe Loan do
       loan = Loan.new(0, 12, 1200)
       expect(loan.pmt).to eq(100)
     end
+
+    it "should return correct pmt value" do
+      loan = Loan.new(0, 36, 10000)
+      expect(loan.pmt).to eq(277.77777777777777)
+    end
+
+    it "should return correct pmt value" do
+      loan = Loan.new(0, 6, 10000)
+      expect(loan.pmt).to eq(1666.6666666666667)
+    end
+  end
+
+  context ".apr" do
+
+    it "should return correct apr value" do
+      loan = Loan.new(16, 24, 10000)
+      expect(loan.apr).to eq(0.24699853524196447)
+    end
+
+    it "should return correct apr value" do
+      loan = Loan.new(13, 24, 10000)
+      expect(loan.apr).to eq(0.2159014588291408)
+    end
+
+    it "should return correct apr value" do
+      loan = Loan.new(13, 18, 10000)
+      expect(loan.apr).to eq(0.2418055150965281)
+    end
+
+    # it "should return correct apr value" do
+    #   loan = Loan.new(13, 6, 10000)
+    #   expect(loan.apr).to eq(0.2418055150965281)
+    # end
+
+    # it "should return correct apr value" do
+    #   loan = Loan.new(13, 36, 10000)
+    #   expect(loan.apr).to eq(0.2418055150965281)
+    # end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finance_math
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.2'
 platform: ruby
 authors:
 - Nebojsa Zoric
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Implementation of Excel functions in Ruby language
+description: Implementation of Loan/Mortgage functions in Ruby language
 email:
 - office@kolosek.com
 executables: []