finance_math 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fadca1b8a2a0ba505f0e0ba580d771ae5f9956df
-  data.tar.gz: f8184187b70e375f2585e107d74af672f3fa09e9
+SHA256:
+  metadata.gz: 96f21dff1ebfa8772bbe2a251e2c24d55c6430ec8e9fc39ca6175aced2aa0e8e
+  data.tar.gz: 5e45af7a4f350de830406dd7caa762c5590cbf7e2f4d70e859a810926acd5429
 SHA512:
-  metadata.gz: d76b7216a8f7133c212f712437f15348f9d985331282e80ee8982767e265e05b546f04d1a16d8e8d103200abe4ff829f59884000c4d32232d7a907e88d12eaf1
-  data.tar.gz: ac4b8cd68df8f2c6721cc0c78883a8aafa9d034b53fe410a40a67d878d5256fbd9923996d37e763a6d366686cb5cf5465587002442575d57580c1abcdb159e9e
+  metadata.gz: 305a7493c91b7a463d8d6543e4607f14dd403082fc044418f5ceac7b25ef9b911f643ac345e734f7b5ce58461ae6a46c5662209d62ba9a6052c1e48f0bfa3db4
+  data.tar.gz: 1e3fbdba12205a00495cdc030c8907afbdc57092b1b0be2b6c5ebbe5cead0091c3b93f16e01fa65ded5e6a7c21930e463d660fe2dc931971115c13f47f5ce4ec

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+        
+      # Database setup
+      - run: bundle exec rake db:create
+      - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+before_script:
+  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/LICENSE.txt

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

data/README.md

@@ -1,11 +1,10 @@
 [![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)
 
 
 ## 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 +18,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.
@@ -26,47 +29,47 @@ Defaults are structure_fee = 5, currency protection = 3, so please update if you
 
 ```ruby
 
-Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000)
+FinanceMath::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.
 
 ```ruby
 
-Loan.new(nominal_rate: 10.5, duration: 12, amount: 15000, structure_fee: 5.1, currency_protection: 2.75, fee: 25)
+FinanceMath::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.
 
-### Loan.pmt
+### FinanceMath::Loan.pmt
 
 Calculates the periodic payment for an annuity investment based on constant-amount periodic payments and a constant interest rate.
 
 ```ruby
 
-loan = Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
+loan = FinanceMath::Loan.new(nominal_rate: 10, duration: 12, amount: 1000)
 loan.pmt
 # 87.9158872300099
 
 ```
 
-### Loan.apr
+### FinanceMath::Loan.apr
 
 Calculates the Annual Percentage Rate.
 
 ```ruby
 
-loan = Loan.new(nominal_rate: 13, duration: 12, amount: 10000)
+loan = FinanceMath::Loan.new(nominal_rate: 13, duration: 12, amount: 10000)
 loan.apr
 #29.179538647635006
 
-loan = Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10)
+loan = FinanceMath::Loan.new(nominal_rate: 15, duration: 36, amount: 10000, structure_fee: 5, currency_protection: 3, fee: 10)
 loan.apr
 #23.964418264624054
 
@@ -84,11 +87,20 @@ loan.apr
 
 Please cover with tests your pull requests
 
-## Copyright
+## Ruby versions
+
+   Currently supported version of 2.x and 3.x
+
+## 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 Nesha Zoric
 
-###Follow up @nebojsaz and @kolosek
+###Follow up @kolosek
 
 
 ## License

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"
@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "rake", "~> 2.0"
+  spec.add_development_dependency 'rspec', "~> 2.0"
 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/finance_math.rb

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

data/lib/version.rb

@@ -1,3 +1,3 @@
 module FinanceMath
-  VERSION = "1.0.2"
+  VERSION = "1.0.6"
 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.6
 platform: ruby
 authors:
-- Nebojsa Zoric
+- Nesha Zoric
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,41 +28,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: '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. '
 email:
-- office@kolosek.com
+- nesha@kolosek.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".tool-versions"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -92,11 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.5.3
 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