finance_math 1.0.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fadca1b8a2a0ba505f0e0ba580d771ae5f9956df
-  data.tar.gz: f8184187b70e375f2585e107d74af672f3fa09e9
+  metadata.gz: e0dbd1b8673be65abee43145026f4aaf8b93ca33
+  data.tar.gz: f7dc075d28a331f0cbad6075151524e0110790b5
 SHA512:
-  metadata.gz: d76b7216a8f7133c212f712437f15348f9d985331282e80ee8982767e265e05b546f04d1a16d8e8d103200abe4ff829f59884000c4d32232d7a907e88d12eaf1
-  data.tar.gz: ac4b8cd68df8f2c6721cc0c78883a8aafa9d034b53fe410a40a67d878d5256fbd9923996d37e763a6d366686cb5cf5465587002442575d57580c1abcdb159e9e
+  metadata.gz: 569f17be14ee3fd2c11f2df6aa3bc3a700680f19c871a9a77314026dda99ca321612a5925d170b2b00584b09aed782463c266c16b0ddc85897dc657f1c64541f
+  data.tar.gz: 36a525578e90f6aaf2eb37d8b3d65efc5ee7b04b79a21eae87c09722fd175bcb70e0e0f4fd0fc5354c7a9b1ba5a5561a3d984c0287f5009362033ed6a8325a51

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Nebojsa Zoric
+Copyright (c) 2015 Nebojsa Zoric/Kolosek
 
 MIT License
 

data/README.md

@@ -5,7 +5,7 @@
 
 ## What is FinanceMath?
 
-FinanceMath is a Ruby library for mapping Loan based Exel functions. It deals with problem of calculating the PMT and APR functions. It implements advanced usage, taking into account bank fees, fee for for each payment and currency protection (if currency other than $ USD). Highly precise with high speed of execution. 
+FinanceMath is a Ruby library for mapping Loan based Exel functions. It deals with problem of calculating the PMT and APR functions. It implements advanced usage, taking into account bank fees, fee for for each payment and currency protection (if currency other than $ USD). Highly precise with high speed of execution.
 
 ## Installation
 
@@ -19,6 +19,10 @@ If you're using Bundler, add the gem to Gemfile.
 
 Run `bundle install`.
 
+## Running tests
+
+    bundle exec rspec spec/
+
 ## Basic Usage
 
 Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan.
@@ -31,7 +35,7 @@ Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000)
 
 ## Advanced Usage
 
-Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan, and additional values such as bank fee, currency protection, and fee for each monthly payment. 
+Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan, and additional values such as bank fee, currency protection, and fee for each monthly payment.
 
 Defaults are structure_fee = 5, currency protection = 3, so please update if you need other values.
 
@@ -40,7 +44,7 @@ Defaults are structure_fee = 5, currency protection = 3, so please update if you
 Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000, structure_fee: 5.1, currency_protection: 2.75, fee: 25)
 ```
 
-## Functions 
+## Functions
 
 This is the list of available functions.
 
@@ -84,9 +88,18 @@ loan.apr
 
 Please cover with tests your pull requests
 
-## Copyright
+## Ruby versions
+
+   Currently supported up to 2.4.1 
+
+## Credits
+
+Finance Math is maintained and sponsored by
+[Kolosek] (http://kolosek.com).
+
+![Kolosek](http://kolosek.com/logo.png)
 
-Copyright (c) 2014-2015 Nebojsa Zoric, and Kolosek, Inc. (http://kolosek.com)
+Initially developed by Nebojsa Zoric
 
 ###Follow up @nebojsaz and @kolosek
 

data/finance_math.gemspec

@@ -6,9 +6,9 @@ require 'version'
 Gem::Specification.new do |spec|
   spec.name          = "finance_math"
   spec.version       = FinanceMath::VERSION
-  spec.authors       = ["Nebojsa Zoric"]
-  spec.email         = ["office@kolosek.com"]
-  spec.summary       = %q{Finance and mortgage library for Ruby.}
+  spec.authors       = ["Nesha Zoric"]
+  spec.email         = ["nesha@kolosek.com"]
+  spec.summary       = %q{Most accurate APR and PMT caluclator for Ruby.}
   spec.description   = %q{Implementation of Loan/Mortgage functions in Ruby language. APR function and PMT function. In calculations it includes implementation of bank fee, marketplace fee, fees for each payment to provide the most precise calculation at very high speed. }
   spec.homepage      = "http://kolosek.com"
   spec.license       = "MIT"

data/lib/finance_math.rb

@@ -2,5 +2,4 @@ require "version"
 
 module FinanceMath
   autoload :Loan,             'finance_math/loan'
-  autoload :Mortgage,         'finance_math/mortgage'
 end

data/lib/finance_math/loan.rb

@@ -13,18 +13,18 @@ module FinanceMath
     # @return [Float] the nominal annual rate
     # @api public
     attr_accessor :nominal_rate
-   
+
     # @return [DecNum] the monthly rate
     # @api public
     attr_reader :monthly_rate
 
     # @return [DecNum] the currency protection
     # @api public
-    attr_reader :currency_protection  
+    attr_reader :currency_protection
 
     # @return [DecNum] the fee for the bank/market
     # @api public
-    attr_reader :structure_fee    
+    attr_reader :structure_fee
 
     # @return [DecNum] P principal
     # @api public
@@ -42,18 +42,11 @@ module FinanceMath
     # @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(options = {})
-      @nominal_rate = options.fetch(:nominal_rate).to_f
-      @duration = options.fetch(:duration).to_f
-      @amount = options.fetch(:amount).to_f
-      @structure_fee = options.fetch(:structure_fee, 5).to_f
-      @currency_protection = options.fetch(:currency_protection, 3).to_f
-      @fee = options.fetch(:fee, 0).to_f
-      @nominal_rate, @amount, @duration, @structure_fee, @currency_protection, @fee = nominal_rate.to_f, amount, duration, structure_fee.to_f, currency_protection.to_f, fee.to_f
+      initialize_options(options)
       @principal = principal_calculation
       @monthly_rate = @nominal_rate / 100 / 12
     end
@@ -73,21 +66,30 @@ module FinanceMath
       def pow1pm1(x, y)
         (x <= -1) ? ((1 + x) ** y) - 1 : Math.exp(y * Math.log(1.0 + x)) - 1
       end
-    
+
       def pow1p(x, y)
         (x.abs > 0.5) ? ((1 + x) ** y) : Math.exp(y * Math.log(1.0 + x))
       end
-    
+
       def interest(monthly_rate, duration)
         pow1p(monthly_rate, duration)
       end
-    
+
       def fvifa(monthly_rate, duration)
         (monthly_rate == 0) ? duration : pow1pm1(monthly_rate, duration) / monthly_rate
       end
 
     private
 
+      def initialize_options(options)
+        @nominal_rate = options.fetch(:nominal_rate).to_f
+        @duration = options.fetch(:duration).to_f
+        @amount = options.fetch(:amount).to_f
+        @structure_fee = options.fetch(:structure_fee, 5).to_f
+        @currency_protection = options.fetch(:currency_protection, 3).to_f
+        @fee = options.fetch(:fee, 0).to_f
+      end
+
       def principal_calculation
         amount * (1 - currency_protection/100 - structure_fee / 100 ) - fee * duration
       end
@@ -97,8 +99,8 @@ module FinanceMath
       # where a = APR/1200, N = duration, P = monthly payment, C = loan_amount
       # Newton-Raphson finds root (the value for 'a' that makes f(a) = 0)
       def calculate_apr
-        payment_ratio = pmt / principal_calculation 
-        duration = @duration 
+        payment_ratio = pmt / principal_calculation
+        duration = @duration
         f = lambda {|k| (k**(duration + 1) - (k**duration * (payment_ratio + 1)) + payment_ratio)}
         f_deriv = lambda { |k| ((duration + 1) * k**duration) - (duration * (payment_ratio + 1) * k**(duration - 1))}
 
@@ -121,4 +123,4 @@ module FinanceMath
         k_plus_one
       end
   end
-end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module FinanceMath
-  VERSION = "1.0.2"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finance_math
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
 platform: ruby
 authors:
-- Nebojsa Zoric
+- Nesha Zoric
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,7 +57,7 @@ description: 'Implementation of Loan/Mortgage functions in Ruby language. APR fu
   fee, fees for each payment to provide the most precise calculation at very high
   speed. '
 email:
-- office@kolosek.com
+- nesha@kolosek.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -93,10 +93,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Finance and mortgage library for Ruby.
+summary: Most accurate APR and PMT caluclator for Ruby.
 test_files:
 - spec/lib/loan_spec.rb
 - spec/spec_helper.rb