interest_calc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b9270952b4db924510e32a7767e8938c0087bfb2808f5f91083f469fdc2f0f9
+  data.tar.gz: 7f35803f477a96ce89afef7fe150c02e7b53de92c33dd2027521e67420d29206
+SHA512:
+  metadata.gz: 7b433d79cc59d0d6a6368205d92d54fff8c877511693b9ce6e51cd230f0c2a04d074c4526d3a82b112ba0836d17c9b6be64d1c8f068c6c72fbe70c3c9a4f4812
+  data.tar.gz: f09d1dc9b2b0290b281f43e707f42737fe364d57d2a979f428ad811f57324a2f9cf6c63e1c588877eec12f1bc5d77b08b321f05f8a17bfebf4dce297fbad616e

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+
+*.sh
+sample_data.rb
+gre.rb
+gpm.rb
+ghug.rb
+.DS_Store

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 yas4891
+
+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,2 @@
+# interest_calc
+Ruby gem to calculate interests

data/interest_calc.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/interest_calc/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'interest_calc'
+  s.version     = InterestCalc::VERSION
+  s.summary     = "Useful methods around calculating interests, especially for open lines of credit"
+  s.description = "Helps you calculate interest for open lines of credit"
+  s.authors     = ["Christoph Engelhardt"]
+  s.email       = 'christoph@christophengelhardt.com'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  s.homepage    = 'https://rubygems.org/gems/interest_calc'
+  s.license     = 'MIT'
+
+  s.add_dependency('ostruct')
+  s.add_dependency('active_support')
+
+  s.add_dependency('interest_days')
+
+end

data/lib/interest_calc/calculators/open_line_calculator.rb

@@ -0,0 +1,159 @@
+require 'ostruct'
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'date'
+
+
+module InterestCalc
+  class OpenLineCalculator
+
+    attr_accessor :interest_rate
+
+    def initialize(interest_rate = 0.05)
+      @interest_rate = interest_rate
+    end
+
+    # calculates the interest per month for an open line of credit
+    def calculate(data)
+
+      return_values = []
+      nitem = nil
+      changes = data[:changes]
+
+      if changes.nil? || changes.count < 1
+        raise Exception.new "No changes to the line of credit provided. Please provide an array of changes data[:changes]"
+      end
+
+      changes = changes.reverse # allows us to use #pop
+      citem = changes.pop
+      cdate = citem[:date]
+      camount = citem[:amount]
+
+      puts "#{self.class.name}##{__method__}:calculation starts: #{cdate.at_beginning_of_month}"
+
+
+      return_values << {year: cdate.year,
+        month: cdate.month,
+        interest: self.calculate_interest(camount, cdate)
+      }
+
+      # after this point the calculations for the first month are done
+
+      cdate = cdate.at_beginning_of_month # normalize value to always be the first of the month
+      i = 0
+
+      # at the start changes won't be empty and
+      # when all the changes have been popped from the stack nitem won't be empty
+      while(!changes.empty? || !nitem.nil?)
+        puts
+        puts
+        puts "#{self.class.name}##{__method__}: RUN #{i}"
+        i+=1
+        # only pop the next item if the previously popped item was used
+        nitem = nitem || changes.pop
+        ndate = nitem[:date]
+        cdate = cdate.next_month
+        new_return_value = {year: cdate.year, month: cdate.month}
+        # the whole month needs to be calculated at the old amount
+        if(ndate.at_beginning_of_month != cdate)
+          puts "#{self.class.name}##{__method__}: FULL month calculation"
+          return_values << {
+            year: cdate.year,
+            month: cdate.month,
+            interest: self.calculate_interest(camount,cdate)
+          }
+        else # withdrawal/deposit within this month
+          puts "#{self.class.name}##{__method__}: SPLIT month calculation"
+          # calculate for first half of month with the old amount
+
+          interest = calculate_interest(camount, cdate, ndate )
+          puts "#{self.class.name}##{__method__}: amount changing. OLD:#{camount} -- change:#{nitem[:amount]} -- NEW:#{camount + nitem[:amount]}"
+          # change the calculation amount by adding the withdrawal/deposit
+          camount += nitem[:amount]
+
+          # calculate interest for 2nd half of month
+          interest += calculate_interest(camount, ndate)
+
+          return_values << {
+            year: cdate.year,
+            month: cdate.month,
+            interest: interest
+          }
+
+          # reset these variables to pop the next changes-item from the stack
+          ndate = nil
+          nitem = nil
+
+          # do NOT change cdate as this is already on the 1st of the month and will
+          # increase in the while loop
+
+        end
+
+
+      end # while !changes.empty?
+      cdate = cdate.next_month
+      # add one final month after the last month with changes
+      # so that users know how much interest is per month going forward
+      return_values << {year: cdate.year,
+        month: cdate.month,
+        interest: self.calculate_interest(camount, cdate)
+      }
+
+      return return_values
+
+    end
+
+
+    def print(data)
+      values = calculate data
+
+      puts "--------------------------------------"
+      puts "|    year-month  |     interest      |"
+      puts "--------------------------------------"
+      values.each do |item|
+        ym = "#{item[:year]}-#{item[:month]}".ljust(16)
+        i = item[:interest].to_f.round(2).to_s.rjust(19)
+        puts "|#{ym}|#{i}|"
+      end
+      puts "--------------------------------------"
+      return values
+    end
+
+    private
+    # calculates the interest for current time until either the end of the month (if no end_date given)
+    # or the given end_date
+    def calculate_interest(camount, cdate, end_date = nil)
+      if camount.nil?
+        raise "amount can't be nil"
+      end
+
+      puts "#{self.class.name}##{__method__}: date:#{cdate} -- end_date:#{end_date}"
+      # calculate until end of month if no end_date given.
+      # Add one day to include last day in calculations
+      end_date = end_date || (cdate.at_end_of_month)
+
+      puts "#{self.class.name}##{__method__}: interest rate: #{@interest_rate}"
+
+      result = interest_days_counter_factor(cdate, end_date) * @interest_rate * camount
+
+      puts "#{self.class.name}##{__method__}: calculated interest: #{result}"
+      return result
+    end
+
+    # returns the days counter factor based on European act/360 calculation strategy
+    def interest_days_counter_factor(date, end_date)
+
+      # use European style of calculation where any date on the 31st is
+      # counted as 30st
+      date = date - 1.day if 31 == date.mday
+      end_date = end_date - 1.day if 31 == end_date.mday
+
+      # add 1 to count the first day as well
+      days = ((end_date - date).to_i + 1)
+      factor = days / 360.0
+      puts "#{self.class.name}##{__method__}: days #{days}-- factor:#{factor}"
+      factor
+    end
+  end
+end

data/lib/interest_calc/version.rb

@@ -0,0 +1,3 @@
+module InterestCalc
+  VERSION = "0.1.0"
+end

data/lib/interest_calc.rb

@@ -0,0 +1,2 @@
+require_relative 'interest_calc/version'
+require_relative 'interest_calc/calculators/open_line_calculator'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: interest_calc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Engelhardt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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: active_support
+  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: interest_days
+  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'
+description: Helps you calculate interest for open lines of credit
+email: christoph@christophengelhardt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- interest_calc.gemspec
+- lib/interest_calc.rb
+- lib/interest_calc/calculators/open_line_calculator.rb
+- lib/interest_calc/version.rb
+homepage: https://rubygems.org/gems/interest_calc
+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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Useful methods around calculating interests, especially for open lines of
+  credit
+test_files: []