formulas 0.1.1 → 0.1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7f8f146ead6fce0f64131ee26955ff1066d13300b3c73f81d7ea3cafb61c8be
-  data.tar.gz: 1ac72a62a41f905d27c84cecd1da31ad434a632ba51110bc05242f0b3d8004c9
+  metadata.gz: 4f95bf8ae022a90b5073d2421bdcad92aa870cc53c0a9c99db8954389e9c832c
+  data.tar.gz: a2502bbb84087d04237173f139ed0edd13b6adb172016a747f3c093a1e249416
 SHA512:
-  metadata.gz: a7d7ccbff597d9ca4b9fa5abac846235086e23d89b714e98cc85d7526cf54e42b6525158d8a294149b96403dc1e98ac6406ef0eecaa5800f8485d84bc92a7061
-  data.tar.gz: 0c2e7a4e8a6ee19433ec5b337c38a90cf1f54e6112bebaf37ad5c34564c8d3509d313d8242e8b014bdfc9d50bde367c9beb63c5937ff3d10d7f29f667e0cdfe4
+  metadata.gz: f4382114d2679c7c9e622750bc24407441f70c689bffefb76293bf7de38077d62f34564e6c8d0dc845dccc19eba3d0836420aad03d5bab9a89de58ab2922a670
+  data.tar.gz: 6d687293ba712f2861b1a7dfd0f78da9a7ce0b0c40b9bd52923c35b17886b6aa9516549b3117497633c357fd8266b18628ec81b6d5a954d533c305f3260a9e77

data/formulas.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'formulas'
-  s.version     = '0.1.1'
+  s.version     = '0.1.1.4'
   s.summary     = "formulas"
   s.description = "Home loan formulas"
   s.authors     = ["formulas"]

data/lib/formulas.rb

@@ -25,6 +25,13 @@ module Formulas
   FREQUENCIES = [ANNUALLY, WEEKLY, FORTNIGHTLY, MONTHLY]
 
   module FrequencyConversions
+    def convert_annually_to_annually(number)
+      number
+    end
+    alias :convert_weekly_to_weekly convert_annually_to_annually
+    alias :convert_fortnightly_to_fortnightly convert_annually_to_annually
+    alias :convert_monthly_to_monthly convert_annually_to_annually
+
     def convert_annually_to_weekly(number)
       number.to_f / 52
     end
@@ -60,5 +67,17 @@ module Formulas
     def convert_monthly_to_fortnightly(number)
       number.to_f * 12 / 26
     end
+
+    def convert_fortnightly_to_annually(number)
+      number.to_f * 26
+    end
+
+    def convert_fortnightly_to_weekly(number)
+      number.to_f / 2
+    end
+
+    def convert_fortnightly_to_monthly(number)
+      (number.to_f * 26) / 12
+    end
   end
 end

data/lib/formulas/paye.rb

@@ -19,6 +19,8 @@ module Formulas
       [[180_000], 39]
     ]
 
+    MAX_ACC_LEVY_PAYABLE = 130_911
+
     def initialize(gross_pay:, frequency: Formulas::MONTHLY)
       super(gross_pay, frequency, TAX_RATES)
     end
@@ -26,5 +28,13 @@ module Formulas
     def tax(request_frequency: Formulas::WEEKLY)
       calculate_tax(request_frequency)
     end
+
+    def levy
+      0.0139
+    end
+
+    def acc_payable
+      annual_gross_pay > MAX_ACC_LEVY_PAYABLE ? MAX_ACC_LEVY_PAYABLE : annual_gross_pay
+    end
   end
 end

data/lib/formulas/salary.rb

@@ -2,7 +2,7 @@
 
 module Formulas
   # Calculate basic salary in frequency
-  # salary = Formulas::Salary.new(gross_pay: 52_000, Salary::ANNUAL)
+  # salary = Formulas::Salary.new(pay: 52_000, Salary::ANNUAL)
   #
   # salary.pay(:monthly)
   #
@@ -15,19 +15,19 @@ module Formulas
     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
+    def initialize(pay:, frequency:)
+      @pay = pay
+      @frequency = frequency.to_sym
 
-      @gross_pay = gross_pay
-      @frequency = frequency
+      invalid_frequency unless FREQUENCIES.include?(@frequency)
+      raise ArgumentError, 'Gross pay must be numeric' unless Numeric === pay
     end
 
-    def gross_pay(request_frequency: @frequency)
+    def pay(request_frequency: @frequency)
       invalid_frequency unless FREQUENCIES.include?(frequency)
-      return @gross_pay if @frequency == request_frequency
+      return @pay if @frequency == request_frequency
 
-      convert_gross_pay_to(request_frequency).round(2)
+      convert_pay_to(request_frequency).round(2)
     end
 
     private
@@ -36,8 +36,8 @@ module Formulas
       raise ArgumentError, "Invalid frequency, frequency are: #{FREQUENCIES.join(', ')}"
     end
 
-    def convert_gross_pay_to(request_frequency)
-      send("convert_#{@frequency}_to_#{request_frequency}", @gross_pay)
+    def convert_pay_to(request_frequency)
+      send("convert_#{@frequency}_to_#{request_frequency}", @pay)
     end
   end
 end

data/lib/formulas/student_loan_repayment.rb

@@ -15,9 +15,9 @@ module Formulas
   #
   #
   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'
+    autoload :RepaymentBase, 'formulas/student_loan_repayment/repayment_base'
+    autoload :FixRepaymentPerPeriod, 'formulas/student_loan_repayment/fix_repayment_per_period'
+    autoload :PercentRepaymentPerThreshold, 'formulas/student_loan_repayment/percent_repayment_per_threshold'
     attr_reader :repayment
 
     def initialize(income_strategy: , repayment_strategy:, rates:)

data/lib/formulas/student_loan_repayment/fix_repayment_per_period.rb

@@ -12,16 +12,16 @@ module Formulas
       FIX_RATE = 0.12
 
       DEFAULT_THRESHOLD = {
-          weekly: [390, 52],
-          fortnightly: [780, 26],
-          four_weeks: [1560, 13],
-          monthly: [1690, 12],
-          annually: [20280, 1],
+        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]
+        less_base_cost = @salary.pay - selected_base[0]
         ((FIX_RATE * less_base_cost * selected_base[1]) / 12).round(2)
       end
     end

data/lib/formulas/superannuation.rb

@@ -24,7 +24,7 @@ module Formulas
     end
 
     def calculate(request_frequency: Formulas::ANNUALLY)
-      result = @salary.gross_pay(request_frequency: request_frequency) * (@super.to_f / 100)
+      result = @salary.pay(request_frequency: request_frequency) * (@super.to_f / 100)
       result.round(2)
     end
   end

data/lib/formulas/withholding_tax.rb

@@ -4,10 +4,25 @@ module Formulas
   class WithholdingTax
     include FrequencyConversions
 
-    def initialize(gross_pay, origin_frequency, tax_rate)
+    attr_reader :origin_frequency
+
+    def initialize(gross_pay, origin_frequency, tax_rate, options: {})
       @gross_pay = gross_pay
       @origin_frequency = origin_frequency
       @tax_rate = tax_rate
+      @options = options
+    end
+
+    def net_pay(request_frequency:)
+      annual_pay_after_tax = annual_gross_pay - calculate_tax(Formulas::ANNUALLY)
+
+      if respond_to?(:levy)
+        net_pay = annual_pay_after_tax - (acc_payable * send(:levy))
+      end
+
+      return net_pay if request_frequency.to_s == Formulas::ANNUALLY.to_s
+
+      send("convert_annually_to_#{request_frequency}", net_pay).round(2)
     end
 
     protected
@@ -15,7 +30,7 @@ module Formulas
     def calculate_tax(request_frequency)
       @request_frequency = request_frequency
 
-      return annual_tax if request_frequency == Formulas::ANNUALLY
+      return annual_tax if request_frequency.to_s == Formulas::ANNUALLY.to_s
 
       send("convert_annually_to_#{request_frequency}", annual_tax).round(2)
     end
@@ -27,7 +42,7 @@ module Formulas
 
       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]
+          l = (index == gross_pay_tax_index) ? annual_gross_pay : current[0][1]
           annual_result += ((l - current[0][0]) * (current[1].to_f / 100))
         end
       end
@@ -35,12 +50,15 @@ module Formulas
     end
 
     def annual_gross_pay
-      return @gross_pay if @origin_frequency == Formulas::ANNUALLY
+      return @gross_pay if @origin_frequency.to_s == Formulas::ANNUALLY.to_s
       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 }
+      @tax_rate.index do |current|
+        (current[0][0] <= annual_gross_pay && current[0][1].nil?) ||
+          (current[0][0] <= annual_gross_pay && current[0][1] >= annual_gross_pay)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formulas
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.1.4
 platform: ruby
 authors:
 - formulas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest