exonio 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f03859cf7c728a214f19e108e7a346635c5b419
-  data.tar.gz: e9d6b0f50cfe6d1b3cc7ba0c9f4c61d5fd438aea
+SHA256:
+  metadata.gz: 4c634f17bc1a7424b3be9e782fb72a8e226c4dd09a7b37d0dc71f026c2909b71
+  data.tar.gz: aa306d1c5dd6de8e32c06916057986291e551779293ceeed832100eacddf7c5b
 SHA512:
-  metadata.gz: 69ea29ea9f2f79ff0f37754f3d9f3863f8923c35561911cdfbe909a158e80be56fa7aeb142050bb6da6fe58d6080667dc432512491b196d1258d59115bb74275
-  data.tar.gz: 52172d1ba501744a5cc5d789f4ecc7f8acb6e2f5ad0a2271c2ec9d3c7f5a82c5b5659553cd5a39652daccc4fdef437b1a827ec43acdb4f31f6790b84637e325d
+  metadata.gz: 33ae1525fa62badfdc56d8203f4eab2d762f5284e4b4996b25b8a447c16f70c8beae9946137a03104e8c68c4c0c7131a70fc673fb26328faf9b74e2a42cc8035
+  data.tar.gz: e6b5907b0f28a7d235d462bbe3861398669d7339e0d77d0b3700cd906628a9d53660c51d5341915206bd6a32bc7dbbeec656e2ddfe4eb78d977914f3e8191496

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,30 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ["2.3.1", "2.7", "3.0", "3.1"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - 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,22 @@
 # CHANGELOG
 
+## 0.6.1
+
+* Update dependencies (#25)
+
+## 0.6.0
+
+* Implements `effect` method (#21)
+
+## 0.5.4
+
+* Fix zero interest rate (#18)
+* Remove BigDecimal.new deprecation warning (#17)
+
+## 0.5.3
+
+* Fix error on IRR function
+
 ## 0.5.2
 
 * Fix the IRR method

data/Gemfile.lock

@@ -1,37 +1,35 @@
 PATH
   remote: .
   specs:
-    exonio (0.5.2)
+    exonio (0.6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (8.2.1)
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    method_source (0.8.2)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+    byebug (8.2.5)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     pry-byebug (3.3.0)
       byebug (~> 8.0)
       pry (~> 0.10)
-    rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    slop (3.6.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
 
 PLATFORMS
   ruby
@@ -40,8 +38,8 @@ DEPENDENCIES
   bundler (~> 1.11)
   exonio!
   pry-byebug (~> 3.3.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.11.2
+   1.17.2

data/README.md

@@ -3,6 +3,9 @@
 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)
+[![Tests](https://github.com/noverde/exonio/actions/workflows/tests.yml/badge.svg)](https://github.com/noverde/exonio/actions)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,6 +32,16 @@ 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
+```
+
 ### FV
 
 What is the future value after 10 years of saving $100 now, with
@@ -124,6 +137,20 @@ Exonio.rate(12 * 3, 2_500, -50_000) # ==> 0.036006853458478955
 
 So, the rate applied is 3.60%.
 
+## Statistical formulas
+
+### Sum
+```ruby
+Exonio.sum([1, 2, 3, 4, 5]) # ==> 15
+```
+### Mean
+```ruby
+Exonio.mean([1, 2, 3, 4, 5]) # ==> 3.0
+```
+### Median
+```ruby
+Exonio.median([1, 2, 3, 6, 5, 4]) # ==> 3.5
+```
 ## TODO
 
 There's a lot of formulas to be implemented, including:
@@ -158,3 +185,4 @@ Exonio is released under the MIT License.
 A special thanks goes to the python [NumPy project](http://www.numpy.org/), which was the source for most
 of the formulas.
 
+

data/exonio.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug", "~> 3.3.0"
 end

data/lib/exonio/financial.rb

@@ -1,5 +1,22 @@
 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 future value of an annuity investment based on
     # constant-amount periodic payments and a constant interest rate.
     #
@@ -50,8 +67,8 @@ module Exonio
     # constant-amount periodic payments and a constant interest rate.
     #
     # @param rate [Float] The interest rate as decimal (not per cent) per period
-    # @param pmt [Float] The number of payments to be made
-    # @param pv [Float] The present value
+    # @param pmt [Float] The payment amount made each period
+    # @param pv [Float] The present value of the payments
     # @param fv [Float] The future value remaining after the final payment has been made
     # @param end_or_begining [Integer] Whether payments are due at the end (0) or
     #   beggining (1) of each period
@@ -62,6 +79,8 @@ module Exonio
     #   Exonio.nper(0.07 / 12, -150, 8000) # ==> 64.07334877066185
     #
     def nper(rate, pmt, pv, fv = 0, end_or_beginning = 0)
+      return (-pv - fv) / pmt if rate.zero?
+
       z = pmt * (1 + rate * end_or_beginning) / rate
       temp = Math.log((-fv + z) / (pv + z))
 

data/lib/exonio/{helpers.rb → helpers/irr_helper.rb}

@@ -11,7 +11,7 @@ module Exonio
 
       values.each do |key, value|
         define_method key do
-          BigDecimal.new(value)
+          BigDecimal(value)
         end
       end
 
@@ -21,7 +21,7 @@ module Exonio
 
       def values(x)
         value = Exonio.npv(x[0].to_f, @transactions)
-        [ value ]
+        [ value.to_d ]
       end
     end
   end

data/lib/exonio/statistical.rb

@@ -0,0 +1,41 @@
+module Exonio
+  module Statistical
+
+    # Sum of all numbers
+    #
+    # @param numbers_ary [array] and array of numbers to sum all elements
+    #
+    # @return [float]
+    #
+    # @example
+    #   Exonio.sum([1,2,3,4,5]) # => 15
+    def sum(numbers_ary)
+      numbers_ary.inject(0, :+)
+    end
+
+    # Simple mean formula: sum elements and / by length
+    #
+    # @param numbers_ary [array] an array of numbers to calculate the mean
+    #
+    # @return [float]
+    #
+    # @example
+    #   Exonio.mean([1,2,3,4,5]) # => 3.0
+    def mean(numbers_ary)
+      numbers_ary.inject(0) { |sum, i| sum + i }.to_f / numbers_ary.size
+    end
+
+    # Median formula
+    # @param numbers_ary [array] an array of numbers
+    #
+    # @return [float]
+    #
+    # @example
+    #   Exonio.median([1,2,3,4,5]) # => 3.0
+    def median(numbers_ary)
+      numbers_ary.sort!
+      len = numbers_ary.length
+      (numbers_ary[(len - 1) / 2] + numbers_ary[len / 2]) / 2.0
+    end
+  end
+end

data/lib/exonio/version.rb

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

data/lib/exonio.rb

@@ -1,11 +1,14 @@
 require 'bigdecimal'
 require 'bigdecimal/newton'
+require "bigdecimal/util"
 
 require 'exonio/version'
 require 'exonio/financial'
-require 'exonio/helpers'
+require 'exonio/statistical'
+require 'exonio/helpers/irr_helper'
 
 module Exonio
   extend Newton
   extend Financial
+  extend Statistical
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exonio
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Rafael Izidoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,21 +74,22 @@ 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
-- lib/exonio/helpers.rb
+- lib/exonio/helpers/irr_helper.rb
+- lib/exonio/statistical.rb
 - lib/exonio/version.rb
 homepage: http://github.com/noverde/exonio
 licenses: []
@@ -108,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Excel usefull formulas written in Ruby

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-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