loan_creator 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8db3e56a2163350ca40694fd499d989155ddcf09
-  data.tar.gz: a37e9da2455b71ef215618ab0f35dd4e55b5cd16
+SHA256:
+  metadata.gz: c39773817a99d44a421aac19ea019f43ba24bba4359f8f61630b480f47662c65
+  data.tar.gz: b645544fb96db2d5bf60c8b8e811e8b08e54d49d7c5fb62f2af4d54e4619d64d
 SHA512:
-  metadata.gz: a56a344d7ed6509fea8625b4897550073f8c5f13e39860501e7d02d8eb40b55cdf4c55b74dca815993d706dc1283c07ec9361cc815590807284d295910858f41
-  data.tar.gz: 3db6aebe3ee2a2916175ecfd5f43f231fdbd669d92e217c4601184e70b8c73ab87468b636c739832b3a9181a5165dca3a9313d29d5fe4512cae3dc0747c9af4a
+  metadata.gz: e24e2f465c85252f8654a62fc252f0f82f75ffd0690b90ee586517769ad7055d24cecd4e7694f73dc6e54f2260969bffff01f65864e161e2cd89e5bb817477ac
+  data.tar.gz: 7428313e7ca37b6f10b5f20375c007ea1af3d00a1dc7ed95f0d82a56543267a7c37f7604a931f541c2a93ca1bb953d15d774fa7cad064ef08c846c40adfa8ca0

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Bundle install
+          command: |
+            gem install bundler:2.1.4
+            bundle install --path vendor/bundle
+      - run:
+          name: Test
+          command: bundle exec rspec
+      - run:
+          name: Coding style
+          command: |
+            gem install rubocop
+            mkdir -p rubocop
+            rubocop --format html -o rubocop/rubocop.html || true
+      - run:
+          name: Notation
+          command: |
+            gem install sexp_processor -v 4.13.0
+            gem install rubycritic -v 4.3.2
+            rubycritic app --no-browser || true
+      - run:
+          name: "Axe d'optimisation"
+          command: |
+            gem install fasterer
+            fasterer || true
+      - run:
+          name: "Audit Securité du Gemfile"
+          command: |
+            gem install bundler-audit
+            bundle audit --update
+      - store_artifacts:
+          path: rubocop/rubocop.html
+      - store_artifacts:
+          path: tmp/rubycritic

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
   Exclude:
     - 'db/**/*'
     - 'vendor/**/*'
@@ -12,7 +12,7 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.7
+ruby-2.7.1

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+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
+-------------------------
+
+- change `capitalized_interests` for `capitalized_interests_beginning_of_period`
+  and `capitalized_interests_end_of_period` in `LoanCreator::Term`
+- add `capitalized_interests` in `:inital_values` for `LoanCreator::Bullet` loans
+
+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,
+    due_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:
@@ -135,9 +148,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.
 

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,6 +20,7 @@ module LoanCreator
       end
 
       borrower_timetable = LoanCreator::Timetable.new(
+        starting_index: lenders_timetables.first.starting_index,
         starts_on: lenders_timetables.first.starts_on,
         period: lenders_timetables.first.period
       )
@@ -34,7 +37,7 @@ module LoanCreator
         term = BORROWER_FINANCIAL_ATTRIBUTES.each_with_object({}) do |k, h|
           h[k] = arr.inject(bigd('0')) { |sum, tt| sum + tt.send(k) }
         end
-        borrower_timetable << LoanCreator::Term.new(all_zero.merge(term))
+        borrower_timetable << LoanCreator::Term.new(**all_zero.merge(term))
       end
       borrower_timetable
     end

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) }
       compute_last_term
       timetable << current_term
       timetable
@@ -16,25 +16,24 @@ 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
-      @total_paid_interests_end_of_period = @period_interests
-      @period_amount_to_pay = @period_capital + @period_interests
+      @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_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
 
-    #   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
+      (amount + @due_interests_beginning_of_period).mult(periodic_interests_rate, BIG_DECIMAL_DIGITS)
     end
 
-    def total_interests
-      total_payment - amount
+    def compute_term(timetable)
+      @due_interests_beginning_of_period = @due_interests_end_of_period
+      @due_interests_end_of_period += compute_capitalized_interests
+      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,85 @@ 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]))
+      (@due_interests_beginning_of_period  = bigd(initial_values[:due_interests] || 0))
+    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
+      @accrued_delta_interests            ||= bigd('0')
+      @total_paid_capital_end_of_period   ||= bigd('0')
+      @total_paid_interests_end_of_period ||= bigd('0')
+      @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,
-        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,
+        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: @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/in_fine.rb

@@ -4,7 +4,7 @@ module LoanCreator
     # Thus we're generating a Linear loan instead of rewriting already existing code.
     def lender_timetable
       options = @options.merge(deferred_in_periods: duration_in_periods - 1)
-      LoanCreator::Linear.new(options).lender_timetable
+      LoanCreator::Linear.new(**options).lender_timetable
     end
   end
 end

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,12 @@ module LoanCreator
       # Accrued interests' delta
       :accrued_delta_interests,
 
+      # Due interests at the beginning of the term (Bullet and UncapitalizedBullet only)
+      :due_interests_beginning_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/timetable.rb

@@ -9,14 +9,15 @@ module LoanCreator
       year:     {years: 1}
     }
 
-    attr_reader :terms, :starts_on, :period #, :interests_start_date
+    attr_reader :terms, :starts_on, :period, :starting_index #, :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/uncapitalized_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) }
       compute_last_term
       timetable << current_term
       timetable
@@ -16,19 +16,24 @@ 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
-      @total_paid_interests_end_of_period = @period_interests
-      @period_amount_to_pay = @period_capital + @period_interests
+      @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_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 total_interests
-      amount.mult(
-        bigd(periodic_interests_rate) * bigd(duration_in_periods),
-        BIG_DECIMAL_DIGITS
-      )
+    def compute_interests
+      amount.mult(bigd(periodic_interests_rate), BIG_DECIMAL_DIGITS)
+    end
+
+    def compute_term(timetable)
+      @due_interests_beginning_of_period = @due_interests_end_of_period
+      @due_interests_end_of_period += compute_interests
+      timetable << current_term
     end
   end
 end

data/lib/loan_creator/version.rb

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

data/loan_creator.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'byebug', '~> 11.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - thibaulth
@@ -9,10 +9,10 @@ authors:
 - younes.serraj
 - Antoine Becquet
 - Jerome Drevet
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -20,28 +20,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - thibault@capsens.eu
 - nicolas.besnard@capsens.eu
@@ -123,8 +123,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
@@ -157,7 +157,7 @@ homepage: https://github.com/CapSens/loan-creator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Create and update timetables from input data
 test_files: []

data/.gitlab-ci.yml

@@ -1,11 +0,0 @@
-rspec:
-  image: "ruby:2.3"
-  before_script:
-    # COMMANDS
-    - ruby -v
-    - which ruby
-    # BUNDLER
-    - gem install bundler --no-ri --no-rdoc
-    - bundle install --jobs $(nproc) "${FLAGS[@]}"
-  script:
-    - bundle exec rspec --color --format documentation