exonio 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c634f17bc1a7424b3be9e782fb72a8e226c4dd09a7b37d0dc71f026c2909b71
-  data.tar.gz: aa306d1c5dd6de8e32c06916057986291e551779293ceeed832100eacddf7c5b
+  metadata.gz: 98f201bb844c16499156bf6e771c9685de8077e122177264f8dd7da579d0cdb9
+  data.tar.gz: 864f3ab57b22c5bc476bd94e91fa6a875b957e0981662ec3bbd2a848beca2678
 SHA512:
-  metadata.gz: 33ae1525fa62badfdc56d8203f4eab2d762f5284e4b4996b25b8a447c16f70c8beae9946137a03104e8c68c4c0c7131a70fc673fb26328faf9b74e2a42cc8035
-  data.tar.gz: e6b5907b0f28a7d235d462bbe3861398669d7339e0d77d0b3700cd906628a9d53660c51d5341915206bd6a32bc7dbbeec656e2ddfe4eb78d977914f3e8191496
+  metadata.gz: 50084b438bad2464cf253f3a4742fa7e9a99f9e254beaea5100c0062b3a481b12ebcd4d920e9e9b6eafc9f91bf3cdc309e8129ddcbfd5ee4f1aaa29fd8234701
+  data.tar.gz: '059d0b131138627a4d791372ddea8e9bc88b7d88ae0a07b5779fe3052306864f4502d70010b9ffdce9d92868ff056c9a435aaff9b0608c116015ac00358b49ff'

data/.github/workflows/gem-push.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/.github/workflows/tests.yml

@@ -8,15 +8,17 @@ on:
 jobs:
   test:
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: ["2.3.1", "2.7", "3.0", "3.1"]
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
-
+      - uses: actions/checkout@v4
+      - name: Remove Gemfile.lock
+        run: rm Gemfile.lock
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.7.1
+
+* Fixed `pmt` when rate is 0.
+
+## 0.7.0
+
+* Implements `nominal` method (#35)
+* Update dependencies (#32)
+
 ## 0.6.1
 
 * Update dependencies (#25)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exonio (0.6.1)
+    exonio (0.7.1)
 
 GEM
   remote: https://rubygems.org/
@@ -17,27 +17,26 @@ GEM
       byebug (~> 8.0)
       pry (~> 0.10)
     rake (13.0.6)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.11)
   exonio!
-  pry-byebug (~> 3.3.0)
+  pry-byebug (~> 3.3)
   rake (~> 13.0)
   rspec (~> 3.0)
 

data/README.md

@@ -34,7 +34,7 @@ To use Exonio you just have to call the method you like to use. Example:
 
 ### EFFECT
 
-The Excel EFFECT function returns the effective annual interest rate, given a nominal interest rate and the number of compounding periods per year. 
+The Excel EFFECT function returns the effective annual interest rate, given a nominal interest rate and the number of compounding periods per year.
 Effective annual interest rate is the interest rate actually earned due to compounding.
 More about this function [EFFECT](https://exceljet.net/excel-functions/excel-effect-function)
 
@@ -42,6 +42,15 @@ More about this function [EFFECT](https://exceljet.net/excel-functions/excel-eff
 Exonio.effect(0.05, 10 * 12) # ==> 0.05126014873337037
 ```
 
+### NOMINAL
+
+The Excel NOMINAL function returns the nominal interest rate when given an effective annual interest rate and the number of compounding periods per year. The effective rate is the actual rate due to compounding. The nominal rate is typically the stated rate.
+More about this function [NOMINAL](https://exceljet.net/functions/nominal-function)
+
+```ruby
+Exonio.nominal(0.05, 12 / 6) # ==> 0.04939015319191986
+```
+
 ### FV
 
 What is the future value after 10 years of saving $100 now, with

data/exonio.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.3"
 end

data/lib/exonio/financial.rb

@@ -17,6 +17,22 @@ module Exonio
       (1 + rate / nper) ** nper - 1
     end
 
+    # Calculates the nominal interest rate when given an effective annual interest rate and the number of compounding periods per year.
+    # The effective rate is the actual rate due to compounding. The nominal rate is typically the stated rate.
+    #
+    # @param rate [Float] The effective annual interest rate as decimal (not per cent).
+    # @param npery [Integer] Number of compounding periods per year.
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.nominal(0.05, 12 / 2) # ==> 0.04939015319191986
+    #
+    def nominal(rate, npery)
+      npery * ((1 + rate)**(1.0/npery) - 1)
+    end
+
+
     # Calculates the future value of an annuity investment based on
     # constant-amount periodic payments and a constant interest rate.
     #
@@ -103,6 +119,8 @@ module Exonio
     #   Exonio.pmt(0.075/12, 12*15, 200_000) # ==> -1854.0247200054619
     #
     def pmt(rate, nper, pv, fv = 0, end_or_beginning = 0)
+      return (-pv - fv) / nper if rate.zero?
+
       temp = (1 + rate) ** nper
       fact = (1 + rate * end_or_beginning) * (temp - 1) / rate
 

data/lib/exonio/version.rb

@@ -1,3 +1,3 @@
 module Exonio
-  VERSION = "0.6.1"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exonio
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Rafael Izidoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
 description: This gem implements some useful Excel formulas like PMT, IPMT, NPER,
   PV, etc...
 email:
@@ -109,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Excel usefull formulas written in Ruby