mirror of
https://github.com/we-promise/sure.git
synced 2026-09-05 14:51:15 +00:00
* feat(budgets): add per-user personal budgets with strict isolation Families can now opt into personal budgets (toggleable via family settings): each family member gets their own budget for a given period instead of sharing a single family-wide budget. - Add families.personal_budgets flag and budgets.user_id, with partial unique indexes so shared budgets (user_id IS NULL) and personal budgets (user_id IS NOT NULL) can't collide. - Budget.find_or_bootstrap scopes lookup/creation by user when the family has personal_budgets enabled. - Scope most_recent_initialized_budget (used to seed a new budget from the prior period) by user_id so one user's copy-forward never bleeds into another user's budget. - budgets.user_id cascades on user deletion so personal budgets don't outlive their owner. * feat(budgets): enforce user-specific budget ownership and cascade deletion * feat(budgets): display user name for personal budgets in budget card on the plan section * feat(budgets): enhance personal budgets display for admins with preview feature indication * feat(budgets): enforce user-specific budget and category visibility for personal budgets * feat(budgets): create budget section titles and add translations notice in preferences * feat(budgets): let household and personal budgets coexist with sharing Previously enabling personal_budgets made the shared household budget unreachable. Budget.find_or_bootstrap now takes an explicit household: flag so both can be resolved independently for the same period, with a new household_budget_enabled family setting to opt out of the household side and keep personal budgets only. Adds a BudgetShare model (read_only/read_write) so a member can grant another family member access to their personal budget, enforced via Budget#viewable_by?/editable_by? across BudgetsController, BudgetCategoriesController, PlansController, and the read-only API. Preferences gains a Budget sharing card (gated on preview access like the rest of the personal budgets UI) and an owner switcher pill ( Household / mine / shared-with-me) appears on the budget page and the Plan hub card. Also fixes personal budgets showing the same "actual spending" as the household budget: actual spending/income now scope to the budget owner's own accounts instead of the viewer's full accessible set, via a new accounts: override on IncomeStatement. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * feat(budgets): enhance budget switcher with icons and improved styling * feat(budgets): remove user name display from budget card and header * feat(budgets): remove unique index on taggable_type and taggable_id in taggings * feat(budgets): enhance budget sharing functionality and improve UI elements * Collapse personal budget migrations --------- Signed-off-by: JulienGourmet <69808509+jubbakka@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: sure-admin <sure-admin@splashblot.com>
270 lines
11 KiB
Ruby
270 lines
11 KiB
Ruby
require "digest/md5"
|
|
|
|
class IncomeStatement
|
|
include Monetizable
|
|
|
|
monetize :median_expense, :median_income
|
|
|
|
attr_reader :family, :user
|
|
|
|
# `accounts:` overrides the account scope entirely (e.g. a personal
|
|
# budget's "owned accounts only" view) instead of inferring it from
|
|
# `user.finance_accounts`. `user` is still kept for cache-key/estimate
|
|
# purposes when both are given.
|
|
def initialize(family, user: nil, accounts: nil)
|
|
@family = family
|
|
@user = user || Current.user
|
|
@accounts = accounts
|
|
end
|
|
|
|
def totals(transactions_scope: nil, date_range:)
|
|
# Default to excluding pending transactions from budget/analytics calculations
|
|
# Pending transactions shouldn't affect budget totals until they post
|
|
transactions_scope ||= family.transactions.visible.excluding_pending
|
|
|
|
result = totals_query(transactions_scope: transactions_scope, date_range: date_range)
|
|
|
|
total_income = result.select { |t| t.classification == "income" }.sum(&:total)
|
|
total_expense = result.select { |t| t.classification == "expense" }.sum(&:total)
|
|
|
|
ScopeTotals.new(
|
|
transactions_count: result.sum(&:transactions_count),
|
|
income_money: Money.new(total_income, family.currency),
|
|
expense_money: Money.new(total_expense, family.currency)
|
|
)
|
|
end
|
|
|
|
def expense_totals(period: Period.current_month)
|
|
# Memoized per instance so callers that also invoke `net_category_totals`
|
|
key = period_cache_key(period)
|
|
@expense_totals_by_period ||= {}
|
|
return @expense_totals_by_period[key] if @expense_totals_by_period.key?(key)
|
|
@expense_totals_by_period[key] = build_period_total(classification: "expense", period: period)
|
|
end
|
|
|
|
def income_totals(period: Period.current_month)
|
|
key = period_cache_key(period)
|
|
@income_totals_by_period ||= {}
|
|
return @income_totals_by_period[key] if @income_totals_by_period.key?(key)
|
|
@income_totals_by_period[key] = build_period_total(classification: "income", period: period)
|
|
end
|
|
|
|
def net_category_totals(period: Period.current_month)
|
|
key = period_cache_key(period)
|
|
@net_category_totals_by_period ||= {}
|
|
return @net_category_totals_by_period[key] if @net_category_totals_by_period.key?(key)
|
|
|
|
expense = expense_totals(period: period)
|
|
income = income_totals(period: period)
|
|
|
|
# Use a stable key for each category: id for persisted, invariant token for synthetic
|
|
cat_key = ->(ct) {
|
|
if ct.category.uncategorized?
|
|
:uncategorized
|
|
elsif ct.category.other_investments?
|
|
:other_investments
|
|
else
|
|
ct.category.id
|
|
end
|
|
}
|
|
|
|
expense_by_cat = expense.category_totals.reject { |ct| ct.category.subcategory? }.index_by { |ct| cat_key.call(ct) }
|
|
income_by_cat = income.category_totals.reject { |ct| ct.category.subcategory? }.index_by { |ct| cat_key.call(ct) }
|
|
|
|
all_keys = (expense_by_cat.keys + income_by_cat.keys).uniq
|
|
raw_expense_categories = []
|
|
raw_income_categories = []
|
|
|
|
all_keys.each do |cat|
|
|
exp_ct = expense_by_cat[cat]
|
|
inc_ct = income_by_cat[cat]
|
|
exp_total = exp_ct&.total || 0
|
|
inc_total = inc_ct&.total || 0
|
|
net = exp_total - inc_total
|
|
category = exp_ct&.category || inc_ct&.category
|
|
|
|
if net > 0
|
|
raw_expense_categories << { category: category, total: net }
|
|
elsif net < 0
|
|
raw_income_categories << { category: category, total: net.abs }
|
|
end
|
|
end
|
|
|
|
total_net_expense = raw_expense_categories.sum { |r| r[:total] }
|
|
total_net_income = raw_income_categories.sum { |r| r[:total] }
|
|
|
|
net_expense_categories = raw_expense_categories.map do |r|
|
|
weight = total_net_expense.zero? ? 0 : (r[:total].to_f / total_net_expense) * 100
|
|
CategoryTotal.new(category: r[:category], total: r[:total], currency: family.currency, weight: weight)
|
|
end
|
|
|
|
net_income_categories = raw_income_categories.map do |r|
|
|
weight = total_net_income.zero? ? 0 : (r[:total].to_f / total_net_income) * 100
|
|
CategoryTotal.new(category: r[:category], total: r[:total], currency: family.currency, weight: weight)
|
|
end
|
|
|
|
@net_category_totals_by_period[key] = NetCategoryTotals.new(
|
|
net_expense_categories: net_expense_categories,
|
|
net_income_categories: net_income_categories,
|
|
total_net_expense: total_net_expense,
|
|
total_net_income: total_net_income,
|
|
currency: family.currency
|
|
)
|
|
end
|
|
|
|
# Income/expense totals for an arbitrary period, optionally scoped to a
|
|
# subset of accounts (e.g. a dashboard widget's account filter). Unlike
|
|
# `income_totals`/`expense_totals`, this isn't memoized per-period since
|
|
# callers (e.g. a monthly bar chart) typically query several distinct
|
|
# periods and account combinations in one request.
|
|
def totals_for(period, account_ids: nil)
|
|
scope = family.transactions.visible.excluding_pending.in_period(period)
|
|
scope = scope.where(entries: { account_id: account_ids }) if account_ids.present?
|
|
|
|
totals(transactions_scope: scope, date_range: period.date_range)
|
|
end
|
|
|
|
# Accounts actually reflected in totals/totals_for: visible, not excluded
|
|
# from reports, not tax-advantaged, and (when scoped to a user) included in
|
|
# that user's finances. Callers offering an account filter (e.g. a
|
|
# dashboard widget) should build their options from this, not a broader
|
|
# "accessible accounts" list, or selecting an ineligible account silently
|
|
# computes to zero instead of the totals it actually appears in elsewhere.
|
|
def eligible_accounts
|
|
@eligible_accounts ||= begin
|
|
scope = family.accounts.visible.included_in_reports
|
|
tax_advantaged_ids = family.tax_advantaged_account_ids
|
|
scope = scope.where.not(id: tax_advantaged_ids) if tax_advantaged_ids.present?
|
|
scope = scope.merge(Account.included_in_finances_for(user)) if user
|
|
scope
|
|
end
|
|
end
|
|
|
|
def median_expense(interval: "month", category: nil)
|
|
if category.present?
|
|
category_stats(interval: interval).find { |stat| stat.classification == "expense" && stat.category_id == category.id }&.median || 0
|
|
else
|
|
family_stats(interval: interval).find { |stat| stat.classification == "expense" }&.median || 0
|
|
end
|
|
end
|
|
|
|
def avg_expense(interval: "month", category: nil)
|
|
if category.present?
|
|
category_stats(interval: interval).find { |stat| stat.classification == "expense" && stat.category_id == category.id }&.avg || 0
|
|
else
|
|
family_stats(interval: interval).find { |stat| stat.classification == "expense" }&.avg || 0
|
|
end
|
|
end
|
|
|
|
def median_income(interval: "month")
|
|
family_stats(interval: interval).find { |stat| stat.classification == "income" }&.median || 0
|
|
end
|
|
|
|
private
|
|
ScopeTotals = Data.define(:transactions_count, :income_money, :expense_money)
|
|
PeriodTotal = Data.define(:classification, :total, :currency, :category_totals)
|
|
CategoryTotal = Data.define(:category, :total, :currency, :weight)
|
|
NetCategoryTotals = Data.define(:net_expense_categories, :net_income_categories, :total_net_expense, :total_net_income, :currency)
|
|
|
|
def categories
|
|
# Keep Category#subcategory?'s parent-based orphan semantics without lazy loads.
|
|
@categories ||= family.categories.includes(:parent).to_a
|
|
end
|
|
|
|
def period_cache_key(period)
|
|
[ period.start_date, period.end_date ]
|
|
end
|
|
|
|
def build_period_total(classification:, period:)
|
|
# Exclude pending transactions from budget calculations
|
|
totals = totals_for_period(period).select { |t| t.classification == classification }
|
|
classification_total = totals.sum(&:total)
|
|
|
|
uncategorized_category = family.categories.uncategorized
|
|
other_investments_category = family.categories.other_investments
|
|
|
|
category_totals = [ *categories, uncategorized_category, other_investments_category ].map do |category|
|
|
parent_category_total = if category.uncategorized?
|
|
# Regular uncategorized: NULL category_id and NOT uncategorized investment
|
|
totals.select { |t| t.category_id.nil? && !t.is_uncategorized_investment }&.sum(&:total) || 0
|
|
elsif category.other_investments?
|
|
# Other investments: NULL category_id AND is_uncategorized_investment
|
|
totals.select { |t| t.category_id.nil? && t.is_uncategorized_investment }&.sum(&:total) || 0
|
|
else
|
|
totals.select { |t| t.category_id == category.id }&.sum(&:total) || 0
|
|
end
|
|
|
|
children_totals = if category.synthetic?
|
|
0
|
|
else
|
|
totals.select { |t| t.parent_category_id == category.id }&.sum(&:total) || 0
|
|
end
|
|
|
|
category_total = parent_category_total + children_totals
|
|
|
|
weight = (category_total.zero? ? 0 : category_total.to_f / classification_total) * 100
|
|
|
|
CategoryTotal.new(
|
|
category: category,
|
|
total: category_total,
|
|
currency: family.currency,
|
|
weight: weight,
|
|
)
|
|
end
|
|
|
|
PeriodTotal.new(
|
|
classification: classification,
|
|
total: category_totals.reject { |ct| ct.category.subcategory? }.sum(&:total),
|
|
currency: family.currency,
|
|
category_totals: category_totals
|
|
)
|
|
end
|
|
|
|
def totals_for_period(period)
|
|
@totals_for_period ||= {}
|
|
@totals_for_period[period_cache_key(period)] ||=
|
|
totals_query(
|
|
transactions_scope: family.transactions.visible.excluding_pending.in_period(period),
|
|
date_range: period.date_range
|
|
)
|
|
end
|
|
|
|
def family_stats(interval: "month")
|
|
@family_stats ||= {}
|
|
@family_stats[interval] ||= Rails.cache.fetch([
|
|
"income_statement", "family_stats", family.id, user&.id, interval, included_account_ids_hash, family.entries_cache_version
|
|
]) { FamilyStats.new(family, interval:, account_ids: included_account_ids).call }
|
|
end
|
|
|
|
def category_stats(interval: "month")
|
|
@category_stats ||= {}
|
|
@category_stats[interval] ||= Rails.cache.fetch([
|
|
"income_statement", "category_stats", family.id, user&.id, interval, included_account_ids_hash, family.entries_cache_version
|
|
]) { CategoryStats.new(family, interval:, account_ids: included_account_ids).call }
|
|
end
|
|
|
|
def included_account_ids
|
|
@included_account_ids ||= if @accounts
|
|
@accounts.pluck(:id)
|
|
elsif user
|
|
user.finance_accounts.pluck(:id)
|
|
end
|
|
end
|
|
|
|
def included_account_ids_hash
|
|
@included_account_ids_hash ||= included_account_ids ? Digest::MD5.hexdigest(included_account_ids.sort.join(",")) : nil
|
|
end
|
|
|
|
def totals_query(transactions_scope:, date_range:)
|
|
sql_hash = Digest::MD5.hexdigest(transactions_scope.to_sql)
|
|
|
|
Rails.cache.fetch([
|
|
"income_statement", "totals_query", "v2", family.id, user&.id, included_account_ids_hash, sql_hash, date_range.begin, date_range.end, family.entries_cache_version, family.accounts.maximum(:updated_at)&.to_i
|
|
]) { Totals.new(family, transactions_scope: transactions_scope, date_range: date_range, included_account_ids: included_account_ids).call }
|
|
end
|
|
|
|
def monetizable_currency
|
|
family.currency
|
|
end
|
|
end
|