finance_math 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f49354650ef84948e84ed7c9b779c7ccc14caa14
+  data.tar.gz: 84b0ecbe335d4dbe1473e8042b8b54cfa1e1dbaa
+SHA512:
+  metadata.gz: 1acd89e12dbb9083724014b867385f04723a07266274e5c0a6dd2716488a53b143594f6c5646f6b8d604f7638ab49f1f01024f97f4e27701d3e0b4f0f01a0ad2
+  data.tar.gz: ee94a8f06ee93ca2d47f7363a6294e02cfd4b85cd7fdb29b01c00112c2cbeb878e10a2bc86d1bfae7940fd3d7cc721545e212ef941eda0a9d598090de29ba254

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+/vendor/bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nebojsa Zoric
+
+MIT License
+
+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,62 @@
+![Gem Version](https://img.shields.io/badge/finance_math-0.2-blue.svg)
+![Build Status](https://img.shields.io/badge/build-passing-green.svg)
+
+
+## What is FinanceMath?
+
+FinanceMath is a Ruby library for mapping Exel functions. Due to lack such libraries to handle every day need, this library is created.
+
+## Installation
+
+FinanceMath is available as a gem, to install it just install the gem:
+
+    gem install finance_math
+
+If you're using Bundler, add the gem to Gemfile.
+
+    gem 'finance_math'
+
+Run `bundle install`.
+
+## Basic Usage
+
+Create an instance, and pass parameters for nominal annual rate, duration (in months), and amount of loan.
+
+```ruby
+
+Loan.new(10.5, 12, 15000)
+```
+
+## Functions 
+
+This is the list of available functions.
+
+## PMT
+
+Calculates the periodic payment for an annuity investment based on constant-amount periodic payments and a constant interest rate.
+
+```ruby
+
+loan = Loan.new(10.5, 12, 15000)
+loan.pmt
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kolosek/finance_math/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Tests
+
+Please cover with tests your pull requests
+
+## License
+
+MIT License. See LICENSE for details.
+
+## Copyright
+
+Copyright (c) 2014-2015 Nebojsa Zoric, and Kolosek, Inc. (http://kolosek.com)

data/Rakefile

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

data/finance_math.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'finance_math/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 library for Ruby.}
+  spec.description   = %q{Implementation of Excel functions in Ruby language}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/lib/finance_math.rb

@@ -0,0 +1,5 @@
+require "finance_math/version"
+
+module FinanceMath
+  autoload :Loan,         'finance_math/loan'
+end

data/lib/finance_math/loan.rb

@@ -0,0 +1,60 @@
+module FinanceMath
+  # the Loan class provides an interface for working with interest rates.
+  # @api public
+  class Loan
+    # @return [Integer] the duration for which the rate is valid, in months
+    # @api public
+    attr_accessor :duration
+
+    # @return [Float] the amount of loan request
+    # @api public
+    attr_accessor :amount
+
+    # @return [Float] the nominal annual rate
+    # @api public
+    attr_accessor :nominal_rate
+   
+    # @return [DecNum] the monthly rate
+    # @api public
+    attr_reader :monthly_rate
+
+
+
+    # create a new Loan instance
+    # @return [Loan]
+    # @param [Numeric] decimal value of the interest rate
+    # @param [Integer] Duration of the loan period
+    # @param [Float] Loan amount
+    # @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(nominal_rate, duration, amount)
+      @nominal_rate, @amount, @duration = nominal_rate.to_f, amount, duration
+      @monthly_rate = @nominal_rate / 100 / 12
+    end
+
+    def pmt(future_value=0, type=0)
+      ((@amount * interest(@monthly_rate, @duration) - future_value ) / ((1.0 + @monthly_rate * type) * fvifa(@monthly_rate, duration)))
+    end
+
+    protected
+
+      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
+  end
+end

data/lib/finance_math/version.rb

@@ -0,0 +1,3 @@
+module FinanceMath
+  VERSION = "0.0.1"
+end

data/spec/lib/loan_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Loan do
+  it "should return initial set nominal rate" do
+    loan = Loan.new(10, 12, 1000)
+    expect(loan.nominal_rate).to eq(10)
+  end
+
+  it "should return initial set duration period" do
+    loan = Loan.new(10, 12, 1000)
+    expect(loan.duration).to eq(12)
+  end
+
+  it "should return initial set amount loaned" do
+    loan = Loan.new(10, 12, 1000)
+    expect(loan.amount).to eq(1000)
+  end
+
+  context ".pmt" do
+
+    it "should return correct pmt value" do
+      loan = Loan.new(10, 12, 1000)
+      expect(loan.pmt).to eq(87.9158872300099)
+    end
+
+    it "should return correct pmt value" do
+      loan = Loan.new(0, 12, 1200)
+      expect(loan.pmt).to eq(100)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/finance_math/loan.rb'
+require 'finance_math'
+
+include FinanceMath

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: finance_math
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nebojsa Zoric
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implementation of Excel functions in Ruby language
+email:
+- office@kolosek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- finance_math.gemspec
+- lib/finance_math.rb
+- lib/finance_math/loan.rb
+- lib/finance_math/version.rb
+- spec/lib/loan_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Finance library for Ruby.
+test_files:
+- spec/lib/loan_spec.rb
+- spec/spec_helper.rb