A local-first personal finance app
[Enhancements] Add quarter date range presets (#8607)
Benoît Viguiera9252f9cbc2c
diff --git a/packages/component-library/src/DateRangePicker.tsx b/packages/component-library/src/DateRangePicker.tsxindex 1992f3b3ba..24c99c1e2e 100644--- a/packages/component-library/src/DateRangePicker.tsx+++ b/packages/component-library/src/DateRangePicker.tsx@@ -260,7 +260,14 @@ export function DateRangePicker({{Boolean(presets?.length) && (<View><Text style={sectionTitleStyle}>{labels.quickSelect}</Text>- <View style={{ gap: 4 }}>+ <View+ style={{+ gap: 4,+ maxHeight: 200,+ overflowY: 'auto',+ paddingRight: 4,+ }}+ >{presets?.map(preset => {// Derive the active preset from the shown range instead// of storing it, so it survives closing and reopeningdiff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-1-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-1-chromium-linux.pngindex bd22a82cee..1991d5594e 100644Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-1-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-1-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-2-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-2-chromium-linux.pngindex fd30bf9c17..6dc237b4ee 100644Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-2-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-2-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-3-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-3-chromium-linux.pngindex 81764480e8..9c5d6d7305 100644Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-3-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-3-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-4-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-4-chromium-linux.pngindex 8c2b1d7303..91d37a69b5 100644Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-4-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-4-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-5-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-5-chromium-linux.pngindex 4ccbb04505..4222623011 100644Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-5-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-5-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-6-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-6-chromium-linux.pngindex 611d5594f5..dd92ca02eb 100644Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-6-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-opens-the-date-range-picker-and-checks-visuals-6-chromium-linux.png differdiff --git a/packages/desktop-client/src/components/formula/QueryManager.tsx b/packages/desktop-client/src/components/formula/QueryManager.tsxindex 4f386a8b2a..3475375e91 100644--- a/packages/desktop-client/src/components/formula/QueryManager.tsx+++ b/packages/desktop-client/src/components/formula/QueryManager.tsx@@ -502,6 +502,8 @@ function QueryItem({lastYear: t('Last year'),yearToDate: t('Year to date'),priorYearToDate: t('Prior year to date'),+ currentQuarter: t('Current quarter'),+ previousQuarter: t('Previous quarter'),} satisfies Record<TimeFrame['mode'], string>;const timeRangeLabel = timeRangeLabels[timeRangeMode];const presetTimeRangeLabels = {@@ -510,6 +512,8 @@ function QueryItem({lastYear: t('Last year transactions'),yearToDate: t('Year to date transactions'),priorYearToDate: t('Prior year to date transactions'),+ currentQuarter: t('Current quarter transactions'),+ previousQuarter: t('Previous quarter transactions'),} satisfies Record<PresetTimeRangeMode, string>;const presetTimeRangeLabel = isPresetTimeRange? presetTimeRangeLabels[timeRangeMode]@@ -785,6 +789,26 @@ function QueryItem({mode = 'priorYearToDate';break;}+ case 'current-quarter': {+ [start, end] = getLiveRange(+ 'Current quarter',+ _earliestTransaction,+ _latestTransaction,+ false,+ );+ mode = 'currentQuarter';+ break;+ }+ case 'previous-quarter': {+ [start, end] = getLiveRange(+ 'Previous quarter',+ _earliestTransaction,+ _latestTransaction,+ false,+ );+ mode = 'previousQuarter';+ break;+ }case 'all-time': {[start, end] = getLiveRange('All time',@@ -823,6 +847,8 @@ function QueryItem({name: 'prior-year-to-date',text: t('Prior year to date'),},+ { name: 'current-quarter', text: t('Current quarter') },+ { name: 'previous-quarter', text: t('Previous quarter') },{ name: 'all-time', text: t('All time') },]}/>diff --git a/packages/desktop-client/src/components/reports/Header.tsx b/packages/desktop-client/src/components/reports/Header.tsxindex 86e242f494..3f60b423a3 100644--- a/packages/desktop-client/src/components/reports/Header.tsx+++ b/packages/desktop-client/src/components/reports/Header.tsx@@ -196,6 +196,12 @@ export function Header({() =>liveRangeAsMonths('Prior year to date', false, 'priorYearToDate'),),+ makePreset('current-quarter', <Trans>Current quarter</Trans>, () =>+ liveRangeAsMonths('Current quarter', false, 'currentQuarter'),+ ),+ makePreset('previous-quarter', <Trans>Previous quarter</Trans>, () =>+ liveRangeAsMonths('Previous quarter', false, 'previousQuarter'),+ ),// `allMonths` may still be empty before the report's async load// finishes....(allMonths.lengthdiff --git a/packages/desktop-client/src/components/reports/ReportOptions.ts b/packages/desktop-client/src/components/reports/ReportOptions.tsindex b61f3df5bf..8c078fe18c 100644--- a/packages/desktop-client/src/components/reports/ReportOptions.ts+++ b/packages/desktop-client/src/components/reports/ReportOptions.ts@@ -127,6 +127,26 @@ const dateRangeOptions: dateRangeProps[] = [Monthly: true,Yearly: false,},+ {+ description: t('Current quarter'),+ key: 'Current quarter',+ name: 'currentQuarter',+ type: 'Month',+ Daily: true,+ Weekly: true,+ Monthly: true,+ Yearly: false,+ },+ {+ description: t('Previous quarter'),+ key: 'Previous quarter',+ name: 'previousQuarter',+ type: 'Month',+ Daily: true,+ Weekly: true,+ Monthly: true,+ Yearly: false,+ },{description: t('Last 30 days'),key: 'Last 30 days',diff --git a/packages/desktop-client/src/components/reports/disabledList.ts b/packages/desktop-client/src/components/reports/disabledList.tsindex 8b23bca3fe..d450e591e7 100644--- a/packages/desktop-client/src/components/reports/disabledList.ts+++ b/packages/desktop-client/src/components/reports/disabledList.ts@@ -37,6 +37,14 @@ const currentIntervalOptions = [description: t('Last month'),disableInclude: true,},+ {+ description: t('Current quarter'),+ disableInclude: true,+ },+ {+ description: t('Previous quarter'),+ disableInclude: true,+ },{description: t('Last 30 days'),disableInclude: true,diff --git a/packages/desktop-client/src/components/reports/getLiveRange.test.ts b/packages/desktop-client/src/components/reports/getLiveRange.test.tsindex bd2f053dc4..ced20a6614 100644--- a/packages/desktop-client/src/components/reports/getLiveRange.test.ts+++ b/packages/desktop-client/src/components/reports/getLiveRange.test.ts@@ -76,4 +76,43 @@ describe('getLiveRange', () => {expect(end).toBe('2017-01-01');});});++ describe('Current quarter', () => {+ it('returns the full quarter containing today (Q1: Jan-Mar)', () => {+ const [start, end] = getLiveRange(+ 'Current quarter',+ EARLIEST,+ LATEST,+ false,+ );+ // currentMonth() = '2017-01', so the quarter is Jan-Mar 2017+ expect(start).toBe('2017-01-01');+ expect(end).toBe('2017-03-31');+ });++ it('clamps start date to earliestTransaction when data starts later', () => {+ const [start, end] = getLiveRange(+ 'Current quarter',+ '2017-02-15',+ LATEST,+ false,+ );+ expect(start).toBe('2017-02-15');+ expect(end).toBe('2017-03-31');+ });+ });++ describe('Previous quarter', () => {+ it('returns the full previous quarter (Q4 of the prior year: Oct-Dec)', () => {+ const [start, end] = getLiveRange(+ 'Previous quarter',+ EARLIEST,+ LATEST,+ false,+ );+ // currentMonth() = '2017-01', so the previous quarter is Oct-Dec 2016+ expect(start).toBe('2016-10-01');+ expect(end).toBe('2016-12-31');+ });+ });});diff --git a/packages/desktop-client/src/components/reports/getLiveRange.ts b/packages/desktop-client/src/components/reports/getLiveRange.tsindex fd3c09336d..e0ee99ebb8 100644--- a/packages/desktop-client/src/components/reports/getLiveRange.ts+++ b/packages/desktop-client/src/components/reports/getLiveRange.ts@@ -54,6 +54,31 @@ export function getLiveRange();break;}+ case 'currentQuarter': {+ const quarterStart = monthUtils.getQuarterStart(+ monthUtils.currentMonth(),+ );+ const quarterEnd = monthUtils.getQuarterEnd(monthUtils.currentMonth());+ [dateStart, dateEnd] = validateRange(+ earliestTransaction,+ quarterStart + '-01',+ monthUtils.lastDayOfMonth(quarterEnd),+ );+ break;+ }+ case 'previousQuarter': {+ const prevQuarterMonth = monthUtils.prevQuarter(+ monthUtils.currentMonth(),+ );+ const quarterStart = monthUtils.getQuarterStart(prevQuarterMonth);+ const quarterEnd = monthUtils.getQuarterEnd(prevQuarterMonth);+ [dateStart, dateEnd] = validateRange(+ earliestTransaction,+ quarterStart + '-01',+ monthUtils.lastDayOfMonth(quarterEnd),+ );+ break;+ }case 'last30Days': {[dateStart, dateEnd] = validateRange(earliestTransaction,diff --git a/packages/desktop-client/src/components/reports/reportRanges.test.ts b/packages/desktop-client/src/components/reports/reportRanges.test.tsindex bc45cc9d0f..32740ec867 100644--- a/packages/desktop-client/src/components/reports/reportRanges.test.ts+++ b/packages/desktop-client/src/components/reports/reportRanges.test.ts@@ -60,6 +60,30 @@ describe('calculateTimeRange', () => {expect(start).toBe('2016-12-18'); // width of 14 days preservedexpect(mode).toBe('sliding-window');});++ it('keeps current quarter as a live time range when restoring a saved widget', () => {+ const [start, end, mode] = calculateTimeRange({+ start: '2016-10',+ end: '2016-12',+ mode: 'currentQuarter',+ });++ expect(start).toBe('2017-01');+ expect(end).toBe('2017-03');+ expect(mode).toBe('currentQuarter');+ });++ it('keeps previous quarter as a live time range when restoring a saved widget', () => {+ const [start, end, mode] = calculateTimeRange({+ start: '2016-07',+ end: '2016-09',+ mode: 'previousQuarter',+ });++ expect(start).toBe('2016-10');+ expect(end).toBe('2016-12');+ expect(mode).toBe('previousQuarter');+ });});// In test mode, monthUtils.currentMonth() returns '2017-01'diff --git a/packages/desktop-client/src/components/reports/reportRanges.ts b/packages/desktop-client/src/components/reports/reportRanges.tsindex ad41e8fe57..470f5b7c6b 100644--- a/packages/desktop-client/src/components/reports/reportRanges.ts+++ b/packages/desktop-client/src/components/reports/reportRanges.ts@@ -282,6 +282,22 @@ export function calculateTimeRange('priorYearToDate',] as const;}+ if (mode === 'currentQuarter') {+ const currentMonth = monthUtils.currentMonth();+ return [+ monthUtils.getQuarterStart(currentMonth),+ monthUtils.getQuarterEnd(currentMonth),+ 'currentQuarter',+ ] as const;+ }+ if (mode === 'previousQuarter') {+ const prevQuarterMonth = monthUtils.prevQuarter(monthUtils.currentMonth());+ return [+ monthUtils.getQuarterStart(prevQuarterMonth),+ monthUtils.getQuarterEnd(prevQuarterMonth),+ 'previousQuarter',+ ] as const;+ }return [start, end, 'static'] as const;}diff --git a/packages/loot-core/src/shared/months.test.ts b/packages/loot-core/src/shared/months.test.tsindex b79fac192a..1931569617 100644--- a/packages/loot-core/src/shared/months.test.ts+++ b/packages/loot-core/src/shared/months.test.ts@@ -4,6 +4,30 @@ test('range returns a full range', () => {expect(monthUtils.range('2016-10', '2018-01')).toMatchSnapshot();});+test('getQuarter returns the quarter number for a given month', () => {+ expect(monthUtils.getQuarter('2024-01')).toBe(1);+ expect(monthUtils.getQuarter('2024-03')).toBe(1);+ expect(monthUtils.getQuarter('2024-04')).toBe(2);+ expect(monthUtils.getQuarter('2024-06')).toBe(2);+ expect(monthUtils.getQuarter('2024-07')).toBe(3);+ expect(monthUtils.getQuarter('2024-09')).toBe(3);+ expect(monthUtils.getQuarter('2024-10')).toBe(4);+ expect(monthUtils.getQuarter('2024-12')).toBe(4);+});++test('getQuarterStart and getQuarterEnd return the bounding months of the quarter', () => {+ expect(monthUtils.getQuarterStart('2024-02')).toBe('2024-01');+ expect(monthUtils.getQuarterEnd('2024-02')).toBe('2024-03');+ expect(monthUtils.getQuarterStart('2024-11')).toBe('2024-10');+ expect(monthUtils.getQuarterEnd('2024-11')).toBe('2024-12');+});++test('prevQuarter subtracts three months, landing in the previous quarter', () => {+ expect(monthUtils.prevQuarter('2024-02')).toBe('2023-11');+ expect(monthUtils.prevQuarter('2024-01')).toBe('2023-10');+ expect(monthUtils.prevQuarter('2024-04')).toBe('2024-01');+});+test('isValidYearMonthDay validates the day against the month and year', () => {expect(monthUtils.isValidYearMonthDay('2024-02-29')).toBe(true);expect(monthUtils.isValidYearMonthDay('2023-02-29')).toBe(false);diff --git a/packages/loot-core/src/shared/months.ts b/packages/loot-core/src/shared/months.tsindex 690b1d116e..58c602d828 100644--- a/packages/loot-core/src/shared/months.ts+++ b/packages/loot-core/src/shared/months.ts@@ -186,6 +186,10 @@ export function prevYear(month: DateLike, format = 'yyyy-MM'): string {return d.format(d.subMonths(_parse(month), 12), format);}+export function prevQuarter(month: DateLike, format = 'yyyy-MM'): string {+ return d.format(d.subMonths(_parse(month), 3), format);+}+export function prevMonth(month: DateLike): string {return d.format(d.subMonths(_parse(month), 1), 'yyyy-MM');}@@ -413,6 +417,20 @@ export function getYearEnd(month: string): string {return getYear(month) + '-12';}+export function getQuarter(month: string): number {+ return Math.floor((Number(month.slice(5, 7)) - 1) / 3) + 1;+}++export function getQuarterStart(month: string): string {+ const startMonth = (getQuarter(month) - 1) * 3 + 1;+ return getYear(month) + '-' + String(startMonth).padStart(2, '0');+}++export function getQuarterEnd(month: string): string {+ const endMonth = getQuarter(month) * 3;+ return getYear(month) + '-' + String(endMonth).padStart(2, '0');+}+export function sheetForMonth(month: string): string {return 'budget' + month.replace('-', '');}diff --git a/packages/loot-core/src/types/models/dashboard.ts b/packages/loot-core/src/types/models/dashboard.tsindex b954f3bd5d..db9d0ec0f0 100644--- a/packages/loot-core/src/types/models/dashboard.ts+++ b/packages/loot-core/src/types/models/dashboard.ts@@ -18,7 +18,9 @@ export type TimeFrame = {| 'lastMonth'| 'lastYear'| 'yearToDate'- | 'priorYearToDate';+ | 'priorYearToDate'+ | 'currentQuarter'+ | 'previousQuarter';};type AbstractWidget<diff --git a/upcoming-release-notes/add-quarter-date-range-presets.md b/upcoming-release-notes/add-quarter-date-range-presets.mdnew file mode 100644index 0000000000..3e448555f0--- /dev/null+++ b/upcoming-release-notes/add-quarter-date-range-presets.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [ildyria]+---++Add Current Quarter and Previous Quarter presets to report date ranges