blend_spreadsheet_loan_generator 0.1.0

data/lib/blend_spreadsheet_loan_generator/formula.rb

@@ -0,0 +1,211 @@
+module BlendSpreadsheetLoanGenerator
+  class Formula
+    include SpreadsheetConcern
+
+    attr_accessor :loan
+
+    def initialize(loan:)
+      @loan = loan
+      @interests_formula = loan.interests_formula
+      @loan_type_formula = loan.loan_type_formula
+    end
+
+    def index_formula(line:)
+      line - 1
+    end
+
+    def due_on_formula(line:)
+      term = line - 1
+      loan.due_on + ((term - 1) * loan.period_duration).months
+    end
+
+    def period_capital_formula(line:)
+      if line == loan.duration + 1
+        "=ARRONDI(#{excel_float(loan.amount)} - #{total_paid_capital_end_of_period(line - 1)}; 2)"
+      else
+        "=ARRONDI(#{period_calculated_capital(line)} - #{period_reimbursed_capitalized_interests(line)} - #{period_reimbursed_capitalized_fees(line)}; 2)"
+      end
+    end
+
+    def period_interests_formula(line:)
+      term = line - 1
+      if term <= loan.deferred_and_capitalized
+        excel_float(0.0)
+      else
+        "=ARRONDI(#{period_calculated_interests(line)}; 2)"
+      end
+    end
+
+    def period_total_formula(line:)
+      total = [
+        period_capital(line),
+        '+',
+        period_interests(line),
+        '+',
+        period_reimbursed_capitalized_interests(line)
+      ].join(' ')
+      "=ARRONDI(#{total}; 2)"
+    end
+
+    def period_calculated_capital_formula(line:)
+      term = line - 1
+      if term <= loan.total_deferred_duration
+        excel_float(0.0)
+      else
+        @loan_type_formula.period_calculated_capital_formula(line: line)
+      end
+    end
+
+    def period_theoric_interests_formula(line:)
+      term = line - 1
+      if term <= loan.deferred_and_capitalized
+        excel_float(0.0)
+      else
+        "=#{period_calculated_interests(line)}"
+      end
+    end
+
+    def period_calculated_interests_formula(line:)
+      amount_to_capitalize = [
+        '(',
+        remaining_capital_start(line),
+        '+',
+        capitalized_interests_start(line),
+        ')'
+      ].join(' ')
+
+      "=#{amount_to_capitalize} * #{period_rate(line)}"
+    end
+
+    def remaining_capital_start_formula(line:)
+      return excel_float(loan.amount) if line == 2
+
+      "=#{excel_float(loan.amount)} - #{total_paid_capital_end_of_period(line - 1)}"
+    end
+
+    def remaining_capital_end_formula(line:)
+      "=#{excel_float(loan.amount)} - #{total_paid_capital_end_of_period(line)}"
+    end
+
+    def total_paid_capital_end_of_period_formula(line:)
+      return "=#{period_capital(line)}" if line == 2
+
+      "=ARRONDI(SOMME(#{column_range(column: period_capital, upto: line)}); 2)"
+    end
+
+    def total_paid_interests_end_of_period_formula(line:)
+      return "=#{period_interests(line)}" if line == 2
+
+      "=ARRONDI(SOMME(#{column_range(column: period_interests, upto: line)}); 2)"
+    end
+
+    def capitalized_interests_start_formula(line:)
+      return excel_float(loan.starting_capitalized_interests) if line == 2
+
+      "=ARRONDI(#{capitalized_interests_end(line - 1)}; 2)"
+    end
+
+    def capitalized_interests_end_formula(line:)
+      term = line - 1
+      if term <= loan.deferred_and_capitalized
+        "=ARRONDI(#{capitalized_interests_start(line)} + #{period_calculated_interests(line)}; 2)"
+      else
+        "=ARRONDI(#{capitalized_interests_start(line)} - #{period_reimbursed_capitalized_interests(line)}; 2)"
+      end
+    end
+
+    def period_reimbursed_capitalized_interests_formula(line:)
+      term = line - 1
+      if term <= loan.total_deferred_duration
+        excel_float(0.0)
+      else
+        "=ARRONDI(MIN(#{period_calculated_capital(line)} - #{period_reimbursed_capitalized_fees(line)}; #{capitalized_interests_start(line)}); 2)"
+      end
+    end
+
+    def period_rate_formula(line:)
+      @interests_formula.period_rate_formula(line: line)
+    end
+
+    def delta_formula(line:)
+      "=#{period_theoric_interests(line)} - #{period_interests(line)}"
+    end
+
+    def accrued_delta_formula(line:)
+      return excel_float(0.0) if line == 2
+
+      "=#{accrued_delta(line - 1)} + #{delta(line)} - #{amount_to_add(line - 1)}"
+    end
+
+    def amount_to_add_formula(line:)
+      "=TRONQUE(#{accrued_delta(line)}; 2)"
+    end
+
+    def period_leap_days_formula(line:)
+      term = line - 1
+      from = loan.due_on + ((term - 2) * loan.period_duration).months
+      to = loan.due_on + ((term - 1) * loan.period_duration).months
+
+      (from...to).sum { |d| d.leap? ? 1 : 0 }
+    end
+
+    def period_non_leap_days_formula(line:)
+      term = line - 1
+      from = loan.due_on + ((term - 2) * loan.period_duration).months
+      to = loan.due_on + ((term - 1) * loan.period_duration).months
+
+      (from...to).sum { |d| d.leap? ? 0 : 1 }
+    end
+
+    def period_fees_formula(line:)
+      term = line - 1
+      if term <= loan.deferred_and_capitalized
+        excel_float(0.0)
+      else
+        "=ARRONDI(#{period_calculated_fees(line)}; 2)"
+      end
+    end
+
+    def period_calculated_fees_formula(line:)
+      amount_to_capitalize = [
+        '(',
+        remaining_capital_start(line),
+        '+',
+        capitalized_interests_start(line),
+        '+',
+        capitalized_fees_start(line),
+        ')'
+      ].join(' ')
+
+      "=#{amount_to_capitalize} * #{period_fees_rate(line)}"
+    end
+
+    def capitalized_fees_start_formula(line:)
+      return excel_float(loan.starting_capitalized_fees) if line == 2
+
+      "=ARRONDI(#{capitalized_fees_end(line - 1)}; 2)"
+    end
+
+    def capitalized_fees_end_formula(line:)
+      term = line - 1
+      if term <= loan.deferred_and_capitalized
+        "=ARRONDI(#{capitalized_fees_start(line)} + #{period_calculated_fees(line)}; 2)"
+      else
+        "=ARRONDI(#{capitalized_fees_start(line)} - #{period_reimbursed_capitalized_fees(line)}; 2)"
+      end
+    end
+
+    def period_reimbursed_capitalized_fees_formula(line:)
+      term = line - 1
+      if term <= loan.total_deferred_duration
+        excel_float(0.0)
+      else
+        "=ARRONDI(MIN(#{period_calculated_capital(line)}; #{capitalized_fees_start(line)}); 2)"
+      end
+    end
+
+    def period_fees_rate_formula(line:)
+      @interests_formula.period_fees_rate_formula(line: line)
+    end
+  end
+end

data/lib/blend_spreadsheet_loan_generator/generate.rb

@@ -0,0 +1,73 @@
+module BlendSpreadsheetLoanGenerator
+  class Generate < Dry::CLI::Command
+    include SpreadsheetConcern
+    include CsvConcern
+
+    attr_accessor :loan
+
+    desc "Generate spreadsheet"
+
+    argument :amount, type: :float, required: true, desc: 'amount borrowed'
+    argument :duration, type: :integer, required: true, desc: 'number of reimbursements'
+    argument :rate, type: :float, required: true, desc: 'year rate'
+
+    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(amount:, duration:, 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
+
+      @loan = Loan.new(
+        amount: amount,
+        duration: duration,
+        period_duration: options.fetch(:period_duration),
+        rate: rate,
+        due_on: options.fetch(: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: options.fetch(:starting_capitalized_interests),
+        starting_capitalized_fees: options.fetch(:starting_capitalized_fees),
+        fees_rate: options.fetch(:fees_rate)
+      )
+
+      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)
+      apply_formats(worksheet: worksheet)
+
+      worksheet.save
+      worksheet.reload
+
+      generate_csv(worksheet: worksheet, target_path: options.fetch(:target_path))
+
+      puts worksheet.human_url
+    rescue => e
+      require 'pry'
+      binding.pry
+    end
+  end
+end

data/lib/blend_spreadsheet_loan_generator/init.rb

@@ -0,0 +1,36 @@
+module BlendSpreadsheetLoanGenerator
+  class Init < Dry::CLI::Command
+
+    argument :client_id, type: :string, required: true, desc: 'GCP client_id'
+    argument :client_secret, type: :string, required: true, desc: 'GCP client_secret'
+
+    def call(client_id:, client_secret:)
+      if !ENV.key?('SPREADSHEET_LOAN_GENERATOR_DIR')
+        puts "Please set up the environment variable SPREADSHEET_LOAN_GENERATOR_DIR to a dir that will store this gem's configuration"
+        return
+      end
+
+      create_config_dir
+      create_config_file(client_id: client_id, client_secret: client_secret)
+    end
+
+    def config_path
+      File.join(ENV['SPREADSHEET_LOAN_GENERATOR_DIR'], 'config.json')
+    end
+
+    def create_config_dir
+      if !File.exists?(ENV['SPREADSHEET_LOAN_GENERATOR_DIR'])
+        FileUtils.mkdir_p(ENV['SPREADSHEET_LOAN_GENERATOR_DIR'])
+      end
+    end
+
+    def create_config_file(client_id:, client_secret:)
+      f = File.new(config_path, 'w')
+      f.write({
+        client_id: client_id,
+        client_secret: client_secret
+      }.to_json)
+      f.close
+    end
+  end
+end

data/lib/blend_spreadsheet_loan_generator/linear.rb

@@ -0,0 +1,20 @@
+module BlendSpreadsheetLoanGenerator
+  class Linear
+    include SpreadsheetConcern
+
+    attr_accessor :loan
+    def initialize(loan:)
+      @loan = loan
+    end
+
+    def period_calculated_capital_formula(*)
+      amount =
+        if loan.deferred_and_capitalized.zero?
+          excel_float(loan.amount)
+        else
+          "(#{capitalized_interests_end(loan.deferred_and_capitalized + 1)} + #{capitalized_fees_end(loan.deferred_and_capitalized + 1)} + #{excel_float(loan.amount)})"
+        end
+      "=#{amount} / #{loan.non_deferred_duration}"
+    end
+  end
+end

data/lib/blend_spreadsheet_loan_generator/loan.rb

@@ -0,0 +1,127 @@
+module BlendSpreadsheetLoanGenerator
+  class Loan
+    attr_accessor :amount,
+                  :duration,
+                  :period_duration,
+                  :rate,
+                  :due_on,
+                  :deferred_and_capitalized,
+                  :deferred,
+                  :type,
+                  :interests_type,
+                  :starting_capitalized_interests,
+                  :fees_rate,
+                  :starting_capitalized_fees
+
+    def initialize(
+      amount:,
+      duration:,
+      period_duration:,
+      rate:,
+      due_on:,
+      deferred_and_capitalized:,
+      deferred:,
+      type:,
+      interests_type:,
+      starting_capitalized_interests:,
+      fees_rate:,
+      starting_capitalized_fees:)
+      @amount = amount.to_f
+      @duration = duration.to_i
+      @period_duration = period_duration.to_i
+      @rate = rate.to_f
+      @due_on = due_on.is_a?(Date) ? due_on : Date.parse(due_on)
+      @deferred_and_capitalized = deferred_and_capitalized.to_i
+      @deferred = deferred.to_i
+      @type = type
+      @interests_type = interests_type
+      @fees_rate = fees_rate.to_f
+      @starting_capitalized_interests = starting_capitalized_interests.to_f
+      @starting_capitalized_fees = starting_capitalized_fees.to_f
+
+      print_validation_errors
+    end
+
+    def print_validation_errors
+      puts 'amount < 0' if amount < 0
+      puts 'deferred & deferred_and_capitalized >= duration' if total_deferred_duration >= duration
+      if type == 'standard' && interests_type == 'realistic' && !fully_deferred?
+        puts 'standard & realistic interests do not work together'
+      end
+    end
+
+    def loan_type_formula
+      "BlendSpreadsheetLoanGenerator::#{type.classify}".constantize.new(loan: self)
+    end
+
+    def interests_formula
+      "BlendSpreadsheetLoanGenerator::#{interests_type.classify}Interests".constantize.new(loan: self)
+    end
+
+    def name_type
+      return 'bullet' if bullet?
+      return 'in_fine' if in_fine?
+
+      type
+    end
+
+    def name_period_duration
+      if period_duration.in?([1, 3, 6, 12])
+        {
+          '1' => 'month',
+          '3' => 'quarter',
+          '6' => 'semester',
+          '12' => 'year'
+        }[period_duration.to_s]
+      else
+        period_duration.to_s
+      end
+    end
+
+    def name_deferred
+      return '0' if fully_deferred?
+
+      total_deferred_duration
+    end
+
+    def name_due_on
+      due_on.strftime('%Y%m%d')
+    end
+
+    def name
+      args = []
+      args += ['realistic'] if interests_type == 'realistic'
+      args += [
+        name_type,
+        name_period_duration,
+        amount,
+        (rate * 100).to_s,
+        duration.to_s,
+        name_deferred,
+        name_due_on
+      ]
+
+      args.join('_')
+    end
+
+    def fully_deferred?
+      duration > 1 && non_deferred_duration == 1
+    end
+
+    def bullet?
+      fully_deferred? && deferred_and_capitalized == total_deferred_duration
+    end
+
+    def in_fine?
+      fully_deferred? && deferred == total_deferred_duration
+    end
+
+    def non_deferred_duration
+      duration - total_deferred_duration
+    end
+
+    def total_deferred_duration
+      deferred_and_capitalized + deferred
+    end
+  end
+end