loan_creator 0.2.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c512fd6d25322111e992b4a6b8cbf24ed2ef492e
-  data.tar.gz: 67a1fdc42b417b91ca5ef72b1aeb9e136aa95a68
+  metadata.gz: 8dff90f00c1b47c09fd2ac97d4a0e3a28e12fbd5
+  data.tar.gz: '078e7ad135c712ef0fb767208cc99557718b99b1'
 SHA512:
-  metadata.gz: af89b4866718ebb10a136c9fb3e6a1c7d54830a398cb0c972677d5472dbe0541bc9c5eac32b137efdbd685fda7f5ef95b0807016fe0f161cc77e0b4287cb3677
-  data.tar.gz: 3c1b146323de4de7d20f597af5ba58c9a509f0131a48b34a1a83a080f42102ae4017cccee613dd2ec63fd5ebc6fae4e6e4c1c7a817276a8a6c433839c1c02722
+  metadata.gz: e318e46a05d49caa450705cb5a6e234c7b3e497dad501961c1339638c0641cc76f88dafb00f07af80b9b9cdc6d5ba1d0b5e761133f863f7a6034d479ddb0f012
+  data.tar.gz: bc258a7bd58a783c033c7c81857b467966e2e4ee25b091cc73cf1de1f5ec94a94f889fb2c32f5be072668503295564a841beb0573585c509b867dc9b0025cbe1

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+v0.6.2
+-------------------------
+
+- add `:initial_values` for loans initialization
+- add and compute `capitalized_interests` for `LoanCreator::Bullet` terms
+
+v0.6.1
+-------------------------
+
+- fix homepage url
+
+v0.6.0
+-------------------------
+
+- add `LoanCreator::UncapitalizedBullet`
+
+v0.5.0
+-------------------------
+
+- add `interests_start_date` in `LoanCreator::Common` attributes, replacing `first_term_date`
+
+v0.3.0
+-------------------------
+
+- add `first_term_date` in `LoanCreator::Common` attributes
+
+v0.2.3
+-------------------------
+
+- rename `starts_at` -> `starts_on`
+
+v0.2.2
+-------------------------
+
+- rename `date` -> `due_on`
+
+v0.2.1
+-------------------------
+
+- convert some options to their expected type by default
+
+v0.2.0
+-------------------------
+
+- Huge rework : add `period`, rename `amount_in_cents` to `amount` and other breaking changes.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at development@capsens.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/README.md

@@ -2,8 +2,6 @@
 
 `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:
@@ -35,6 +33,7 @@ There are four types of loans. All inherit from a `LoanCreator::Common` class.
     LoanCreator::Linear
     LoanCreator::InFine
     LoanCreator::Bullet
+    LoanCreator::UncapitalizedBullet
 ```
 
 Each instance of one of the previous classes has the following attributes:
@@ -46,6 +45,20 @@ Each instance of one of the previous classes has the following attributes:
     :starts_at
     :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:
@@ -55,7 +68,7 @@ There is also a `LoanCreator::Timetable` class dedicated to record the data of t
       :index
 
       # Term date
-      :date
+      :due_on
 
       # Remaining due capital at the beginning of the term
       :crd_beginning_of_period
@@ -99,8 +112,29 @@ 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.
@@ -115,8 +149,35 @@ Capital share shall be repaid in full at loan's end.
 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.
 
+`UncapitalizedBullet` same as bullet, the only difference is the interests\
+are NOT capitalized.
+
 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.
+
+## Calculation
+
+An excel simulator for standard case can be found [here](CapSens_Loan.xlsx).
+
 ## 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.
@@ -125,7 +186,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/loan_creator.
+Bug reports and pull requests are welcome on GitHub at https://github.com/CapSens/loan_creator.
 
 
 ## License

data/lib/loan_creator.rb

@@ -7,13 +7,14 @@ 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 :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'
 end

data/lib/loan_creator/borrower_timetable.rb

@@ -18,7 +18,7 @@ module LoanCreator
       end
 
       borrower_timetable = LoanCreator::Timetable.new(
-        starts_at: lenders_timetables.first.starts_at,
+        starts_on: lenders_timetables.first.starts_on,
         period: lenders_timetables.first.period
       )
 

data/lib/loan_creator/bullet.rb

@@ -2,11 +2,12 @@ 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 }
+      (duration_in_periods - 1).times { |period| compute_term(timetable, period + 1) }
       compute_last_term
       timetable << current_term
       timetable
@@ -15,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

@@ -13,13 +13,15 @@ module LoanCreator
       :period,
       :amount,
       :annual_interests_rate,
-      :starts_at,
+      :starts_on,
       :duration_in_periods
     ].freeze
 
     OPTIONAL_ATTRIBUTES = {
       # attribute: default_value
-      deferred_in_periods: 0
+      deferred_in_periods: 0,
+      interests_start_date: nil,
+      initial_values: {}
     }.freeze
 
     attr_reader *REQUIRED_ATTRIBUTES
@@ -31,6 +33,8 @@ module LoanCreator
       reinterpret_attributes
       set_attributes
       validate_attributes
+      set_initial_values
+      validate_initial_values
     end
 
     def periodic_interests_rate_percentage
@@ -48,7 +52,7 @@ module LoanCreator
     end
 
     def self.bigd(value)
-      BigDecimal.new(value, BIG_DECIMAL_DIGITS)
+      BigDecimal(value, BIG_DECIMAL_DIGITS)
     end
 
     def bigd(value)
@@ -65,6 +69,8 @@ module LoanCreator
       @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
@@ -82,43 +88,108 @@ module LoanCreator
       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_at) { |v| !!Date.parse(v) }
+      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 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')
+      @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
+        period_amount_to_pay:               @period_amount_to_pay,
+        due_on:                             @due_on,
+        index:                              compute_index
       )
     end
 
     def new_timetable
-      LoanCreator::Timetable.new(starts_at: starts_at, period: period)
+      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
+    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

@@ -1,12 +1,16 @@
 # 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)

data/lib/loan_creator/in_fine.rb

@@ -3,9 +3,7 @@ module LoanCreator
     # 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
-      raise ArgumentError.new(:deferred_in_periods) unless deferred_in_periods == 0
-      options = { deferred_in_periods: duration_in_periods - 1 }
-      options = REQUIRED_ATTRIBUTES.each_with_object(options) { |k,h| h[k] = send(k) }
+      options = @options.merge(deferred_in_periods: duration_in_periods - 1)
       LoanCreator::Linear.new(options).lender_timetable
     end
   end

data/lib/loan_creator/linear.rb

@@ -5,12 +5,19 @@ module LoanCreator
       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
+        compute_current_term(idx)
         timetable << current_term
       end
+
       timetable
     end
 
@@ -20,7 +27,7 @@ module LoanCreator
       idx == (duration_in_periods - 1)
     end
 
-    def compute_current_term
+    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
@@ -42,6 +49,8 @@ module LoanCreator
       @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

data/lib/loan_creator/standard.rb

@@ -6,6 +6,12 @@ module LoanCreator
       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
@@ -42,6 +48,8 @@ module LoanCreator
       @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)

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,
 
@@ -36,23 +39,23 @@ module LoanCreator
       :period_amount_to_pay
     ].freeze
 
-    ATTRIBUTES = [
+    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
-      :date,
+      :due_on,
+    ]
 
-      # These values are to be specified during Term's initialization
-      *ARGUMENTS
-    ].freeze
+    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

data/lib/loan_creator/timetable.rb

@@ -3,39 +3,35 @@ 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 }
+      month:    {months: 1},
+      quarter:  {months: 3},
+      semester: {months: 6},
+      year:     {years: 1}
     }
 
-    attr_reader :terms, :starts_at, :period
+    attr_reader :terms, :starts_on, :period #, :interests_start_date
 
-    def initialize(starts_at:, period:)
-      @terms = []
-      @starts_at = (Date === starts_at ? starts_at : Date.parse(starts_at))
+    def initialize(starts_on:, period:, interests_start_date: nil, starting_index: 1)
       raise ArgumentError.new(:period) unless PERIODS.keys.include?(period)
-      @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))
+      end
     end
 
     def <<(term)
-      raise ArgumentError.new('LoanCreator::Term expected') unless LoanCreator::Term === term
-      term.index = autoincrement_index
-      term.date = autoincrement_date
+      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 reset_indexes_and_dates
-      @autoincrement_index = 0
-      @autoincrement_date = @starts_at
-      @terms.each do |term|
-        term[:index] = autoincrement_index
-        term[:date] = autoincrement_date
-      end
-      self
-    end
-
     def to_csv(header: true)
       output = []
       output << terms.first.to_h.keys.join(',') if header
@@ -43,20 +39,33 @@ module LoanCreator
       output
     end
 
+    def term(index)
+      @terms.find { |term| term.index == index }
+    end
+
     private
 
-    # First term index of a timetable term is 1
     def autoincrement_index
-      @autoincrement_index ||= 0
-      @autoincrement_index += 1
+      @current_index = (@current_index.nil? ? @starting_index : @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
 
-    # First term date of timetable term is the starts_at given date
-    def autoincrement_date
-      @autoincrement_date ||= @starts_at
-      date = @autoincrement_date
-      @autoincrement_date = @autoincrement_date.advance(PERIODS.fetch(@period))
-      date
+    def reset_dates
+      @_dates = nil
     end
   end
 end

data/lib/loan_creator/uncapitalized_bullet.rb

@@ -0,0 +1,34 @@
+module LoanCreator
+  class UncapitalizedBullet < 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
+
+    def total_interests
+      amount.mult(
+        bigd(periodic_interests_rate) * bigd(duration_in_periods),
+        BIG_DECIMAL_DIGITS
+      )
+    end
+  end
+end

data/lib/loan_creator/version.rb

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

data/loan_creator.gemspec

@@ -5,11 +5,11 @@ 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.authors       = ["thibaulth", "nicob", "younes.serraj", "Antoine Becquet", "Jerome Drevet"]
+  spec.email         = ['thibault@capsens.eu', 'nicolas.besnard@capsens.eu', 'younes.serraj@gmail.com', "antoine@capsens.eu", "jerome@capsens.eu"]
 
   spec.summary       = 'Create and update timetables from input data'
-  spec.homepage      = 'https://capsens.githost.io/capsens/loan-creator'
+  spec.homepage      = 'https://github.com/CapSens/loan-creator'
   spec.license       = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,16 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.2
 platform: ruby
 authors:
 - thibaulth
 - nicob
 - younes.serraj
+- Antoine Becquet
+- Jerome Drevet
 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
@@ -115,6 +117,8 @@ email:
 - thibault@capsens.eu
 - nicolas.besnard@capsens.eu
 - younes.serraj@gmail.com
+- antoine@capsens.eu
+- jerome@capsens.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -126,6 +130,9 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CapSens_Loan.xlsx
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -143,9 +150,10 @@ files:
 - lib/loan_creator/standard.rb
 - lib/loan_creator/term.rb
 - lib/loan_creator/timetable.rb
+- lib/loan_creator/uncapitalized_bullet.rb
 - lib/loan_creator/version.rb
 - loan_creator.gemspec
-homepage: https://capsens.githost.io/capsens/loan-creator
+homepage: https://github.com/CapSens/loan-creator
 licenses:
 - MIT
 metadata: {}