bankroll 0.1.0

data/lib/bankroll/payment.rb

@@ -0,0 +1,28 @@
+module Bankroll
+  class Payment
+    extend Callable
+    extend Dry::Initializer
+
+    option :present_value, Types["bankroll.decimal"]
+    option :interest_rate, Types["bankroll.decimal"]
+    option :periods, Types["bankroll.decimal"]
+
+    def call
+      payment
+    end
+
+    private
+
+    def payment
+      @present_value * mortgage_constant
+    end
+
+    def mortgage_constant
+      ONE / annuity_factor
+    end
+
+    def annuity_factor
+      AnnuityFactor.call(interest_rate: @interest_rate, periods: @periods)
+    end
+  end
+end

data/lib/bankroll/present_value.rb

@@ -0,0 +1,28 @@
+module Bankroll
+  class PresentValue
+    extend Callable
+    extend Dry::Initializer
+
+    # Calculates the present value of an annuity, e.g. the minimal loan amount
+    # required for a certain home price
+
+    option :periods, Types["bankroll.decimal"]
+    option :payment, Types["bankroll.decimal"]
+    option :future_value, Types["bankroll.decimal"], default: -> { ZERO }
+    option :interest_rate, Types["bankroll.decimal"], default: -> { ZERO }
+
+    def call
+      present_value
+    end
+
+    private
+
+    def present_value
+      @payment * annuity_factor
+    end
+
+    def annuity_factor
+      AnnuityFactor.call(periods: @periods, interest_rate: @interest_rate)
+    end
+  end
+end

data/lib/bankroll/total_periods.rb

@@ -0,0 +1,44 @@
+module Bankroll
+  class TotalPeriods
+    extend Callable
+    extend Dry::Initializer
+
+    # Equivalent to Excel's NPER
+    # Calculates the total periods of an investment given a fixed payment,
+    # an interest rate and the loan's present value.
+    # Future value can be 0 for the end of a loan or any intermediate value
+
+    option :interest_rate, Types["bankroll.decimal"]
+    option :payment, Types["bankroll.decimal"]
+    option :present_value, Types["bankroll.decimal"]
+    option :future_value, Types["bankroll.decimal"]
+    option :type, Types["annuity_type"], default: -> { :ordinary }
+
+    def call
+      return (-@present_value - @future_value) / @payment if interest_rate.zero?
+
+      Bankroll::Decimal[periods]
+    end
+
+    private
+
+    def periods
+      Math.log(percentage_of_total_interest_on_principal) /
+        Math.log((1 + @interest_rate))
+    end
+
+    def percentage_of_total_interest_on_principal
+      (-@future_value + initial_payment_interest) / 
+        (@present_value + initial_payment_interest)
+    end
+
+    def initial_payment_interest
+      case type
+      when :ordinary
+        (@payment * (1 + @interest_rate)) / @interest_rate
+      else
+        0
+      end
+    end
+  end
+end

data/lib/bankroll/types.rb

@@ -0,0 +1,26 @@
+module Bankroll
+  module Types
+    include Dry.Types()
+
+    Constructor = Dry::Types::Constructor
+
+    def self.[](key)
+      Dry::Types[key]
+    end
+
+    def self.register(key, value)
+      Dry::Types.register(key, value)
+    end
+
+    ConvertToDecimal = lambda do |value|
+      if value.is_a? Bankroll::Decimal
+        return value
+      else
+        Bankroll::Decimal[value.to_s]
+      end
+    end
+
+    register("bankroll.decimal", Constructor[Bankroll::Decimal, fn: ConvertToDecimal])
+    register("annuity_type", Types["symbol"].enum(:ordinary, :due))
+  end
+end

data/lib/bankroll/unpaid_balance.rb

@@ -0,0 +1,42 @@
+module Bankroll
+  class UnpaidBalance
+    extend Callable
+    extend Dry::Initializer
+
+    ONE = Decimal['1'].freeze
+
+    option :present_value, Types["bankroll.decimal"]
+    option :interest_rate, Types["bankroll.decimal"]
+    option :periods, Types["bankroll.decimal"]
+    option :period, Types["bankroll.decimal"]
+
+    def call
+      unpaid_balance
+    end
+
+    private
+
+    def unpaid_balance
+      payment * annuity_factor
+    end
+
+    def payment
+      Payment.call(
+        present_value: @present_value,
+        interest_rate: @interest_rate,
+        periods: @periods
+      )
+    end
+
+    def annuity_factor
+      AnnuityFactor.call(
+        interest_rate: @interest_rate, 
+        periods: remaining
+      )
+    end
+
+    def remaining
+      @periods - @period
+    end
+  end
+end

data/lib/bankroll/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bankroll
+  VERSION = "0.1.0"
+end

data/lib/bankroll.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+require "dry-types"
+require "dry-initializer"
+require "dry-equalizer"
+require "delegate"
+
+require_relative "bankroll/version"
+require_relative "bankroll/callable"
+require_relative "bankroll/decimal"
+require_relative "bankroll/types"
+
+require_relative "bankroll/cumulative_interest"
+require_relative "bankroll/present_value"
+require_relative "bankroll/future_value"
+require_relative "bankroll/annuity_factor"
+require_relative "bankroll/payment"
+require_relative "bankroll/unpaid_balance"
+require_relative "bankroll/interest_payment"
+require_relative "bankroll/amortization_schedule"
+require_relative "bankroll/total_periods"
+require_relative "bankroll/interest_rate"
+
+BigDecimal.mode(BigDecimal::ROUND_MODE, Bankroll::Decimal::ROUNDING)
+
+module Bankroll
+  ZERO = Decimal['0'].freeze
+  ONE = Decimal['1'].freeze
+
+
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.payment(**kwargs)
+    Payment.call(**kwargs)
+  end
+
+  def self.interest_rate(**kwargs)
+    InterestRate.call(**kwargs)
+  end
+
+  def self.unpaid_balance(**kwargs)
+    UnpaidBalance.call(**kwargs)
+  end
+
+  def self.present_value(**kwargs)
+    PresentValue.call(**kwargs)
+  end
+
+  def self.future_value(**kwargs)
+    FutureValue.call(**kwargs)
+  end
+
+  def self.cumulative_interest(**kwargs)
+    CumulativeInterest.call(**kwargs)
+  end
+
+  def self.annuity_factor(**kwargs)
+    AnnuityFactor.call(**kwargs)
+  end
+
+  def self.total_periods(**kwargs)
+    TotalPeriods.call(**kwargs)
+  end
+
+  def self.amortization_schedule(**kwargs)
+    AmortizationSchedule.call(**kwargs)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bankroll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nolan J Tait
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  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: dry-initializer
+  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: dry-equalizer
+  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: Mortgage and refinance calculations for ruby
+email:
+- nolanjtait@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bankroll.gemspec
+- bin/bundle
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/bankroll.rb
+- lib/bankroll/amortization_schedule.rb
+- lib/bankroll/annuity_factor.rb
+- lib/bankroll/callable.rb
+- lib/bankroll/cumulative_interest.rb
+- lib/bankroll/decimal.rb
+- lib/bankroll/future_value.rb
+- lib/bankroll/interest_payment.rb
+- lib/bankroll/interest_rate.rb
+- lib/bankroll/payment.rb
+- lib/bankroll/present_value.rb
+- lib/bankroll/total_periods.rb
+- lib/bankroll/types.rb
+- lib/bankroll/unpaid_balance.rb
+- lib/bankroll/version.rb
+homepage: https://github.com/nolantait/bankroll
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nolantait/bankroll
+  source_code_uri: https://github.com/nolantait/bankroll
+  changelog_uri: https://github.com/nolantait/bankroll/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Mortgage and refinance calculations for ruby
+test_files: []