exonio 0.5.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2177008fa8ad1fce23bd78efe356f146ab94350acb804eacc6fbdf7cf0b73756
-  data.tar.gz: a8a144747cec2755ae8c6739b91b8a4cc8eee4630ac6c950147c2eca260d5711
+  metadata.gz: d9378589552d7f80a4b46042b0a0a55dc84e79d65484f53381a8d534b20186dc
+  data.tar.gz: 91ca4fd17ff38669d5c8284f377fabae0d689ce24e489fa391032815d926c33f
 SHA512:
-  metadata.gz: 74c8699b45184bcee100bda0aacf58f526461a02f4904e728ab9d1c2f4c3822a30fd19ea5fdff3de8c7f325eded5428e0946e2f243d15515c008181958404052
-  data.tar.gz: 170be11052472cdc4ed37f11bd6821a5f3273b44fd3e8374a52502918bb6d84a67f2c6e4483d35626533851852abee7e2426d04dfc1d89dbd00331d4a16c9131
+  metadata.gz: 3b89195bd85a1fb68a01db4cfbedb845e1b15a3dcdcdf8099fd8bd74f5d782f7e2ebaf538221d467c87b193f2389f1225a41e1b2dfb60e23ffd8d0d428875cb6
+  data.tar.gz: 295d2b187c08d1a65a6533293756f73635ed6457ba57895f220b6b845cd38601d812dde4fdc056bc6330e295d0eecdf816a8ddf0f6959dcbbe2dbbf0fb5a8cc8

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+
+updates:
+  - open-pull-requests-limit: 10
+    package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "noverde/developers"
+
+  - open-pull-requests-limit: 10
+    package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "noverde/developers"

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

@@ -0,0 +1,26 @@
+name: RubyGem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1"
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Publish to RubyGems
+        uses: noverde/github-actions/push-rubygems@main
+        with:
+          rubygems_api_key: ${{ secrets.RUBYGEMS_TOKEN }}

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ["2.3.1", "2.7", "3.0", "3.1", "3.2"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Remove Gemfile.lock
+        run: rm Gemfile.lock
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake spec

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+bin/
 /.config
 /coverage/
 /InstalledFiles
@@ -29,8 +30,8 @@ build/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
 # .ruby-gemset
+.ruby-version
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 0.7.0
+
+* Implements `nominal` method (#35)
+* Update dependencies (#32)
+
+## 0.6.1
+
+* Update dependencies (#25)
+
+## 0.6.0
+
+* Implements `effect` method (#21)
+
 ## 0.5.4
 
 * Fix zero interest rate (#18)

data/Gemfile.lock

@@ -1,41 +1,40 @@
 PATH
   remote: .
   specs:
-    exonio (0.5.4)
+    exonio (0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (8.2.5)
-    coderay (1.1.2)
-    diff-lcs (1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
     method_source (1.0.0)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.3.0)
       byebug (~> 8.0)
       pry (~> 0.10)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.6)
+    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.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.11)
   exonio!
   pry-byebug (~> 3.3.0)
   rake (~> 13.0)

data/README.md

@@ -4,7 +4,7 @@ This gem brings some useful Excel formulas to Ruby. For now, it just has
 financial formulas, but could have more (like statistical formulas) in the future.
 
 [![Gem Version](https://badge.fury.io/rb/exonio.svg)](https://badge.fury.io/rb/exonio)
-[![Build Status](https://travis-ci.org/Noverde/exonio.svg?branch=master)](https://travis-ci.org/Noverde/exonio)
+[![Tests](https://github.com/noverde/exonio/actions/workflows/tests.yml/badge.svg)](https://github.com/noverde/exonio/actions)
 
 ## Installation
 
@@ -32,6 +32,25 @@ To use Exonio you just have to call the method you like to use. Example:
 
 ## Available Formulas
 
+### EFFECT
+
+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)
+
+```ruby
+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,7 +18,6 @@ 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"

data/lib/exonio/financial.rb

@@ -1,5 +1,38 @@
 module Exonio
   module Financial
+    # Calculates the effective annual interest rate, given a nominal interest rate and the number of
+    # compounding periods. Nominal interest rate is the stated rate on the financial product.
+    # Effective annual interest rate is the interest rate actually earned due to compounding.
+    # constant-amount periodic payments and a constant interest rate.
+    #
+    # @param rate [Float] The nominal interest rate as decimal (not per cent) per period
+    # @param nper [Integer] The number of compounding periods
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.effect(0.05, 12 * 10) # ==> 0.05126014873337037
+    #
+    def effect(rate, nper)
+      (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.
     #

data/lib/exonio/version.rb

@@ -1,3 +1,3 @@
 module Exonio
-  VERSION = "0.5.4"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exonio
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Rafael Izidoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2023-08-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
@@ -74,17 +60,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - exonio.gemspec
 - lib/exonio.rb
 - lib/exonio/financial.rb
@@ -109,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Excel usefull formulas written in Ruby

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.2
-  - 2.1
-before_install: gem install bundler -v 1.11.2

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "exonio"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here