loan_creator 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db3e56a2163350ca40694fd499d989155ddcf09
-  data.tar.gz: a37e9da2455b71ef215618ab0f35dd4e55b5cd16
+  metadata.gz: 8dff90f00c1b47c09fd2ac97d4a0e3a28e12fbd5
+  data.tar.gz: '078e7ad135c712ef0fb767208cc99557718b99b1'
 SHA512:
-  metadata.gz: a56a344d7ed6509fea8625b4897550073f8c5f13e39860501e7d02d8eb40b55cdf4c55b74dca815993d706dc1283c07ec9361cc815590807284d295910858f41
-  data.tar.gz: 3db6aebe3ee2a2916175ecfd5f43f231fdbd669d92e217c4601184e70b8c73ab87468b636c739832b3a9181a5165dca3a9313d29d5fe4512cae3dc0747c9af4a
+  metadata.gz: e318e46a05d49caa450705cb5a6e234c7b3e497dad501961c1339638c0641cc76f88dafb00f07af80b9b9cdc6d5ba1d0b5e761133f863f7a6034d479ddb0f012
+  data.tar.gz: bc258a7bd58a783c033c7c81857b467966e2e4ee25b091cc73cf1de1f5ec94a94f889fb2c32f5be072668503295564a841beb0573585c509b867dc9b0025cbe1

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.6.2
+-------------------------
+
+- add `:initial_values` for loans initialization
+- add and compute `capitalized_interests` for `LoanCreator::Bullet` terms
+
 v0.6.1
 -------------------------
 

data/README.md

@@ -46,6 +46,19 @@ Each instance of one of the previous classes has the following attributes:
     :duration_in_periods
     :deferred_in_periods (default to zero)
     :interests_start_date (optional)
+    :initial_values (to generate a timetable from a previous term or at a given state)
+```
+
+Initial values must be a hash with specific keys, like so:
+
+```ruby
+{
+    paid_capital: 0,
+    paid_interests: 11000.0,
+    accrued_delta_interests: 0,
+    starting_index: 2,
+    capitalized_interests: 0
+}
 ```
 
 There is also a `LoanCreator::Timetable` class dedicated to record the data of the loans' terms. Each instance of `LoanCreator::Timetable` represents an array of `LoanCreator::Term` records, each having the following attributes:

data/lib/loan_creator/bullet.rb

@@ -7,7 +7,7 @@ module LoanCreator
       reset_current_term
       @crd_beginning_of_period = amount
       @crd_end_of_period = amount
-      (duration_in_periods - 1).times { timetable << current_term }
+      (duration_in_periods - 1).times { |period| compute_term(timetable, period + 1) }
       compute_last_term
       timetable << current_term
       timetable
@@ -16,25 +16,22 @@ module LoanCreator
     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
+      @crd_end_of_period                  = bigd('0')
+      @period_interests                   = compute_capitalized_interests(duration_in_periods)
+      @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
+      @period_amount_to_pay               = @period_capital + @period_interests
+      @capitalized_interests              = compute_capitalized_interests(duration_in_periods)
     end
 
-    #   Capital * (periodic_interests_rate ^(total_terms))
-    #
-    def total_payment
-      amount.mult(
-        (bigd(1) + periodic_interests_rate) ** bigd(duration_in_periods),
-        BIG_DECIMAL_DIGITS
-      )
+    def compute_capitalized_interests(period)
+      amount.mult((bigd(1) + periodic_interests_rate) ** period, BIG_DECIMAL_DIGITS) - amount
     end
 
-    def total_interests
-      total_payment - amount
+    def compute_term(timetable, period)
+      @capitalized_interests = compute_capitalized_interests(period)
+      timetable << current_term
     end
   end
 end

data/lib/loan_creator/common.rb

@@ -21,6 +21,7 @@ module LoanCreator
       # attribute: default_value
       deferred_in_periods: 0,
       interests_start_date: nil,
+      initial_values: {}
     }.freeze
 
     attr_reader *REQUIRED_ATTRIBUTES
@@ -32,6 +33,8 @@ module LoanCreator
       reinterpret_attributes
       set_attributes
       validate_attributes
+      set_initial_values
+      validate_initial_values
     end
 
     def periodic_interests_rate_percentage
@@ -90,53 +93,82 @@ module LoanCreator
       validate(:deferred_in_periods) { |v| v.is_a?(Integer) && v >= 0 && v < duration_in_periods }
     end
 
+    def validate_initial_values
+      return if initial_values.blank?
+
+      validate(:total_paid_capital_end_of_period) { |v| v.is_a?(BigDecimal) && v >= 0 }
+      validate(:total_paid_interests_end_of_period) { |v| v.is_a?(BigDecimal) && v >= 0 }
+      validate(:accrued_delta_interests) { |v| v.is_a?(BigDecimal) }
+      validate(:starting_index) { |v| v.is_a?(Integer) && v >= 0 }
+    end
+
+    def set_initial_values
+      @starting_index  = initial_values[:starting_index] || 1
+
+      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]))
+    end
+
     def reset_current_term
-      @crd_beginning_of_period = bigd('0')
-      @crd_end_of_period = bigd('0')
-      @period_theoric_interests = bigd('0')
-      @delta_interests = bigd('0')
-      @accrued_delta_interests = bigd('0')
-      @amount_to_add = bigd('0')
-      @period_interests = bigd('0')
-      @period_capital = bigd('0')
-      @total_paid_capital_end_of_period = bigd('0')
-      @total_paid_interests_end_of_period = bigd('0')
-      @period_amount_to_pay = bigd('0')
-      @due_on = nil
-      @index = nil
+      @crd_beginning_of_period            = bigd('0')
+      @crd_end_of_period                  = bigd('0')
+      @period_theoric_interests           = bigd('0')
+      @capitalized_interests              = bigd('0')
+      @delta_interests                    = bigd('0')
+      @accrued_delta_interests            = @accrued_delta_interests || bigd('0')
+      @amount_to_add                      = bigd('0')
+      @period_interests                   = bigd('0')
+      @period_capital                     = bigd('0')
+      @total_paid_capital_end_of_period   = @total_paid_capital_end_of_period || bigd('0')
+      @total_paid_interests_end_of_period = @total_paid_interests_end_of_period || 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,
-        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,
+        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:              @capitalized_interests,
+        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: @index
+        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, interests_start_date: interests_start_date)
+      LoanCreator::Timetable.new(
+        starts_on: starts_on,
+        period: period,
+        interests_start_date: interests_start_date,
+        starting_index: @starting_index
+      )
+    end
+
+    def compute_index
+      @index ? (@starting_index + @index - 1) : nil
     end
 
     def compute_term_zero
-      @crd_beginning_of_period = @crd_end_of_period
-      @period_theoric_interests = term_zero_interests
-      @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
-      @accrued_delta_interests += @delta_interests
-      @period_interests = @period_theoric_interests.round(2)
-      @total_paid_interests_end_of_period += @period_interests
-      @period_amount_to_pay = @period_interests
-      @index = 0
+      @crd_beginning_of_period              = @crd_end_of_period
+      @period_theoric_interests             = term_zero_interests
+      @delta_interests                      = @period_theoric_interests - @period_theoric_interests.round(2)
+      @accrued_delta_interests             += @delta_interests
+      @period_interests                     = @period_theoric_interests.round(2)
+      @total_paid_interests_end_of_period  += @period_interests
+      @period_amount_to_pay                 = @period_interests
+      @index                                = 0
     end
 
     def term_zero_interests

data/lib/loan_creator/linear.rb

@@ -17,6 +17,7 @@ module LoanCreator
         compute_current_term(idx)
         timetable << current_term
       end
+
       timetable
     end
 

data/lib/loan_creator/term.rb

@@ -17,6 +17,9 @@ module LoanCreator
       # Accrued interests' delta
       :accrued_delta_interests,
 
+      # Capitalized interests (Bullet only)
+      :capitalized_interests,
+
       # Adjustment of -0.01, 0 or +0.01 cent depending on accrued_delta_interests
       :amount_to_add,
 

data/lib/loan_creator/timetable.rb

@@ -11,12 +11,13 @@ module LoanCreator
 
     attr_reader :terms, :starts_on, :period #, :interests_start_date
 
-    def initialize(starts_on:, period:, interests_start_date: nil)
+    def initialize(starts_on:, period:, interests_start_date: nil, starting_index: 1)
       raise ArgumentError.new(:period) unless PERIODS.keys.include?(period)
 
-      @terms     = []
-      @starts_on = (starts_on.is_a?(Date) ? starts_on : Date.parse(starts_on))
-      @period    = period
+      @terms          = []
+      @starts_on      = (starts_on.is_a?(Date) ? starts_on : Date.parse(starts_on))
+      @period         = period
+      @starting_index = starting_index
 
       if interests_start_date
         @interests_start_date = (interests_start_date.is_a?(Date) ? interests_start_date : Date.parse(interests_start_date))
@@ -45,7 +46,7 @@ module LoanCreator
     private
 
     def autoincrement_index
-      @current_index = @current_index.nil? ? 1 : @current_index + 1
+      @current_index = (@current_index.nil? ? @starting_index : @current_index + 1)
     end
 
     def date_for(index)

data/lib/loan_creator/version.rb

@@ -1,3 +1,3 @@
 module LoanCreator
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.6.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - thibaulth
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler