exonio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 869b6fadbc67f60c0e2f8b0e895729937d81fc4f
+  data.tar.gz: 130a055e7462d062ef80c08bb4047b290cbd9e1e
+SHA512:
+  metadata.gz: 0e5a2f45443ff975165c2101ea57fc5397d8a3e3ee7c1cc93ede9119ab2d050d865a16a439e5c306ba26c3b898220a90a6385ed97176f8378c5dbaea1ba9782e
+  data.tar.gz: c0065bced80d07a240ca0c2a57a0a958207e300093dd09bbdea781dae432794e89d1705a116fb5a996326e1f47f755dbb39d03c237ae18800b65d009b89eca5f

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exonio.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    exonio (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  exonio!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.md

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Noverde Team.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,108 @@
+# Exonio
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exonio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exonio
+
+## Usage
+
+To use Exonio you just have to call the method you like to use. Example:
+
+```ruby
+ Exonio.pmt(0.075 / 12, 12 * 15, 200_000) # ==> -1854.02
+```
+
+## Available Formulas
+
+### FV
+
+What is the future value after 10 years of saving $100 now, with
+an additional monthly savings of $100 with the interest rate at
+5% (annually) compounded monthly?
+
+```ruby
+Exonio.fv(0.05 / 12, 10 * 12, -100, -100) # ==> 15692.93
+```
+
+By convention, the negative sign represents cash flow out (i.e. money not
+available today).  Thus, saving $100 a month at 5% annual interest leads
+to $15,692.93 available to spend in 10 years.
+
+### NPER
+
+If you only had $150/month to pay towards the loan, how long would it take
+to pay-off a loan of $8,000 at 7% annual interest?
+
+```ruby
+Exonio.nper(0.07 / 12, -150, 8000) # ==> 64.07334877066185
+```
+
+So, over 64 months would be required to pay off the loan.
+
+### PMT
+
+What is the monthly payment needed to pay off a $200,000 loan in 15
+years at an annual interest rate of 7.5%?
+
+```ruby
+Exonio.nper(0.075 / 12, 12 * 15, 200_000) # ==> -1854.02
+```
+
+In order to pay-off (i.e., have a future-value of 0) the $200,000 obtained
+today, a monthly payment of $1,854.02 would be required.  Note that this
+example illustrates usage of `fv` (future value) having a default value of 0.
+
+## TODO
+
+There's a lot of formulas to be implemented, including:
+
+* ACCRINT
+* ACCRINTM
+* AMORDEGRC
+* AMORLINC
+* DB
+* DDB
+* IPMT
+* IRR
+* MIRR
+* NPV
+* PPMT
+* PV
+* RATE
+* SLN
+* SYD
+* VDB
+
+So feel free to pick one of those and open a pull request \o/.
+
+## Contributing
+ 1. Fork the repository
+ 2. Create a branch
+ 3. Hack hack hack...
+ 4. Create a spec
+ 5. Open a Pull Request ;)
+
+## License
+
+Exonio is released under the MIT License.
+
+## Special Thanks
+
+A special thanks goes to the python [NumPy project](http://www.numpy.org/), which was the source for most
+of the formulas.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/exonio.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exonio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exonio"
+  spec.version       = Exonio::VERSION
+  spec.authors       = ["Rafael Izidoro"]
+  spec.email         = ["izidoro.rafa@gmail.com"]
+
+  spec.summary       = %q{Excel usefull formulas written in Ruby}
+  spec.description   = %q{This gem implements some useful Excel formulas like PMT, IPMT, NPER, PV, etc...}
+  spec.homepage      = "http://github.com/noverde/exonio"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/exonio.rb

@@ -0,0 +1,6 @@
+require "exonio/version"
+require "exonio/financial"
+
+module Exonio
+  extend Financial
+end

data/lib/exonio/financial.rb

@@ -0,0 +1,72 @@
+module Exonio
+  module Financial
+    # Calculates the future value of an annuity investment based on
+    # constant-amount periodic payments and a constant interest rate.
+    #
+    # @param rate [Float] The interest rate as decimal (not per cent) per period
+    # @param nper [Integer] The number of compounding periods
+    # @param pmt [Float] The number of payments to be made
+    # @param pv [Float] The present value
+    # @param end_or_begining [Integer] Whether payments are due at the end (0) or
+    #   beggining (1) of each period
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.fv(0.05 / 12, 12 * 10, -100, -100) # ==> 15692.93
+    #
+    def fv(rate, nper, pmt, pv, end_or_beginning = 0)
+      temp = (1 + rate) ** nper
+      fact = (1 + rate* end_or_beginning) * (temp - 1) / rate
+      result = -(pv * temp + pmt * fact)
+
+      result.round(2)
+    end
+
+
+    # Calculates the number of payment periods for an investment based on
+    # 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 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
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.nper(0.07 / 12, -150, 8000) # ==> 64.07334877066185
+    #
+    def nper(rate, pmt, pv, fv = 0, end_or_beginning = 0)
+      z = pmt * (1 + rate * end_or_beginning) / rate
+      temp = Math.log((-fv + z) / (pv + z))
+
+      temp / Math.log(1 + rate)
+    end
+
+    # Calculates the periodic payment for an annuity investment based on
+    # constant-amount periodic payments and a constant interest rate.
+    #
+    # @param rate [Float] The interest rate as decimal (not per cent) per period
+    # @param nper [Integer] The number of payments to be made (number of periods)
+    # @param pv [Float] The present value of the annuity
+    # @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
+    #
+    # @return [Float]
+    #
+    # @example
+    #   Exonio.pmt(0.075/12, 12*15, 200_000) # ==> -1854.02
+    #
+    def pmt(rate, nper, pv, fv = 0, end_or_beginning = 0)
+      temp = (1 + rate) ** nper
+      fact = (1 + rate * end_or_beginning) * (temp - 1) / rate
+      result = -(fv + pv * temp) / fact
+
+      result.round(2)
+    end
+  end
+end

data/lib/exonio/version.rb

@@ -0,0 +1,3 @@
+module Exonio
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: exonio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael Izidoro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-22 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem implements some useful Excel formulas like PMT, IPMT, NPER,
+  PV, etc...
+email:
+- izidoro.rafa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exonio.gemspec
+- lib/exonio.rb
+- lib/exonio/financial.rb
+- lib/exonio/version.rb
+homepage: http://github.com/noverde/exonio
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Excel usefull formulas written in Ruby
+test_files: []