formulas 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 689f6cec1e958e23dba5a41b2eb083aa812961657b4a011911374afe5fef20f6
-  data.tar.gz: e00de4f4bb6e815516a3cc8ece2c7ba8655921d56143a6a92d4e41b22abcdc90
+  metadata.gz: a7f8f146ead6fce0f64131ee26955ff1066d13300b3c73f81d7ea3cafb61c8be
+  data.tar.gz: 1ac72a62a41f905d27c84cecd1da31ad434a632ba51110bc05242f0b3d8004c9
 SHA512:
-  metadata.gz: 0f3be3c409bce08fd1606ff9cde1da525353f5d1e25cf87c1083e7a13c592b6dd0c77c507f67bfa444add566f9fe3abab39aa0bcc85b2ffc8a2f2bed0bcb9892
-  data.tar.gz: 3e3e80e654b6f904342e0e87ba8c92e175c19f5d4e64b1670bba81c2325a8a8d0e8dd7ecf15c1c48234b25e9a8a4f916c3dd46f4f8a0a4cfd07c13534eff75d8
+  metadata.gz: a7d7ccbff597d9ca4b9fa5abac846235086e23d89b714e98cc85d7526cf54e42b6525158d8a294149b96403dc1e98ac6406ef0eecaa5800f8485d84bc92a7061
+  data.tar.gz: 0c2e7a4e8a6ee19433ec5b337c38a90cf1f54e6112bebaf37ad5c34564c8d3509d313d8242e8b014bdfc9d50bde367c9beb63c5937ff3d10d7f29f667e0cdfe4

data/formulas.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'formulas'
+  s.version     = '0.1.1'
+  s.summary     = "formulas"
+  s.description = "Home loan formulas"
+  s.authors     = ["formulas"]
+  s.email       = 'boopage@gmail.com'
+  s.platform    = Gem::Platform::RUBY
+  s.files       = Dir['lib/**/*.rb', 'formulas.gemspec']
+  s.homepage    =
+    'https://rubygems.org/gems/formulas'
+  s.license       = 'MIT'
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest", ">= 5.8"
+  s.add_development_dependency "minitest-reporters", ">= 1.1"
+end

data/lib/formulas.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Formulas
-  autoload :StudentLoanRepayment, './lib/formulas/student_loan_repayment'
-  autoload :Salary, './lib/formulas/salary'
-  autoload :PAYE, './lib/formulas/paye'
-  autoload :PAYG, './lib/formulas/payg'
-  autoload :Income, './lib/formulas/income'
-  autoload :WithholdingTax, './lib/formulas/withholding_tax'
-  autoload :Superannuation, './lib/formulas/superannuation'
-  autoload :LoanPrincipalCalculator, './lib/formulas/loan_principal_calculator'
+  autoload :StudentLoanRepayment, 'formulas/student_loan_repayment'
+  autoload :Salary, 'formulas/salary'
+  autoload :PAYE, 'formulas/paye'
+  autoload :PAYG, 'formulas/payg'
+  autoload :Income, 'formulas/income'
+  autoload :WithholdingTax, 'formulas/withholding_tax'
+  autoload :Superannuation, 'formulas/superannuation'
+  autoload :LoanPrincipalCalculator, 'formulas/loan_principal_calculator'
 
   MULTIPLIER_IN_FREQUENCY = {
     weekly: 52,

data/lib/formulas/expense.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Formulas
+  module Expense
+    extend self
+
+    # Expense.monthly_credit_card(10_000, 3)
+    # => 300
+    def monthly_credit_card(amount, monthly_interest_rate)
+      amount * (monthly_interest_rate / 100)
+    end
+  end
+end

data/lib/formulas/household.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Formulas
+  # Provide calculation for household expenses based on the number of child
+  # and single or pair of adults
+  #
+  # source = Household::Source.new(independent_expenses: [1262, 1878], dependent_expenses: 347)
+  # household = Household.new(independents: integer, dependents: integer, source: source)
+  #
+  # household.cal(:month)
+  #
+  class HouseHold
+    def initialize(independents:, dependents:, source: Source.new)
+      @independents = independents
+      @dependents = dependents
+      @source = source
+    end
+
+    def cal
+      @source.calculate_expense(independents: @independents, dependents: @dependents)
+    end
+  end
+end

data/lib/formulas/household/source.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Formulas
+  module Expense
+    module Household
+      class Source
+        DEFAULT_INDEPENDENT_EXPENSE = [1_262, 1_878]
+        DEFAULT_DEPENDENT_EXPENSE = 347
+        MAX_DEPENDENT = 4
+        MAX_INDEPENDENT = 2
+
+        def calculate_expense(independents:, dependents:)
+          validate(independents, dependents)
+
+          ind_exp = DEFAULT_DEPENDENT_EXPENSE[0..independents].sum
+          de_exp = dependents * DEFAULT_DEPENDENT_EXPENSE
+          ind_exp + de_exp
+        end
+
+        private
+
+        def validate(independents, dependents)
+          raise "" if independents < 0
+          raise "" if dependents < 0
+        end
+      end
+    end
+  end
+end

data/lib/formulas/income.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Formulas
+  module Income
+    extend self
+    DEFAULT_KIWISAVER = 3
+    DEFAULT_SUPER = 9.5
+
+    # Income.monthly_benefit_payment(100, :weekly)
+    # => 433
+    def monthly_benefit_payment(amount, frequency)
+      amount * Formulas::MULTIPLIER_IN_FREQUENCY[frequency] / 12
+    end
+
+    alias monthly_boarder_income monthly_benefit_payment
+
+    # Income.monthly_rental_income(100, :weekly)
+    # => 325
+    def monthly_rental_income(amount, frequency, fraction: 0.75)
+      (amount * Formulas::MULTIPLIER_IN_FREQUENCY[frequency] / 12) * fraction
+    end
+  end
+end

data/lib/formulas/loan_principal_calculator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+#
+module Formulas
+  class LoanPrincipalCalculator
+    attr_accessor :apr, :months, :repayment
+
+    def divide_by
+      interest_with_principal - 1
+    end
+
+    def interest_with_principal
+      (1 + (apr / 12)) ** months
+    end
+
+    def principal
+      (((repayment * divide_by) / interest_with_principal) * 12 ) / apr
+    end
+  end
+end

data/lib/formulas/paye.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# https://www.ato.gov.au/Rates/Individual-income-tax-rates/
+#
+module Formulas
+  # Calculate basic salary in frequency
+  # paye = Formulas::PAYE.new(gross_pay: 52_000, frequency: Formulas::ANNUAL)
+  #
+  # paye.tax(:monthly)
+  # => 718.33
+  #
+  # Provide a way to calculate pay as you earn calculator
+  class PAYE < WithholdingTax
+    # Provide a way to calculate PAYE tax
+    TAX_RATES = [
+      [[0, 14_000], 10.5],
+      [[14_000, 48_000], 17.5],
+      [[48_000, 70_000], 30],
+      [[70_000, 180_000], 33],
+      [[180_000], 39]
+    ]
+
+    def initialize(gross_pay:, frequency: Formulas::MONTHLY)
+      super(gross_pay, frequency, TAX_RATES)
+    end
+
+    def tax(request_frequency: Formulas::WEEKLY)
+      calculate_tax(request_frequency)
+    end
+  end
+end

data/lib/formulas/payg.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# https://www.ato.gov.au/rates/individual-income-tax-rates/
+#
+module Formulas
+  # Calculate basic salary in frequency
+  # salary = Income::Salary.new(52_000, Salary::ANNUAL)
+  #
+  # Taxable income
+  #
+  # Tax on this income
+  #
+  # 0 – $18,200
+  #
+  # Nil
+  #
+  # $18,201 – $45,000
+  #
+  # 19 cents for each $1 over $18,200
+  #
+  # $45,001 – $120,000
+  #
+  # $5,092 plus 32.5 cents for each $1 over $45,000
+  #
+  # $120,001 – $180,000
+  #
+  # $29,467 plus 37 cents for each $1 over $120,000
+  #
+  # $180,001 and over
+  #
+  # $51,667 plus 45 cents for each $1 over $180,000
+  #
+  # Plus 2 percent medicare
+  #
+  # salary.calculate(:monthly)
+  class PAYG < WithholdingTax
+    # Provide a way to calculate pay as you earn calculator
+    TAX_RATES = [
+      [[0, 18_200], 0],
+      [[18_201, 45_000], 19],
+      [[45_001, 120_000], 32.5],
+      [[120_001, 180_000], 37],
+      [[180_001], 45]
+    ]
+
+    def initialize(gross_pay:, frequency: Formulas::MONTHLY)
+      super(gross_pay, frequency, TAX_RATES)
+    end
+
+    def tax(request_frequency: Formulas::WEEKLY)
+      calculate_tax(request_frequency) * 1.02
+    end
+  end
+end

data/lib/formulas/salary.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Formulas
+  # Calculate basic salary in frequency
+  # salary = Formulas::Salary.new(gross_pay: 52_000, Salary::ANNUAL)
+  #
+  # salary.pay(:monthly)
+  #
+  # Provide a way to calculate salary in different frequencies
+  # It provide summaries of salary breakdown after deductions
+  # such as withholding tax, super, health care and methods to
+  # get the take home pay
+  #
+  class Salary
+    include FrequencyConversions
+    attr_reader :frequency
+
+    def initialize(gross_pay:, frequency:)
+      invalid_frequency unless FREQUENCIES.include?(frequency)
+      raise ArgumentError, 'Gross pay must be numeric' unless Numeric === gross_pay
+
+      @gross_pay = gross_pay
+      @frequency = frequency
+    end
+
+    def gross_pay(request_frequency: @frequency)
+      invalid_frequency unless FREQUENCIES.include?(frequency)
+      return @gross_pay if @frequency == request_frequency
+
+      convert_gross_pay_to(request_frequency).round(2)
+    end
+
+    private
+
+    def invalid_frequency
+      raise ArgumentError, "Invalid frequency, frequency are: #{FREQUENCIES.join(', ')}"
+    end
+
+    def convert_gross_pay_to(request_frequency)
+      send("convert_#{@frequency}_to_#{request_frequency}", @gross_pay)
+    end
+  end
+end

data/lib/formulas/student_loan_repayment.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# require_relative 'student_loan_repayment/fix_repayment_per_period'
+
+module Formulas
+
+  # Provide calculation to work out student loan repayment in frequency
+  # loan = StudentLoan.new(salary_amount: 1000, salary_frequency: Income::Salary::WEEKLY)
+  #
+  # loan.repayment
+  # => <#ConstantPerPeriod>
+  #
+  # loan.repayment
+  # => 317
+  #
+  #
+  module StudentLoanRepayment
+    autoload :RepaymentBase, './lib/formulas/student_loan_repayment/repayment_base'
+    autoload :FixRepaymentPerPeriod, './lib/formulas/student_loan_repayment/fix_repayment_per_period'
+    autoload :PercentRepaymentPerThreshold, './lib/formulas/student_loan_repayment/percent_repayment_per_threshold'
+    attr_reader :repayment
+
+    def initialize(income_strategy: , repayment_strategy:, rates:)
+      raise 'Missing required salary' unless income_strategy
+      raise 'Missing required repayment rates' unless rates
+      raise 'Missing required repayment strategy' unless repayment_strategy
+
+      @repayment = repayment_strategy.new(salary: income_strategy, repayment: rates)
+    end
+  end
+end

data/lib/formulas/student_loan_repayment/fix_repayment_per_period.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+#
+# @salary = Formulas::Salary.new(gross_pay: 100_000, frequency: Formulas::ANNUALLY)
+# @repayment_rates = Formulas::StudentLoanRepayment::FixRepaymentPerPeriod::DEFAULT_THRESHOLD
+#
+# loan = Formulas::StudentLoanRepayment::FixRepaymentPerPeriod.new(salary: @salary, repayment: @repayment_rates)
+# assert_equal loan.repayment, 797.2
+#
+module Formulas
+  module StudentLoanRepayment
+    class FixRepaymentPerPeriod < RepaymentBase
+      FIX_RATE = 0.12
+
+      DEFAULT_THRESHOLD = {
+          weekly: [390, 52],
+          fortnightly: [780, 26],
+          four_weeks: [1560, 13],
+          monthly: [1690, 12],
+          annually: [20280, 1],
+      }
+
+      def repayment
+        selected_base = @repayment_threshold[@salary.frequency]
+        less_base_cost = @salary.gross_pay - selected_base[0]
+        ((FIX_RATE * less_base_cost * selected_base[1]) / 12).round(2)
+      end
+    end
+  end
+end

data/lib/formulas/student_loan_repayment/percent_repayment_per_threshold.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Formulas
+  module StudentLoanRepayment
+    class PercentRepaymentPerThreshold < RepaymentBase
+      DEFAULT_THRESHOLD = [
+          [[0, 46_620], 0],
+          [[46_620, 53_826], 1],
+          [[53_826, 57_055], 2],
+          [[57_056, 60_479], 2.5],
+          [[60_480, 64_108], 3],
+          [[64_109, 67_954], 3.5],
+          [[67_955, 72_031], 4],
+          [[72_032, 76_354], 4.5],
+          [[76_355, 80_935], 5],
+          [[80_936, 85_792], 5.5],
+          [[85_793, 90_939], 6],
+          [[90_940, 96_396], 6.5],
+          [[96_397, 102_179], 7],
+          [[102_180, 108_309], 7.5],
+          [[108_310, 114_707], 8],
+          [[114_708, 121_698], 8.5],
+          [[121_699, 128_999], 9],
+          [[129_000, 136_739], 9.5],
+          [[136_740], 10],
+      ]
+    end
+  end
+end

data/lib/formulas/student_loan_repayment/repayment_base.rb

@@ -0,0 +1,10 @@
+module Formulas
+  module StudentLoanRepayment
+    class RepaymentBase
+      def initialize(salary:, repayment_threshold:)
+        @salary = salary
+        @repayment_threshold = repayment_threshold
+      end
+    end
+  end
+end

data/lib/formulas/superannuation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Formulas
+  # Calculate the super using the as per frequency
+  #
+  # salary = Formulas::Salary.new(gross_pay: 52_000, Salary::ANNUAL)
+  # super = Super.new(salary: salary, Super::KIWISAVER)
+  #
+  # super.calculate
+  # => 1,560.00
+  #
+  # super.calculate(Formulas::WEEKLY)
+  # => 30.00
+  #
+  class Superannuation
+    include FrequencyConversions
+
+    KIWISAVER = 3
+    AU_SUPER = 10
+
+    def initialize(salary:, superannuation:)
+      @salary =  salary
+      @super = superannuation
+    end
+
+    def calculate(request_frequency: Formulas::ANNUALLY)
+      result = @salary.gross_pay(request_frequency: request_frequency) * (@super.to_f / 100)
+      result.round(2)
+    end
+  end
+end

data/lib/formulas/withholding_tax.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Formulas
+  class WithholdingTax
+    include FrequencyConversions
+
+    def initialize(gross_pay, origin_frequency, tax_rate)
+      @gross_pay = gross_pay
+      @origin_frequency = origin_frequency
+      @tax_rate = tax_rate
+    end
+
+    protected
+
+    def calculate_tax(request_frequency)
+      @request_frequency = request_frequency
+
+      return annual_tax if request_frequency == Formulas::ANNUALLY
+
+      send("convert_annually_to_#{request_frequency}", annual_tax).round(2)
+    end
+
+    private
+
+    def annual_tax
+      annual_result = 0
+
+      if gross_pay_tax_index > 0
+        @tax_rate[0..gross_pay_tax_index].each_with_index do |current, index|
+          l = (index == gross_pay_tax_index) ? @gross_pay : current[0][1]
+          annual_result += ((l - current[0][0]) * (current[1].to_f / 100))
+        end
+      end
+      annual_result
+    end
+
+    def annual_gross_pay
+      return @gross_pay if @origin_frequency == Formulas::ANNUALLY
+      send("convert_#{@origin_frequency}_to_annually", @gross_pay)
+    end
+
+    def gross_pay_tax_index
+      @tax_rate.index { |current| current[0][0] <= annual_gross_pay && current[0][1] >= annual_gross_pay }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formulas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - formulas
@@ -39,12 +39,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 description: Home loan formulas
-email: ''
+email: boopage@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- formulas.gemspec
 - lib/formulas.rb
+- lib/formulas/expense.rb
+- lib/formulas/household.rb
+- lib/formulas/household/source.rb
+- lib/formulas/income.rb
+- lib/formulas/loan_principal_calculator.rb
+- lib/formulas/paye.rb
+- lib/formulas/payg.rb
+- lib/formulas/salary.rb
+- lib/formulas/student_loan_repayment.rb
+- lib/formulas/student_loan_repayment/fix_repayment_per_period.rb
+- lib/formulas/student_loan_repayment/percent_repayment_per_threshold.rb
+- lib/formulas/student_loan_repayment/repayment_base.rb
+- lib/formulas/superannuation.rb
+- lib/formulas/withholding_tax.rb
 homepage: https://rubygems.org/gems/formulas
 licenses:
 - MIT