feat(grid): show average for numeric selections

Closes #4929
This commit is contained in:
t8y2 committed 2026-08-24 22:53:11 +00:00
1 parent e2fa810f2e
commit b3e8709272
13 files changed
+133 -10

No files matched your search

@@ -1,5 +1,5 @@
import { describe, expect, it } from "vitest";
import { dedupeColumnIndexes, summarizeSelection } from "@/lib/dataGrid/gridSelection";
import { createPendingSelectionSummary, dedupeColumnIndexes, formatSelectionAggregate, formatSelectionAverage, summarizeSelection } from "@/lib/dataGrid/gridSelection";
describe("gridSelection", () => {
it("summarizes empty selections", () => {
@@ -8,6 +8,7 @@ describe("gridSelection", () => {
rowCount: 0,
numericCount: 0,
sum: 0,
average: null,
});
});
@@ -25,6 +26,7 @@ describe("gridSelection", () => {
rowCount: 2,
numericCount: 4,
sum: 10,
average: 2.5,
});
});
@@ -42,9 +44,58 @@ describe("gridSelection", () => {
rowCount: 2,
numericCount: 3,
sum: 105.5,
average: 105.5 / 3,
});
});
it("uses the same numeric participation rules for sum and average", () => {
expect(
summarizeSelection({
columns: ["value"],
rows: [[null], [true], [false], [""], [" "], ["not a number"], [Number.NaN], [Number.POSITIVE_INFINITY]],
}),
).toEqual({
cellCount: 8,
rowCount: 8,
numericCount: 0,
sum: 0,
average: null,
});
});
it.each([
["single cell", [[8]], 1, 1, 8],
["row", [[1, 3]], 2, 1, 2],
["column", [[1], [3]], 2, 2, 2],
["range", [[1, 2], [3, 4]], 4, 2, 2.5],
] as const)("averages a %s selection without changing its counts", (_label, rows, cellCount, rowCount, average) => {
expect(summarizeSelection({ columns: [], rows: rows.map((row) => [...row]) })).toMatchObject({ cellCount, rowCount, average });
});
it("does not expose an infinite average when a finite-value sum overflows", () => {
expect(summarizeSelection({ columns: ["value"], rows: [[Number.MAX_VALUE], [Number.MAX_VALUE]] })).toMatchObject({
numericCount: 2,
sum: Number.POSITIVE_INFINITY,
average: null,
});
});
it("keeps pending summaries count-only and formats sum and average identically", () => {
expect(createPendingSelectionSummary(1_000_000, 100_000)).toEqual({
cellCount: 1_000_000,
rowCount: 100_000,
numericCount: 0,
sum: 0,
average: null,
});
expect(formatSelectionAggregate(-0, "en-US")).toBe("0");
expect(formatSelectionAggregate(1 / 3, "en-US")).toBe("0.333333333333");
expect(formatSelectionAggregate(2.5, "en-US")).toBe("2.5");
expect(formatSelectionAverage(1 / 3, "en-US")).toBe("0.333333333333");
expect(formatSelectionAverage(null, "en-US")).toBe("—");
expect(formatSelectionAverage(Number.POSITIVE_INFINITY, "en-US")).toBe("—");
});
it("dedupeColumnIndexes preserves the first visible occurrence instead of sorting", () => {
// After drag-reordering, visible order is [2, 0, 1]; extraction must keep it,
// not revert to numeric [0, 1, 2].
@@ -27,6 +27,7 @@ export interface SelectionSummary {
rowCount: number;
numericCount: number;
sum: number;
average: number | null;
}
export function parseClipboardTable(text: string): string[][] {
@@ -123,5 +124,25 @@ export function summarizeSelection(selection: SelectionData): SelectionSummary {
rowCount: selection.rows.length,
numericCount,
sum,
average: numericCount > 0 && Number.isFinite(sum) ? sum / numericCount : null,
};
}
export function createPendingSelectionSummary(cellCount: number, rowCount: number): SelectionSummary {
return {
cellCount,
rowCount,
numericCount: 0,
sum: 0,
average: null,
};
}
export function formatSelectionAggregate(value: number, locales?: Intl.LocalesArgument): string {
const normalized = Object.is(value, -0) ? 0 : value;
return Number.isInteger(normalized) ? String(normalized) : normalized.toLocaleString(locales, { maximumFractionDigits: 12 });
}
export function formatSelectionAverage(value: number | null | undefined, locales?: Intl.LocalesArgument): string {
return typeof value === "number" && Number.isFinite(value) ? formatSelectionAggregate(value, locales) : "—";
}