Files
sure/test/controllers/reports_controller_test.rb
David Gil 3d91e60a8a feat: Add subcategory breakdown to Cash Flow Sankey and Reports (#639)
* feat: Add subcategory breakdown to Cash Flow and Reports

Implements Discussion #546 - adds hierarchical category/subcategory
visualization to both the Sankey chart and Reports breakdown tables.

Sankey chart changes:
- Income: subcategory → parent category → Cash Flow
- Expense: Cash Flow → parent category → subcategory
- Extracted process_category_totals helper to DRY up income/expense logic

Reports breakdown changes:
- Subcategories display nested under parent categories
- Smaller dots and indented rows for visual hierarchy
- Extracted _breakdown_table partial to eliminate duplication

* fix: Dynamic node padding for Sankey chart with many nodes

- Add dynamic nodePadding calculation to prevent padding from dominating
  chart height when there are many subcategory nodes
- Extract magic numbers to static constants for configuration
- Decompose monolithic #draw() into focused methods
- Consolidate duplicate tooltip/currency formatting code
- Modernize syntax with spread operators and optional chaining

* fix: Hide overlapping Sankey labels, show on hover

- Add label overlap detection by grouping nodes by column depth
- Hide labels that would overlap with adjacent nodes
- Show hidden labels on hover (node rectangle or connected links)
- Add hover events to node rectangles (not just text)

* fix: Use deterministic fallback colors for categories

- Replace Category::COLORS.sample with Category::UNCATEGORIZED_COLOR
  for income categories in Sankey chart (was producing different colors
  on each page load)
- Add nil color fallback in reports_controller for parent and root
  categories

Addresses CodeRabbit review feedback.

* fix: Expand CSS variable map for d3 color manipulation

Add hex mappings for commonly used CSS variables so d3 can manipulate
opacity for gradients and hover effects:
- var(--color-destructive) -> #EC2222
- var(--color-gray-400) -> #9E9E9E
- var(--color-gray-500) -> #737373

* test: Add tests for subcategory breakdown in dashboard and reports

- Test dashboard renders Sankey chart with parent/subcategory transactions
- Test reports groups transactions by parent and subcategories
- Test reports handles categories with nil colors
- Use EntriesTestHelper#create_transaction for cleaner test setup

* Fix lint: use Number.NEGATIVE_INFINITY

* Remove obsolete nil color test

Category model now validates color presence, so nil color categories
cannot exist. The fallback handling in reports_controller is still in
place but the scenario is unreachable.

* Update reports_controller.rb

* FIX trade category

---------

Co-authored-by: sokie <sokysrm@gmail.com>
2026-01-20 00:01:55 +01:00

242 lines
7.7 KiB
Ruby

require "test_helper"
class ReportsControllerTest < ActionDispatch::IntegrationTest
include EntriesTestHelper
setup do
sign_in @user = users(:family_admin)
@family = @user.family
end
test "index renders successfully" do
get reports_path
assert_response :ok
end
test "index with monthly period" do
get reports_path(period_type: :monthly)
assert_response :ok
assert_select "h1", text: I18n.t("reports.index.title")
end
test "index with quarterly period" do
get reports_path(period_type: :quarterly)
assert_response :ok
end
test "index with ytd period" do
get reports_path(period_type: :ytd)
assert_response :ok
end
test "index with custom period and date range" do
get reports_path(
period_type: :custom,
start_date: 1.month.ago.to_date.to_s,
end_date: Date.current.to_s
)
assert_response :ok
end
test "index with last 6 months period" do
get reports_path(period_type: :last_6_months)
assert_response :ok
end
test "index shows empty state when no transactions" do
# Delete all transactions for the family by deleting from accounts
@family.accounts.each { |account| account.entries.destroy_all }
get reports_path
assert_response :ok
assert_select "h3", text: I18n.t("reports.empty_state.title")
end
test "index with budget performance for current month" do
# Create a budget for current month
budget = Budget.find_or_bootstrap(@family, start_date: Date.current.beginning_of_month)
category = @family.categories.expenses.first
# Fail fast if test setup is incomplete
assert_not_nil category, "Test setup failed: no expense category found for family"
assert_not_nil budget, "Test setup failed: budget could not be created or found"
# Find or create budget category to avoid duplicate errors
budget_category = budget.budget_categories.find_or_initialize_by(category: category)
budget_category.budgeted_spending = Money.new(50000, @family.currency)
budget_category.save!
get reports_path(period_type: :monthly)
assert_response :ok
end
test "index calculates summary metrics correctly" do
get reports_path(period_type: :monthly)
assert_response :ok
assert_select "h3", text: I18n.t("reports.summary.total_income")
assert_select "h3", text: I18n.t("reports.summary.total_expenses")
assert_select "h3", text: I18n.t("reports.summary.net_savings")
end
test "index builds trends data" do
get reports_path(period_type: :monthly)
assert_response :ok
assert_select "h2", text: I18n.t("reports.trends.title")
assert_select "th", text: I18n.t("reports.trends.month")
end
test "index handles invalid date parameters gracefully" do
get reports_path(
period_type: :custom,
start_date: "invalid-date",
end_date: "also-invalid"
)
assert_response :ok # Should not crash, uses defaults
end
test "index swaps dates when end_date is before start_date" do
start_date = Date.current
end_date = 1.month.ago.to_date
get reports_path(
period_type: :custom,
start_date: start_date.to_s,
end_date: end_date.to_s
)
assert_response :ok
# Should show flash message about invalid date range
assert flash[:alert].present?, "Flash alert should be present"
assert_match /End date cannot be before start date/, flash[:alert]
# Verify the response body contains the swapped date range in the correct order
assert_includes @response.body, end_date.strftime("%b %-d, %Y")
assert_includes @response.body, start_date.strftime("%b %-d, %Y")
end
test "spending patterns returns data when expense transactions exist" do
# Create expense category
expense_category = @family.categories.create!(
name: "Test Groceries",
classification: "expense"
)
# Create account
account = @family.accounts.first
# Create expense transaction on a weekday (Monday)
weekday_date = Date.current.beginning_of_month + 2.days
weekday_date = weekday_date.next_occurring(:monday)
entry = account.entries.create!(
name: "Grocery shopping",
date: weekday_date,
amount: 50.00,
currency: "USD",
entryable: Transaction.new(
category: expense_category,
kind: "standard"
)
)
# Create expense transaction on a weekend (Saturday)
weekend_date = weekday_date.next_occurring(:saturday)
weekend_entry = account.entries.create!(
name: "Weekend shopping",
date: weekend_date,
amount: 75.00,
currency: "USD",
entryable: Transaction.new(
category: expense_category,
kind: "standard"
)
)
get reports_path(period_type: :monthly)
assert_response :ok
# Verify spending patterns shows data (not the "no data" message)
assert_select ".text-center.py-8.text-tertiary", { text: /No spending data/, count: 0 }, "Should not show 'No spending data' message when transactions exist"
end
test "export transactions with API key authentication" do
# Use an active API key with read permissions
api_key = api_keys(:active_key)
# Make sure the API key has the correct source
api_key.update!(source: "web") unless api_key.source == "web"
get export_transactions_reports_path(
format: :csv,
period_type: :ytd,
start_date: Date.current.beginning_of_year,
end_date: Date.current,
api_key: api_key.plain_key
)
assert_response :ok
assert_equal "text/csv", @response.media_type
assert_match /Category/, @response.body
end
test "export transactions with invalid API key" do
get export_transactions_reports_path(
format: :csv,
period_type: :ytd,
api_key: "invalid_key"
)
assert_response :unauthorized
assert_match /Invalid or expired API key/, @response.body
end
test "export transactions without API key uses session auth" do
# Should use normal session-based authentication
# The setup already signs in @user = users(:family_admin)
assert_not_nil @user, "User should be set in test setup"
assert_not_nil @family, "Family should be set in test setup"
get export_transactions_reports_path(
format: :csv,
period_type: :ytd,
start_date: Date.current.beginning_of_year,
end_date: Date.current
)
assert_response :ok, "Export should work with session auth. Response: #{@response.body}"
assert_equal "text/csv", @response.media_type
end
test "export transactions swaps dates when end_date is before start_date" do
start_date = Date.current
end_date = 1.month.ago.to_date
get export_transactions_reports_path(
format: :csv,
period_type: :custom,
start_date: start_date.to_s,
end_date: end_date.to_s
)
assert_response :ok
assert_equal "text/csv", @response.media_type
# Verify the CSV content is generated (should not crash)
assert_not_nil @response.body
end
test "index groups transactions by parent and subcategories" do
# Create parent category with subcategories
parent_category = @family.categories.create!(name: "Entertainment", classification: "expense", color: "#FF5733")
subcategory_movies = @family.categories.create!(name: "Movies", classification: "expense", parent: parent_category, color: "#33FF57")
subcategory_games = @family.categories.create!(name: "Games", classification: "expense", parent: parent_category, color: "#5733FF")
# Create transactions using helper
create_transaction(account: @family.accounts.first, name: "Cinema ticket", amount: 15, category: subcategory_movies)
create_transaction(account: @family.accounts.first, name: "Video game", amount: 60, category: subcategory_games)
get reports_path(period_type: :monthly)
assert_response :ok
assert_select "table.w-full"
end
end