loan_creator 0.5.0 → 0.6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ce94717f0c667263653597ea2037844157e6cebe
-  data.tar.gz: e498fe9069ca0ff9c3d765083a182f28ddc3ca22
+SHA256:
+  metadata.gz: af7d0ce0dc0202794a3f37abf13b9f0af74e214a3d5629779d312acb1f5d02f0
+  data.tar.gz: c7304d6eb2ecc855702c2e403378860ad029b30180054e7658bfc86980fc7fb0
 SHA512:
-  metadata.gz: da8108111a04280719eba3143444bd2ceac35abaade6521c2e9a5a3297266037c7d8e194156c3a373602fe766bbce49c23ebe515a2db1b64e1a35ac67a4aff06
-  data.tar.gz: 5e49dd7114a25fc67e9230ea0d6120b7a12bb83b6b6c50d28eecbfb7c92cc7bbd68da4ca26d0bf7dffe0b7b1fc2a7ec9acbbbb9369bf2cdfb1eb6837625dd2be
+  metadata.gz: a3991a0c94c5445bf179d8c363a56926c9bb8b90bddf23ae1d220dd74eed7d9ec225174fd06c2033a85fde23502af09346d1196f2755ac7cae26a625f6396669
+  data.tar.gz: d080c6fe10ad761bc19947edbe701736f80ab38fded009ea2bce40292440878141e4a06e8a6fc4988b956ee8918a058e3b24345f3b39d152d03b543fec18aefc

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.7
+3.2.5

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+v0.6.1.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:
@@ -137,6 +136,9 @@ 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
@@ -155,10 +157,14 @@ There is no deferred time for `InFine` and `Bullet` loans as it would be equival
 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.  
+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.
@@ -167,7 +173,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/borrower_timetable.rb

@@ -34,7 +34,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/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/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.5.0'.freeze
+  VERSION = '0.6.1.1'.freeze
 end

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/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|
@@ -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'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'byebug', '~> 11.0'

metadata

@@ -1,45 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: loan_creator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1.1
 platform: ruby
 authors:
 - thibaulth
 - nicob
 - younes.serraj
-autorequire: 
+- Antoine Becquet
+- Jerome Drevet
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2024-09-02 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,11 +112,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 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,8 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CapSens_Loan.xlsx
 - Gemfile
 - LICENSE.txt
@@ -144,13 +150,14 @@ 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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,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.5.18
+signing_key:
 specification_version: 4
 summary: Create and update timetables from input data
 test_files: []