exonio 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7c8540cc0960cf7ecaa4ca890b9fcffa0e83188
-  data.tar.gz: 7242e19ab28e0746c164d6d7144763830ddd86a9
+  metadata.gz: b41d64738c1775bc0b495caecdf951a4a4021724
+  data.tar.gz: 9983f55a871c45c3df8e7588ab33c4bfd635da3f
 SHA512:
-  metadata.gz: 5060942e118057edcd050a004ec2f0a84ba4ed8054f6c0d6021bd9ee121dc25006bbd0b8a65f7bdc4dedf7b2e79c901a4446feddb8a7d82044c0804f775639e6
-  data.tar.gz: 220d4df06a167c0966b72f98042e6032a13aef295178f88e1dc8cefa60d4b8055e9e53bfd40ee41d1aa47a6e9c2558bbcff6571605f17267c5dcf871aa031b84
+  metadata.gz: c5f39c4732cb7cb0e44ed923bebfc05d21936cd2e17ae5d2c3b47cfc78b7c587c958aa6aa4065bcfb79a6bb7d157b3000c533326e30fd567a5b45a292aeeb3a8
+  data.tar.gz: b547a202794b5acab4317d5aee0b8c80e56ad37ed7d624c5147e6cabea88b149caaa380eea3f26ae83d542efb20d3810b6409cdeb6e3f7ad60db97fae03b4c13

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.4.0
+
+* Implements `rate` method
+
 ## 0.3.0
 
 * Implements `ipmt` method

data/Gemfile.lock

@@ -1,12 +1,22 @@
 PATH
   remote: .
   specs:
-    exonio (0.3.0)
+    exonio (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (8.2.1)
+    coderay (1.1.0)
     diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
     rake (10.5.0)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
@@ -21,6 +31,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
+    slop (3.6.0)
 
 PLATFORMS
   ruby
@@ -28,6 +39,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.11)
   exonio!
+  pry-byebug (~> 3.3.0)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -92,6 +92,17 @@ By convention, the negative sign represents cash flow out (i.e., money not avail
 Thus, to end up with $20,000.00 in 10 years saving $100 a month at 5% annual
 interest, an initial deposit of $2715,09 should be made.
 
+### RATE
+
+Suppose you take a loan of $50,000.00 to pay in 3 years with a monthly payment of $2,500.00.
+What is the rate applied to this loan?
+
+```ruby
+Exonio.rate(12 * 3, 2_500, -50_000) # ==> 0.036006853458478955
+```
+
+So, the rate applied is 3.60%.
+
 ## TODO
 
 There's a lot of formulas to be implemented, including:
@@ -106,7 +117,6 @@ There's a lot of formulas to be implemented, including:
 * MIRR
 * NPV
 * PPMT
-* RATE
 * SLN
 * SYD
 * VDB

data/exonio.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.3.0"
 end

data/lib/exonio/financial.rb

@@ -111,5 +111,48 @@ module Exonio
 
       -(fv + pmt * fact) / temp
     end
+
+    # Calculates the interest rate of an annuity investment based on
+    # constant-amount periodic payments and the assumption of a constant interest rate.
+    #
+    # @param nper [Integer] The number of payments to be made (number of periods)
+    # @param pmt [Float] The amount per period to be paid
+    # @param pv [Float] The present value
+    # @param fv [Float] The future value remaining after the final payment has been made
+    # @param end_or_begining [Integer] Whether payments are due at the end (0) or
+    #   beggining (1) of each period
+    # @param rate_guess [Float] An estimate for what the interest rate will be
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.rate(12, 363.78, -3056.00) # ==> 0.05963422268883278
+    #
+    def rate(nper, pmt, pv, fv = 0, end_or_beginning = 0, rate_guess = 0.10)
+      guess = rate_guess
+      tolerancy = 1e-6
+      close = false
+
+      begin
+        temp = newton_iter(guess, nper, pmt, pv, fv, end_or_beginning)
+        next_guess = guess - temp
+        diff = (next_guess - guess).abs
+        close = diff < tolerancy
+        guess = next_guess
+      end while !close
+
+      next_guess
+    end
+
+    private
+
+    # This method was borrowed from the NumPy rate formula
+    # which was generated by Sage
+    #
+    def newton_iter(r, n, p, x, y, w)
+      t1 = (r+1)**n
+      t2 = (r+1)**(n-1)
+      ((y + t1*x + p*(t1 - 1)*(r*w + 1)/r) / (n*t2*x - p*(t1 - 1)*(r*w + 1)/(r**2) + n*p*t2*(r*w + 1)/r + p*(t1 - 1)*w/r))
+    end
   end
 end

data/lib/exonio/version.rb

@@ -1,3 +1,3 @@
 module Exonio
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exonio
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rafael Izidoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 description: This gem implements some useful Excel formulas like PMT, IPMT, NPER,
   PV, etc...
 email: