Files
sure/app/models/savings_contribution.rb
Guillem Arias 77660d2ee4 feat(savings): add savings goals
Adds a standalone Savings goals feature: a piggy-bank style tracker that
lets a family set a target, link one or more Depository accounts as
funding sources, and log manual contributions over time. Supersedes #1569
(closed) — same intent, redesigned per reviewer + Discord feedback.

What this adds:

- New `/savings_goals` sidebar entry (piggy-bank icon) with index, show,
  state-filtered tabs (all/active/paused/completed/archived), and a
  2-step modal stepper for creation (Identity → Review).
- Multi-account funding via a `SavingsGoalAccount` join: a goal requires
  ≥1 linked Depository account (checking/savings/HSA/CD/money-market),
  and all linked accounts must share the goal's currency.
- Tracker balance model: goal balance = SUM(contributions.amount). No
  auto-flow from account balances. Contributions are pure logical
  records and don't move money between accounts.
- Manual contributions modal scoped to the goal's linked accounts.
  Initial contributions seeded at creation can't be deleted; manual
  ones can.
- AASM lifecycle: active / paused / completed / archived.
  Hard-delete only after archive.
- Status pills (On track / Behind / Reached / No date) derived from
  pace vs target_date.
- AI Assistant tool `create_savings_goal` lets the sidebar chat create
  a goal end-to-end from a natural-language prompt; soft errors carry
  the available-accounts list back to the LLM (mirrors the existing
  `import_bank_statement` pattern).
- Family-scoped throughout (`Current.family`-only access, account
  family-scoping enforced both in controllers and the AI tool).
- Demo data seed wires up 4 sample goals across the Depository accounts.

Intentionally out of scope (separate PRs / v1.1):

- Auto-fund from budget surplus + Sidekiq cron + budget-show card.
- Dashboard "Savings goals" widget.
- "Behind pace" projection chart on the detail page.
- `evaluate_savings_goal_feasibility` LLM tool (level-setting before
  create_savings_goal).
- Spend-less goals inside Budgets.
- Family-member-private goals (deferred investigation).
2026-05-11 11:20:37 +02:00

57 lines
1.5 KiB
Ruby

class SavingsContribution < ApplicationRecord
include Monetizable
SOURCES = %w[manual initial].freeze
belongs_to :savings_goal
belongs_to :account
validates :amount, presence: true, numericality: { greater_than: 0 }
validates :currency, presence: true
validates :contributed_at, presence: true
validates :source, inclusion: { in: SOURCES }
validate :currency_matches_goal
validate :account_must_belong_to_family
validate :account_must_be_linked_to_goal
before_validation :sync_currency_from_goal
monetize :amount
scope :chronological, -> { order(contributed_at: :desc, created_at: :desc) }
def manual?
source == "manual"
end
def initial?
source == "initial"
end
private
def sync_currency_from_goal
self.currency = savings_goal.currency if savings_goal && currency.blank?
end
def currency_matches_goal
return if savings_goal.nil? || currency.blank?
return if currency == savings_goal.currency
errors.add(:currency, :must_match_goal)
end
def account_must_belong_to_family
return if savings_goal.nil? || account.nil?
return if account.family_id == savings_goal.family_id
errors.add(:account, :must_belong_to_family)
end
def account_must_be_linked_to_goal
return if savings_goal.nil? || account.nil?
return if savings_goal.savings_goal_accounts.where(account_id: account_id).exists?
errors.add(:account, :must_be_linked_to_goal)
end
end