Merge pull request #673 from officialasishkumar/feat/filter-preset-relative-dates

feat(transactions): keep filter preset dates relative to today
This commit is contained in:
Herculino Trotta authored and GitHub committed 2026-11-14 11:41:04 -03:00
commit 304817470d
7 files changed
+274

No files matched your search

+54
View File
@@ -1,3 +1,5 @@
import datetime
import django_filters
from apps.accounts.models import Account
from apps.common.fields.month_year import MonthYearFormField
@@ -14,6 +16,7 @@ from apps.transactions.models import (
)
from crispy_forms.helper import FormHelper
from crispy_forms.layout import HTML, Column, Div, Field, Layout, Row
from dateutil.relativedelta import relativedelta
from django import forms
from django.db.models import Q
from django.utils.translation import gettext_lazy as _
@@ -62,6 +65,13 @@ class TransactionsFilter(django_filters.FilterSet):
"is_paid": {"1", "0"},
"mute_status": {"active", "muted"},
}
# How each date filter moves when a preset keeps its dates relative to today
relative_date_units = {
"date_start": "days",
"date_end": "days",
"reference_date_start": "months",
"reference_date_end": "months",
}
description = django_filters.CharFilter(
label=_("Content"),
@@ -332,6 +342,50 @@ class TransactionsFilter(django_filters.FilterSet):
return True
return False
def shift_dates(self, since, until):
"""
Move the date filters forward by the time elapsed between two dates.
Dates move by days and reference months by months, so a preset saved
from today, or for the current month, keeps meaning that later on.
A date range of whole months, like the 1st to the 31st, moves by
months instead, so it stays whole months.
Dates are read as ISO, or as typed in the user's format by presets saved
before they were stored as ISO, and written back in the user's format.
"""
months = (until.year - since.year) * 12 + until.month - since.month
shifts = {
"days": relativedelta(days=(until - since).days),
"months": relativedelta(months=months),
}
dates = {}
for name in self.relative_date_units:
for value in (self.data.get(name), self.form[name].data):
try:
dates[name] = datetime.date.fromisoformat(value)
break
except (TypeError, ValueError):
pass
start, end = dates.get("date_start"), dates.get("date_end")
whole_months = (
start
and end
and start.day == 1
and (end + datetime.timedelta(days=1)).day == 1
)
for name, value in dates.items():
shift = shifts[self.relative_date_units[name]]
if whole_months and name == "date_start":
shift = shifts["months"]
elif whole_months and name == "date_end":
# day=31 lands on the last day of the shifted month, whatever its length
shift = shifts["months"] + relativedelta(day=31)
self.data[name] = self.form.fields[name].widget.format_value(value + shift)
@staticmethod
def filter_category(queryset, name, value):
if not value:
@@ -0,0 +1,15 @@
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
("transactions", "0053_sub_transaction"),
]
operations = [
migrations.AddField(
model_name="filterpreset",
name="relative_to",
field=models.DateField(blank=True, null=True),
),
]
+3
View File
@@ -47,6 +47,9 @@ class FilterPreset(models.Model):
)
name = models.CharField(max_length=100)
parameters = models.JSONField(default=dict)
# When set, the saved dates are moved along with today when the preset is
# applied, keeping the distance they had to this date
relative_to = models.DateField(null=True, blank=True)
class Meta:
ordering = ["name", "id"]
@@ -1,3 +1,6 @@
import datetime
from unittest import mock
from django.contrib.auth import get_user_model
from django.test import TestCase, override_settings
from django.urls import reverse
@@ -51,6 +54,55 @@ class FilterPresetViewTests(TestCase):
)
self.assertContains(response, "Account X Unpaid")
def test_create_keeps_dates_relative_to_today_when_asked(self):
self.user.settings.date_format = "d/m/Y"
self.user.settings.save()
today = datetime.date(2026, 8, 20)
with mock.patch("django.utils.timezone.localdate", return_value=today):
self.client.post(
reverse("filter_preset_create"),
{
"name": "Today",
"date_start": "20/08/2026",
"relative_dates": "true",
},
HTTP_HX_REQUEST="true",
)
preset = FilterPreset.objects.get(owner=self.user, name="Today")
self.assertEqual(preset.relative_to, today)
self.assertEqual(preset.parameters, {"date_start": ["2026-08-20"]})
def test_create_keeps_dates_fixed_by_default(self):
self.client.post(
reverse("filter_preset_create"),
{
"name": "August",
"reference_date_start": "August 2026",
"relative_dates": "false",
},
HTTP_HX_REQUEST="true",
)
preset = FilterPreset.objects.get(owner=self.user, name="August")
self.assertIsNone(preset.relative_to)
def test_create_ignores_relative_dates_without_a_date_filter(self):
self.client.post(
reverse("filter_preset_create"),
{
"name": "Unpaid without dates",
"is_paid": ["0"],
"date_start": "",
"relative_dates": "true",
},
HTTP_HX_REQUEST="true",
)
preset = FilterPreset.objects.get(owner=self.user, name="Unpaid without dates")
self.assertIsNone(preset.relative_to)
def test_create_rejects_a_blank_name(self):
response = self.client.post(
reverse("filter_preset_create"),
@@ -82,6 +134,121 @@ class FilterPresetViewTests(TestCase):
"updated",
)
def test_apply_moves_relative_dates_along_with_today(self):
self.user.settings.date_format = "d/m/Y"
self.user.settings.save()
preset = FilterPreset.objects.create(
owner=self.user,
name="Next days",
parameters={
"date_start": ["20/08/2026"],
"date_end": ["31/08/2026"],
"reference_date_start": ["August 2026"],
"reference_date_end": ["September 2026"],
},
relative_to=datetime.date(2026, 8, 20),
)
with mock.patch(
"django.utils.timezone.localdate",
return_value=datetime.date(2027, 1, 5),
):
response = self.client.get(
reverse("filter_preset_apply", args=[preset.pk]),
HTTP_HX_REQUEST="true",
)
data = response.context["filter"].data
self.assertEqual(data["date_start"], "05/01/2027")
self.assertEqual(data["date_end"], "16/01/2027")
self.assertEqual(data["reference_date_start"], "January 2027")
self.assertEqual(data["reference_date_end"], "February 2027")
self.assertContains(response, 'data-value="2027-01-05"')
self.assertContains(response, 'data-value="2027-01-16"')
self.assertContains(response, 'data-value="2027-01-01"')
self.assertContains(response, 'data-value="2027-02-01"')
def test_apply_keeps_a_whole_month_range_on_whole_months(self):
self.user.settings.date_format = "d/m/Y"
self.user.settings.save()
preset = FilterPreset.objects.create(
owner=self.user,
name="This month",
parameters={"date_start": ["01/01/2027"], "date_end": ["31/01/2027"]},
relative_to=datetime.date(2027, 1, 20),
)
with mock.patch(
"django.utils.timezone.localdate",
return_value=datetime.date(2027, 2, 3),
):
response = self.client.get(
reverse("filter_preset_apply", args=[preset.pk]),
HTTP_HX_REQUEST="true",
)
self.assertContains(response, 'data-value="2027-02-01"')
self.assertContains(response, 'data-value="2027-02-28"')
def test_apply_shows_stored_dates_in_the_users_current_format(self):
self.user.settings.date_format = "m/d/Y"
self.user.settings.save()
preset = FilterPreset.objects.create(
owner=self.user,
name="August",
parameters={
"date_start": ["2026-08-20"],
"reference_date_start": ["2026-08-01"],
},
)
response = self.client.get(
reverse("filter_preset_apply", args=[preset.pk]),
HTTP_HX_REQUEST="true",
)
self.assertContains(response, 'data-value="2026-08-20"')
self.assertContains(response, 'value="August 2026"')
def test_apply_keeps_fixed_dates_unchanged(self):
self.user.settings.date_format = "d/m/Y"
self.user.settings.save()
preset = FilterPreset.objects.create(
owner=self.user,
name="August",
parameters={
"date_start": ["20/08/2026"],
"reference_date_start": ["August 2026"],
},
)
with mock.patch(
"django.utils.timezone.localdate",
return_value=datetime.date(2027, 1, 5),
):
response = self.client.get(
reverse("filter_preset_apply", args=[preset.pk]),
HTTP_HX_REQUEST="true",
)
data = response.context["filter"].data
self.assertEqual(data["date_start"], "20/08/2026")
self.assertEqual(data["reference_date_start"], "August 2026")
self.assertContains(response, 'data-value="2026-08-20"')
self.assertContains(response, 'data-value="2026-08-01"')
def test_presets_with_relative_dates_are_marked_in_the_list(self):
FilterPreset.objects.create(
owner=self.user,
name="Today",
parameters={"date_start": ["20/08/2026"]},
relative_to=datetime.date(2026, 8, 20),
)
response = self.client.get(reverse("transactions_all_index"))
self.assertContains(response, "Dates relative to today", count=1)
def test_clear_returns_the_default_filter_form_without_changing_the_url(self):
response = self.client.get(
"/transactions/filter/clear/",
@@ -715,10 +715,25 @@ def filter_preset_create(request):
for key in TransactionsFilter.base_filters
if key in request.POST
}
# Dates are stored as ISO, so a later change of date format or language
# doesn't stop the preset from reading them
date_form = TransactionsFilter(request.POST).form
for key in TransactionsFilter.relative_date_units:
if date_form[key].data:
parameters[key] = [date_form[key].data]
has_dates = any(
any(parameters.get(key, [])) for key in TransactionsFilter.relative_date_units
)
relative_to = None
if has_dates and request.POST.get("relative_dates") == "true":
relative_to = timezone.localdate(timezone.now())
FilterPreset.objects.create(
owner=request.user,
name=name,
parameters=parameters,
relative_to=relative_to,
)
return render(
request,
@@ -738,6 +753,10 @@ def filter_preset_apply(request, preset_id):
data.setlist(key, values)
transaction_filter = TransactionsFilter(data)
# Fixed presets shift by nothing, which still puts ISO dates in the user's format
today = timezone.localdate(timezone.now())
transaction_filter.shift_dates(since=preset.relative_to or today, until=today)
response = render(
request,
"transactions/fragments/filter_form.html",
@@ -11,16 +11,26 @@
hx-target="#filter-presets"
hx-swap="outerHTML">
<input id="filter-preset-name" type="hidden" name="name">
<input id="filter-preset-relative-dates" type="hidden" name="relative_dates">
<template id="filter-preset-relative-dates-option">
<label class="label cursor-pointer justify-center gap-2 whitespace-normal mt-4">
<input type="checkbox" class="checkbox checkbox-sm checkbox-primary">
<span>{% translate 'Keep dates relative to today' %}</span>
</label>
</template>
<button class="btn btn-outline btn-primary btn-sm" type="button"
data-title="{{ save_filter_preset_title }}"
data-input-label="{{ preset_name_label }}"
data-cancel-text="{{ cancel_label }}"
data-confirm-text="{{ save_label }}"
_="on click
set relativeDatesTemplate to #filter-preset-relative-dates-option
set relativeDatesOption to relativeDatesTemplate.content.firstElementChild.cloneNode(true)
call Swal.fire({title: @data-title,
input: 'text',
inputLabel: @data-input-label,
inputAttributes: {maxlength: '100'},
didOpen: \ popup -> Swal.getInput().after(relativeDatesOption),
showCancelButton: true,
cancelButtonText: @data-cancel-text,
confirmButtonText: @data-confirm-text,
@@ -32,7 +42,9 @@
if result.isConfirmed
set presetName to result.value.trim()
if presetName is not ''
set relativeDatesCheckbox to the first <input/> in relativeDatesOption
set #filter-preset-name.value to presetName
set #filter-preset-relative-dates.value to relativeDatesCheckbox.checked
trigger submit on #save-filter-preset
end
end">
@@ -15,6 +15,10 @@
hx-target="#filter"
hx-swap="outerHTML">
{{ preset.name }}
{% if preset.relative_to %}
<i class="fa-solid fa-clock-rotate-left fa-fw opacity-60"
title="{% translate 'Dates relative to today' %}"></i>
{% endif %}
</button>
<button class="btn btn-ghost btn-xs opacity-0 group-hover:opacity-100 focus:opacity-100"
type="button"