Merge pull request #694 from officialasishkumar/feat/default-filter-preset

feat(transactions): open the transaction pages with a default filter preset
This commit is contained in:
Herculino Trotta authored and GitHub committed 2026-11-20 16:52:33 -03:00
commit a12bfdc91f
8 files changed
+215 -13

No files matched your search

+1 -1
View File
@@ -45,7 +45,7 @@ def monthly_overview(request, month: int, year: int):
previous_month = 12 if month == 1 else month - 1
previous_year = year - 1 if previous_month == 12 and month == 1 else year
f = TransactionsFilter(request.GET)
f = TransactionsFilter.for_page(request)
return render(
request,
+31
View File
@@ -8,6 +8,7 @@ from apps.common.widgets.decimal import ArbitraryDecimalDisplayNumberInput
from apps.common.widgets.tom_select import TomSelectMultiple
from apps.currencies.models import Currency
from apps.transactions.models import (
FilterPreset,
SubTransaction,
Transaction,
TransactionCategory,
@@ -19,6 +20,8 @@ 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.http import QueryDict
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
from django_filters import Filter
@@ -325,6 +328,34 @@ class TransactionsFilter(django_filters.FilterSet):
custom_entity_choices + entity_choices
)
@classmethod
def from_preset(cls, preset):
"""The filter a preset saved, with relative dates moved to today."""
data = QueryDict(mutable=True)
for key, values in preset.parameters.items():
if key in cls.base_filters:
data.setlist(key, values)
transaction_filter = cls(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)
return transaction_filter
@classmethod
def for_page(cls, request):
"""
The filter a page opens with: the one in its URL or, when the URL
has none, the user's default preset.
"""
if not any(key in request.GET for key in cls.base_filters):
preset = FilterPreset.objects.filter(
owner=request.user, is_default=True
).first()
if preset:
return cls.from_preset(preset)
return cls(request.GET)
@property
def has_active_filters(self):
for name in self.base_filters:
@@ -0,0 +1,24 @@
# Generated by Django 5.2.17 on 2026-11-19 20:42
from django.conf import settings
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('transactions', '0055_transactioncategory_auto_match_and_more'),
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
]
operations = [
migrations.AddField(
model_name='filterpreset',
name='is_default',
field=models.BooleanField(default=False),
),
migrations.AddConstraint(
model_name='filterpreset',
constraint=models.UniqueConstraint(condition=models.Q(('is_default', True)), fields=('owner',), name='unique_default_filter_preset'),
),
]
+10
View File
@@ -50,9 +50,19 @@ class FilterPreset(models.Model):
# 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)
# Applied when a page with the transaction filter opens without filters
# of its own. A user has at most one.
is_default = models.BooleanField(default=False)
class Meta:
ordering = ["name", "id"]
constraints = [
models.UniqueConstraint(
fields=["owner"],
condition=Q(is_default=True),
name="unique_default_filter_preset",
),
]
def __str__(self):
return self.name
@@ -2,6 +2,7 @@ import datetime
from unittest import mock
from django.contrib.auth import get_user_model
from django.db import IntegrityError
from django.test import TestCase, override_settings
from django.urls import reverse
@@ -272,7 +273,7 @@ class FilterPresetViewTests(TestCase):
"updated",
)
def test_other_users_cannot_apply_or_delete_a_preset(self):
def test_other_users_cannot_apply_delete_or_default_a_preset(self):
self.client.force_login(self.other_user)
apply_response = self.client.get(
@@ -283,10 +284,119 @@ class FilterPresetViewTests(TestCase):
reverse("filter_preset_delete", args=[self.preset.pk]),
HTTP_HX_REQUEST="true",
)
default_response = self.client.post(
reverse("filter_preset_toggle_default", args=[self.preset.pk]),
HTTP_HX_REQUEST="true",
)
self.assertEqual(apply_response.status_code, 404)
self.assertEqual(delete_response.status_code, 404)
self.assertTrue(FilterPreset.objects.filter(pk=self.preset.pk).exists())
self.assertEqual(default_response.status_code, 404)
self.preset.refresh_from_db()
self.assertFalse(self.preset.is_default)
def test_toggle_default_sets_and_unsets_the_default_preset(self):
url = reverse("filter_preset_toggle_default", args=[self.preset.pk])
response = self.client.post(url, HTTP_HX_REQUEST="true")
self.assertEqual(response.status_code, 200)
self.preset.refresh_from_db()
self.assertTrue(self.preset.is_default)
self.assertContains(response, 'id="filter-presets"')
self.assertContains(response, 'aria-pressed="true"', count=1)
response = self.client.post(url, HTTP_HX_REQUEST="true")
self.preset.refresh_from_db()
self.assertFalse(self.preset.is_default)
self.assertNotContains(response, 'aria-pressed="true"')
def test_toggle_default_moves_the_default_from_the_previous_preset(self):
self.preset.is_default = True
self.preset.save()
other_users_default = FilterPreset.objects.create(
owner=self.other_user, name="Theirs", is_default=True
)
income = FilterPreset.objects.create(
owner=self.user, name="Income", parameters={"type": ["IN"]}
)
self.client.post(
reverse("filter_preset_toggle_default", args=[income.pk]),
HTTP_HX_REQUEST="true",
)
self.assertEqual(
list(FilterPreset.objects.filter(owner=self.user, is_default=True)),
[income],
)
other_users_default.refresh_from_db()
self.assertTrue(other_users_default.is_default)
def test_a_user_cannot_have_two_default_presets(self):
self.preset.is_default = True
self.preset.save()
with self.assertRaises(IntegrityError):
FilterPreset.objects.create(
owner=self.user, name="Second default", is_default=True
)
def test_all_transactions_page_opens_with_the_default_preset(self):
self.user.settings.date_format = "d/m/Y"
self.user.settings.save()
FilterPreset.objects.create(
owner=self.user,
name="From today",
parameters={"is_paid": ["1"], "date_start": ["2026-08-20"]},
relative_to=datetime.date(2026, 8, 20),
is_default=True,
)
with mock.patch(
"django.utils.timezone.localdate",
return_value=datetime.date(2027, 1, 5),
):
response = self.client.get(reverse("transactions_all_index"))
data = response.context["filter"].data
self.assertEqual(data.getlist("is_paid"), ["1"])
self.assertEqual(data["date_start"], "05/01/2027")
self.assertContains(response, 'data-value="2027-01-05"')
self.assertIs(response.context["filter_is_active"], True)
def test_filters_in_the_url_take_precedence_over_the_default_preset(self):
self.preset.is_default = True
self.preset.save()
response = self.client.get(reverse("transactions_all_index"), {"type": ["IN"]})
data = response.context["filter"].data
self.assertEqual(data.getlist("type"), ["IN"])
self.assertEqual(data.getlist("is_paid"), ["1", "0"])
def test_all_transactions_page_ignores_presets_that_are_not_default(self):
response = self.client.get(reverse("transactions_all_index"))
self.assertIs(response.context["filter_is_active"], False)
def test_monthly_page_opens_with_the_default_preset(self):
self.preset.is_default = True
self.preset.save()
FilterPreset.objects.create(
owner=self.other_user,
name="Theirs",
parameters={"type": ["IN"]},
is_default=True,
)
response = self.client.get(reverse("monthly_overview", args=[8, 2026]))
data = response.context["filter"].data
self.assertEqual(data.getlist("is_paid"), ["0"])
self.assertEqual(data.getlist("type"), ["IN", "EX"])
self.assertIs(response.context["filter_is_active"], True)
def test_delete_removes_the_current_users_preset(self):
response = self.client.post(
+5
View File
@@ -16,6 +16,11 @@ urlpatterns = [
views.filter_preset_apply,
name="filter_preset_apply",
),
path(
"transactions/filter-presets/<int:preset_id>/toggle-default/",
views.filter_preset_toggle_default,
name="filter_preset_toggle_default",
),
path(
"transactions/filter-presets/<int:preset_id>/delete/",
views.filter_preset_delete,
+22 -10
View File
@@ -28,6 +28,7 @@ from dateutil.relativedelta import relativedelta
from django.contrib import messages
from django.contrib.auth.decorators import login_required
from django.core.paginator import Paginator
from django.db import transaction as db_transaction
from django.db.models import Case, F, IntegerField, Q, Value, When
from django.http import FileResponse, Http404, HttpResponse, JsonResponse, QueryDict
from django.shortcuts import get_object_or_404, render
@@ -688,7 +689,7 @@ def transaction_all_index(request):
order = request.session.get("all_transactions_order", "default")
summary_tab = request.session.get("transaction_all_summary_tab", "currency")
f = TransactionsFilter(request.GET)
f = TransactionsFilter.for_page(request)
return render(
request,
"transactions/pages/transactions.html",
@@ -747,15 +748,7 @@ def filter_preset_create(request):
@require_http_methods(["GET"])
def filter_preset_apply(request, preset_id):
preset = get_object_or_404(FilterPreset, pk=preset_id, owner=request.user)
data = QueryDict(mutable=True)
for key, values in preset.parameters.items():
if key in TransactionsFilter.base_filters:
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)
transaction_filter = TransactionsFilter.from_preset(preset)
response = render(
request,
@@ -770,6 +763,25 @@ def filter_preset_apply(request, preset_id):
return response
@only_htmx
@login_required
@require_http_methods(["POST"])
def filter_preset_toggle_default(request, preset_id):
preset = get_object_or_404(FilterPreset, pk=preset_id, owner=request.user)
with db_transaction.atomic():
# A user has a single default preset
FilterPreset.objects.filter(owner=request.user, is_default=True).exclude(
pk=preset.pk
).update(is_default=False)
preset.is_default = not preset.is_default
preset.save(update_fields=["is_default"])
return render(
request,
"transactions/fragments/filter_presets.html",
{"filter_presets": FilterPreset.objects.filter(owner=request.user)},
)
@only_htmx
@login_required
@require_http_methods(["GET"])
@@ -20,6 +20,16 @@
title="{% translate 'Dates relative to today' %}"></i>
{% endif %}
</button>
<button class="btn btn-ghost btn-xs {% if not preset.is_default %}opacity-0 group-hover:opacity-100 focus:opacity-100{% endif %}"
type="button"
title="{% if preset.is_default %}{% translate 'Default preset, applied when the page opens' %}{% else %}{% translate 'Set as default' %}{% endif %}"
aria-label="{% blocktranslate with name=preset.name %}Use {{ name }} as default{% endblocktranslate %}"
aria-pressed="{{ preset.is_default|yesno:'true,false' }}"
hx-post="{% url 'filter_preset_toggle_default' preset.id %}"
hx-target="#filter-presets"
hx-swap="outerHTML">
<i class="{% if preset.is_default %}fa-solid text-warning{% else %}fa-regular{% endif %} fa-star fa-fw"></i>
</button>
<button class="btn btn-ghost btn-xs opacity-0 group-hover:opacity-100 focus:opacity-100"
type="button"
aria-label="{% blocktranslate with name=preset.name %}Delete {{ name }}{% endblocktranslate %}"