loan_creator 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce94717f0c667263653597ea2037844157e6cebe
+  data.tar.gz: e498fe9069ca0ff9c3d765083a182f28ddc3ca22
+SHA512:
+  metadata.gz: da8108111a04280719eba3143444bd2ceac35abaade6521c2e9a5a3297266037c7d8e194156c3a373602fe766bbce49c23ebe515a2db1b64e1a35ac67a4aff06
+  data.tar.gz: 5e49dd7114a25fc67e9230ea0d6120b7a12bb83b6b6c50d28eecbfb7c92cc7bbd68da4ca26d0bf7dffe0b7b1fc2a7ec9acbbbb9369bf2cdfb1eb6837625dd2be

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,11 @@
+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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'db/**/*'
+    - 'vendor/**/*'
+  DisplayCopNames: true
+
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Lint/UnifiedInteger:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+loan_creator

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.7

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loan_creator.gemspec
+gemspec
+
+gem 'activesupport'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 thibaulth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# LoanCreator
+
+`loan_creator` gem intends to provide a set of methods to allow automatic generation of loan timetables, for simulation, from a lender point of view and from a borrower point of view, regarding financial rounding differences. As of today, the gem makes the borrower support any rounding issue. In a later work, an option should be provided to decide who supports such issues.
+
+Link to Loan_Creator excel simulator [Click here] (Excel)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'loan_creator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loan_creator
+
+## Usage
+
+Parent module
+
+```ruby
+    module LoanCreator
+```
+
+There are four types of loans. All inherit from a `LoanCreator::Common` class.
+
+```ruby
+    LoanCreator::Standard
+    LoanCreator::Linear
+    LoanCreator::InFine
+    LoanCreator::Bullet
+```
+
+Each instance of one of the previous classes has the following attributes:
+
+```ruby
+    :period
+    :amount
+    :annual_interests_rate
+    :starts_at
+    :duration_in_periods
+    :deferred_in_periods (default to zero)
+    :interests_start_date (optional)
+```
+
+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:
+
+```ruby
+      # Term number (starts at 1)
+      :index
+
+      # Term date
+      :due_on
+
+      # Remaining due capital at the beginning of the term
+      :crd_beginning_of_period
+
+      # Remaining due capital at the end of the term
+      :crd_end_of_period
+
+      # Theoricaly due interests
+      :period_theoric_interests
+
+      # Difference between theorical and real (rounded) due interests
+      :delta_interests
+
+      # Accrued interests' delta
+      :accrued_delta_interests
+
+      # Adjustment of -0.01 0 or +0.01 cent depending on accrued_delta_interests
+      :amount_to_add
+
+      # Interests to pay this term
+      :period_interests
+
+      # Capital to pay this term
+      :period_capital
+
+      # Total capital paid so far (including current term)
+      :total_paid_capital_end_of_period
+
+      # Total interests paid so far (including current term)
+      :total_paid_interests_end_of_period
+
+      # Amount to pay this term
+      :period_amount_to_pay
+```
+
+`#periodic_interests_rate` renders a precise calculation of the loan's periodic interests rate based on two inputs: `#annual_interests_rate` and `#period`.
+
+`#lender_timetable` shall be defined in each loan class. It renders an instance of `LoanCreator::Timetable` which contains an ascending order array of `LoanCreator::Term`. It takes into account financial rounding differences and makes the borrower
+support all those differences.
+
+`.borrower_timetable(*lenders_timetables)` (class method) intends to sum each attribute of each provided `lender_timetable` on each term and thus to provide an ascending order array of `LoanCreator::Term`. It should be used for the borrower of a loan, once all lenders and their lending amounts
+are known. It makes the borrower support all financial rounding differences.
+
+## Example
+
+```ruby
+loan_creator = LoanCreator::Standard.new(
+  period: :year,
+  amount: 42_000,
+  annual_interests_rate: 4,
+  starts_on: '2019-03-01',
+  duration_in_periods: 5,
+  deferred_in_periods: 1,
+  interests_start_date: '2019-02-10'
+)
+loan_creator.lender_timetable
+# => #<LoanCreator::Timetable:0x0000000003198bd0 @terms=[...] ...>
+loan_creator.lender_timetable.terms.first
+# => #<LoanCreator::Term:0x00000000030f1a88 @crd_beginning_of_period=0.42e5,
+# [...] @period_amount_to_pay=0.8745e2, @index=0, @due_on=Sun, 10 Feb 2019>
+````
+
+## Explanation
+
+### Classes
+
+`Standard` loan generates terms with constant payments.
+
+`Linear` loan generates terms with constant capital share payment.
+
+`Standard` and `Linear` loans may be capital-deferred, i.e. capital repayment is delayed.\
+Interests are to be payed normally during this period.
+
+`InFine` loan generates terms where terms' payments are composed by interests only.\
+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.
+
+There is no deferred time for `InFine` and `Bullet` loans as it would be equivalent to increasing loan's duration.
+
+### Attributes
+
+`period`: A `Symbol`. `:month`, `:quarter`, `:semester` or `:year`.
+
+`duration_in_periods`: An `Integer`.
+
+`amount`: Any number that can be converted to `BigDecimal`.
+
+`annual_interests_rate`: In percentage. Any number that can be converted to `BigDecimal`.
+
+`starts_at`: A `Date`, or a `String` that can be parsed.
+
+`deferred_in_periods`: Optional. An `Integer`, smaller than `duration_in_periods`. Number of periods during which no
+capital is refunded, only interest. Only relevant for `Standard` and `Linear` loans.
+
+`interests_start_date`: Optional. To be used when the loan starts before the first full term date. This then compute an
+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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/loan_creator.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "loan_creator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/loan_creator.rb

@@ -0,0 +1,19 @@
+require 'active_support/all'
+require 'bigdecimal'
+
+require 'loan_creator/initialize_bigdecimal'
+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'
+end

data/lib/loan_creator/borrower_timetable.rb

@@ -0,0 +1,42 @@
+module LoanCreator
+  module BorrowerTimetable
+    BORROWER_FINANCIAL_ATTRIBUTES = [
+      :crd_beginning_of_period,
+      :crd_end_of_period,
+      :period_interests,
+      :period_capital,
+      :total_paid_capital_end_of_period,
+      :total_paid_interests_end_of_period,
+      :period_amount_to_pay
+    ].freeze
+
+    def borrower_timetable(*lenders_timetables)
+      raise ArgumentError.new('Array of LoanCreator::Timetable expected') unless Array === lenders_timetables
+      raise ArgumentError.new('At least one LoanCreator::Timetable expected') unless lenders_timetables.length > 0
+      lenders_timetables.each do |lender_timetable|
+        raise ArgumentError.new('Array of LoanCreator::Timetable expected') unless LoanCreator::Timetable === lender_timetable
+      end
+
+      borrower_timetable = LoanCreator::Timetable.new(
+        starts_on: lenders_timetables.first.starts_on,
+        period: lenders_timetables.first.period
+      )
+
+      # Borrower timetable is not concerned with computation-related value (delta, etc.),
+      # thus we start with all values to zero, then we override only BORROWER_FINANCIAL_ATTRIBUTES.
+      all_zero = LoanCreator::Term::ARGUMENTS.each_with_object({}) { |k, h| h[k] = bigd('0') }
+
+      # Group lenders' terms by index
+      transposed_terms = lenders_timetables.map(&:terms).transpose
+      # For each term, sum each required element
+      # First borrower's term contains the sums of lenders' first terms' elements (LoanCreator::Term::ARGUMENT), etc.
+      transposed_terms.each do |arr|
+        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))
+      end
+      borrower_timetable
+    end
+  end
+end

data/lib/loan_creator/bullet.rb

@@ -0,0 +1,40 @@
+module LoanCreator
+  class Bullet < LoanCreator::Common
+    def lender_timetable
+      raise ArgumentError.new(:deferred_in_periods) unless deferred_in_periods == 0
+      raise ArgumentError.new(:interests_start_date) unless interests_start_date.nil?
+      timetable = new_timetable
+      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
+      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
+    end
+
+    #   Capital * (periodic_interests_rate ^(total_terms))
+    #
+    def total_payment
+      amount.mult(
+        (bigd(1) + periodic_interests_rate) ** bigd(duration_in_periods),
+        BIG_DECIMAL_DIGITS
+      )
+    end
+
+    def total_interests
+      total_payment - amount
+    end
+  end
+end

data/lib/loan_creator/common.rb

@@ -0,0 +1,163 @@
+module LoanCreator
+  class Common
+    extend BorrowerTimetable
+
+    PERIODS_IN_MONTHS = {
+      month: 1,
+      quarter: 3,
+      semester: 6,
+      year: 12
+    }.freeze
+
+    REQUIRED_ATTRIBUTES = [
+      :period,
+      :amount,
+      :annual_interests_rate,
+      :starts_on,
+      :duration_in_periods
+    ].freeze
+
+    OPTIONAL_ATTRIBUTES = {
+      # attribute: default_value
+      deferred_in_periods: 0,
+      interests_start_date: nil,
+    }.freeze
+
+    attr_reader *REQUIRED_ATTRIBUTES
+    attr_reader *OPTIONAL_ATTRIBUTES.keys
+
+    def initialize(**options)
+      @options = options
+      require_attributes
+      reinterpret_attributes
+      set_attributes
+      validate_attributes
+    end
+
+    def periodic_interests_rate_percentage
+      @periodic_interests_rate_percentage ||=
+        annual_interests_rate.div(12 / PERIODS_IN_MONTHS[period], BIG_DECIMAL_DIGITS)
+    end
+
+    def periodic_interests_rate
+      @periodic_interests_rate ||=
+        periodic_interests_rate_percentage.div(100, BIG_DECIMAL_DIGITS)
+    end
+
+    def lender_timetable
+      raise NotImplementedError
+    end
+
+    def self.bigd(value)
+      BigDecimal(value, BIG_DECIMAL_DIGITS)
+    end
+
+    def bigd(value)
+      self.class.bigd(value)
+    end
+
+    private
+
+    def require_attributes
+      REQUIRED_ATTRIBUTES.each { |k| raise ArgumentError.new(k) unless @options.fetch(k, nil) }
+    end
+
+    def reinterpret_attributes
+      @options[:period] = @options[:period].to_sym
+      @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)
+    end
+
+    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)) }
+    end
+
+    def validate(key, &block)
+      raise unless block.call(instance_variable_get(:"@#{key}"))
+    rescue
+      raise ArgumentError.new(key)
+    end
+
+    def validate_attributes
+      validate(:period) { |v| PERIODS_IN_MONTHS.keys.include?(v) }
+      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 }
+    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
+    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,
+        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
+      )
+    end
+
+    def new_timetable
+      LoanCreator::Timetable.new(starts_on: starts_on, period: period, interests_start_date: interests_start_date)
+    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
+    end
+
+    def term_zero_interests
+      @crd_beginning_of_period * term_zero_interests_rate
+    end
+
+    def term_zero_interests_rate
+      term_zero_interests_rate_percentage = (annual_interests_rate * term_zero_duration).div(365, BIG_DECIMAL_DIGITS)
+      term_zero_interests_rate_percentage.div(100, BIG_DECIMAL_DIGITS)
+    end
+
+    def term_zero_duration
+      (term_zero_date - interests_start_date).to_i
+    end
+
+    def term_zero_date
+      starts_on.advance(months: -PERIODS_IN_MONTHS.fetch(@period))
+    end
+
+    def term_zero?
+      interests_start_date && interests_start_date < term_zero_date
+    end
+  end
+end

data/lib/loan_creator/excel_formulas.rb

@@ -0,0 +1,41 @@
+# Source: https://gist.github.com/mattetti/1015948
+
+module LoanCreator::ExcelFormulas
+  # Returns the interest payment
+  # for a given period for an investment based on periodic, constant payments and a constant interest rate.
+  def ipmt(rate, per, nper, pv, fv=0, type=0)
+    p = _pmt(rate, nper, pv, fv, 0);
+    ip = -(pv * _pow1p(rate, per - 1) * rate + p * _pow1pm1(rate, per - 1))
+    (type == 0) ? ip : ip / (1 + rate)
+  end
+
+  # Returns the payment on the principal
+  # for a given period for an investment based on periodic, constant payments and a constant interest rate.
+  def ppmt(rate, per, nper, pv, fv=0, type=0)
+    p = _pmt(rate, nper, pv, fv, type)
+    ip = ipmt(rate, per, nper, pv, fv, type)
+    p - ip
+  end
+
+  protected
+
+  def _pmt(rate, nper, pv, fv=0, type=0)
+    ((-pv * _pvif(rate, nper) - fv ) / ((bigd('1.0') + rate * type) * _fvifa(rate, nper)))
+  end
+
+  def _pow1pm1(x, y)
+    (x <= -1) ? ((1 + x) ** y) - 1 : Math.exp(y * Math.log(bigd('1.0') + x)) - 1
+  end
+
+  def _pow1p(x, y)
+    (x.abs > bigd('0.5')) ? ((1 + x) ** y) : Math.exp(y * Math.log(bigd('1.0') + x))
+  end
+
+  def _pvif(rate, nper)
+    _pow1p(rate, nper)
+  end
+
+  def _fvifa(rate, nper)
+    (rate == 0) ? nper : _pow1pm1(rate, nper) / rate
+  end
+end

data/lib/loan_creator/in_fine.rb

@@ -0,0 +1,10 @@
+module LoanCreator
+  class InFine < LoanCreator::Common
+    # InFine is the same as a Linear loan with (duration - 1) deferred periods.
+    # 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
+    end
+  end
+end

data/lib/loan_creator/initialize_bigdecimal.rb

@@ -0,0 +1,6 @@
+# Round towards the nearest neighbor, unless both neighbors are
+# equidistant, in which case round towards the even neighbor
+# (Bank rounding)
+# usage of BigDecimal method: div(value, digits)
+# usage of BigDecimal method: mult(value, digits)
+BigDecimal.mode(BigDecimal::ROUND_HALF_EVEN, true)

data/lib/loan_creator/linear.rb

@@ -0,0 +1,65 @@
+# coding: utf-8
+module LoanCreator
+  class Linear < LoanCreator::Common
+    def lender_timetable
+      timetable = new_timetable
+      reset_current_term
+      @crd_end_of_period = amount
+
+      if term_zero?
+        compute_term_zero
+        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
+      timetable
+    end
+
+    private
+
+    def last_period?(idx)
+      idx == (duration_in_periods - 1)
+    end
+
+    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
+      @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_capital = period_capital
+      @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
+    end
+
+    def period_capital
+      if @last_period
+        @crd_beginning_of_period
+      elsif @deferred_period
+        bigd(0)
+      else
+        (amount / (duration_in_periods - deferred_in_periods)).round(2)
+      end
+    end
+  end
+end

data/lib/loan_creator/standard.rb

@@ -0,0 +1,83 @@
+module LoanCreator
+  class Standard < LoanCreator::Common
+    include LoanCreator::ExcelFormulas
+
+    def lender_timetable
+      timetable = new_timetable
+      reset_current_term
+      @crd_end_of_period = amount
+
+      if term_zero?
+        compute_term_zero
+        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
+      timetable
+    end
+
+    private
+
+    def last_period?(idx)
+      idx == (duration_in_periods - 1)
+    end
+
+    def compute_current_term(idx)
+      @crd_beginning_of_period = @crd_end_of_period
+      @period_theoric_interests = period_theoric_interests(idx)
+      @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_capital = period_capital(idx)
+      @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
+    end
+
+    def period_theoric_interests(idx)
+      if @deferred_period
+        @crd_beginning_of_period * periodic_interests_rate
+      else
+        -ipmt(
+          periodic_interests_rate,
+          (idx + 1) - deferred_in_periods,
+          duration_in_periods - deferred_in_periods,
+          amount
+        )
+      end
+    end
+
+    def period_capital(idx)
+      if @last_period
+        @crd_beginning_of_period
+      elsif @deferred_period
+        bigd(0)
+      else
+        -ppmt(
+          periodic_interests_rate,
+          (idx + 1) - deferred_in_periods,
+          duration_in_periods - deferred_in_periods,
+          amount
+        ).round(2)
+      end
+    end
+  end
+end

data/lib/loan_creator/term.rb

@@ -0,0 +1,70 @@
+module LoanCreator
+  class Term
+
+    ARGUMENTS = [
+      # Remaining due capital at the beginning of the term
+      :crd_beginning_of_period,
+
+      # Remaining due capital at the end of the term
+      :crd_end_of_period,
+
+      # Theoricaly due interests
+      :period_theoric_interests,
+
+      # Difference between theorical and real (rounded) due interests
+      :delta_interests,
+
+      # Accrued interests' delta
+      :accrued_delta_interests,
+
+      # Adjustment of -0.01, 0 or +0.01 cent depending on accrued_delta_interests
+      :amount_to_add,
+
+      # Interests to pay this term
+      :period_interests,
+
+      # Capital to pay this term
+      :period_capital,
+
+      # Total capital paid so far (including current term)
+      :total_paid_capital_end_of_period,
+
+      # Total interests paid so far (including current term)
+      :total_paid_interests_end_of_period,
+
+      # Amount to pay this term
+      :period_amount_to_pay
+    ].freeze
+
+    OPTIONAL_ARGUMENTS = [
+      # Term number (starts at 1)
+      # This value is to be set by Timetable
+      :index,
+
+      # Term date
+      # This value is to be set by Timetable
+      :due_on,
+    ]
+
+    ATTRIBUTES = (ARGUMENTS + OPTIONAL_ARGUMENTS).freeze
+
+    attr_accessor *ATTRIBUTES
+
+    def initialize(**options)
+      ARGUMENTS.each { |k| instance_variable_set(:"@#{k}", options.fetch(k)) }
+      OPTIONAL_ARGUMENTS.each { |k| instance_variable_set(:"@#{k}", options.fetch(k, nil)) }
+    end
+
+    def to_csv
+      ATTRIBUTES.map { |k| instance_variable_get(:"@#{k}") }.join(',')
+    end
+
+    def to_s
+      to_csv
+    end
+
+    def to_h
+      ATTRIBUTES.each_with_object({}) { |k, h| h[k] = instance_variable_get(:"@#{k}") }
+    end
+  end
+end

data/lib/loan_creator/timetable.rb

@@ -0,0 +1,70 @@
+# 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 :terms, :starts_on, :period #, :interests_start_date
+
+    def initialize(starts_on:, period:, interests_start_date: nil)
+      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
+
+      if interests_start_date
+        @interests_start_date = (interests_start_date.is_a?(Date) ? interests_start_date : Date.parse(interests_start_date))
+      end
+    end
+
+    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)
+      @terms << term
+      self
+    end
+
+    def to_csv(header: true)
+      output = []
+      output << terms.first.to_h.keys.join(',') if header
+      terms.each { |t| output << t.to_csv }
+      output
+    end
+
+    def term(index)
+      @terms.find { |term| term.index == index }
+    end
+
+    private
+
+    def autoincrement_index
+      @current_index = @current_index.nil? ? 1 : @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
+    end
+  end
+end

data/lib/loan_creator/version.rb

@@ -0,0 +1,3 @@
+module LoanCreator
+  VERSION = '0.5.0'.freeze
+end

data/loan_creator.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loan_creator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'loan_creator'
+  spec.version       = LoanCreator::VERSION
+  spec.authors       = %w[thibaulth nicob younes.serraj]
+  spec.email         = ['thibault@capsens.eu', 'nicolas.besnard@capsens.eu', 'younes.serraj@gmail.com']
+
+  spec.summary       = 'Create and update timetables from input data'
+  spec.homepage      = 'https://capsens.githost.io/capsens/loan-creator'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+
+  spec.add_runtime_dependency 'bigdecimal'
+  spec.add_runtime_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: loan_creator
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- thibaulth
+- nicob
+- younes.serraj
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- thibault@capsens.eu
+- nicolas.besnard@capsens.eu
+- younes.serraj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CapSens_Loan.xlsx
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/loan_creator.rb
+- lib/loan_creator/borrower_timetable.rb
+- lib/loan_creator/bullet.rb
+- lib/loan_creator/common.rb
+- lib/loan_creator/excel_formulas.rb
+- lib/loan_creator/in_fine.rb
+- lib/loan_creator/initialize_bigdecimal.rb
+- lib/loan_creator/linear.rb
+- lib/loan_creator/standard.rb
+- lib/loan_creator/term.rb
+- lib/loan_creator/timetable.rb
+- lib/loan_creator/version.rb
+- loan_creator.gemspec
+homepage: https://capsens.githost.io/capsens/loan-creator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Create and update timetables from input data
+test_files: []