au_loan_calculations 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92c63ef9ede64da1ff83e5f31c5c43381904d6c1b826c497a9208b4326f8becb
+  data.tar.gz: 75dc94b341e28b6ed20cd39a174055de6dbf2044a210c6d9ad98ab23e2afb29b
+SHA512:
+  metadata.gz: e3175a983c5ad867ecb92986b4c8d66bc37020e381bf9e5dadf9096265254ab1f7940f67561a1b8936803af713df3c29f1590649f4d7b90b44d6d9510e61d6d0
+  data.tar.gz: c81e2c4cfa1c1e397e999264e39b963601f15fbc56d0a9d5fff529ea52127f45d4f0cb59069a4332dfc304b39cae1a84b05229a80a3df382d0beea3e10591c29

data/README.md

@@ -0,0 +1,69 @@
+# HomeLoan
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/home_loan`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'au_loan_calculations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install au_loan_calculations
+
+## Usage
+
+#### How to calculate monthly repayment for a Loan
+
+To calculate the monthly repayment value for a loan call the following class method:
+
+```ruby
+AuLoanCalculations::Loan.calculate_monthly_repayment(repayment_type, interest_rate, loan_amount, period=360, iop=0, future_value=0, type=0)
+```
+
+#### How to convert an amount frequency
+
+Convert an amount to other frequency:
+
+```ruby
+AuLoanCalculations::Parse.convert_amount(amount, frequency, convert_to)
+```
+The allowed values for **frequency** and **convert_to** are: `weekly`, `fortnightly`, `monthly` and `yearly`.
+
+
+#### How to calculate the PAYG NET income value
+
+To calculate the PAYG NET income value call the class method:
+
+```ruby
+AuLoanCalculations::Income.calculate_payg_net_value(value, year*)
+```
+
+The `year` parameter is optional. Its default value is the current year.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/home_loan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HomeLoan project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/home_loan/blob/master/CODE_OF_CONDUCT.md).

data/assets/csvs/payg_tax_rates/2018.csv

@@ -0,0 +1,6 @@
+min_value,max_value,threshold,tax_over_threshold,tax_per_dollar_over_threshold,medicare_levy_percentage
+0,18200,0,0,0,2
+18201,37000,18200,0,0.19,2
+37001,87000,37000,3572,0.325,2
+87001,180000,87000,19822,0.37,2
+180001,1000000000000,180000,54232,0.45,2

data/lib/au_loan_calculations.rb

@@ -0,0 +1,10 @@
+require "au_loan_calculations/exception/asset_not_found_error"
+
+require "au_loan_calculations/version"
+require "au_loan_calculations/loan"
+require "au_loan_calculations/parse"
+require "au_loan_calculations/income"
+
+module AuLoanCalculations
+
+end

data/lib/au_loan_calculations/exception/asset_not_found_error.rb

@@ -0,0 +1,9 @@
+module AuLoanCalculations
+  module Exception
+    class AssetNotFoundError < StandardError
+      def initialize(msg = 'Asset not found')
+        super
+      end
+    end
+  end
+end

data/lib/au_loan_calculations/income.rb

@@ -0,0 +1,44 @@
+require 'date'
+require 'csv'
+
+module AuLoanCalculations
+  class Income
+
+    def self.calculate_payg_net_value(value, year=Date.today.year)
+      begin
+        # income_tax_rates_file = CSV.read("vendor/assets/csvs/payg_tax_rates/#{year.to_s}.csv", { headers: true })
+        gem_path ||= File.expand_path '..', File.dirname(__FILE__)
+        assets_path ||= File.join gem_path, "../assets"
+        file = File.join assets_path, "csvs/payg_tax_rates/#{year.to_s}.csv"
+
+        income_tax_rates_file = CSV.read(file, { headers: true })
+
+        income_tax_rates_file.each do |income_tax_rate|
+
+          # check the income tax rate
+          if value >= income_tax_rate["min_value"].to_i && value <= income_tax_rate["max_value"].to_i
+
+            # calculate the taxable value
+            tax_over_threshold = value - income_tax_rate["threshold"].to_i
+
+            # sum the taxable value plus range tax value
+            tax_value = tax_over_threshold * income_tax_rate["tax_per_dollar_over_threshold"].to_f
+
+            # calculate medicare levy value
+            medicare_levy_value = (value * income_tax_rate["medicare_levy_percentage"].to_f) / 100
+
+            # calculate total tax (including medicare levy value)
+            total_tax = income_tax_rate["tax_over_threshold"].to_i + tax_value + medicare_levy_value
+
+            # income value - total tax
+            return (value - total_tax)
+          end
+        end
+
+      rescue Errno::ENOENT
+        raise AuLoanCalculations::Exception::AssetNotFoundError, "Unable to find the income tax rates for #{year}."
+      end
+    end
+
+  end
+end

data/lib/au_loan_calculations/loan.rb

@@ -0,0 +1,31 @@
+module AuLoanCalculations
+  class Loan
+
+    # period - number of periods (months)
+    # interest_only_period - interest only period (years)
+    # type - when the payments are due:
+    #  0: end of the period, e.g. end of month (default)
+    #  1: beginning of period
+    def self.calculate_monthly_repayment(repayment_type, interest_rate, loan_amount, period=360, iop=0, future_value=0, type=0)
+      interest_rate = (interest_rate / 100) / 12
+
+      if repayment_type == "interest_only"
+        interest_only_period = iop
+        period = period - (interest_only_period * 12)
+      else
+        period = period
+      end
+
+
+      return -(loan_amount + future_value)/period if interest_rate == 0
+
+      pvif = ((1 + interest_rate) ** period)
+      pmt = - interest_rate * loan_amount * ( pvif + future_value ) / ( pvif - 1 )
+
+      pmt = pmt / (1 + interest_rate) if type == 1
+
+      return pmt.round(2).abs
+    end
+
+  end
+end

data/lib/au_loan_calculations/parse.rb

@@ -0,0 +1,62 @@
+module AuLoanCalculations
+  class Parse
+
+    # the amount to be converted.
+    # the current frequency - allowed values: weekly, fortnightly, monthly, yearly
+    # the frequency the amount should be converted - allowed values: weekly, fortnightly, monthly, yearly
+    def self.convert_amount(amount, frequency, convert_to)
+      value = case convert_to
+      when 'weekly'
+        case frequency
+        when 'fortnightly'
+          amount / 2
+        when 'monthly'
+          (amount * 12) / 52
+        when 'yearly'
+          amount / 52
+        else
+          amount
+        end
+
+      when 'fortnightly'
+        case frequency
+        when 'weekly'
+          amount * 2
+        when 'monthly'
+          (amount * 12) / 26
+        when 'yearly'
+          amount / 26
+        else
+          amount
+        end
+
+      when 'monthly'
+        case frequency
+        when 'weekly'
+          (amount * 52) / 12
+        when 'fortnightly'
+          (amount * 26) / 12
+        when 'yearly'
+          amount / 12
+        else
+          amount
+        end
+
+      when 'yearly'
+        case frequency
+        when 'weekly'
+          amount * 52
+        when 'fortnightly'
+          amount * 26
+        when 'monthly'
+          amount * 12
+        else
+          amount
+        end
+      end
+
+      value.round(2)
+    end
+
+  end
+end

data/lib/au_loan_calculations/version.rb

@@ -0,0 +1,3 @@
+module AuLoanCalculations
+  VERSION = "0.1.6"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: au_loan_calculations
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Andre Possebom
+- Pedro Pereira Santos
+- Rod Dutra
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: AuLoanCalculations library contains a couple of useful functions for
+  Austrlian home loans.
+email:
+- andre@loandolphin.com.au
+- pedro@loandolphin.com.au
+- rod@loandolphin.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- assets/csvs/payg_tax_rates/2018.csv
+- lib/au_loan_calculations.rb
+- lib/au_loan_calculations/exception/asset_not_found_error.rb
+- lib/au_loan_calculations/income.rb
+- lib/au_loan_calculations/loan.rb
+- lib/au_loan_calculations/parse.rb
+- lib/au_loan_calculations/version.rb
+homepage: https://github.com/possebom/au_loan_calculations_gem
+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.7.5
+signing_key: 
+specification_version: 4
+summary: This gem contains home loan functions for Australian market.
+test_files: []