blend_spreadsheet_loan_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 740b10d39f33e08cc9522d153db7fd353d90711139f1dea78577ff00294745e9
+  data.tar.gz: e99017730cf0b998baf028f90b2237151c3eba8c2d0b1f581b808f7c8ada1438
+SHA512:
+  metadata.gz: 4496083db9061a2521f248554d5da3fbe2c63c8bf955b2a788640aae0244670ad0a213e2df8550632524e6089685ddabd47156e07ce5f1a64cbb648d18bffe73
+  data.tar.gz: bd42f93b037d7813f854c6228bc1d5b54203c74f32f6788bbbe43bd962f0a496edece072c2ded50efc9de6aeb628f6dd0dd68ec8c99c94535a7e20dfa57d3410

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+
+*.csv
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blend_spreadsheet_loan_generator.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/README.md

@@ -0,0 +1,36 @@
+# SpreadsheetLoanGenerator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/spreadsheet_loan_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spreadsheet_loan_generator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install spreadsheet_loan_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/blend_spreadsheet_loan_generator.
+

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 "blend_spreadsheet_loan_generator"
+
+# 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(__FILE__)

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/blend_spreadsheet_loan_generator.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/blend_spreadsheet_loan_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blend_spreadsheet_loan_generator'
+  spec.version       = BlendSpreadsheetLoanGenerator::VERSION
+  spec.authors       = ['MZiserman']
+  spec.email         = ['martinziserman@gmail.com']
+
+  spec.summary       = 'Generate spreadsheets amortization schedules from the command line'
+  spec.homepage      = 'https://github.com/CapSens/blend_spreadsheet_loan_generator'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables << 'bslg'
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'csv'
+  spec.add_runtime_dependency 'dry-cli', '0.6'
+  spec.add_runtime_dependency 'google_drive'
+  spec.add_development_dependency 'pry'
+end

data/exe/bslg

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/blend_spreadsheet_loan_generator'
+
+Dry::CLI.new(BlendSpreadsheetLoanGenerator).call

data/lib/blend_spreadsheet_loan_generator.rb

@@ -0,0 +1,37 @@
+require 'dry/cli'
+require 'google_drive'
+require 'active_support/all'
+require 'fileutils'
+require 'csv'
+
+require 'blend_spreadsheet_loan_generator/version'
+
+module BlendSpreadsheetLoanGenerator
+  class Error < StandardError; end
+
+  extend Dry::CLI::Registry
+
+  autoload :SpreadsheetConcern, 'blend_spreadsheet_loan_generator/concerns/spreadsheet_concern'
+  autoload :CsvConcern, 'blend_spreadsheet_loan_generator/concerns/csv_concern'
+
+  autoload :Linear, 'blend_spreadsheet_loan_generator/linear'
+  autoload :Standard, 'blend_spreadsheet_loan_generator/standard'
+  autoload :NormalInterests, 'blend_spreadsheet_loan_generator/normal_interests'
+  autoload :SimpleInterests, 'blend_spreadsheet_loan_generator/simple_interests'
+  autoload :RealisticInterests, 'blend_spreadsheet_loan_generator/realistic_interests'
+  autoload :Formula, 'blend_spreadsheet_loan_generator/formula'
+
+  autoload :Loan, 'blend_spreadsheet_loan_generator/loan'
+
+  autoload :Version, 'blend_spreadsheet_loan_generator/version'
+  autoload :Generate, 'blend_spreadsheet_loan_generator/generate'
+  autoload :Restructure, 'blend_spreadsheet_loan_generator/restructure'
+  autoload :EarlyRepay, 'blend_spreadsheet_loan_generator/early_repay'
+  autoload :Init, 'blend_spreadsheet_loan_generator/init'
+
+  register 'init', Init, aliases: ['i', '-i', '--init']
+  register 'version', Version, aliases: ['v', '-v', '--version']
+  register 'generate', Generate, aliases: ['g', '-g', '--generate']
+  register 'restructure', Restructure, aliases: ['r', '-r', '--restructure']
+  register 'early_repay', EarlyRepay, aliases: ['er', '-er', '--early_repay']
+end

data/lib/blend_spreadsheet_loan_generator/concerns/csv_concern.rb

@@ -0,0 +1,29 @@
+module BlendSpreadsheetLoanGenerator
+  module CsvConcern
+    extend ActiveSupport::Concern
+
+    included do
+      def generate_csv(worksheet:, target_path:)
+        filename = File.join(target_path, "#{loan.name}.csv")
+        CSV.open(filename, 'wb') do |csv|
+          loan.duration.times do |line|
+            row = []
+            columns.each.with_index do |name, column|
+              row << (
+                case name
+                when 'index'
+                  worksheet[line + 2, column + 1]
+                when 'due_on'
+                  Date.parse(worksheet[line + 2, column + 1]).strftime('%m/%d/%Y')
+                else
+                  worksheet[line + 2, column + 1].gsub(',', '.').to_f
+                end
+              )
+            end
+            csv << row
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blend_spreadsheet_loan_generator/concerns/spreadsheet_concern.rb

@@ -0,0 +1,123 @@
+module BlendSpreadsheetLoanGenerator
+  module SpreadsheetConcern
+    extend ActiveSupport::Concern
+
+    included do
+      def columns
+        %w[
+          index
+          due_on
+          remaining_capital_start
+          remaining_capital_end
+          period_theoric_interests
+          delta
+          accrued_delta
+          amount_to_add
+          period_interests
+          period_capital
+          total_paid_capital_end_of_period
+          total_paid_interests_end_of_period
+          period_total
+          capitalized_interests_start
+          capitalized_interests_end
+          period_rate
+          period_calculated_capital
+          period_calculated_interests
+          period_reimbursed_capitalized_interests
+          period_leap_days
+          period_non_leap_days
+          period_fees
+          period_calculated_fees
+          capitalized_fees_start
+          capitalized_fees_end
+          period_reimbursed_capitalized_fees
+          period_fees_rate
+        ]
+      end
+
+      def currency_columns
+        %w[
+          remaining_capital_start
+          remaining_capital_end
+          amount_to_add
+          period_interests
+          period_capital
+          total_paid_capital_end_of_period
+          total_paid_interests_end_of_period
+          period_total
+          capitalized_interests_start
+          capitalized_interests_end
+          period_reimbursed_capitalized_interests
+          period_fees
+          capitalized_fees_start
+          capitalized_fees_end
+          period_reimbursed_capitalized_fees
+        ]
+      end
+
+      def precise_columns
+        %w[
+          period_theoric_interests
+          period_calculated_interests
+          period_calculated_capital
+          delta
+          accrued_delta
+          period_rate
+          period_calculated_fees
+          period_fees_rate
+        ]
+      end
+
+      def column_letter(column)
+        ('A'..'ZZ').to_a[columns.index(column)]
+      end
+
+      def apply_formats(worksheet:)
+        precise_columns.each do |column|
+          index = columns.index(column) + 1
+          worksheet.set_number_format(1, index, loan.duration + 1, 1, '0.00000000')
+        end
+        currency_columns.each do |column|
+          index = columns.index(column) + 1
+          worksheet.set_number_format(1, index, loan.duration + 1, 1, '0.00')
+        end
+      end
+
+      def apply_formulas(worksheet:)
+        columns.each.with_index do |title, column|
+          worksheet[1, column + 1] = title
+        end
+        loan.duration.times do |line|
+          columns.each.with_index do |title, column|
+            worksheet[line + 2, column + 1] = @formula.send("#{title}_formula", line: line + 2)
+          end
+        end
+      end
+
+      def column_range(column: 'A', upto: , exclude_head: true)
+        start_line = exclude_head ? 2 : 1
+
+        "#{column}#{start_line}:#{column}#{upto}"
+      end
+
+      def index_to_line(index:)
+        index + 1 # first term is on line 2
+      end
+
+      def excel_float(float)
+        float.to_s.gsub('.', ',')
+      end
+
+      # used heavily in formula concern
+      def respond_to_missing?(method_name, include_private = false)
+        columns.include?(method_name.to_s) || super
+      end
+
+      def method_missing(method_name, *args, **kwargs)
+        return super unless respond_to_missing?(method_name)
+
+        "#{column_letter(method_name.to_s)}#{args.first}"
+      end
+    end
+  end
+end

data/lib/blend_spreadsheet_loan_generator/early_repay.rb

@@ -0,0 +1,163 @@
+module BlendSpreadsheetLoanGenerator
+  class EarlyRepay < Dry::CLI::Command
+    include SpreadsheetConcern
+    include CsvConcern
+
+    attr_accessor :loan
+
+    desc "Generate spreadsheet"
+
+    argument :last_paid_term, type: :integer, required: true, desc: 'last paid term, restructuration starts at last_paid + 1'
+    argument :amount_paid, type: :integer, required: true, desc: 'amount early repaid'
+    argument :from_path, type: :string, required: true, desc: 'csv to restructure'
+    argument :rate, type: :float, required: true, desc: 'year rate post restructuration'
+
+    option :period_duration, type: :integer, default: 1, desc: 'duration of a period in months'
+    option :due_on, type: :date, default: Date.today, desc: 'date of the pay day of the first period DD/MM/YYYY'
+    option :deferred_and_capitalized, type: :integer, default: 0, desc: 'periods with no capital or interests paid'
+    option :deferred, type: :integer, default: 0, desc: 'periods with only interests paid'
+    option :type, type: :string, default: 'standard', values: %w[standard linear], desc: 'type of amortization'
+    option :interests_type, type: :string, default: 'simple', values: %w[simple realistic normal], desc: 'type of interests calculations'
+    option :fees_rate, type: :float, default: 0.0, required: true, desc: 'year fees rate'
+    option :starting_capitalized_interests, type: :float, default: 0.0, desc: 'starting capitalized interests (if ongoing loan)'
+    option :starting_capitalized_fees, type: :float, default: 0.0, desc: 'starting capitalized fees (if ongoing loan)'
+    option :target_path, type: :string, default: './', desc: 'where to put the generated csv'
+
+    def call(last_paid_term:, amount_paid:, from_path:, rate:, **options)
+      begin
+        session = GoogleDrive::Session.from_config(
+          File.join(ENV['SPREADSHEET_LOAN_GENERATOR_DIR'], 'config.json')
+        )
+      rescue StandardError => e
+        if ENV['SPREADSHEET_LOAN_GENERATOR_DIR'].blank?
+          puts 'please set SPREADSHEET_LOAN_GENERATOR_DIR'
+        else
+          puts 'Cannot connect to google drive. Did you run slg init CLIENT_ID CLIENT_SECRET ?'
+        end
+        return
+      end
+
+      f = CSV.open(from_path)
+      values = f.to_a
+      values.map! { |r| set_types([columns, r].transpose.to_h.with_indifferent_access) }
+
+      last_paid_line = values.index { |term| term[:index] == last_paid_term.to_i }
+
+      total_to_be_paid = (
+        values[last_paid_line + 1][:remaining_capital_start] +
+        values[last_paid_line + 1][:capitalized_interests_start] +
+        values[last_paid_line + 1][:capitalized_fees_start]
+      )
+
+      amount_paid = amount_paid.to_f
+      duration = (
+        if total_to_be_paid == amount_paid
+          1
+        else
+          values.last[:index] - values[last_paid_line][:index]
+        end
+      )
+
+      starting_capitalized_interests = 0.0
+      starting_capitalized_fees = 0.0
+
+      due_on = values[last_paid_line + 1][:due_on] + 1.month
+
+      capital_paid = amount_paid.to_f - (
+        values[last_paid_line + 1][:capitalized_interests_start] +
+        values[last_paid_line + 1][:capitalized_fees_start]
+      )
+
+      @loan = Loan.new(
+        amount: values[last_paid_line][:remaining_capital_end],
+        duration: duration,
+        rate: rate,
+        fees_rate: options.fetch(:fees_rate),
+        period_duration: options.fetch(:period_duration),
+        due_on: due_on,
+        deferred_and_capitalized: options.fetch(:deferred_and_capitalized),
+        deferred: options.fetch(:deferred),
+        type: options.fetch(:type),
+        interests_type: options.fetch(:interests_type),
+        starting_capitalized_interests: starting_capitalized_interests,
+        starting_capitalized_fees: starting_capitalized_fees
+      )
+
+      spreadsheet = session.create_spreadsheet(loan.name)
+      worksheet = spreadsheet.add_worksheet(loan.type, loan.duration + 2, columns.count + 1, index: 0)
+
+      @formula = Formula.new(loan: loan)
+
+      apply_formulas(worksheet: worksheet)
+
+      worksheet[2, columns.index('remaining_capital_start') + 1] =
+        excel_float(values[last_paid_line][:remaining_capital_end])
+
+      worksheet[2, columns.index('remaining_capital_end') + 1] =
+        excel_float(values[last_paid_line][:remaining_capital_end] - capital_paid)
+
+      worksheet[2, columns.index('period_interests') + 1] =
+        excel_float(values[last_paid_line + 1][:period_interests])
+
+      worksheet[2, columns.index('period_fees') + 1] =
+        excel_float(values[last_paid_line + 1][:period_fees])
+
+      worksheet[2, columns.index('period_capital') + 1] =
+        excel_float(capital_paid)
+
+      worksheet[2, columns.index('capitalized_interests_start') + 1] =
+        excel_float(values[last_paid_line + 1][:capitalized_interests_start])
+
+      worksheet[2, columns.index('capitalized_fees_start') + 1] =
+        excel_float(values[last_paid_line + 1][:capitalized_fees_start])
+
+      worksheet[2, columns.index('period_reimbursed_capitalized_interests') + 1] =
+        excel_float(values[last_paid_line + 1][:capitalized_interests_start])
+
+      worksheet[2, columns.index('period_reimbursed_capitalized_fees') + 1] =
+        excel_float(values[last_paid_line + 1][:capitalized_fees_start])
+
+      apply_formats(worksheet: worksheet)
+
+      worksheet.save
+      worksheet.reload
+
+      generate_csv(worksheet: worksheet, target_path: options.fetch(:target_path))
+
+      puts worksheet.human_url
+    end
+
+    def set_types(h)
+      h[:index] = h[:index].to_i
+
+      h[:due_on] = Date.strptime(h[:due_on], '%m/%d/%Y')
+      h[:remaining_capital_start] = h[:remaining_capital_start].to_f
+      h[:remaining_capital_end] = h[:remaining_capital_end].to_f
+      h[:period_theoric_interests] = h[:period_theoric_interests].to_f
+      h[:delta] = h[:delta].to_f
+      h[:accrued_delta] = h[:accrued_delta].to_f
+      h[:amount_to_add] = h[:amount_to_add].to_f
+      h[:period_interests] = h[:period_interests].to_f
+      h[:period_capital] = h[:period_capital].to_f
+      h[:total_paid_capital_end_of_period] = h[:total_paid_capital_end_of_period].to_f
+      h[:total_paid_interests_end_of_period] = h[:total_paid_interests_end_of_period].to_f
+      h[:period_total] = h[:period_total].to_f
+      h[:capitalized_interests_start] = h[:capitalized_interests_start].to_f
+      h[:capitalized_interests_end] = h[:capitalized_interests_end].to_f
+      h[:period_rate] = h[:period_rate].to_f
+      h[:period_calculated_capital] = h[:period_calculated_capital].to_f
+      h[:period_calculated_interests] = h[:period_calculated_interests].to_f
+      h[:period_reimbursed_capitalized_interests] = h[:period_reimbursed_capitalized_interests].to_f
+      h[:period_leap_days] = h[:period_leap_days].to_i
+      h[:period_non_leap_days] = h[:period_non_leap_days].to_i
+      h[:period_fees] = h[:period_fees].to_f
+      h[:period_calculated_fees] = h[:period_calculated_fees].to_f
+      h[:capitalized_fees_start] = h[:capitalized_fees_start].to_f
+      h[:capitalized_fees_end] = h[:capitalized_fees_end].to_f
+      h[:period_reimbursed_capitalized_fees] = h[:period_reimbursed_capitalized_fees].to_f
+      h[:period_fees_rate] = h[:period_fees_rate].to_f
+
+      h
+    end
+  end
+end