loan_creator 0.10.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 838d0d280c585125b013b8ea6d7e8b58e94c2234fffe3d49d1c97f39a67b254f
-  data.tar.gz: 7a607035130b53af6678bdec2a91b9d99fcace0a1710db1ef83333a4b15133b0
+  metadata.gz: 2e7d8a7b39adf42e2c93e977c82ecf6c53f5695716cc5ef291a6b5a0963e0dd5
+  data.tar.gz: a4ed3fcf50360222a3795846d0d1ec3367126b851e6381a8ffbfc98ba972a709
 SHA512:
-  metadata.gz: 06c8e0dfa135c8a80f9969f60db83a8bc3630161fea4f208dff6480ab9142635d196aaa729fdb32fd89e38e87804cbc76fcc1f10ec464c680c10219ef7aec23c
-  data.tar.gz: c710e04d68debd3d7f63569586aed46ac1426aabf9ed995fa762a18745916d1f31339f93b173159ddd61dcf23b145527471dbc7ff873a1bdfc46169e310f4322
+  metadata.gz: e6e6465cc26a14667894139cc4f57e1bab128ebd77a01559d2b04d1ba77b3aecc9c5ec457fe5ba7a1c1cea4ac9f7021fa6f26d16646f6241167ade85b9251d98
+  data.tar.gz: 144466496ce6a6b8895fca5657cf07db090e0ca8834b04ac84631a0dbfe71e89d8dfce2d8697358f905486edae636b1014cc049597c267fa0ec829088966d406

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+v0.12.1
+-------------------------
+#### Bugfix
+- `Bullet` and `Uncapitalized Bullet` now manage roundings as other loan types
+
+v0.12.0
+-------------------------
+- improve argument error management and allow amount equal to zero.
+
+v0.11.0
+-------------------------
+- add `multi_part_interests_calculation` option.
+
+v0.10.0
+-------------------------
+- fix `term_dates` options, notably with `starts_on`.
+
 v0.9.1
 -------------------------
 - add spec importer `scripts/convert_export_to_spec.rb {csv_url}`

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,25 @@ 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)
+      periodic_theoric_interests =
+        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
+
+      apply_interests_roundings(periodic_theoric_interests)
     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,23 +104,37 @@ 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)
-      raise unless block.call(instance_variable_get(:"@#{key}"))
-    rescue => e
-      raise ArgumentError.new([key, e.message].join(': '))
+    def validate(message, &block)
+      raise ArgumentError.new(message) unless block.call
     end
 
     def validate_attributes
-      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?
+      validate("amount #{@amount} must be positive") do
+        @amount.is_a?(BigDecimal) && @amount >= 0
+      end
+      validate("annual_interests_rate #{@annual_interests_rate} must be positive") do
+        @annual_interests_rate.is_a?(BigDecimal) && @annual_interests_rate >= 0
+      end
+      validate("starts_on #{@starts_on} must be a date but is a #{@starts_on.class}") do
+        @starts_on.is_a?(Date)
+      end
+      validate("duration_in_periods #{@duration_in_periods} must be positive") do
+        @duration_in_periods.is_a?(Integer) && @duration_in_periods > 0
+      end
+      validate("deferred_in_periods #{@deferred_in_periods} must be positive and less than duration_in_periods #{@duration_in_periods}") do
+        @deferred_in_periods.is_a?(Integer) && @deferred_in_periods >= 0 && @deferred_in_periods < duration_in_periods
+      end
+      if term_dates?
+        validate_term_dates
+      else
+        validate("period #{@period} must be in #{PERIODS_IN_MONTHS}") do
+          PERIODS_IN_MONTHS.keys.include?(@period)
+        end
+      end
+
     end
 
     def validate_term_dates
@@ -132,10 +149,18 @@ module LoanCreator
     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 }
+      validate("total_paid_capital_end_of_period #{@total_paid_capital_end_of_period} must be positive") do
+        @total_paid_capital_end_of_period.is_a?(BigDecimal) && @total_paid_capital_end_of_period >= 0
+      end
+      validate("total_paid_interests_end_of_period #{@total_paid_interests_end_of_period} must be positive") do
+        @total_paid_interests_end_of_period.is_a?(BigDecimal) && @total_paid_interests_end_of_period >= 0
+      end
+      validate("accrued_delta_interests must be a BigDecimal but is a #{@accrued_delta_interests.class}") do
+        @accrued_delta_interests.is_a?(BigDecimal)
+      end
+      validate("starting_index #{@starting_index} must be positive") do
+        @starting_index.is_a?(Integer) && @starting_index >= 0
+      end
     end
 
     def set_initial_values
@@ -236,43 +261,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 +289,28 @@ 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
+
+    def apply_interests_roundings(periodic_theoric_interests)
+      @period_theoric_interests = periodic_theoric_interests
+      @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
+      @accrued_delta_interests += @delta_interests
+      @amount_to_add = bigd(
+        if @accrued_delta_interests >= bigd('0.01')
+          '0.01'
+        elsif @accrued_delta_interests <= bigd('-0.01')
+          '-0.01'
+        else
+          '0'
+        end
+      )
+      @accrued_delta_interests -= @amount_to_add
+      @period_theoric_interests.round(2) + @amount_to_add
     end
   end
 end

data/lib/loan_creator/linear.rb

@@ -23,25 +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)
-      @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
-      @accrued_delta_interests += @delta_interests
-      @amount_to_add = bigd(
-        if @accrued_delta_interests >= bigd('0.01')
-          '0.01'
-        elsif @accrued_delta_interests <= bigd('-0.01')
-          '-0.01'
+
+      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
-          '0'
+          period_theoric_interests(periodic_interests_rate(timetable_term_dates[timetable.current_index], @due_on))
         end
-      )
-      @accrued_delta_interests -= @amount_to_add
-      @period_interests = @period_theoric_interests.round(2) + @amount_to_add
+
+      @period_interests = apply_interests_roundings(period_theoric_interests)
       @period_capital = period_capital
       @total_paid_capital_end_of_period += @period_capital
       @total_paid_interests_end_of_period += @period_interests

data/lib/loan_creator/standard.rb

@@ -24,23 +24,11 @@ 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)
-      @delta_interests = @period_theoric_interests - @period_theoric_interests.round(2)
-      @accrued_delta_interests += @delta_interests
-      @amount_to_add = bigd(
-        if @accrued_delta_interests >= bigd('0.01')
-          '0.01'
-        elsif @accrued_delta_interests <= bigd('-0.01')
-          '-0.01'
-        else
-          '0'
-        end
-      )
-      @accrued_delta_interests -= @amount_to_add
-      @period_interests = @period_theoric_interests.round(2) + @amount_to_add
+
+      @period_interests = apply_interests_roundings(period_theoric_interests(@index, computed_periodic_interests_rate))
       @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

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,8 +33,9 @@ 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])
-      amount.mult(bigd(computed_periodic_interests_rate), BIG_DECIMAL_DIGITS)
+      computed_periodic_interests_rate = periodic_interests_rate(timetable_term_dates[timetable.current_index], due_date)
+
+      apply_interests_roundings(amount.mult(bigd(computed_periodic_interests_rate), BIG_DECIMAL_DIGITS))
     end
 
     def compute_term(timetable)

data/lib/loan_creator/version.rb

@@ -1,3 +1,3 @@
 module LoanCreator
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.12.1'.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'

data/loan_creator.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   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'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.1
 platform: ruby
 authors:
 - thibaulth
@@ -9,10 +9,10 @@ authors:
 - younes.serraj
 - Antoine Becquet
 - Jerome Drevet
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,7 +140,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - thibault@capsens.eu
 - nicolas.besnard@capsens.eu
@@ -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
@@ -187,7 +188,7 @@ homepage: https://github.com/CapSens/loan-creator
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -203,7 +204,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: []