mudrat_projector 0.9.0

data/test/models/transaction_handler_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class TransactionHandlerTest < Minitest::Test
+  def setup
+    @chart = ChartOfAccounts.new.tap do |c|
+      c.add_account :checking, type: :asset
+      c.add_account :job, type: :revenue
+    end
+    @projection = Projection.new range: (jan_1_2000..dec_31_2000), chart: @chart
+    @transaction_handler = TransactionHandler.new projection: @projection
+  end
+
+  def test_routes_non_scheduled_transactions_in_range_to_projection
+    @transaction_handler << fixed_transaction
+    assert_equal 1, @projection.transaction_sequence.size
+  end
+
+  def test_does_not_route_non_scheduled_transactions_after_range_to_projection
+    @transaction_handler << fixed_transaction(date: jan_1_2001)
+    assert_equal 0, @projection.transaction_sequence.size
+  end
+
+  def test_routes_non_scheduled_transactions_after_range_to_next_projector
+    @transaction_handler.next_projector = next_projector
+    @transaction_handler << fixed_transaction(date: jan_1_2001)
+    assert_equal 1, next_projector.transactions.size
+  end
+
+  def test_routes_a_scheduled_transaction_into_projector
+    @transaction_handler << scheduled_transaction
+    assert_equal 12, @projection.transaction_sequence.size
+  end
+
+  def test_routes_any_remainder_of_a_scheduled_transaction_into_next_projector
+    @transaction_handler.next_projector = next_projector
+    @transaction_handler << scheduled_transaction(end_date: july_1_2001)
+    assert_equal 1, next_projector.transactions.size
+  end
+
+  private
+
+  def fixed_transaction date: jan_1_2000, amount: 1000
+    Transaction.new(
+      date: date,
+      debit:  { amount: amount, account_id: :checking },
+      credit: { amount: amount, account_id: :job      },
+    )
+  end
+
+  def scheduled_transaction start_date: jan_1_2000, end_date: dec_31_2000, amount: 1000
+    ScheduledTransaction.new(
+      date: start_date,
+      debit:  { amount: amount, account_id: :checking },
+      credit: { amount: amount, account_id: :job      },
+      schedule: every_month(until: end_date),
+    )
+  end
+
+  def next_projector
+    @next_projector ||=
+      Struct.new :transactions do
+        def add_transaction transaction
+          transactions.push transaction
+        end
+      end.new(Array.new)
+  end
+end

data/test/models/transaction_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class TransactionTest < Minitest::Test
+  def test_balanced_on_fixed_transactions
+    assert Transaction.new(
+      date: jan_1_2000,
+      credits: [{ amount: 1, account_id: :checking }], 
+      debits: [{ amount: 1, account_id: :bills }],
+    ).balanced?
+
+    refute Transaction.new(
+      date: jan_1_2000,
+      credits: [{ amount: 1, account_id: :checking }], 
+      debits: [{ amount: 2, account_id: :bills }],
+    ).balanced?
+  end
+
+  def test_balanced_on_percentage_transactions
+    refute Transaction.new(
+      date: jan_1_2000,
+      credit: { percent: 25.0, of: :savings, account_id: :checking },
+      debit: { amount: 25, account_id: :bills },
+    ).balanced?
+
+    refute Transaction.new(
+      date: jan_1_2000,
+      credit: { percent: 25.0, of: :savings, account_id: :checking }, 
+      debit: { percent: 24.0, of: :savings, account_id: :bills },
+    ).balanced?
+
+    assert Transaction.new(
+      date: jan_1_2000,
+      credit: { percent: 25.0, of: :savings , account_id: :checking }, 
+      debits: [{percent: 12.5, of: :savings , account_id: :bills },
+               {percent: 12.5, of: :savings , account_id: :bills }],
+    ).balanced?
+  end
+
+  def test_can_supply_a_single_credit_or_debit
+    Transaction.new(
+      date: jan_1_2000,
+      credit: { amount: 1, account_id: :checking }, 
+      debit: { amount: 1, account_id: :bills },
+    )
+    # Can't supply both a :credit and :credits
+    assert_raises ArgumentError do
+      Transaction.new(
+        date: jan_1_2000,
+        credit: { amount: 1, account_id: :checking }, 
+        credits: [{ amount: 2, account_id: :checking }], 
+        debits: [{ amount: 1, account_id: :bills }],
+      )
+    end
+  end
+
+  private
+
+  def valid_transaction schedule: nil
+    Transaction.new(
+      date: jan_1_2000, 
+      credits: [{ amount: 1, account_id: :checking }],
+      debits:  [{ amount: 1, account_id: :bills }],
+      schedule: schedule,
+    )
+  end
+end

data/test/models/validator_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class ValidatorTest < Minitest::Test
+  def setup
+    @projector = Projector.new from: jan_1_2000
+    @projector.add_account :checking, type: :asset
+    @projector.add_account :job,      type: :revenue
+  end
+
+  def test_cannot_add_transaction_without_entriess
+    assert_raises Projector::InvalidTransaction do
+      @projector.add_transaction(
+        date: jan_1_2000
+      )
+    end
+    assert_raises Projector::InvalidTransaction do
+      @projector.add_transaction(
+        date: jan_1_2000,
+        credits: [],
+        debits:  [],
+      )
+    end
+  end
+
+  def test_past_transaction
+    assert_raises Projector::InvalidTransaction do
+      @projector.add_transaction(
+        date: dec_31_1999,
+        credit: { amount: 1000, account_id: :job      },
+        debit:  { amount: 1000, account_id: :checking },
+      )
+    end
+  end
+
+  def test_cannot_add_single_transaction_which_does_not_balance
+    assert_raises Projector::BalanceError do
+      @projector.add_transaction(
+        date: jan_1_2000,
+        credit: { amount: 1000, account_id: :job      },
+        debit:  { amount: 999,  account_id: :checking },
+      )
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,69 @@
+require 'simplecov' if ENV['COVERAGE']
+
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/reporters'
+
+require 'ostruct'
+require 'pp'
+
+require 'mudrat_projector'
+
+# Require pry library on demand to avoid eating its >500ms start up penalty
+class Binding
+  def method_missing sym, *args
+    if sym == :pry && args.empty? && !block_given?
+      require 'pry'
+      pry
+    else
+      super
+    end
+  end
+end
+
+# Dates need friendlier output
+class Date
+  def inspect
+    strftime
+  end
+end
+
+# BigDecimal needs friendlier output
+class BigDecimal < Numeric
+  def inspect
+    "#<BigDecmial:#{round(10).to_f.inspect}>"
+  end
+end
+
+Minitest::Reporters.use! MiniTest::Reporters::DefaultReporter.new
+
+class Minitest::Test
+  include MudratProjector
+
+  # Enable you to just call "jan_1_2000" to new up a date.
+  def method_missing sym, *args, &block
+    return super if block_given? || args.size > 0
+    begin
+      Date.parse sym.to_s
+    rescue ArgumentError => ae
+      super
+    end
+  end
+
+  private
+
+  def epoch
+    jan_1_1970
+  end
+
+  def every_month **params
+    end_date = params[:until]
+    if end_date
+      from = params[:from] || jan_1_2000
+      count = DateDiff.date_diff unit: :month, from: from, to: end_date
+      { unit: :month, scalar: 1, count: count }
+    else
+      { unit: :month, scalar: 1 }
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: mudrat_projector
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- ntl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mudrat Projector is a simple financial projection engine.
+email:
+- nathanladd+github@gmail.com
+executables:
+- testrb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/testrb
+- finance_fu.txt
+- lib/mudrat_projector.rb
+- lib/mudrat_projector/account.rb
+- lib/mudrat_projector/amortizer.rb
+- lib/mudrat_projector/banker_rounding.rb
+- lib/mudrat_projector/chart_of_accounts.rb
+- lib/mudrat_projector/date_diff.rb
+- lib/mudrat_projector/projection.rb
+- lib/mudrat_projector/projector.rb
+- lib/mudrat_projector/schedule.rb
+- lib/mudrat_projector/scheduled_transaction.rb
+- lib/mudrat_projector/tax_calculation.rb
+- lib/mudrat_projector/tax_calculator.rb
+- lib/mudrat_projector/tax_values_by_year.yml
+- lib/mudrat_projector/transaction.rb
+- lib/mudrat_projector/transaction_entry.rb
+- lib/mudrat_projector/transaction_handler.rb
+- lib/mudrat_projector/validator.rb
+- lib/mudrat_projector/version.rb
+- mudrat_projector.gemspec
+- test/integrations/long_term_projection_test.rb
+- test/integrations/mortgage_test.rb
+- test/integrations/self_employed_tax_calculation_test.rb
+- test/models/accounts_test.rb
+- test/models/chart_of_accounts_test.rb
+- test/models/date_diff_test.rb
+- test/models/projection_test.rb
+- test/models/projector_test.rb
+- test/models/schedule_test.rb
+- test/models/scheduled_transaction_test.rb
+- test/models/tax_calculator_test.rb
+- test/models/transaction_entry_test.rb
+- test/models/transaction_handler_test.rb
+- test/models/transaction_test.rb
+- test/models/validator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ntl/mudrat-projector
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Mudrat Projector is a simple financial projection engine designed for personal
+  finance computations.
+test_files:
+- test/integrations/long_term_projection_test.rb
+- test/integrations/mortgage_test.rb
+- test/integrations/self_employed_tax_calculation_test.rb
+- test/models/accounts_test.rb
+- test/models/chart_of_accounts_test.rb
+- test/models/date_diff_test.rb
+- test/models/projection_test.rb
+- test/models/projector_test.rb
+- test/models/schedule_test.rb
+- test/models/scheduled_transaction_test.rb
+- test/models/tax_calculator_test.rb
+- test/models/transaction_entry_test.rb
+- test/models/transaction_handler_test.rb
+- test/models/transaction_test.rb
+- test/models/validator_test.rb
+- test/test_helper.rb