loan_creator 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 838d0d280c585125b013b8ea6d7e8b58e94c2234fffe3d49d1c97f39a67b254f
-  data.tar.gz: 7a607035130b53af6678bdec2a91b9d99fcace0a1710db1ef83333a4b15133b0
+  metadata.gz: 3f7d2dcd74aa8a01bb25577eaf1c6ea05daba9eef071d76119d7ad00773fe0f7
+  data.tar.gz: ed40fe1ff5610cbef9bc5c5c92f31095a0eaa6ad745a8f194861e65d5b8e316b
 SHA512:
-  metadata.gz: 06c8e0dfa135c8a80f9969f60db83a8bc3630161fea4f208dff6480ab9142635d196aaa729fdb32fd89e38e87804cbc76fcc1f10ec464c680c10219ef7aec23c
-  data.tar.gz: c710e04d68debd3d7f63569586aed46ac1426aabf9ed995fa762a18745916d1f31339f93b173159ddd61dcf23b145527471dbc7ff873a1bdfc46169e310f4322
+  metadata.gz: 16256ac04047a1b505e37dddec9299d5409d1940dfe2d7271ebc0cc5207bfb5301f3375fbf3f793cb5a70dbacab3e5a7c3c6bd87d07c6449faeba2dd73368f71
+  data.tar.gz: 4fe77879f1dfa61adecaf5d30dcf2dd5d6c501c1d82b75232cd106ffa827c440d52326a37c25bc939f445010ab7c4d256527e92edef2124d3c6ed8369337c0eb

data/lib/loan_creator/bullet.rb

@@ -24,7 +24,7 @@ module LoanCreator
     def compute_last_term(timetable)
       @crd_end_of_period                  = bigd('0')
       @due_interests_beginning_of_period  = @due_interests_end_of_period
-      @period_interests                   = @due_interests_end_of_period + compute_capitalized_interests(@due_on, timetable)
+      @period_interests                   = @due_interests_end_of_period + compute_capitalized_interests(timetable)
       @due_interests_end_of_period        = 0
       @period_capital                     = @crd_beginning_of_period
       @total_paid_capital_end_of_period   += @period_capital
@@ -32,14 +32,22 @@ module LoanCreator
       @period_amount_to_pay               = @period_capital + @period_interests
     end
 
-    def compute_capitalized_interests(due_date, timetable)
-      computed_periodic_interests_rate = periodic_interests_rate(due_date, relative_to_date: timetable_term_dates[timetable.next_index - 1])
-      (amount + @due_interests_beginning_of_period).mult(computed_periodic_interests_rate, BIG_DECIMAL_DIGITS)
+    def compute_capitalized_interests(timetable)
+      if multi_part_interests_calculation && term_dates? && (timetable_term_dates[timetable.current_index] + 1.year) < @due_on
+        multi_part_interests(
+          timetable_term_dates[timetable.current_index],
+          @due_on,
+          annual_interests_rate,
+          amount_to_capitalize
+        )
+      else
+        compute_period_generated_interests(periodic_interests_rate(timetable_term_dates[timetable.current_index], @due_on))
+      end
     end
 
     def compute_term(timetable)
       @due_interests_beginning_of_period = @due_interests_end_of_period
-      @due_interests_end_of_period += compute_capitalized_interests(@due_on, timetable)
+      @due_interests_end_of_period += compute_capitalized_interests(timetable)
     end
   end
 end

data/lib/loan_creator/common.rb

@@ -1,6 +1,7 @@
 module LoanCreator
   class Common
     extend BorrowerTimetable
+    include TimeHelper
 
     PERIODS_IN_MONTHS = {
       month: 1,
@@ -30,9 +31,11 @@ module LoanCreator
       deferred_in_periods: 0,
       interests_start_date: nil,
       initial_values: {},
-      realistic_durations: false
+      realistic_durations: false,
+      multi_part_interests_calculation: true
     }.freeze
 
+
     attr_reader *REQUIRED_ATTRIBUTES
     attr_reader *OPTIONAL_ATTRIBUTES.keys
 
@@ -47,9 +50,9 @@ module LoanCreator
       prepare_custom_term_dates if term_dates?
     end
 
-    def periodic_interests_rate(date = nil, relative_to_date: nil)
+    def periodic_interests_rate(start_date, end_date)
       if realistic_durations?
-        compute_realistic_periodic_interests_rate_percentage_for(date, relative_to_date: relative_to_date).div(100, BIG_DECIMAL_DIGITS)
+        compute_realistic_periodic_interests_rate(start_date, end_date, annual_interests_rate)
       else
         @periodic_interests_rate ||=
           annual_interests_rate.div(12 / PERIODS_IN_MONTHS[period], BIG_DECIMAL_DIGITS).div(100, BIG_DECIMAL_DIGITS)
@@ -101,7 +104,7 @@ module LoanCreator
 
     def set_attributes
       required_attributes.each { |k| instance_variable_set(:"@#{k}", @options.fetch(k)) }
-      OPTIONAL_ATTRIBUTES.each { |k,v| instance_variable_set(:"@#{k}", @options.fetch(k, v)) }
+      OPTIONAL_ATTRIBUTES.each { |k, v| instance_variable_set(:"@#{k}", @options.fetch(k, v)) }
     end
 
     def validate(key, &block)
@@ -236,43 +239,6 @@ module LoanCreator
       (interests_start_date && interests_start_date < term_zero_date) && !term_dates?
     end
 
-    def leap_days_count(date, relative_to_date:)
-      start_year = relative_to_date.year
-      end_year = date.year
-
-      (start_year..end_year).sum do |year|
-        next 0 unless Date.gregorian_leap?(year)
-
-        start_date =
-          if start_year == year
-            relative_to_date
-          else
-            Date.new(year - 1, 12, 31)
-          end
-
-        end_date =
-          if end_year == year
-            date
-          else
-            Date.new(year, 12, 31)
-          end
-
-        end_date - start_date
-      end
-    end
-
-    def compute_realistic_periodic_interests_rate_percentage_for(date, relative_to_date:)
-      total_days = date - relative_to_date
-      leap_days = bigd(leap_days_count(date, relative_to_date: relative_to_date))
-      non_leap_days = bigd(total_days - leap_days)
-
-      annual_interests_rate.mult(
-        leap_days.div(366, BIG_DECIMAL_DIGITS) +
-        non_leap_days.div(365, BIG_DECIMAL_DIGITS),
-        BIG_DECIMAL_DIGITS
-      )
-    end
-
     def realistic_durations?
       term_dates? || @realistic_durations.present?
     end
@@ -301,7 +267,11 @@ module LoanCreator
     end
 
     def compute_period_generated_interests(interests_rate)
-      (@crd_beginning_of_period + @due_interests_beginning_of_period).mult(interests_rate, BIG_DECIMAL_DIGITS)
+      amount_to_capitalize.mult(interests_rate, BIG_DECIMAL_DIGITS)
+    end
+
+    def amount_to_capitalize
+      @crd_beginning_of_period + @due_interests_beginning_of_period
     end
   end
 end

data/lib/loan_creator/linear.rb

@@ -23,12 +23,25 @@ module LoanCreator
       @last_period = last_period?(idx)
       @deferred_period = @index <= deferred_in_periods
       @due_on = timetable_term_dates[timetable.next_index]
-      computed_periodic_interests_rate = periodic_interests_rate(@due_on, relative_to_date: timetable_term_dates[timetable.next_index - 1])
 
       # Reminder: CRD beginning of period = CRD end of period **of previous period**
       @crd_beginning_of_period = @crd_end_of_period
       @due_interests_beginning_of_period = @due_interests_end_of_period
-      @period_theoric_interests = period_theoric_interests(computed_periodic_interests_rate)
+
+      @period_theoric_interests = (
+        # if period is more than a year
+        if multi_part_interests_calculation && term_dates? && (timetable_term_dates[timetable.current_index] + 1.year) < @due_on
+          multi_part_interests(
+            timetable_term_dates[timetable.current_index],
+            @due_on,
+            annual_interests_rate,
+            amount_to_capitalize
+          )
+        else
+          period_theoric_interests(periodic_interests_rate(timetable_term_dates[timetable.current_index], @due_on))
+        end
+      )
+
       @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
       @accrued_delta_interests += @delta_interests
       @amount_to_add = bigd(

data/lib/loan_creator/standard.rb

@@ -24,7 +24,7 @@ module LoanCreator
       @last_period = last_period?(idx)
       @deferred_period = @index <= deferred_in_periods
       @due_on = timetable_term_dates[timetable.next_index]
-      computed_periodic_interests_rate = periodic_interests_rate(@due_on, relative_to_date: timetable_term_dates[timetable.next_index - 1])
+      computed_periodic_interests_rate = periodic_interests_rate(timetable_term_dates[timetable.current_index], @due_on)
 
       @crd_beginning_of_period = @crd_end_of_period
       @period_theoric_interests = period_theoric_interests(@index, computed_periodic_interests_rate)

data/lib/loan_creator/time_helper.rb

@@ -0,0 +1,62 @@
+module LoanCreator
+  module TimeHelper
+    extend ActiveSupport::Concern
+
+    included do
+      def leap_days_count(start_date, end_date)
+        start_year = start_date.year
+        # mostly no op but allows to skip one iteration if end date is january 1st
+        end_year = (end_date - 1.day).year
+
+        (start_year..end_year).sum do |year|
+          next 0 unless Date.gregorian_leap?(year)
+
+          current_start_date =
+            if start_year == year
+              start_date
+            else
+              Date.new(year, 1, 1)
+            end
+
+          current_end_date =
+            if end_year == year
+              end_date
+            else
+              Date.new(year + 1, 1, 1)
+            end
+
+          current_end_date - current_start_date
+        end
+      end
+
+      def compute_realistic_periodic_interests_rate(start_date, end_date, annual_interests_rate)
+        total_days = end_date - start_date
+        leap_days = bigd(leap_days_count(start_date, end_date))
+        non_leap_days = bigd(total_days - leap_days)
+
+        annual_interests_rate.mult(
+          leap_days.div(366, BIG_DECIMAL_DIGITS) +
+          non_leap_days.div(365, BIG_DECIMAL_DIGITS),
+          BIG_DECIMAL_DIGITS
+        ).div(100, BIG_DECIMAL_DIGITS)
+      end
+
+      # for terms spanning more than a year,
+      # we capitalize each years until the last one which behaves normally
+      def multi_part_interests(start_date, end_date, annual_interests_rate, amount_to_capitalize)
+        duration_in_days = end_date - start_date
+        leap_days = bigd(leap_days_count(start_date, end_date))
+        non_leap_days = bigd(duration_in_days - leap_days)
+
+        ratio = non_leap_days.div(365, BIG_DECIMAL_DIGITS) + leap_days.div(366, BIG_DECIMAL_DIGITS)
+        full_years, year_part = ratio.divmod(1)
+        rate = annual_interests_rate.div(100, BIG_DECIMAL_DIGITS)
+
+        total = amount_to_capitalize.mult((1 + rate)**full_years, BIG_DECIMAL_DIGITS)
+                                    .mult(1 + rate * year_part, BIG_DECIMAL_DIGITS)
+
+        total - amount_to_capitalize
+      end
+    end
+  end
+end

data/lib/loan_creator/timetable.rb

@@ -40,5 +40,9 @@ module LoanCreator
     def next_index
       @current_index.nil? ? @starting_index : @current_index + 1
     end
+
+    def current_index
+      @current_index.nil? ? @starting_index - 1 : @current_index
+    end
   end
 end

data/lib/loan_creator/uncapitalized_bullet.rb

@@ -33,7 +33,7 @@ module LoanCreator
     end
 
     def compute_interests(due_date, timetable)
-      computed_periodic_interests_rate = periodic_interests_rate(due_date, relative_to_date: timetable_term_dates[timetable.next_index - 1])
+      computed_periodic_interests_rate = periodic_interests_rate(timetable_term_dates[timetable.current_index], due_date)
       amount.mult(bigd(computed_periodic_interests_rate), BIG_DECIMAL_DIGITS)
     end
 

data/lib/loan_creator/version.rb

@@ -1,3 +1,3 @@
 module LoanCreator
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

data/lib/loan_creator.rb

@@ -8,6 +8,7 @@ module LoanCreator
   BIG_DECIMAL_DIGITS = 14
 
   autoload :ExcelFormulas,            'loan_creator/excel_formulas'
+  autoload :TimeHelper,               'loan_creator/time_helper'
   autoload :BorrowerTimetable,        'loan_creator/borrower_timetable'
   autoload :Common,                   'loan_creator/common'
   autoload :Standard,                 'loan_creator/standard'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - thibaulth
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,6 +178,7 @@ files:
 - lib/loan_creator/standard.rb
 - lib/loan_creator/term.rb
 - lib/loan_creator/term_dates_validator.rb
+- lib/loan_creator/time_helper.rb
 - lib/loan_creator/timetable.rb
 - lib/loan_creator/uncapitalized_bullet.rb
 - lib/loan_creator/version.rb