finance_math 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4ad290f93c61538088a542df817d1d3b527f287
-  data.tar.gz: 1dcd17731cd9f09023fbf667358d4e01ecca95fd
+  metadata.gz: fadca1b8a2a0ba505f0e0ba580d771ae5f9956df
+  data.tar.gz: f8184187b70e375f2585e107d74af672f3fa09e9
 SHA512:
-  metadata.gz: 4ac4c610dfb82ff5afce7e6361a04bd7e3e3c09a1e14d61bc3822278b7bc9d2857f1f8283f78484355313283068841da0595353e246aba1216e52ed8e1d15c2b
-  data.tar.gz: 3be42c6b204dd638fdccac9fb13235429fd162ec10d33dd9d94e918722e9d13eed503b70019d6decf1dfb290856247f52f1ca63231e0243e969b19850c4b6fbe
+  metadata.gz: d76b7216a8f7133c212f712437f15348f9d985331282e80ee8982767e265e05b546f04d1a16d8e8d103200abe4ff829f59884000c4d32232d7a907e88d12eaf1
+  data.tar.gz: ac4b8cd68df8f2c6721cc0c78883a8aafa9d034b53fe410a40a67d878d5256fbd9923996d37e763a6d366686cb5cf5465587002442575d57580c1abcdb159e9e

data/README.md

@@ -1,4 +1,4 @@
-![Gem Version](https://img.shields.io/badge/finance_math-1.0-blue.svg)
+[![Gem Version](https://badge.fury.io/rb/finance_math.svg)](http://badge.fury.io/rb/finance_math)
 [![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)
 
@@ -22,21 +22,22 @@ Run `bundle install`.
 ## Basic Usage
 
 Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan.
+Defaults are structure_fee = 5, currency protection = 3, so please update if you need other values.
 
 ```ruby
 
-Loan.new(10.5, 12, 15000)
+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. 
 
-Defaults are bank fee = 5, currency protection = 3, so please update if you need other values.
+Defaults are structure_fee = 5, currency protection = 3, so please update if you need other values.
 
 ```ruby
 
-Loan.new(10.5, 12, 15000, 5.1, 2.75, 25)
+Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000, structure_fee: 5.1, currency_protection: 2.75, fee: 25)
 ```
 
 ## Functions 
@@ -49,7 +50,7 @@ Calculates the periodic payment for an annuity investment based on constant-amou
 
 ```ruby
 
-loan = Loan.new(10, 12, 1000)
+loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
 loan.pmt
 # 87.9158872300099
 
@@ -61,11 +62,11 @@ Calculates the Annual Percentage Rate.
 
 ```ruby
 
-loan = Loan.new(13, 12, 10000)
+loan = Loan.new(nominal_rate: 13, duration: 12, amount: 10000)
 loan.apr
 #29.179538647635006
 
-loan = Loan.new(15, 36, 10000, 5, 3, 10)
+loan = Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10)
 loan.apr
 #23.964418264624054
 

data/lib/finance_math/loan.rb

@@ -46,13 +46,21 @@ module FinanceMath
     # @see http://en.wikipedia.org/wiki/Nominal_interest_rate
     # @api public
 
-    def initialize(nominal_rate, duration, amount, structure_fee=5, currency_protection=3, fee=0)
+    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
       @principal = principal_calculation
       @monthly_rate = @nominal_rate / 100 / 12
     end
 
-    def pmt(future_value=0, type=0)
+    def pmt(options = {})
+      future_value = options.fetch(:future_value, 0)
+      type = options.fetch(:type, 0)
       ((@amount * interest(@monthly_rate, @duration) - future_value ) / ((1.0 + @monthly_rate * type) * fvifa(@monthly_rate, duration)))
     end
 

data/lib/version.rb

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

data/spec/lib/loan_spec.rb

@@ -2,44 +2,44 @@ require 'spec_helper'
 
 describe Loan do
   it "should return initial set nominal rate" do
-    loan = Loan.new(10, 12, 1000)
+    loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
     expect(loan.nominal_rate).to eq(10)
   end
 
   it "should return initial set duration period" do
-    loan = Loan.new(10, 12, 1000)
+    loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
     expect(loan.duration).to eq(12)
   end
 
   it "should return initial set amount loaned" do
-    loan = Loan.new(10, 12, 1000)
+    loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
     expect(loan.amount).to eq(1000)
   end
 
   context ".pmt" do
 
     it "should return correct pmt value" do
-      loan = Loan.new(10, 12, 1000)
+      loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
       expect(loan.pmt).to eq(87.9158872300099)
     end
 
     it "should return correct pmt value" do
-      loan = Loan.new(0, 12, 1200)
+      loan = Loan.new(nominal_rate: 0, duration: 12, amount: 1200)
       expect(loan.pmt).to eq(100)
     end
 
     it "should return correct pmt value" do
-      loan = Loan.new(0, 36, 10000)
+      loan = Loan.new(nominal_rate: 0, duration: 36, amount: 10000)
       expect(loan.pmt).to eq(277.77777777777777)
     end
 
     it "should return correct pmt value" do
-      loan = Loan.new(0, 6, 10000)
+      loan = Loan.new(nominal_rate: 0, duration: 6, amount: 10000)
       expect(loan.pmt).to eq(1666.6666666666667)
     end
 
     it "should return correct pmt value" do
-      loan = Loan.new(13, 90, 1000000)
+      loan = Loan.new(nominal_rate: 13, duration: 90, amount: 1000000)
       expect(loan.pmt).to eq(17449.90775727763)
     end
   end
@@ -47,62 +47,62 @@ describe Loan do
   context ".apr, edge cases" do
 
     it "should return correct apr value" do
-      loan = Loan.new(16, 24, 9200)
+      loan = Loan.new(nominal_rate: 16, duration: 24, amount: 9200)
       expect(loan.apr).to eq(24.699310868498614)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 24, 10000)
+      loan = Loan.new(nominal_rate: 13, duration: 24, amount: 10000)
       expect(loan.apr).to eq(21.589972932434698)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 18, 10000)
+      loan = Loan.new(nominal_rate: 13, duration: 18, amount: 10000)
       expect(loan.apr).to eq(24.1815502466296)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 12, 10000)
+      loan = Loan.new(nominal_rate: 13, duration: 12, amount: 10000)
       expect(loan.apr).to eq(29.179538647635006)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 6, 10000)
+      loan = Loan.new(nominal_rate: 13, duration: 6, amount: 10000)
       expect(loan.apr).to eq(42.82076503747119)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 36, 10000)
+      loan = Loan.new(nominal_rate: 13, duration: 36, amount: 10000)
       expect(loan.apr).to eq(18.93638316167774)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 90, 10000000)
+      loan = Loan.new(nominal_rate: 13, duration: 90, amount: 10000000)
       expect(loan.apr).to eq(15.690778147507167)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 90, 50000000)
+      loan = Loan.new(nominal_rate: 13, duration: 90, amount: 50000000)
       expect(loan.apr).to eq(15.690778147507167)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(13, 1, 50000000)
+      loan = Loan.new(nominal_rate: 13, duration: 1, amount: 50000000)
       expect(loan.apr).to eq(118.47826151517138)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(80, 1, 1000)
+      loan = Loan.new(nominal_rate: 80, duration: 1, amount: 1000)
       expect(loan.apr).to eq(191.30434783476406)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(36, 200, 500)
+      loan = Loan.new(nominal_rate: 36, duration: 200, amount: 500)
       expect(loan.apr).to eq(39.173057290003044)
     end
 
     it "should return correct apr value" do
-      loan = Loan.new(15, 36, 10000, 5, 3, 10)
+      loan = Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10)
       expect(loan.apr).to eq(23.964418264624054)
     end
   end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: finance_math
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Nebojsa Zoric
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 'Implementation of Loan/Mortgage functions in Ruby language. APR function
@@ -62,7 +62,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,12 +83,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []