morty 0.0.1 → 0.1.0

data/features/cancel.feature

@@ -0,0 +1,130 @@
+Feature: Cancellations
+
+  Create an adjustment when an activity is cancelled.
+
+  Background:
+    Given a simulating accountant
+
+      And a start date of 2026-01-01
+      And an interest rate of 36.5%
+      And the schedule:
+       | payment | 2026-01-06 | 1005.00 |
+
+      And I simulate these activities:
+       | issue | 2026-01-01 | 1000.00 |
+
+     Then I have these balances:
+       | cash      | -1000.00 |
+       | principal |  1000.00 |
+
+      And I have 1 issue activity
+
+  Scenario: Cancel an activity without adjustment
+     When I save and reload the accountant
+      And I cancel the 2026-01-01 issue on 2026-01-01
+
+     Then I have these balances:
+       | cash      | 0.00 |
+       | principal | 0.00 |
+
+      And these activity counts:
+       | issue  | 1 |
+       | cancel | 1 |
+
+  Scenario: Cancel an activity with adjustment
+    Given I simulate until 2026-01-02
+
+     When I save and reload the accountant
+      And I cancel the 2026-01-01 issue on 2026-01-02
+
+     Then I have these balances:
+       | cash      | 0.00 |
+       | principal | 0.00 |
+       | interest  | 0.00 |
+       | revenue   | 0.00 |
+
+      And these activity counts:
+       | issue      | 1 |
+       | cancel     | 1 |
+       | interest   | 1 |
+       | adjustment | 1 |
+
+  Scenario: Cancel an activity in the past
+    When I simulate until 2026-01-08
+     And I save and reload the accountant
+     And I cancel the 2026-01-06 payment on 2026-01-08
+
+    Then I have these balances:
+      | cash      | -1000.00 |
+      | principal |  1000.00 |
+      | interest  |     7.00 |
+      | revenue   |    -7.00 |
+
+     And these activity counts:
+       | issue      | 1 |
+       | payment    | 1 |
+       | interest   | 5 |
+       | cancel     | 1 |
+       | adjustment | 1 |
+
+  Scenario: Cancel an activity entered today
+    When I simulate until 2026-01-06
+
+    Then I have these balances:
+      | cash      |  5.00 |
+      | principal |  0.00 |
+      | interest  |  0.00 |
+      | revenue   | -5.00 |
+
+     And these activity counts:
+       | issue    | 1 |
+       | payment  | 1 |
+       | interest | 5 |
+
+    When I save and reload the accountant
+     And I cancel the 2026-01-06 payment on 2026-01-06
+
+    Then I have these balances:
+      | cash      | -1000.00 |
+      | principal |  1000.00 |
+      | interest  |     5.00 |
+      | revenue   |    -5.00 |
+
+     And these activity counts:
+       | issue    | 1 |
+       | payment  | 1 |
+       | interest | 5 |
+       | cancel   | 1 |
+
+  Scenario: Cancel an interleaved activity
+    When I simulate these activities:
+      | payment | 2026-01-01 | 500.00 |
+      | finish  | 2026-01-06 |        |
+
+    Then I have these balances:
+      | cash      |  505.00 |
+      | principal |    0.00 |
+      | interest  |    0.00 |
+      | revenue   |   -2.50 |
+      | payable   | -502.50 |
+
+     And I have these activity counts:
+       | issue    | 1 |
+       | payment  | 2 |
+       | interest | 5 |
+
+    When I cancel the 2026-01-01 payment
+
+    Then I have these balances:
+      | cash      |  5.00 |
+      | principal |  0.00 |
+      | interest  |  0.00 |
+      | revenue   | -5.00 |
+      | payable   |  0.00 |
+
+     And these activity counts:
+       | issue      | 1 |
+       | payment    | 2 |
+       | interest   | 5 |
+       | cancel     | 1 |
+       | adjustment | 1 |

data/features/daily.feature

@@ -0,0 +1,42 @@
+Feature: Daily
+
+  An accountant can define a daily process to run during a simulation.
+  It may accrue daily interest, assess late fees, default principal balances, etc.
+
+  In addition, it could be the actual process used to perform these activities on a daily basis.
+
+  Background:
+    Given a daily accountant
+      And a start date of today
+      And an interest rate of 36.5%
+
+  Scenario: Daily guard passes
+    When I run the daily for today
+    Then I have an interest activity
+
+  Scenario: Daily guard fails
+    When I run the daily for today
+    Then I have 1 activity
+
+    When I run the daily for tomorrow
+    Then I still have 1 activity
+
+    When I run the daily for 2 days from now
+    Then I have 2 activities
+
+     And I have these balances:
+       | interest |  2.00 |
+       | revenue  | -2.00 |
+
+  Scenario: Daily runs only once
+    Given a simulating accountant
+      And a start date of today
+      And an interest rate of 36.5%
+      And I simulate these activities:
+        | issue | 1000.00 |
+
+     When I run the daily for tomorrow
+     Then I have 1 interest activity
+
+     When I run the daily for tomorrow
+     Then I have 1 interest activity

data/features/default.feature

@@ -0,0 +1,33 @@
+Feature: Default
+
+  Scenario: Late principal and interest
+    Given a defaulting accountant
+      And a start date of 2026-01-01
+      And an interest rate of 36.5%
+
+      And the schedule:
+        | issue   | 2026-01-01 | 1000.00 |
+        | default | 2026-02-01 |  100.00 |
+        | default | 2026-03-01 |  100.00 |
+
+    When I simulate until 2026-02-01
+
+    Then I save and reload the accountant
+     And I have these balances:
+       | cash           | -1000.00 |
+       | principal      |   931.00 |
+       | principal_late |    69.00 |
+       | interest       |     0.00 |
+       | interest_late  |    31.00 |
+       | revenue        |   -31.00 |
+
+     When I simulate until 2026-03-01
+
+     Then I save and reload the accountant
+      And I have these balances:
+        | cash           | -1000.00 |
+        | principal      |   859.00 |
+        | principal_late |   141.00 |
+        | interest       |     0.00 |
+        | interest_late  |    59.00 |
+        | revenue        |   -59.00 |

data/features/ledger.feature

@@ -0,0 +1,57 @@
+Feature: Ledgers
+
+  Background:
+    Given a multiple ledgers accountant
+      And a start date of 2026-01-01
+      And an interest rate of 36.5%
+      And the schedule:
+        | payment | 2026-01-06 | 1005.00 |
+
+  Scenario: Different dailies
+    When I simulate these activities:
+      | issue  | 2026-01-01 | 1000.00 |
+      | finish | 2026-01-06 |         |
+
+    Then the default ledger has these balances:
+      | cash      |  5.00 |
+      | principal |  0.00 |
+      | interest  |  0.00 |
+      | revenue   | -5.00 |
+
+     And the aggressive ledger has these balances:
+      | cash      |   5.00 |
+      | principal |  45.00 |
+      | interest  |   0.00 |
+      | revenue   | -50.00 |
+
+     And I have these activity counts:
+      | issue    | 1 |
+      | payment  | 1 |
+      | interest | 5 |
+
+    When I save and reload the accountant
+
+    Then I have these activity counts:
+      | issue    | 1 |
+      | payment  | 1 |
+      | interest | 5 |
+
+     And the default ledger has these balances:
+      | cash      |  5.00 |
+      | principal |  0.00 |
+      | interest  |  0.00 |
+      | revenue   | -5.00 |
+
+     And the default ledger has these aggregated balances:
+      | accruing | 0.00 |
+      | varying  | 0.00 |
+
+     And the aggressive ledger has these balances:
+      | cash      |   5.00 |
+      | principal |  45.00 |
+      | interest  |   0.00 |
+      | revenue   | -50.00 |
+
+     And the aggressive ledger has these aggregated balances:
+      | accruing | 45.00 |
+      | varying  | 50.00 |

data/features/retroactive.feature

@@ -0,0 +1,92 @@
+Feature: Retroactive Activities
+
+  Create activities that are accounted for in present, but effective in the past.
+
+  Background:
+    Given a simulating accountant
+      And a start date of 2026-01-01
+      And an interest rate of 36.5%
+
+  Scenario: Retroactive activity
+
+     When I simulate to 2026-01-03
+
+     Then I have all zero balances
+
+     When I apply an issue activity effective 2026-01-01 for $1000.00
+
+     Then I have these balances:
+       | cash      | -1000.00 |
+       | principal |  1000.00 |
+       | interest  |     2.00 |
+       | revenue   |    -2.00 |
+
+     And I have these activity counts:
+       | issue      | 1 |
+       | adjustment | 1 |
+
+  Scenario: Retroactive activity with adjustment
+
+     When I simulate these activities:
+       | issue  | 2026-01-01 | 1000.00 |
+       | finish | 2026-01-02 |         |
+
+     Then I have these balances:
+       | cash      | -1000.00 |
+       | principal |  1000.00 |
+       | interest  |     1.00 |
+       | revenue   |    -1.00 |
+
+     When I apply a payment activity effective 2026-01-01 for $1000.00
+
+     Then I have all zero balances
+      And I have these activity counts:
+       | issue      | 1 |
+       | payment    | 1 |
+       | interest   | 1 |
+       | adjustment | 1 |
+
+  Scenario: Cancelling a retroactive activity
+
+     When I simulate these activities:
+       | issue  | 2026-01-01 | 1000.00 |
+       | finish | 2026-01-02 |         |
+
+      And I apply a payment activity effective 2026-01-01 for $500.00
+
+     Then I have these balances:
+       | cash      | -500.00 |
+       | principal |  500.00 |
+       | interest  |    0.50 |
+       | revenue   |   -0.50 |
+
+     When I simulate to 2026-01-03
+
+     Then I have these balances:
+       | cash      | -500.00 |
+       | principal |  500.00 |
+       | interest  |    1.00 |
+       | revenue   |   -1.00 |
+
+     When I cancel the 2026-01-01 payment
+
+     Then I have these balances:
+       | cash      | -1000.00 |
+       | principal |  1000.00 |
+       | interest  |     2.00 |
+       | revenue   |    -2.00 |
+
+     When I save and reload the accountant
+
+     Then I have these balances:
+       | cash      | -1000.00 |
+       | principal |  1000.00 |
+       | interest  |     2.00 |
+       | revenue   |    -2.00 |
+
+      And I have these activity counts:
+       | issue      | 1 |
+       | interest   | 2 |
+       | payment    | 1 |
+       | cancel     | 1 |
+       | adjustment | 2 |

data/features/return.feature

@@ -0,0 +1,112 @@
+Feature: Returns
+
+  Create an adjustment activity when an activity is returned.
+
+  Background:
+    Given a simulating accountant
+
+      And a start date of 2016-01-01
+      And an interest rate of 36.5%
+      And the schedule:
+       | payment | 2026-01-06 | 1005.00 |
+
+      And I simulate these activities:
+        | issue | 2026-01-01 | 1000.00 |
+
+     Then I have these balances:
+       | cash      | -1000.00 |
+       | principal |  1000.00 |
+
+      And I have 1 issue activity
+
+  Scenario: Return an activity without adjustment
+    When I save and reload the accountant
+     And I return the 2026-01-01 issue
+
+    Then I have these balances:
+      | cash      | 0.00 |
+      | principal | 0.00 |
+
+     And these activity counts:
+       | issue  | 1 |
+       | return | 1 |
+
+  Scenario: Return an activity with adjustment
+    When I simulate until 2026-01-02
+
+     And I save and reload the accountant
+     And I return the 2026-01-01 issue
+
+    Then I have these balances:
+      | cash      | 0.00 |
+      | principal | 0.00 |
+      | interest  | 0.00 |
+      | revenue   | 0.00 |
+
+     And these activity counts:
+       | issue      | 1 |
+       | return     | 1 |
+       | interest   | 1 |
+       | adjustment | 1 |
+
+  Scenario: Return an activity entered today
+    When I simulate until 2026-01-06
+
+    Then I have these balances:
+      | cash      |  5.00 |
+      | principal |  0.00 |
+      | interest  |  0.00 |
+      | revenue   | -5.00 |
+
+     And these activity counts:
+       | issue    | 1 |
+       | payment  | 1 |
+       | interest | 5 |
+
+    When I save and reload the accountant
+     And I return the 2026-01-06 payment
+
+    Then I have these balances:
+      | cash      | -1000.00 |
+      | principal |  1000.00 |
+      | interest  |     5.00 |
+      | revenue   |    -5.00 |
+
+     And these activity counts:
+       | issue    | 1 |
+       | payment  | 1 |
+       | interest | 5 |
+       | return   | 1 |
+
+  Scenario: Return an interleaved activity
+    When I simulate these activities:
+      | payment | 2026-01-01 | 500.00 |
+      | finish  | 2026-01-06 |        |
+
+    Then I have these balances:
+      | cash      |  505.00 |
+      | principal |    0.00 |
+      | interest  |    0.00 |
+      | revenue   |   -2.50 |
+      | payable   | -502.50 |
+
+     And these activity counts:
+       | issue    | 1 |
+       | payment  | 2 |
+       | interest | 5 |
+
+    When I return the 2026-01-01 payment
+
+    Then I have these balances:
+      | cash      |  5.00 |
+      | principal |  0.00 |
+      | interest  |  0.00 |
+      | revenue   | -5.00 |
+      | payable   |  0.00 |
+
+     And these activity counts:
+       | issue      | 1 |
+       | payment    | 2 |
+       | interest   | 5 |
+       | return     | 1 |
+       | adjustment | 1 |

data/features/reversal.feature

@@ -0,0 +1,57 @@
+Feature: Reversal
+
+  Reverse an activity.
+
+  Background:
+    Given a simulating accountant
+
+      And a start date of 2026-01-01
+      And an interest rate of 0.00%
+
+      And I simulate these activities:
+        | issue    | 2026-01-01 | 1000.00 |
+        | late_fee | 2026-01-02 |   10.00 |
+
+     Then I have these balances:
+       | principal        |  1000.00 |
+       | cash             | -1000.00 |
+       | late_fee         |    10.00 |
+       | late_fee_revenue |   -10.00 |
+
+      And I have a late_fee activity
+      And I save and reload the accountant
+
+  Scenario: Reverse an activity
+     When I reverse the 2026-01-02 late_fee
+
+     Then I have these balances:
+       | principal        |  1000.00 |
+       | cash             | -1000.00 |
+       | late_fee         |     0.00 |
+       | late_fee_revenue |     0.00 |
+
+      And these activity counts:
+        | issue    | 1 |
+        | late_fee | 1 |
+        | reversal | 1 |
+
+  # Cancelling the late fee would make a lot more sense,
+  # as it will create the adjustment and zero out the late_fee
+  # receivable
+  Scenario: Reverse an activity, retroactively
+    When I apply a payment for $10
+     And I simulate until 2026-01-03
+
+     And I reverse the 2026-01-02 late_fee
+
+    Then I have these balances:
+      | principal        | 1000.00 |
+      | cash             | -990.00 |
+      | late_fee         |  -10.00 |
+      | late_fee_revenue |    0.00 |
+
+    And these activity counts:
+      | issue    | 1 |
+      | late_fee | 1 |
+      | payment  | 1 |
+      | reversal | 1 |

data/features/simulation.feature

@@ -0,0 +1,128 @@
+Feature: Simulation
+
+  Background:
+    Given a simulating accountant
+      And a start date of 2026-01-01
+      And an interest rate of 36.5%
+      And the schedule:
+        | payment | 2026-01-11 | 1010.00 |
+
+  Scenario: No start date
+    Given the accountant:
+      """
+        @accountant = SimulatingAccountant.new
+      """
+     Then the accountant is valid
+      But I cannot simulate
+
+  Scenario: Same day payoff
+    When I simulate these activities:
+      | issue   | 2026-01-01 | 100.00 |
+      | payment | 2026-01-01 | 100.00 |
+
+    Then I have these balances:
+      | cash      | 0.00 |
+      | principal | 0.00 |
+
+  Scenario: Next-Day Payment
+    When I simulate these activities:
+      | issue   | 2026-01-01 | 1000.00 |
+      | payment | 2026-01-02 | 1000.00 |
+
+    Then I have these balances:
+      | cash      |  0.00 |
+      | principal |  1.00 |
+      | interest  |  0.00 |
+      | revenue   | -1.00 |
+
+     And I have these activity counts:
+       | issue    | 1 |
+       | payment  | 1 |
+       | interest | 1 |
+
+  Scenario: Simulation with scheduled activity
+    When I simulate these activities:
+      | issue  | 2026-01-01 | 1000.00 |
+      | finish | 2026-01-11 |         |
+
+    Then I have these balances:
+      | cash      |  10.00 |
+      | principal |   0.00 |
+      | interest  |   0.00 |
+      | revenue   | -10.00 |
+
+    And I have these activity counts:
+      | issue    |  1 |
+      | payment  |  1 |
+      | interest | 10 |
+
+    And I save the accountant
+
+   When I reload the accountant with a start date of 2026-01-02
+   Then I have these balances:
+     | cash      | -1000.00 |
+     | principal |  1000.00 |
+     | interest  |     1.00 |
+     | revenue   |    -1.00 |
+
+   And I have these activity counts:
+     | issue    | 1 |
+     | interest | 1 |
+
+  When I reload the accountant with a start_date of 2026-01-11
+  Then I have these balances:
+    | cash      |  10.00 |
+    | principal |   0.00 |
+    | interest  |   0.00 |
+    | revenue   | -10.00 |
+
+   And I have these activity counts:
+     | issue    |  1 |
+     | payment  |  1 |
+     | interest | 10 |
+
+  Scenario: Multiple interest rates
+    Given a simulating accountant
+      And a start date of 2026-01-01
+      And the interest rates:
+        | effective_date | rate |
+        | 2026-01-01     | 36.5 |
+        | 2026-01-02     |    0 |
+        | 2026-01-03     | 36.5 |
+
+    When I simulate these activities:
+      | issue  | 2026-01-01 | 1000.0 |
+      | finish | 2026-01-04 |        |
+
+    Then I have these balances:
+      | cash      | -1000.00 |
+      | principal |  1000.00 |
+      | interest  |     2.00 |
+      | revenue   |    -2.00 |
+
+  Scenario: Daily interest rate, payment on start date
+    Given a simulating accountant
+      And a start date of 2026-01-01
+      And a daily interest rate of 1.00%
+      And the schedule:
+        | issue   | 2026-01-01 | 1000.00|
+        | payment | 2026-01-01 | 500.00 |
+
+     When I simulate until 2026-01-01
+     Then I have these balances:
+       | cash      | -500.00 |
+       | principal |  500.00 |
+
+     When I simulate until 2026-01-01
+     Then I have these balances:
+       | cash      | -500.00 |
+       | principal |  500.00 |
+
+     When I save the accountant
+      And I reload the accountant with a start date of 2026-01-03
+      And I simulate until 2026-01-03
+     Then I have these balances:
+       | cash      | -500.00 |
+       | principal |  500.00 |
+       | interest  |    5.00 |
+       | revenue   |   -5.00 |

data/features/support/accountants/adjusting_accountant.rb

@@ -0,0 +1,34 @@
+class AdjustingAccountant < Morty::Accountant
+  balance :accruing, %w[principal]
+
+  activity :issue do
+    entry :principal, :cash, amount
+  end
+
+  activity :interest do
+    if rate = accountant.rate_for(accountant.date.yesterday)
+      amount ||= (rate.daily_for(accountant.date.yesterday) * balances[:accruing]).floor(2)
+
+      entry :interest, :revenue, amount
+    end
+  end
+
+  activity :late_fee do
+    entry :late_fee, :late_fee_revenue, amount
+  end
+
+  waterfall :payment, limit: :cr, complete: true, entries: <<~END
+    cash late_fee
+    cash interest
+    cash principal
+    cash payable
+  END
+
+  daily do
+    activity :interest, accountant.date.yesterday
+  end
+
+  daily_guard do
+    accountant.activities.with_type(:interest).none? { |a| a.effective_date == accountant.date.yesterday }
+  end
+end

data/features/support/accountants/daily_accountant.rb

@@ -0,0 +1,13 @@
+class DailyAccountant < Morty::Accountant
+  daily do
+    activity :interest, today, "1.00"
+  end
+
+  daily_guard do
+    today != Date.today + 1
+  end
+
+  activity :interest do
+    entry :interest, :revenue, amount
+  end
+end

data/features/support/accountants/default_accountant.rb

@@ -0,0 +1,2 @@
+class DefaultAccountant < Morty::Accountant
+end