loan_creator 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f175586a927e2dd609903b79ed629c1ab5bc3aecde02b1cc5809629d33c5b852
-  data.tar.gz: fd695b7fba80c64efa7b5c0cefc9a1092ed6c74aa4ac070da3cb25771740e3bf
+  metadata.gz: fb6c8e7e02bc1349e47dcb07602828d051cfa63ac7fc3e16394604f8dda05e27
+  data.tar.gz: d103c1e0524641e73b307702eec5bd1cf43029236a3d791805e4d62e7e0732d3
 SHA512:
-  metadata.gz: 6de1a02fc201dd985c0c255ee7b96989d477723607015647f9608228174f9bfdd4aa7f667ea9d74425a251b4912dae0430e1edd84623b7a8c1953e28ce1797f9
-  data.tar.gz: b3b3e8d4a1d007b1f8481238df1d021b5f597d2a46b887495f4099320dcd20711ccc2fb9e2ed2fa34775a99c33826c9de2d4a5b7ede12d7eb8e978d45df017f1
+  metadata.gz: c201e2a5fb2a5aaa54b1870b635e11c08b90d35f45258852f4cf61e5faa99756272b54db5a85c470123b5baaf5dedd5a9be79af8577796595997540cad4662b9
+  data.tar.gz: 00556c176b2e27765ca5112878495c7982cdaeb75abfe3b3956b57c6be57dfcf6c8cf89136bbfa0c94c40e7d43927ff2eafa8c0518f99d0be914e1bd7df1b70d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+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
 -------------------------
 

data/README.md

@@ -183,6 +183,8 @@ 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/common.rb

@@ -17,6 +17,14 @@ 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,
@@ -36,6 +44,7 @@ module LoanCreator
       validate_attributes
       set_initial_values
       validate_initial_values
+      prepare_custom_term_dates if term_dates?
     end
 
     def periodic_interests_rate(date = nil, relative_to_date: nil)
@@ -75,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
@@ -210,7 +233,7 @@ 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:)
@@ -222,7 +245,29 @@ module LoanCreator
     end
 
     def realistic_durations?
-      !!@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)

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - thibaulth
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,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