amortizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40ee0ac1619616e17dd30ee17321e671db480385
+  data.tar.gz: f891a114ab17c803d693581af5c035dc2130e388
+SHA512:
+  metadata.gz: 5b4c38fc4ae89262c94b208a404a88486097c777faa158e4d4692d95592980ab00374f5448664d57c47ee525e9079662bc52a96434f06780e2ae1523ae555410
+  data.tar.gz: 9656c03ea6096a98096d3f096b46a9e888671feba7aff3de151ec3901b04574f6f6dc20fc832d27e4b3d150409eaac4872e66bff05e6886bbaae005274b5317d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Geordee Naliyath
+
+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,36 @@
+# Amortizer
+
+A simple gem to calculate amortizing loan payments, as part of training at Samyukti
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'amortizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amortizer
+
+## Usage
+
+
+    require 'amortizer'
+    include Amortizer
+
+    loan = Loan.new(1000000, 10.5, 120)
+    loan.payment
+
+Please see the spec for more examples.
+
+## Contributing
+
+1. Fork it ( http://github.com/samyukti/amortizer/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/amortizer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amortizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amortizer"
+  spec.version       = Amortizer::VERSION
+  spec.authors       = ["Geordee Naliyath"]
+  spec.email         = ["geordee@gmail.com"]
+  spec.summary       = %q{A simple gem to calculate amortizing loan payments.}
+  spec.description   = %q{A simple gem to calculate amortizing loan payments, as part of training at Samyukti}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "bigdecimal"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/amortizer.rb

@@ -0,0 +1,6 @@
+require "amortizer/version"
+require "amortizer/loan"
+
+module Amortizer
+
+end

data/lib/amortizer/loan.rb

@@ -0,0 +1,53 @@
+module Amortizer
+
+  require 'bigdecimal/util'
+
+  class Loan
+    attr_accessor :decimals
+  
+    def initialize(principal, rate, term)
+      @principal = principal
+      @rate      = rate
+      @term      = term
+
+      @valid = convert_to_bigdecimals && validate_inputs if inputs_are_numbers
+      @rate /= (12 * 100) if @valid
+    end
+
+    def payment
+      calculate_payment if @valid
+    end
+
+  private
+
+    def calculate_payment
+      if @rate == 0
+        payment = (@principal / @term)
+      else
+        payment = @principal * ((@rate * ((1 + @rate) ** @term)) /
+                                    (((1 + @rate) ** @term) - 1))
+      end
+      payment.nan? ? nil : payment.to_f.round(@decimals || 2)
+    end
+
+    def is_number?(input)
+      true if Float(input) rescue false
+    end
+
+    def inputs_are_numbers
+      is_number?(@principal) && is_number?(@rate) && is_number?(@term)
+    end
+
+    def convert_to_bigdecimals
+      @principal = @principal.to_d
+      @rate      = @rate.to_d
+      @term      = @term.to_d
+    end
+
+    def validate_inputs
+      (@principal >= 0.0) && (@rate >= 0.0) && (@term >= 1.0)
+    end
+
+  end
+
+end

data/lib/amortizer/version.rb

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

data/spec/amortizer_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+include Amortizer
+
+describe Loan do
+  describe "#payment" do
+    # valid scenarios
+    it "returns 13493.5 for principal 1000000, rate 10.5, term 120" do
+      loan = Loan.new(1000000, 10.5, 120)
+      loan.payment.should == 13493.5
+    end
+
+    it "returns payment correctly, with rate as integer" do
+      loan = Loan.new(1000000, 10, 120)
+      loan.payment.should == 13215.07
+    end
+
+    it "returns payment correctly, if principal contains decimal" do
+      loan = Loan.new(1000.1, 10.1, 110)
+      loan.payment.should == 13.98
+    end
+
+    it "returns payment correctly, if term contains decimal" do
+      loan = Loan.new(1000.1, 10.1, 10.1)
+      loan.payment.should == 103.7
+    end
+
+    it "returns payment if principal, rate and term are strings of valid numbers" do
+      loan = Loan.new("1000000", "10.5", "120")
+      loan.payment.should == 13493.5
+    end
+
+    it "returns payment if the parameter is string of a valid number without integer part" do
+      loan = Loan.new("1000000", ".5", "120")
+      loan.payment.should == 8545.14
+    end
+
+    it "returns the same payment if the method is executed multiple times" do
+      loan = Loan.new(1000000, 10, 120)
+      loan.payment
+      loan.payment.should == 13215.07
+    end
+
+    it "returns the payment without decimals if 0 decimals are specified" do
+      loan = Loan.new(1000000, 10, 120)
+      loan.decimals = 0
+      loan.payment.should == 13215
+    end
+
+    it "returns the payment with 4 decimals if 4 decimals are specified" do
+      loan = Loan.new(1000000, 10, 120)
+      loan.decimals = 4
+      loan.payment.should == 13215.0737
+    end
+
+    # edge scenarios
+    it "returns 0 if the principal is 0" do
+      loan = Loan.new(0, 1, 1)
+      loan.payment.should == 0
+    end
+
+    it "returns principal in equal parts for term if the rate is 0" do
+      loan = Loan.new(1, 0, 2)
+      loan.payment.should == 0.5
+    end
+
+    it "returns payment if the term is equal to 1" do
+      loan = Loan.new(100, 1, 1)
+      loan.payment.should == 100.08
+    end
+
+    it "returns nil if the term is less than 1" do
+      loan = Loan.new(100, 1, 0.99)
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the term is less than 1" do
+      loan = Loan.new(100, 1, "0.9999999999999999999".to_d)
+      loan.payment.should be_nil
+    end
+
+    it "returns payment if the principal is very low" do
+      loan = Loan.new(0.0000000001, 1.0, 1.0)
+      loan.payment.should == 0.0
+    end
+
+    it "returns payment if the principal is very low" do
+      loan = Loan.new(0.0000000001, 1.0, 1.0)
+      loan.decimals = 20
+      loan.payment.should == 1.0008333333e-10
+    end
+
+    it "returns payment if the rate is very low" do
+      loan = Loan.new(1.0, 0.0000000001, 1.0)
+      loan.decimals = 20
+      loan.payment.should == 1.0000000000000833
+    end
+
+    it "returns payment if the principal is very large" do
+      loan = Loan.new(99999999999999999999, 1.0, 1.0)
+      loan.payment.should > 0
+    end
+
+    it "returns payment if the rate is very large" do
+      loan = Loan.new(1.0, 99999999999999999999, 1.0)
+      loan.payment.should > 0
+    end
+
+    it "returns payment if the term is very large and rate is 0" do
+      loan = Loan.new(1.0, 0, 99999999999999999999)
+      loan.decimals = 20
+      loan.payment.should > 0
+    end
+
+    # invalid scenarios
+    it "returns nil if the principal is negative" do
+      loan = Loan.new(-0.1, 1.0, 1.0)
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the rate is negative" do
+      loan = Loan.new(1.0, -0.1, 1.0)
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the term is negative" do
+      loan = Loan.new(1.0, 1.0, -0.1)
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the principal is string which does not convert to a number" do
+      loan = Loan.new("x", "1", "1")
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the rate is string which does not convert to a number" do
+      loan = Loan.new("1", "x", "1")
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the term is string which does not convert to a number" do
+      loan = Loan.new("1", "5", "x")
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the parameter is string of a valid number without decimal part" do
+      loan = Loan.new("1", "5.", "1")
+      loan.payment.should be_nil
+    end
+
+    it "returns nil if the term is very large and rate is 1" do
+      loan = Loan.new(1.0, 1, 99999999999999999999)
+      loan.decimals = 20
+      loan.payment.should == nil
+    end
+
+    it "returns nil if the term is very large and rate is very small" do
+      loan = Loan.new(1.0, 0.000000000000000001, 99999999999999999999)
+      loan.decimals = 20
+      loan.payment.should == nil
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'amortizer'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: amortizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Geordee Naliyath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: A simple gem to calculate amortizing loan payments, as part of training
+  at Samyukti
+email:
+- geordee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amortizer.gemspec
+- lib/amortizer.rb
+- lib/amortizer/loan.rb
+- lib/amortizer/version.rb
+- spec/amortizer_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.0.6
+signing_key: 
+specification_version: 4
+summary: A simple gem to calculate amortizing loan payments.
+test_files:
+- spec/amortizer_spec.rb
+- spec/spec_helper.rb