1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-07-18 20:59:39 +02:00
Maybe/test/models/account/current_balance_manager_test.rb
Zach Gollwitzer 3eea5a9891
Some checks are pending
Publish Docker image / ci (push) Waiting to run
Publish Docker image / Build docker image (push) Blocked by required conditions
Add auto-update strategies for current balance on manual accounts (#2460)
* Add auto-update strategies for current balance on manual accounts

* Remove deprecated BalanceUpdater, replace with new methods
2025-07-17 06:49:56 -04:00

324 lines
12 KiB
Ruby

require "test_helper"
class Account::CurrentBalanceManagerTest < ActiveSupport::TestCase
setup do
@family = families(:empty)
@linked_account = accounts(:connected)
end
# -------------------------------------------------------------------------------------------------
# Manual account current balance management
#
# Manual accounts do not manage `current_anchor` valuations and have "auto-update strategies" to set the current balance.
# -------------------------------------------------------------------------------------------------
test "when one or more reconciliations exist, append new reconciliation to represent the current balance" do
account = @family.accounts.create!(
name: "Test",
balance: 1000,
cash_balance: 1000,
currency: "USD",
accountable: Depository.new
)
# A reconciliation tells us that the user is tracking this account's value with balance-only updates
account.entries.create!(
date: 30.days.ago.to_date,
name: "First manual recon valuation",
amount: 1200,
currency: "USD",
entryable: Valuation.new(kind: "reconciliation")
)
manager = Account::CurrentBalanceManager.new(account)
assert_equal 1, account.valuations.count
# Here, we assume user is once again "overriding" the balance to 1400
manager.set_current_balance(1400)
today_valuation = account.entries.valuations.find_by(date: Date.current)
assert_equal 2, account.valuations.count
assert_equal 1400, today_valuation.amount
assert_equal 1400, account.balance
end
test "all manual non cash accounts append reconciliations for current balance updates" do
[ Property, Vehicle, OtherAsset, Loan, OtherLiability ].each do |account_type|
account = @family.accounts.create!(
name: "Test",
balance: 1000,
cash_balance: 1000,
currency: "USD",
accountable: account_type.new
)
manager = Account::CurrentBalanceManager.new(account)
assert_equal 0, account.valuations.count
manager.set_current_balance(1400)
assert_equal 1, account.valuations.count
today_valuation = account.entries.valuations.find_by(date: Date.current)
assert_equal 1400, today_valuation.amount
assert_equal 1400, account.balance
end
end
# Scope: Depository, CreditCard only (i.e. all-cash accounts)
#
# If a user has an opening balance (valuation) for their manual *Depository* or *CreditCard* account and has 1+ transactions, the intent of
# "updating current balance" typically means that their start balance is incorrect. We follow that user intent
# by default and find the delta required, and update the opening balance so that the timeline reflects this current balance
#
# The purpose of this is so we're not cluttering up their timeline with "balance reconciliations" that reset the balance
# on the current date. Our goal is to keep the timeline with as few "Valuations" as possible.
#
# If we ever build a UI that gives user options, this test expectation may require some updates, but for now this
# is the least surprising outcome.
test "when no reconciliations exist on cash accounts, adjust opening balance with delta until it gets us to the desired balance" do
account = @family.accounts.create!(
name: "Test",
balance: 900, # the balance after opening valuation + transaction have "synced" (1000 - 100 = 900)
cash_balance: 900,
currency: "USD",
accountable: Depository.new
)
account.entries.create!(
date: 1.year.ago.to_date,
name: "Test opening valuation",
amount: 1000,
currency: "USD",
entryable: Valuation.new(kind: "opening_anchor")
)
account.entries.create!(
date: 10.days.ago.to_date,
name: "Test expense transaction",
amount: 100,
currency: "USD",
entryable: Transaction.new
)
# What we're asserting here:
# 1. User creates the account with an opening balance of 1000
# 2. User creates a transaction of 100, which then reduces the balance to 900 (the current balance value on account above)
# 3. User requests "current balance update" back to 1000, which was their intention
# 4. We adjust the opening balance by the delta (100) to 1100, which is the new opening balance, so that the transaction
# of 100 reduces it down to 1000, which is the current balance they intended.
assert_equal 1, account.valuations.count
assert_equal 1, account.transactions.count
# No new valuation is appended; we're just adjusting the opening valuation anchor
assert_no_difference "account.entries.count" do
manager = Account::CurrentBalanceManager.new(account)
manager.set_current_balance(1000)
end
opening_valuation = account.valuations.find_by(kind: "opening_anchor")
assert_equal 1100, opening_valuation.entry.amount
assert_equal 1000, account.balance
end
# (SEE ABOVE TEST FOR MORE DETAILED EXPLANATION)
# Same assertions as the test above, but Credit Card accounts are liabilities, which means expenses increase balance; not decrease
test "when no reconciliations exist on credit card accounts, adjust opening balance with delta until it gets us to the desired balance" do
account = @family.accounts.create!(
name: "Test",
balance: 1100, # the balance after opening valuation + transaction have "synced" (1000 + 100 = 1100) (expenses increase balance)
cash_balance: 1100,
currency: "USD",
accountable: CreditCard.new
)
account.entries.create!(
date: 1.year.ago.to_date,
name: "Test opening valuation",
amount: 1000,
currency: "USD",
entryable: Valuation.new(kind: "opening_anchor")
)
account.entries.create!(
date: 10.days.ago.to_date,
name: "Test expense transaction",
amount: 100,
currency: "USD",
entryable: Transaction.new
)
assert_equal 1, account.valuations.count
assert_equal 1, account.transactions.count
assert_no_difference "account.entries.count" do
manager = Account::CurrentBalanceManager.new(account)
manager.set_current_balance(1000)
end
opening_valuation = account.valuations.find_by(kind: "opening_anchor")
assert_equal 900, opening_valuation.entry.amount
assert_equal 1000, account.balance
end
# -------------------------------------------------------------------------------------------------
# Linked account current balance management
#
# Linked accounts manage "current balance" via the special `current_anchor` valuation.
# This is NOT a user-facing feature, and is primarily used in "processors" while syncing
# linked account data (e.g. via Plaid)
# -------------------------------------------------------------------------------------------------
test "when no existing anchor for linked account, creates new anchor" do
manager = Account::CurrentBalanceManager.new(@linked_account)
assert_difference -> { @linked_account.entries.count } => 1,
-> { @linked_account.valuations.count } => 1 do
result = manager.set_current_balance(1000)
assert result.success?
assert result.changes_made?
assert_nil result.error
end
current_anchor = @linked_account.valuations.current_anchor.first
assert_not_nil current_anchor
assert_equal 1000, current_anchor.entry.amount
assert_equal "current_anchor", current_anchor.kind
entry = current_anchor.entry
assert_equal 1000, entry.amount
assert_equal Date.current, entry.date
assert_equal "Current balance", entry.name # Depository type returns "Current balance"
assert_equal 1000, @linked_account.balance
end
test "updates existing anchor for linked account" do
# First create a current anchor
manager = Account::CurrentBalanceManager.new(@linked_account)
result = manager.set_current_balance(1000)
assert result.success?
current_anchor = @linked_account.valuations.current_anchor.first
original_id = current_anchor.id
original_entry_id = current_anchor.entry.id
# Travel to tomorrow to ensure date change
travel_to Date.current + 1.day do
# Now update it
assert_no_difference -> { @linked_account.entries.count } do
assert_no_difference -> { @linked_account.valuations.count } do
result = manager.set_current_balance(2000)
assert result.success?
assert result.changes_made?
end
end
current_anchor.reload
assert_equal original_id, current_anchor.id # Same valuation record
assert_equal original_entry_id, current_anchor.entry.id # Same entry record
assert_equal 2000, current_anchor.entry.amount
assert_equal Date.current, current_anchor.entry.date # Should be updated to current date
end
assert_equal 2000, @linked_account.balance
end
test "when no changes made, returns success with no changes made" do
# First create a current anchor
manager = Account::CurrentBalanceManager.new(@linked_account)
result = manager.set_current_balance(1000)
assert result.success?
assert result.changes_made?
# Try to set the same value on the same date
result = manager.set_current_balance(1000)
assert result.success?
assert_not result.changes_made?
assert_nil result.error
assert_equal 1000, @linked_account.balance
end
test "updates only amount when balance changes" do
manager = Account::CurrentBalanceManager.new(@linked_account)
# Create initial anchor
result = manager.set_current_balance(1000)
assert result.success?
current_anchor = @linked_account.valuations.current_anchor.first
original_date = current_anchor.entry.date
# Update only the balance
result = manager.set_current_balance(1500)
assert result.success?
assert result.changes_made?
current_anchor.reload
assert_equal 1500, current_anchor.entry.amount
assert_equal original_date, current_anchor.entry.date # Date should remain the same if on same day
assert_equal 1500, @linked_account.balance
end
test "updates date when called on different day" do
manager = Account::CurrentBalanceManager.new(@linked_account)
# Create initial anchor
result = manager.set_current_balance(1000)
assert result.success?
current_anchor = @linked_account.valuations.current_anchor.first
original_amount = current_anchor.entry.amount
# Travel to tomorrow and update with same balance
travel_to Date.current + 1.day do
result = manager.set_current_balance(1000)
assert result.success?
assert result.changes_made? # Should be true because date changed
current_anchor.reload
assert_equal original_amount, current_anchor.entry.amount
assert_equal Date.current, current_anchor.entry.date # Should be updated to new current date
end
assert_equal 1000, @linked_account.balance
end
test "current_balance returns balance from current anchor" do
manager = Account::CurrentBalanceManager.new(@linked_account)
# Create a current anchor
manager.set_current_balance(1500)
# Should return the anchor's balance
assert_equal 1500, manager.current_balance
# Update the anchor
manager.set_current_balance(2500)
# Should return the updated balance
assert_equal 2500, manager.current_balance
assert_equal 2500, @linked_account.balance
end
test "current_balance falls back to account balance when no anchor exists" do
manager = Account::CurrentBalanceManager.new(@linked_account)
# When no current anchor exists, should fall back to account.balance
assert_equal @linked_account.balance, manager.current_balance
assert_equal @linked_account.balance, @linked_account.balance
end
end