mirror of
https://github.com/we-promise/sure.git
synced 2026-07-28 04:32:12 +00:00
* Add "Money In / Out" dashboard widget Adds a new dashboard section showing a monthly bar chart of cash activity alongside a summary card (net balance, income, expenses), with per-widget month navigation and account filtering. - IncomeStatement#totals_for computes income/expense totals for an arbitrary period, optionally scoped to a set of account ids - New bar_chart_controller.js (D3) renders the monthly bars - Income/expense rows link through to filtered transactions Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Fix tooltip/dropdown positioning and split money flow chart by income/expense The widget's @container wrapper established a new containing block for position:fixed descendants, so the month-picker and account-filter menus (floating-ui, strategy: fixed) and the D3 tooltip (container- relative coordinates) rendered away from their trigger/bar. Drop @container in favor of regular viewport breakpoints for this full-width widget, and position the tooltip with page-relative coordinates like the other chart controllers. Also replace the single combined bar per month with a grouped expense/income pair (red/green, with a legend) so each month's inflow and outflow are visible independently. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Cap and scroll the money flow widget's month picker Add an optional max_height to DS::Menu (opt-in, backward compatible) so a long item list scrolls inside a fixed-height panel instead of overflowing the viewport. Use it for the money flow widget's 12-month picker. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Use design system tokens for income/expense indicators in money flow widget Swap the four bg-green-500/bg-red-500 dot indicators (legend + income/expense row links) in the money flow widget for bg-success/bg-destructive, matching the "functional tokens only" rule. The same partial already uses text-success/text-destructive for the balance figure, and bg-success/ bg-destructive are already established elsewhere (DS::Alert, budget_categories/_budget_category.html.erb). * Fix future-month 500 and pending-transaction link mismatch in money flow widget Two CI review findings on the money flow widget: - A future month passed via ?money_flow_month= (e.g. a bookmarked/hand-edited URL) made end_date earlier than month_start once capped at Date.current, which Period.custom rejects, causing a 500. money_flow_month_param now clamps future months to the current month, same as it already does for malformed input. - The income/expense row links passed type/date/account filters but no status, so Transaction::Search included pending transactions even though the displayed totals (IncomeStatement#totals_for) exclude them via excluding_pending. Add status: ["confirmed"] to both links so the linked list matches the card total. Also strengthens the widget's controller tests: asserts the highlighted bar's actual income/expense values instead of just its presence, and adds a regression test proving an account id outside the current user's accessible accounts is dropped (falls back to the unfiltered state) rather than leaking or erroring. * Fix account filter eligibility and SVG dark mode fill in money flow widget Two more CI review findings on the money flow widget: The account filter iterated over all visible/accessible accounts, a broader set than IncomeStatement actually counts (accounts excluded from reports, tax-advantaged accounts like 401k/IRA, or shared accounts not included in the user's finances). Selecting one of these silently computed to zero while its drill-down link could still list its transactions. Add IncomeStatement#eligible_accounts, mirroring the same criteria already applied in the totals SQL, and use it for both the checkbox list and the account_ids intersection. The D3 axis tick text elements used text-primary/text-secondary, which set CSS color, not SVG fill, so labels rendered with the default black fill and were unreadable in dark mode. Add fill-current, matching the pattern already used in sankey_chart_controller.js. Adds controller/model tests for eligible_accounts (excluded from the account filter, ignored when passed as a filter id, excluded from totals) and verifies the dark-mode fill fix visually. * Extract duplicated bar-chart JSON parsing into a test helper The css_select("[data-controller='bar-chart']").first + JSON.parse(chart["data-bar-chart-data-value"]) pattern was repeated across four money flow widget tests in pages_controller_test.rb. Extract it into a private money_flow_bars helper and use it everywhere instead. * Preserve eligible account scope in money flow drill-down links when unfiltered The income/expense drill-down links used money_flow_data[:account_ids] directly, which is nil in the widget's default unfiltered state, so .compact dropped the account filter entirely from the link. TransactionsController treats an absent account_ids as all accessible accounts, a broader set than IncomeStatement#eligible_accounts (which excludes tax-advantaged, excluded-from-reports, and non-finance shared accounts). Users with any such account could click a displayed total and see transactions that were never counted in it. Use selected_account_ids (already computed as money_flow_data[:account_ids] || accounts.map(&:id)) for both links instead, so they always pin to the same eligible accounts backing the total, filtered or not. Left the month-picker link on money_flow_data[:account_ids] so navigating months while unfiltered doesn't bloat the URL with every eligible account id. Adds a regression test confirming the default (unfiltered) links include account_ids and exclude an ineligible account's id. * Refine Money In/Out dashboard widget - 6-month window (was 3), half-width default with responsive stack, income-first bars, 2px floor + faded in-progress (partial) month - Expense series/figures neutral (gray/text-primary) — app reserves red for negative/overspend; neutral zero balance - Account filter: outline DS::Button + list-filter icon trigger with in-panel search (DS::SearchInput + list-filter), matching the app's filter convention - i18n search_accounts (en + fr); bump money_flow bar-count test 3 -> 6 * Clarify Money In/Out scope: month label, 6-month caption, filter "All" Addresses confusion between the widget's own month picker and the dashboard's global period, and between the picked month and the 6-month chart span. - Card now headed with the selected month (e.g. "July 2026") so it's clear the totals below are that month's, driven by the picker - Chart legend row captioned "Last N months" so the trailing window is explicit - Info tooltip by the month picker: the widget scopes to the month you pick here, independent of the dashboard's top-level period - Account filter trigger reads "All accounts" when nothing is filtered out, instead of "Filter accounts (N)" - i18n (en + fr) for the new strings * Match tooltip expense dot to the gray bar palette --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: Guillem Arias <accounts@gariasf.com>
261 lines
10 KiB
Ruby
261 lines
10 KiB
Ruby
require "digest/md5"
|
|
|
|
class IncomeStatement
|
|
include Monetizable
|
|
|
|
monetize :median_expense, :median_income
|
|
|
|
attr_reader :family, :user
|
|
|
|
def initialize(family, user: nil)
|
|
@family = family
|
|
@user = user || Current.user
|
|
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 ||= user ? user.finance_accounts.pluck(:id) : nil
|
|
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
|