loan_creator 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cca09d7b818ee423c142ca692301a01963982ff2b003c65b8097f2972648fa5
-  data.tar.gz: ba3169e453b3dcd7dbab5f5ce543fbc03c6744e87425adfdb12ad8bfdbf102b7
+  metadata.gz: fb6c8e7e02bc1349e47dcb07602828d051cfa63ac7fc3e16394604f8dda05e27
+  data.tar.gz: d103c1e0524641e73b307702eec5bd1cf43029236a3d791805e4d62e7e0732d3
 SHA512:
-  metadata.gz: a40a97895eacab077be8a4a8ca414fda3a026bb6aac721ca35e03891d24ea6c58f44cd6a68e875860ff660a8b418692ad88e00d89b0e6c16842006f99330cae7
-  data.tar.gz: 833292dfdfabe53174a6c65b9509df02060c72c09bfa67c08e8e73535ed1e413e335269d5a073ad5951a76cc310b5eb2f53e138053312d6be8622ad096e3309e
+  metadata.gz: c201e2a5fb2a5aaa54b1870b635e11c08b90d35f45258852f4cf61e5faa99756272b54db5a85c470123b5baaf5dedd5a9be79af8577796595997540cad4662b9
+  data.tar.gz: 00556c176b2e27765ca5112878495c7982cdaeb75abfe3b3956b57c6be57dfcf6c8cf89136bbfa0c94c40e7d43927ff2eafa8c0518f99d0be914e1bd7df1b70d

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+v0.9.0
+-------------------------
+- add possibility to pass the argument `term_dates` for `LoanCreator::Bullet`, `LoanCreator::InFine` and `LoanCreator::Linear`
+- `term_dates` option is based on `realistic_durations` and allow to compute terms custom date to custom date
+
+v0.8.2
+-------------------------
+
+- manage initial value `due_interests` for Linear and InFine loan types
+
+v0.8.1
+-------------------------
+- add `realistic_durations` option
+
+v0.8.0
+-------------------------
+
+#### Feature
+- due interests to date are now store into `due_interests_` columns for `LoanCreator::UncapitalizedBullet`
+
+#### Bugfix
+- fix `initial_values` not taking `paid_capital` and `paid_interests` into account for `LoanCreator::UncapitalizedBullet`
+  and `LoanCreator::Bullet`
+
+#### Breaking changes
+- rename columns `capitalized_interests_beginning_of_period` and `capitalized_interests_end_of_period` for
+  `due_interests_beginning_of_period` and `due_interests_end_of_period`
+- rename `capitalized_interests` option in `:inital_values` into `due_interests`
+
+
+v0.7.1
+-------------------------
+
+- fix `index` for `borrower_timetable` method that did not take into account starting index of `lender_timetables`
+
 v0.7.0
 -------------------------
 

data/README.md

@@ -44,9 +44,10 @@ Each instance of one of the previous classes has the following attributes:
     :annual_interests_rate
     :starts_at
     :duration_in_periods
-    :deferred_in_periods (default to zero)
+    :deferred_in_periods (defaults to zero)
     :interests_start_date (optional)
     :initial_values (to generate a timetable from a previous term or at a given state)
+    :realistic_durations (optional, defaults to false)
 ```
 
 Initial values must be a hash with specific keys, like so:
@@ -57,7 +58,7 @@ Initial values must be a hash with specific keys, like so:
     paid_interests: 11000.0,
     accrued_delta_interests: 0,
     starting_index: 2,
-    capitalized_interests: 0
+    due_interests: 0
 }
 ```
 
@@ -102,6 +103,9 @@ There is also a `LoanCreator::Timetable` class dedicated to record the data of t
 
       # Amount to pay this term
       :period_amount_to_pay
+
+      # Whether or not to use the real number of days in each month
+      :realistic_durations
 ```
 
 `#periodic_interests_rate` renders a precise calculation of the loan's periodic interests rate based on two inputs: `#annual_interests_rate` and `#period`.
@@ -148,9 +152,11 @@ Capital share shall be repaid in full at loan's end.
 `Bullet` loan generates terms where terms' payments are zero. \
 Interests are capitalized, i.e. added to the borrowed capital on each term.\
 Capital share shall be repaid in full and all interests paid at loan's end.
+N.b.: Due capitalized interests to date are stored into terms under `due_intesrests_` columns
 
 `UncapitalizedBullet` same as bullet, the only difference is the interests\
 are NOT capitalized.
+N.b.: Due interests to date are stored into terms under `due_intesrests_` columns
 
 There is no deferred time for `InFine` and `Bullet` loans as it would be equivalent to increasing loan's duration.
 
@@ -174,6 +180,11 @@ additional term with only interests for the time difference.
 For example, with a `start_at` in january 2020 and a `interests_start_date` in october 2019, the timetable will include a
 first term corresponding to 3 months of interests.
 
+`realistic_durations`: Optional. A boolean tha specifies whether or not to use the real number of days in each month when calculating the periodic interests rate. Note that leap years are taken into account. Default: `false`.
+The default behaviour is to use the `period` in relation to the number of months in a year (ie: 12)
+
+`term_dates`: Optional. Implemented for `LoanCreator::Bullet`, `LoanCreator::InFine` and `LoanCreator::Linear`. Can be used if you want to implement custom due dates for terms. Terms will be compute from date to date. Must be an array with following dates.
+
 ## Calculation
 
 An excel simulator for standard case can be found [here](CapSens_Loan.xlsx).

data/lib/loan_creator.rb

@@ -7,14 +7,15 @@ require 'loan_creator/version'
 module LoanCreator
   BIG_DECIMAL_DIGITS = 14
 
-  autoload :ExcelFormulas,       'loan_creator/excel_formulas'
-  autoload :BorrowerTimetable,   'loan_creator/borrower_timetable'
-  autoload :Common,              'loan_creator/common'
-  autoload :Standard,            'loan_creator/standard'
-  autoload :Linear,              'loan_creator/linear'
-  autoload :InFine,              'loan_creator/in_fine'
-  autoload :Bullet,              'loan_creator/bullet'
-  autoload :Timetable,           'loan_creator/timetable'
-  autoload :Term,                'loan_creator/term'
-  autoload :UncapitalizedBullet, 'loan_creator/uncapitalized_bullet'
+  autoload :ExcelFormulas,            'loan_creator/excel_formulas'
+  autoload :BorrowerTimetable,        'loan_creator/borrower_timetable'
+  autoload :Common,                   'loan_creator/common'
+  autoload :Standard,                 'loan_creator/standard'
+  autoload :Linear,                   'loan_creator/linear'
+  autoload :InFine,                   'loan_creator/in_fine'
+  autoload :Bullet,                   'loan_creator/bullet'
+  autoload :Timetable,                'loan_creator/timetable'
+  autoload :Term,                     'loan_creator/term'
+  autoload :UncapitalizedBullet,      'loan_creator/uncapitalized_bullet'
+  autoload :TermDatesValidator,        'loan_creator/term_dates_validator'
 end

data/lib/loan_creator/borrower_timetable.rb

@@ -7,6 +7,8 @@ module LoanCreator
       :period_capital,
       :total_paid_capital_end_of_period,
       :total_paid_interests_end_of_period,
+      :due_interests_beginning_of_period,
+      :due_interests_end_of_period,
       :period_amount_to_pay
     ].freeze
 
@@ -18,8 +20,8 @@ module LoanCreator
       end
 
       borrower_timetable = LoanCreator::Timetable.new(
-        starts_on: lenders_timetables.first.starts_on,
-        period: lenders_timetables.first.period
+        starting_index: lenders_timetables.first.starting_index,
+        loan: lenders_timetables.first.loan
       )
 
       # Borrower timetable is not concerned with computation-related value (delta, etc.),

data/lib/loan_creator/bullet.rb

@@ -7,33 +7,39 @@ module LoanCreator
       reset_current_term
       @crd_beginning_of_period = amount
       @crd_end_of_period = amount
-      (duration_in_periods - 1).times { |period| compute_term(timetable) }
-      compute_last_term
-      timetable << current_term
+
+      duration_in_periods.times { |idx| timetable << compute_current_term(idx, timetable) }
+
       timetable
     end
 
     private
 
-    def compute_last_term
-      @crd_end_of_period                         = bigd('0')
-      @capitalized_interests_beginning_of_period = @capitalized_interests_end_of_period
-      @period_interests                          = @capitalized_interests_end_of_period + compute_capitalized_interests
-      @capitalized_interests_end_of_period       = 0
-      @period_capital                            = @crd_beginning_of_period
-      @total_paid_capital_end_of_period          = @period_capital
-      @total_paid_interests_end_of_period        = @period_interests
-      @period_amount_to_pay                      = @period_capital + @period_interests
+    def compute_current_term(idx, timetable)
+      @due_on = timetable_term_dates[timetable.next_index]
+      last_period?(idx) ? compute_last_term(timetable) : compute_term(timetable)
+      current_term
+    end
+
+    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)
+      @due_interests_end_of_period        = 0
+      @period_capital                     = @crd_beginning_of_period
+      @total_paid_capital_end_of_period   += @period_capital
+      @total_paid_interests_end_of_period += @period_interests
+      @period_amount_to_pay               = @period_capital + @period_interests
     end
 
-    def compute_capitalized_interests
-      (amount + @capitalized_interests_beginning_of_period).mult(periodic_interests_rate, BIG_DECIMAL_DIGITS)
+    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)
     end
 
     def compute_term(timetable)
-      @capitalized_interests_beginning_of_period = @capitalized_interests_end_of_period
-      @capitalized_interests_end_of_period += compute_capitalized_interests
-      timetable << current_term
+      @due_interests_beginning_of_period = @due_interests_end_of_period
+      @due_interests_end_of_period += compute_capitalized_interests(@due_on, timetable)
     end
   end
 end

data/lib/loan_creator/common.rb

@@ -17,11 +17,20 @@ module LoanCreator
       :duration_in_periods
     ].freeze
 
+    REQUIRED_ATTRIBUTES_TERM_DATES = [
+      :amount,
+      :annual_interests_rate,
+      :starts_on,
+      :duration_in_periods,
+      :term_dates
+    ].freeze
+
     OPTIONAL_ATTRIBUTES = {
       # attribute: default_value
       deferred_in_periods: 0,
       interests_start_date: nil,
-      initial_values: {}
+      initial_values: {},
+      realistic_durations: false
     }.freeze
 
     attr_reader *REQUIRED_ATTRIBUTES
@@ -35,16 +44,29 @@ module LoanCreator
       validate_attributes
       set_initial_values
       validate_initial_values
+      prepare_custom_term_dates if term_dates?
     end
 
-    def periodic_interests_rate_percentage
-      @periodic_interests_rate_percentage ||=
-        annual_interests_rate.div(12 / PERIODS_IN_MONTHS[period], BIG_DECIMAL_DIGITS)
+    def periodic_interests_rate(date = nil, relative_to_date: nil)
+      if realistic_durations?
+        compute_realistic_periodic_interests_rate_percentage_for(date, relative_to_date: relative_to_date).div(100, BIG_DECIMAL_DIGITS)
+      else
+        @periodic_interests_rate ||=
+          annual_interests_rate.div(12 / PERIODS_IN_MONTHS[period], BIG_DECIMAL_DIGITS).div(100, BIG_DECIMAL_DIGITS)
+      end
     end
 
-    def periodic_interests_rate
-      @periodic_interests_rate ||=
-        periodic_interests_rate_percentage.div(100, BIG_DECIMAL_DIGITS)
+    def timetable_term_dates
+      @_timetable_term_dates ||= Hash.new do |dates, index|
+        dates[index] =
+          if index < 1
+            dates[index + 1].advance(months: -PERIODS_IN_MONTHS.fetch(period))
+          elsif index == 1
+            starts_on
+          else
+            starts_on.advance(months: PERIODS_IN_MONTHS.fetch(period) * (index - 1))
+          end
+      end
     end
 
     def lender_timetable
@@ -62,35 +84,49 @@ module LoanCreator
     private
 
     def require_attributes
-      REQUIRED_ATTRIBUTES.each { |k| raise ArgumentError.new(k) unless @options.fetch(k, nil) }
+      required_attributes.each { |k| raise ArgumentError.new(k) unless @options.fetch(k, nil) }
     end
 
     def reinterpret_attributes
-      @options[:period] = @options[:period].to_sym
+      @options[:period] = @options[:period].to_sym unless term_dates?
       @options[:amount] = bigd(@options[:amount])
       @options[:annual_interests_rate] = bigd(@options[:annual_interests_rate])
       @options[:starts_on] = Date.parse(@options[:starts_on]) if @options[:starts_on].is_a?(String)
       @options[:interests_start_date] = Date.parse(@options[:interests_start_date]) if @options[:interests_start_date].is_a?(String)
+
+      if term_dates?
+        @options[:term_dates].map!{ |term_date| Date.parse(term_date.to_s) }
+      end
     end
 
     def set_attributes
-      REQUIRED_ATTRIBUTES.each { |k| instance_variable_set(:"@#{k}", @options.fetch(k)) }
+      required_attributes.each { |k| instance_variable_set(:"@#{k}", @options.fetch(k)) }
       OPTIONAL_ATTRIBUTES.each { |k,v| instance_variable_set(:"@#{k}", @options.fetch(k, v)) }
     end
 
     def validate(key, &block)
       raise unless block.call(instance_variable_get(:"@#{key}"))
-    rescue
-      raise ArgumentError.new(key)
+    rescue => e
+      raise ArgumentError.new([key, e.message].join(': '))
     end
 
     def validate_attributes
-      validate(:period) { |v| PERIODS_IN_MONTHS.keys.include?(v) }
+      validate(:period) { |v| PERIODS_IN_MONTHS.keys.include?(v) } unless term_dates?
       validate(:amount) { |v| v.is_a?(BigDecimal) && v > 0 }
       validate(:annual_interests_rate) { |v| v.is_a?(BigDecimal) && v >= 0 }
       validate(:starts_on) { |v| v.is_a?(Date) }
       validate(:duration_in_periods) { |v| v.is_a?(Integer) && v > 0 }
       validate(:deferred_in_periods) { |v| v.is_a?(Integer) && v >= 0 && v < duration_in_periods }
+      validate_term_dates if term_dates?
+    end
+
+    def validate_term_dates
+      TermDatesValidator.call(
+        term_dates: @options[:term_dates],
+        duration_in_periods: @options[:duration_in_periods],
+        interests_start_date: @options[:interests_start_date],
+        loan_class: self.class.name
+      )
     end
 
     def validate_initial_values
@@ -103,59 +139,57 @@ module LoanCreator
     end
 
     def set_initial_values
-      @starting_index  = initial_values[:starting_index] || 1
+      @starting_index         = initial_values[:starting_index] || 1
+      @initial_due_interests  = bigd(initial_values[:due_interests] || 0)
 
       return if initial_values.blank?
 
       (@total_paid_capital_end_of_period   = bigd(initial_values[:paid_capital]))
       (@total_paid_interests_end_of_period = bigd(initial_values[:paid_interests]))
       (@accrued_delta_interests            = bigd(initial_values[:accrued_delta_interests]))
-      if self.is_a?(LoanCreator::Bullet)
-        (@capitalized_interests_beginning_of_period = bigd(initial_values[:capitalized_interests] || 0))
-      end
+      (@due_interests_beginning_of_period  = bigd(initial_values[:due_interests] || 0))
     end
 
     def reset_current_term
-      @accrued_delta_interests ||= bigd('0')
-      @total_paid_capital_end_of_period ||= bigd('0')
+      @accrued_delta_interests            ||= bigd('0')
+      @total_paid_capital_end_of_period   ||= bigd('0')
       @total_paid_interests_end_of_period ||= bigd('0')
-      @capitalized_interests_beginning_of_period ||= bigd('0')
-      @crd_beginning_of_period                   = bigd('0')
-      @crd_end_of_period                         = bigd('0')
-      @period_theoric_interests                  = bigd('0')
-      @capitalized_interests_end_of_period       = @capitalized_interests_beginning_of_period
-      @delta_interests                           = bigd('0')
-      @amount_to_add                             = bigd('0')
-      @period_interests                          = bigd('0')
-      @period_capital                            = bigd('0')
-      @period_amount_to_pay                      = bigd('0')
-      @due_on                                    = nil
+      @due_interests_beginning_of_period  ||= bigd('0')
+      @crd_beginning_of_period            =   bigd('0')
+      @crd_end_of_period                  =   bigd('0')
+      @period_theoric_interests           =   bigd('0')
+      @due_interests_end_of_period        =   @due_interests_beginning_of_period
+      @delta_interests                    =   bigd('0')
+      @amount_to_add                      =   bigd('0')
+      @period_interests                   =   bigd('0')
+      @period_capital                     =   bigd('0')
+      @period_amount_to_pay               =   bigd('0')
+      @due_on                             =   nil
     end
 
     def current_term
       LoanCreator::Term.new(
-        crd_beginning_of_period:                   @crd_beginning_of_period,
-        crd_end_of_period:                         @crd_end_of_period,
-        period_theoric_interests:                  @period_theoric_interests,
-        delta_interests:                           @delta_interests,
-        accrued_delta_interests:                   @accrued_delta_interests,
-        capitalized_interests_beginning_of_period: @capitalized_interests_beginning_of_period,
-        capitalized_interests_end_of_period:       @capitalized_interests_end_of_period,
-        amount_to_add:                             @amount_to_add,
-        period_interests:                          @period_interests,
-        period_capital:                            @period_capital,
-        total_paid_capital_end_of_period:          @total_paid_capital_end_of_period,
-        total_paid_interests_end_of_period:        @total_paid_interests_end_of_period,
-        period_amount_to_pay:                      @period_amount_to_pay,
-        due_on:                                    @due_on,
-        index:                                     compute_index
+        crd_beginning_of_period:            @crd_beginning_of_period,
+        crd_end_of_period:                  @crd_end_of_period,
+        period_theoric_interests:           @period_theoric_interests,
+        delta_interests:                    @delta_interests,
+        accrued_delta_interests:            @accrued_delta_interests,
+        due_interests_beginning_of_period:  @due_interests_beginning_of_period,
+        due_interests_end_of_period:        @due_interests_end_of_period,
+        amount_to_add:                      @amount_to_add,
+        period_interests:                   @period_interests,
+        period_capital:                     @period_capital,
+        total_paid_capital_end_of_period:   @total_paid_capital_end_of_period,
+        total_paid_interests_end_of_period: @total_paid_interests_end_of_period,
+        period_amount_to_pay:               @period_amount_to_pay,
+        due_on:                             @due_on,
+        index:                              compute_index
       )
     end
 
     def new_timetable
       LoanCreator::Timetable.new(
-        starts_on: starts_on,
-        period: period,
+        loan: self,
         interests_start_date: interests_start_date,
         starting_index: @starting_index
       )
@@ -165,6 +199,10 @@ module LoanCreator
       @index ? (@starting_index + @index - 1) : nil
     end
 
+    def last_period?(idx)
+      idx == (duration_in_periods - 1)
+    end
+
     def compute_term_zero
       @crd_beginning_of_period              = @crd_end_of_period
       @period_theoric_interests             = term_zero_interests
@@ -174,6 +212,7 @@ module LoanCreator
       @total_paid_interests_end_of_period  += @period_interests
       @period_amount_to_pay                 = @period_interests
       @index                                = 0
+      @due_on                               = timetable_term_dates[0]
     end
 
     def term_zero_interests
@@ -194,7 +233,45 @@ module LoanCreator
     end
 
     def term_zero?
-      interests_start_date && interests_start_date < term_zero_date
+      (interests_start_date && interests_start_date < term_zero_date) && !term_dates?
+    end
+
+    def compute_realistic_periodic_interests_rate_percentage_for(date, relative_to_date:)
+      realistic_days = 365
+      realistic_days += 1 if date.leap?
+      realistic_days_in_period = (date - relative_to_date).to_i
+
+      annual_interests_rate.div(bigd(realistic_days) / bigd(realistic_days_in_period), BIG_DECIMAL_DIGITS)
+    end
+
+    def realistic_durations?
+      term_dates? || @realistic_durations.present?
+    end
+
+    def required_attributes
+      if term_dates?
+        REQUIRED_ATTRIBUTES_TERM_DATES
+      else
+        REQUIRED_ATTRIBUTES
+      end
+    end
+
+    def term_dates?
+      @options[:term_dates].present?
+    end
+
+    def prepare_custom_term_dates
+      term_dates = @options[:term_dates].each_with_index.with_object({}) do |(term_date, index), obj|
+        obj[index + 1] = term_date
+      end
+
+      term_dates[0] = starts_on
+      @_timetable_term_dates = term_dates
+      @realistic_durations = true
+    end
+
+    def compute_period_generated_interests(interests_rate)
+      (@crd_beginning_of_period + @due_interests_beginning_of_period).mult(interests_rate, BIG_DECIMAL_DIGITS)
     end
   end
 end

data/lib/loan_creator/linear.rb

@@ -11,26 +11,24 @@ module LoanCreator
         timetable << current_term
       end
 
-      duration_in_periods.times do |idx|
-        @last_period = last_period?(idx)
-        @deferred_period = idx < deferred_in_periods
-        compute_current_term(idx)
-        timetable << current_term
-      end
+      duration_in_periods.times { |idx| timetable << compute_current_term(idx, timetable) }
 
       timetable
     end
 
     private
 
-    def last_period?(idx)
-      idx == (duration_in_periods - 1)
-    end
+    def compute_current_term(idx, timetable)
+      @index = idx + 1
+      @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])
 
-    def compute_current_term(idx)
       # Reminder: CRD beginning of period = CRD end of period **of previous period**
       @crd_beginning_of_period = @crd_end_of_period
-      @period_theoric_interests = @crd_beginning_of_period * periodic_interests_rate
+      @due_interests_beginning_of_period = @due_interests_end_of_period
+      @period_theoric_interests = period_theoric_interests(computed_periodic_interests_rate)
       @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
       @accrued_delta_interests += @delta_interests
       @amount_to_add = bigd(
@@ -49,8 +47,17 @@ module LoanCreator
       @total_paid_interests_end_of_period += @period_interests
       @period_amount_to_pay = @period_interests + @period_capital
       @crd_end_of_period -= @period_capital
-      @due_on = nil
-      @index = idx + 1
+      @due_interests_end_of_period -= reimbursed_due_interests
+
+      current_term
+    end
+
+    def period_theoric_interests(computed_periodic_interests_rate)
+      if @due_interests_beginning_of_period > 0
+        reimbursed_due_interests + compute_period_generated_interests(computed_periodic_interests_rate)
+      else
+        compute_period_generated_interests(computed_periodic_interests_rate)
+      end
     end
 
     def period_capital
@@ -58,9 +65,26 @@ module LoanCreator
         @crd_beginning_of_period
       elsif @deferred_period
         bigd(0)
+      elsif @due_interests_beginning_of_period > 0
+        compute_period_capital - reimbursed_due_interests
+      else
+        compute_period_capital
+      end
+    end
+
+    def reimbursed_due_interests
+      if @deferred_period
+        bigd(0)
       else
-        (amount / (duration_in_periods - deferred_in_periods)).round(2)
+        [
+          @due_interests_beginning_of_period,
+          compute_period_capital
+        ].min
       end
     end
+
+    def compute_period_capital
+      ((amount + @initial_due_interests) / (duration_in_periods - deferred_in_periods)).round(2)
+    end
   end
 end

data/lib/loan_creator/standard.rb

@@ -12,24 +12,22 @@ module LoanCreator
         timetable << current_term
       end
 
-      duration_in_periods.times do |idx|
-        @last_period = last_period?(idx)
-        @deferred_period = idx < deferred_in_periods
-        compute_current_term(idx)
-        timetable << current_term
-      end
+      duration_in_periods.times { |idx| timetable << compute_current_term(idx, timetable) }
+
       timetable
     end
 
     private
 
-    def last_period?(idx)
-      idx == (duration_in_periods - 1)
-    end
+    def compute_current_term(idx, timetable)
+      @index = idx + 1
+      @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])
 
-    def compute_current_term(idx)
       @crd_beginning_of_period = @crd_end_of_period
-      @period_theoric_interests = period_theoric_interests(idx)
+      @period_theoric_interests = period_theoric_interests(@index, computed_periodic_interests_rate)
       @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
       @accrued_delta_interests += @delta_interests
       @amount_to_add = bigd(
@@ -43,37 +41,37 @@ module LoanCreator
       )
       @accrued_delta_interests -= @amount_to_add
       @period_interests = @period_theoric_interests.round(2) + @amount_to_add
-      @period_capital = period_capital(idx)
+      @period_capital = period_capital(@index, computed_periodic_interests_rate)
       @total_paid_capital_end_of_period += @period_capital
       @total_paid_interests_end_of_period += @period_interests
       @period_amount_to_pay = @period_interests + @period_capital
       @crd_end_of_period -= @period_capital
-      @due_on = nil
-      @index = idx + 1
+
+      current_term
     end
 
-    def period_theoric_interests(idx)
+    def period_theoric_interests(idx, computed_periodic_interests_rate)
       if @deferred_period
-        @crd_beginning_of_period * periodic_interests_rate
+        @crd_beginning_of_period * computed_periodic_interests_rate
       else
         -ipmt(
-          periodic_interests_rate,
-          (idx + 1) - deferred_in_periods,
+          computed_periodic_interests_rate,
+          idx - deferred_in_periods,
           duration_in_periods - deferred_in_periods,
           amount
         )
       end
     end
 
-    def period_capital(idx)
+    def period_capital(idx, computed_periodic_interests_rate)
       if @last_period
         @crd_beginning_of_period
       elsif @deferred_period
         bigd(0)
       else
         -ppmt(
-          periodic_interests_rate,
-          (idx + 1) - deferred_in_periods,
+          computed_periodic_interests_rate,
+          idx - deferred_in_periods,
           duration_in_periods - deferred_in_periods,
           amount
         ).round(2)

data/lib/loan_creator/term.rb

@@ -17,11 +17,11 @@ module LoanCreator
       # Accrued interests' delta
       :accrued_delta_interests,
 
-      # Capitalized interests at the beginning of the term (Bullet only)
-      :capitalized_interests_beginning_of_period,
+      # Due interests at the beginning of the term (Bullet and UncapitalizedBullet only)
+      :due_interests_beginning_of_period,
 
-      # Capitalized interests at the end of the term (Bullet only)
-      :capitalized_interests_end_of_period,
+      # Due interests at the end of the term (Bullet and UncapitalizedBullet only)
+      :due_interests_end_of_period,
 
       # Adjustment of -0.01, 0 or +0.01 cent depending on accrued_delta_interests
       :amount_to_add,

data/lib/loan_creator/term_dates_validator.rb

@@ -0,0 +1,73 @@
+module LoanCreator
+  module TermDatesValidator
+    def self.call(term_dates:, duration_in_periods:, interests_start_date:, loan_class:)
+      is_array(term_dates)
+      matches_duration(term_dates, duration_in_periods)
+      interests_start_date_present(interests_start_date)
+      coherent_dates_for_non_bullet(term_dates)
+      coherent_dates_for_bullet(term_dates) if bullet?(loan_class)
+    end
+
+    private
+
+    def self.is_array(term_dates)
+      unless term_dates.is_a?(Array)
+        raise TypeError, 'the :term_dates option must be an Array'
+      end
+    end
+
+    def self.matches_duration(term_dates, duration_in_periods)
+      unless term_dates.size == duration_in_periods
+        raise ArgumentError, "the size of :term_dates (#{term_dates.size}) do not match the :duration_in_periods (#{duration_in_periods})"
+      end
+    end
+
+    def self.interests_start_date_present(interests_start_date)
+      if interests_start_date.present?
+        raise ArgumentError, ":interests_start_date is no compatible with :term_dates"
+      end
+    end
+
+    def self.coherent_dates_for_non_bullet(term_dates)
+      term_dates.each_with_index do |term_date, index|
+        next if index.zero?
+
+        previous_term_date = term_dates[index - 1]
+
+        unless term_date > previous_term_date
+          previous_term_date_description =
+            ":term_dates[#{index - 1}] (#{term_dates[index - 1].strftime('%Y-%m-%d')})"
+
+          error_message = "#{previous_term_date_description} must be before :term_dates[#{index}] (#{term_date.strftime('%Y-%m-%d')})"
+
+          raise ArgumentError, error_message
+        end
+      end
+    end
+
+    def self.coherent_dates_for_bullet(term_dates)
+      term_dates.each_with_index do |term_date, index|
+        next if index.zero?
+
+        days_in_year = 365
+        days_in_year += 1 if term_date.leap?
+
+        previous_term_date = term_dates[index - 1]
+        days_between = (term_date - previous_term_date).to_i.abs
+
+        if days_between > days_in_year
+          previous_term_date_description =
+            ":term_dates[#{index - 1}] (#{term_dates[index - 1].strftime('%Y-%m-%d')})"
+
+          error_description = "There are #{days_between} days between #{previous_term_date_description} and :term_dates[#{index}]"
+
+          raise ArgumentError, "term dates can't be more than 1 year apart. #{error_description}"
+        end
+      end
+    end      
+
+    def self.bullet?(loan_class)
+      loan_class == "LoanCreator::Bullet"
+    end
+  end
+end

data/lib/loan_creator/timetable.rb

@@ -1,22 +1,13 @@
 # coding: utf-8
 module LoanCreator
   class Timetable
-    # Used to calculate next term's date (see ActiveSupport#advance)
-    PERIODS = {
-      month:    {months: 1},
-      quarter:  {months: 3},
-      semester: {months: 6},
-      year:     {years: 1}
-    }
+    attr_reader :loan, :terms, :starting_index #, :interests_start_date
 
-    attr_reader :terms, :starts_on, :period #, :interests_start_date
-
-    def initialize(starts_on:, period:, interests_start_date: nil, starting_index: 1)
-      raise ArgumentError.new(:period) unless PERIODS.keys.include?(period)
+    delegate :starts_on, :period, to: :loan
 
+    def initialize(loan:, interests_start_date: nil, starting_index: 1)
       @terms          = []
-      @starts_on      = (starts_on.is_a?(Date) ? starts_on : Date.parse(starts_on))
-      @period         = period
+      @loan           = loan
       @starting_index = starting_index
 
       if interests_start_date
@@ -26,8 +17,11 @@ module LoanCreator
 
     def <<(term)
       raise ArgumentError.new('LoanCreator::Term expected') unless term.is_a?(LoanCreator::Term)
-      term.index  ||= autoincrement_index
-      term.due_on ||= date_for(term.index)
+
+      @current_index = term.index || next_index
+
+      term.index    = @current_index
+      term.due_on ||= loan.timetable_term_dates[term.index]
       @terms << term
       self
     end
@@ -43,29 +37,8 @@ module LoanCreator
       @terms.find { |term| term.index == index }
     end
 
-    private
-
-    def autoincrement_index
-      @current_index = (@current_index.nil? ? @starting_index : @current_index + 1)
-    end
-
-    def date_for(index)
-      @_dates ||= Hash.new do |dates, index|
-        dates[index] =
-          if index < 1
-            dates[index + 1].advance(PERIODS.fetch(period).transform_values {|n| -n})
-          elsif index == 1
-            starts_on
-          else
-            dates[index - 1].advance(PERIODS.fetch(period))
-          end
-      end
-
-      @_dates[index]
-    end
-
-    def reset_dates
-      @_dates = nil
+    def next_index
+      @current_index.nil? ? @starting_index : @current_index + 1
     end
   end
 end

data/lib/loan_creator/uncapitalized_bullet.rb

@@ -7,28 +7,39 @@ module LoanCreator
       reset_current_term
       @crd_beginning_of_period = amount
       @crd_end_of_period = amount
-      (duration_in_periods - 1).times { timetable << current_term }
-      compute_last_term
-      timetable << current_term
+
+      duration_in_periods.times { |idx| timetable << compute_current_term(idx, timetable) }
+
       timetable
     end
 
     private
 
-    def compute_last_term
-      @crd_end_of_period = bigd('0')
-      @period_interests = total_interests
-      @period_capital = @crd_beginning_of_period
-      @total_paid_capital_end_of_period = @period_capital
-      @total_paid_interests_end_of_period = @period_interests
-      @period_amount_to_pay = @period_capital + @period_interests
+    def compute_current_term(idx, timetable)
+      @due_on = timetable_term_dates[timetable.next_index]
+      last_period?(idx) ? compute_last_term(timetable) : compute_term(timetable)
+      current_term
+    end
+
+    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_interests(@due_on, timetable)
+      @due_interests_end_of_period        =  0
+      @period_capital                     =  @crd_beginning_of_period
+      @total_paid_capital_end_of_period   += @period_capital
+      @total_paid_interests_end_of_period += @period_interests
+      @period_amount_to_pay               =  @period_capital + @period_interests
+    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])
+      amount.mult(bigd(computed_periodic_interests_rate), BIG_DECIMAL_DIGITS)
     end
 
-    def total_interests
-      amount.mult(
-        bigd(periodic_interests_rate) * bigd(duration_in_periods),
-        BIG_DECIMAL_DIGITS
-      )
+    def compute_term(timetable)
+      @due_interests_beginning_of_period = @due_interests_end_of_period
+      @due_interests_end_of_period += compute_interests(@due_on, timetable)
     end
   end
 end

data/lib/loan_creator/version.rb

@@ -1,3 +1,3 @@
 module LoanCreator
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/loan_creator.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'table_print', '~> 1.5'
 
   spec.add_runtime_dependency 'bigdecimal'
   spec.add_runtime_dependency 'activesupport'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - thibaulth
@@ -9,10 +9,10 @@ authors:
 - younes.serraj
 - Antoine Becquet
 - Jerome Drevet
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +140,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - thibault@capsens.eu
 - nicolas.besnard@capsens.eu
@@ -149,6 +177,7 @@ files:
 - lib/loan_creator/linear.rb
 - lib/loan_creator/standard.rb
 - lib/loan_creator/term.rb
+- lib/loan_creator/term_dates_validator.rb
 - lib/loan_creator/timetable.rb
 - lib/loan_creator/uncapitalized_bullet.rb
 - lib/loan_creator/version.rb
@@ -157,7 +186,7 @@ homepage: https://github.com/CapSens/loan-creator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Create and update timetables from input data
 test_files: []