mirror of
https://github.com/we-promise/sure.git
synced 2026-09-05 06:41:08 +00:00
* feat(bills): schema and domain core for the bills subsystem First of three chunks carved out of #3083. This one carries the schema and the domain layer: no bills pages, no calendar feed, no assistant tools. Nothing here is reachable from the UI yet, so it changes no user-visible behavior on its own. Schema, in a single migration with a full down: - recurrence_rules, recurring_occurrences, recurring_allocations, recurring_price_changes and recurring_match_rejections - bill columns on recurring_transactions (bill_type, payment_url, autopay, notes, anchor and end conditions, weekend adjustment, dedup scope) - the four data backfills, in their original order Domain layer: - Schedule, the pure date PORO every cadence resolves through, and FrequencyPreset for the labels - OccurrenceGenerator, Matcher, Allocator, PriceChangeDetector, Classifier, DeclaredBill, HistoryBackfiller and PaycheckPlanner - Pipeline, tying detection to generation, plus the nightly job and rake task Existing detection code changed in three places, each a bug this schema exposes: - Cleaner used a flat two-month staleness threshold, which silently retired every quarterly and annual series - SubscriptionAuditGenerator used a flat 45-day overdue threshold, meaningless at both ends of the frequency range - CashFlowWarningGenerator read one projected entry per series, which only equalled the monthly amount because every series was monthly; weekly bills were under-counted fourfold in its 30-day projection The JSON API travels with the model rather than the UI, because the status enum widens here. The API accepts only active and inactive on write; suggested, paused and ended are lifecycle states owned by detection, so the documented enum stays truthful. Uniqueness keys gain dedup_scope alongside amount, never instead of it: a series that is not price-forked carries a blank scope, so amount is what keeps two different prices apart. Suite 7,550 runs, 0 failures. Rubocop and brakeman clean. Eager loading verified, and the migration reverses and re-applies. Includes the first review round: orphan repair matches income and refuses coincidental twins, session imports persist occurrence mappings across chunks, semimonthly anchors canonicalize, classifier keywords match whole words, and the down refuses rather than failing when price-forked rows exist. * Address second review round Bound the cross-currency default allocation by the entry leftover and the occurrence remainder, matching the same-currency path. Let keyword stems carry a suffix again after the word-boundary fix silenced them. Skip an incoherent recurrence rule row instead of rolling back the whole import. Check rollback collisions per restored index so a refusal cannot land after the bills tables are dropped. Replay the closed_at test through a real second import. Preload the orphan repair associations and move the allocator errors to locale keys. * Match index NULL semantics in the rollback collision checks GROUP BY treats NULLs as equal but the restored unique indexes do not: account_id is nullable and indexed, so two accountless rows can never collide under any of them. Excluding NULL accounts keeps the guard from refusing a rollback PostgreSQL can perform. Verified live both ways: accountless duplicates roll back, a real collision still refuses. * Address maintainer review Scope the payable debt-destination subquery to the row and its family instead of scanning every account in the installation. Batch the cash flow generator remaining-amount sums into one grouped query, matching the two sibling sites. Enforce both window bounds in the after_count branch so a future-anchored plan cannot leak past the requested end date. Skip the explicit regeneration when the day column change will fire the model callback anyway. Add the missing locale entry for the allocation currency validation.
179 lines
5.5 KiB
Ruby
179 lines
5.5 KiB
Ruby
# One expected instance of a recurring obligation: the August rent, this
|
|
# month's electric bill. Holds what is specific to the instance (due date,
|
|
# amount override, skip/snooze, payments via allocations); the rest inherits
|
|
# from the series.
|
|
#
|
|
# Stored status is minimal -- scheduled, plus the terminal paid / skipped /
|
|
# missed. Upcoming, due, overdue and partially paid all derive from dates and
|
|
# allocation sums, so they cannot drift stale. `missed` is only ever set by the
|
|
# user.
|
|
class RecurringOccurrence < ApplicationRecord
|
|
include Monetizable
|
|
|
|
# App defaults when the series leaves its per-bill knobs NULL.
|
|
DEFAULT_NOTIFY_DAYS = 3
|
|
DEFAULT_GRACE_DAYS = 3
|
|
|
|
# Rounding epsilon for accumulation close: payments summing to within a
|
|
# cent of the expected amount count as full payment.
|
|
CLOSE_EPSILON = BigDecimal("0.01")
|
|
|
|
belongs_to :recurring_transaction
|
|
belongs_to :family
|
|
has_many :allocations, class_name: "RecurringAllocation",
|
|
foreign_key: :recurring_occurrence_id, dependent: :destroy, inverse_of: :recurring_occurrence
|
|
|
|
monetize :expected_amount, allow_nil: true
|
|
|
|
enum :status, { scheduled: "scheduled", paid: "paid", skipped: "skipped", missed: "missed" }
|
|
|
|
validates :original_due_on, :due_on, :currency, presence: true
|
|
validates :expected_amount, numericality: { greater_than_or_equal_to: 0 }, allow_nil: true
|
|
|
|
scope :open_status, -> { where(status: :scheduled) }
|
|
scope :closed, -> { where.not(status: :scheduled) }
|
|
scope :due_between, ->(from, to) { where(due_on: from..to) }
|
|
|
|
# The amount this occurrence expects, resolving NULL through the series'
|
|
# amount strategy, which is what lets a price edit update every open
|
|
# occurrence with no sweep. `series_amount` overrides what the series says it
|
|
# costs now, so a price change can pin what a row claimed before the edit.
|
|
def resolved_expected_amount(series_amount: nil)
|
|
return expected_amount if expected_amount.present?
|
|
|
|
series = recurring_transaction
|
|
fallback = series_amount || series.amount
|
|
|
|
case series.amount_strategy
|
|
when "average"
|
|
series.expected_amount_avg.presence || fallback
|
|
when "last"
|
|
last_paid_total.presence || fallback
|
|
else
|
|
fallback
|
|
end.abs
|
|
end
|
|
|
|
def resolved_expected_amount_money
|
|
Money.new(resolved_expected_amount, currency)
|
|
end
|
|
|
|
# Snoozing postpones the presentation-level due date without rewriting the
|
|
# schedule.
|
|
def effective_due_on
|
|
[ due_on, snoozed_until ].compact.max
|
|
end
|
|
|
|
# List views preload allocation sums in one grouped query and inject them
|
|
# here, so row rendering issues no per-occurrence SUM.
|
|
attr_writer :cached_confirmed_allocated
|
|
|
|
def confirmed_allocated
|
|
@cached_confirmed_allocated || allocations.confirmed.sum(:allocated_amount)
|
|
end
|
|
|
|
def confirmed_allocated_money
|
|
Money.new(confirmed_allocated, currency)
|
|
end
|
|
|
|
def remaining_amount
|
|
[ resolved_expected_amount - confirmed_allocated, 0 ].max
|
|
end
|
|
|
|
def remaining_amount_money
|
|
Money.new(remaining_amount, currency)
|
|
end
|
|
|
|
# Exact sum, not tolerance: $1,850 allocated against $2,000 rent is
|
|
# partially paid with $150 remaining, always.
|
|
def partially_paid?
|
|
scheduled? && confirmed_allocated.positive? && confirmed_allocated < resolved_expected_amount
|
|
end
|
|
|
|
def overpaid?
|
|
confirmed_allocated > resolved_expected_amount + CLOSE_EPSILON
|
|
end
|
|
|
|
# Presentation state for open occurrences: upcoming until the notify
|
|
# window, due through the grace period, overdue after it.
|
|
def derived_state
|
|
return status.to_sym unless scheduled?
|
|
|
|
today = Date.current
|
|
|
|
if today > effective_due_on + grace_days
|
|
:overdue
|
|
elsif today >= effective_due_on - notify_days
|
|
:due
|
|
else
|
|
:upcoming
|
|
end
|
|
end
|
|
|
|
def overdue?
|
|
derived_state == :overdue
|
|
end
|
|
|
|
# --- Lifecycle actions. Closing freezes the resolved amount so the row is
|
|
# self-contained history; reopening keeps that value as an explicit override
|
|
# rather than un-freezing it. ---
|
|
|
|
def close!(new_status, source:)
|
|
update!(
|
|
status: new_status,
|
|
expected_amount: resolved_expected_amount,
|
|
closed_at: Time.current,
|
|
closed_source: source
|
|
)
|
|
end
|
|
|
|
def skip!(source: "user")
|
|
close!("skipped", source: source)
|
|
end
|
|
|
|
def miss!
|
|
close!("missed", source: "user")
|
|
end
|
|
|
|
def reopen!
|
|
update!(status: "scheduled", closed_at: nil, closed_source: nil)
|
|
end
|
|
|
|
def snooze!(until_date)
|
|
update!(snoozed_until: until_date)
|
|
end
|
|
|
|
def override_amount!(amount)
|
|
update!(expected_amount: amount.presence)
|
|
end
|
|
|
|
private
|
|
def notify_days
|
|
recurring_transaction.notify_days_before || DEFAULT_NOTIFY_DAYS
|
|
end
|
|
|
|
def grace_days
|
|
recurring_transaction.overdue_grace_days || DEFAULT_GRACE_DAYS
|
|
end
|
|
|
|
# What the last settled cycle actually cost. `expected_amount` on a closed
|
|
# row is the frozen estimate, so reading it would re-propose the guess and
|
|
# strategy could never converge on a variable bill's real amount.
|
|
# Memoized: every amount label on a row asks this same question.
|
|
def last_paid_total
|
|
return @last_paid_total if defined?(@last_paid_total)
|
|
|
|
@last_paid_total = begin
|
|
previous = recurring_transaction.recurring_occurrences
|
|
.paid
|
|
.where("due_on < ?", due_on)
|
|
.order(due_on: :desc)
|
|
.first
|
|
if previous
|
|
total = previous.allocations.confirmed.sum(:allocated_amount)
|
|
total.positive? ? total : nil
|
|
end
|
|
end
|
|
end
|
|
end
|