mirror of
https://github.com/eitchtee/WYGIWYH.git
synced 2026-11-16 13:51:26 +01:00
feat(transactions): add exclude tab to transaction filter
Split the filter into Include and Exclude tabs. Exclusions for content, accounts, currencies, categories, tags and entities are applied together with the existing filters, and are kept by presets, Clear and the active-filter indicator.
This commit is contained in:
1 parent
e552723078
commit
0d8de481d6
2 files changed
+183
-15
No files matched your search
@@ -12,7 +12,7 @@ from apps.transactions.models import (
|
||||
TransactionTag,
|
||||
)
|
||||
from crispy_forms.helper import FormHelper
|
||||
from crispy_forms.layout import Column, Field, Layout, Row
|
||||
from crispy_forms.layout import HTML, Column, Div, Field, Layout, Row
|
||||
from django import forms
|
||||
from django.db.models import Q
|
||||
from django.utils.translation import gettext_lazy as _
|
||||
@@ -36,6 +36,18 @@ def content_filter(queryset, name, value):
|
||||
return queryset
|
||||
|
||||
|
||||
def exclude_matching(positive_filter):
|
||||
"""Turn a positive filter method into one that drops the rows it would keep."""
|
||||
|
||||
def method(queryset, name, value):
|
||||
if not value:
|
||||
return queryset
|
||||
matching = positive_filter(queryset, name, value)
|
||||
return queryset.exclude(pk__in=matching.values("pk"))
|
||||
|
||||
return method
|
||||
|
||||
|
||||
class MonthYearFilter(Filter):
|
||||
field_class = MonthYearFormField
|
||||
|
||||
@@ -124,6 +136,42 @@ class TransactionsFilter(django_filters.FilterSet):
|
||||
lookup_expr="lte",
|
||||
label=_("Amount max"),
|
||||
)
|
||||
exclude_description = django_filters.CharFilter(
|
||||
label=_("Content"),
|
||||
method=exclude_matching(content_filter),
|
||||
widget=forms.TextInput(attrs={"type": "search"}),
|
||||
)
|
||||
exclude_account = django_filters.ModelMultipleChoiceFilter(
|
||||
field_name="account__name",
|
||||
queryset=Account.objects.all(),
|
||||
to_field_name="name",
|
||||
exclude=True,
|
||||
label=_("Accounts"),
|
||||
widget=TomSelectMultiple(checkboxes=True, remove_button=True, group_by="group"),
|
||||
)
|
||||
exclude_currency = django_filters.ModelMultipleChoiceFilter(
|
||||
field_name="account__currency",
|
||||
queryset=Currency.objects.all(),
|
||||
to_field_name="id",
|
||||
exclude=True,
|
||||
label=_("Currencies"),
|
||||
widget=TomSelectMultiple(checkboxes=True, remove_button=True),
|
||||
)
|
||||
exclude_category = django_filters.MultipleChoiceFilter(
|
||||
label=_("Categories"),
|
||||
widget=TomSelectMultiple(checkboxes=True, remove_button=True),
|
||||
method="filter_exclude_category",
|
||||
)
|
||||
exclude_tags = django_filters.MultipleChoiceFilter(
|
||||
label=_("Tags"),
|
||||
widget=TomSelectMultiple(checkboxes=True, remove_button=True),
|
||||
method="filter_exclude_tags",
|
||||
)
|
||||
exclude_entities = django_filters.MultipleChoiceFilter(
|
||||
label=_("Entities"),
|
||||
widget=TomSelectMultiple(checkboxes=True, remove_button=True),
|
||||
method="filter_exclude_entities",
|
||||
)
|
||||
|
||||
class Meta:
|
||||
model = Transaction
|
||||
@@ -178,21 +226,53 @@ class TransactionsFilter(django_filters.FilterSet):
|
||||
"mute_status",
|
||||
template="transactions/widgets/transaction_type_filter_buttons.html",
|
||||
),
|
||||
Field("description"),
|
||||
Row(Column("date_start"), Column("date_end")),
|
||||
Row(
|
||||
Column("reference_date_start"),
|
||||
Column("reference_date_end"),
|
||||
Div(
|
||||
HTML(
|
||||
'<div role="tablist" class="tabs tabs-border mb-2">'
|
||||
'<button type="button" role="tab" class="tab" '
|
||||
":class=\"{'tab-active': tab === 'include'}\" "
|
||||
":aria-selected=\"tab === 'include'\" "
|
||||
"@click=\"tab = 'include'\">"
|
||||
f"{_('Include')}</button>"
|
||||
'<button type="button" role="tab" class="tab" '
|
||||
":class=\"{'tab-active': tab === 'exclude'}\" "
|
||||
":aria-selected=\"tab === 'exclude'\" "
|
||||
"@click=\"tab = 'exclude'\">"
|
||||
f"{_('Exclude')}</button>"
|
||||
"</div>"
|
||||
),
|
||||
Div(
|
||||
Field("description"),
|
||||
Row(Column("date_start"), Column("date_end")),
|
||||
Row(
|
||||
Column("reference_date_start"),
|
||||
Column("reference_date_end"),
|
||||
),
|
||||
Row(
|
||||
Column("from_amount"),
|
||||
Column("to_amount"),
|
||||
),
|
||||
Field("account", size=1),
|
||||
Field("currency", size=1),
|
||||
Field("category", size=1),
|
||||
Field("tags", size=1),
|
||||
Field("entities", size=1),
|
||||
role="tabpanel",
|
||||
x_show="tab === 'include'",
|
||||
),
|
||||
Div(
|
||||
Field("exclude_description"),
|
||||
Field("exclude_account", size=1),
|
||||
Field("exclude_currency", size=1),
|
||||
Field("exclude_category", size=1),
|
||||
Field("exclude_tags", size=1),
|
||||
Field("exclude_entities", size=1),
|
||||
role="tabpanel",
|
||||
x_show="tab === 'exclude'",
|
||||
x_cloak="",
|
||||
),
|
||||
x_data="{ tab: 'include' }",
|
||||
),
|
||||
Row(
|
||||
Column("from_amount"),
|
||||
Column("to_amount"),
|
||||
),
|
||||
Field("account", size=1),
|
||||
Field("currency", size=1),
|
||||
Field("category", size=1),
|
||||
Field("tags", size=1),
|
||||
Field("entities", size=1),
|
||||
)
|
||||
|
||||
self.form.fields["to_amount"].widget = ArbitraryDecimalDisplayNumberInput()
|
||||
@@ -201,6 +281,7 @@ class TransactionsFilter(django_filters.FilterSet):
|
||||
self.form.fields["date_end"].widget = AirDatePickerInput()
|
||||
|
||||
self.form.fields["account"].queryset = Account.objects.all()
|
||||
self.form.fields["exclude_account"].queryset = Account.objects.all()
|
||||
category_choices = list(
|
||||
TransactionCategory.objects.values_list("name", "name").order_by("name")
|
||||
)
|
||||
@@ -209,11 +290,15 @@ class TransactionsFilter(django_filters.FilterSet):
|
||||
("uncategorized", _("Uncategorized")),
|
||||
]
|
||||
self.form.fields["category"].choices = custom_choices + category_choices
|
||||
self.form.fields["exclude_category"].choices = (
|
||||
custom_choices + category_choices
|
||||
)
|
||||
tag_choices = list(
|
||||
TransactionTag.objects.values_list("name", "name").order_by("name")
|
||||
)
|
||||
custom_tag_choices = [("any", _("Tagged")), ("untagged", _("Untagged"))]
|
||||
self.form.fields["tags"].choices = custom_tag_choices + tag_choices
|
||||
self.form.fields["exclude_tags"].choices = custom_tag_choices + tag_choices
|
||||
entity_choices = list(
|
||||
TransactionEntity.objects.values_list("name", "name").order_by("name")
|
||||
)
|
||||
@@ -222,6 +307,9 @@ class TransactionsFilter(django_filters.FilterSet):
|
||||
("no_entity", _("No entity")),
|
||||
]
|
||||
self.form.fields["entities"].choices = custom_entity_choices + entity_choices
|
||||
self.form.fields["exclude_entities"].choices = (
|
||||
custom_entity_choices + entity_choices
|
||||
)
|
||||
|
||||
@property
|
||||
def has_active_filters(self):
|
||||
@@ -309,6 +397,15 @@ class TransactionsFilter(django_filters.FilterSet):
|
||||
|
||||
return queryset
|
||||
|
||||
def filter_exclude_category(self, queryset, name, value):
|
||||
return exclude_matching(self.filter_category)(queryset, name, value)
|
||||
|
||||
def filter_exclude_tags(self, queryset, name, value):
|
||||
return exclude_matching(self.filter_tags)(queryset, name, value)
|
||||
|
||||
def filter_exclude_entities(self, queryset, name, value):
|
||||
return exclude_matching(self.filter_entities)(queryset, name, value)
|
||||
|
||||
@staticmethod
|
||||
def filter_mute_status(queryset, name, value):
|
||||
from apps.common.middleware.thread_local import get_current_user
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
from decimal import Decimal
|
||||
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.test import TestCase, override_settings
|
||||
from django.urls import reverse
|
||||
from django.utils import timezone
|
||||
|
||||
from apps.accounts.models import Account
|
||||
from apps.currencies.models import Currency
|
||||
from apps.transactions.models import Transaction, TransactionCategory, TransactionTag
|
||||
|
||||
|
||||
@override_settings(
|
||||
STORAGES={
|
||||
"default": {"BACKEND": "django.core.files.storage.FileSystemStorage"},
|
||||
"staticfiles": {
|
||||
"BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage"
|
||||
},
|
||||
},
|
||||
WHITENOISE_AUTOREFRESH=True,
|
||||
)
|
||||
class ExcludeFilterTests(TestCase):
|
||||
def setUp(self):
|
||||
self.user = get_user_model().objects.create_user(
|
||||
email="exclude@test.com", password="pass"
|
||||
)
|
||||
self.client.force_login(self.user)
|
||||
currency = Currency.objects.create(code="BRL", name="Real", decimal_places=2)
|
||||
self.account = Account.objects.create(name="Wallet", currency=currency)
|
||||
food = TransactionCategory.objects.create(name="Food")
|
||||
home = TransactionTag.objects.create(name="home")
|
||||
|
||||
self.make("Groceries", category=food).tags.add(home)
|
||||
self.make("Restaurant", category=food, notes="with friends")
|
||||
self.make("Rent").tags.add(home)
|
||||
self.make("Gift")
|
||||
|
||||
def make(self, description, **kwargs):
|
||||
today = timezone.localdate(timezone.now())
|
||||
return Transaction.objects.create(
|
||||
account=self.account,
|
||||
type=Transaction.Type.EXPENSE,
|
||||
date=today,
|
||||
reference_date=today.replace(day=1),
|
||||
amount=Decimal("10"),
|
||||
description=description,
|
||||
**kwargs,
|
||||
)
|
||||
|
||||
def listed(self, params):
|
||||
response = self.client.get(
|
||||
reverse("transactions_all_list"), params, HTTP_HX_REQUEST="true"
|
||||
)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
page = response.context["page_obj"]
|
||||
late = response.context["late_transactions"] or []
|
||||
return sorted(t.description for t in [*page, *late])
|
||||
|
||||
def test_exclusions_join_with_inclusions(self):
|
||||
cases = [
|
||||
({"exclude_category": ["Food"]}, ["Gift", "Rent"]),
|
||||
({"exclude_category": ["uncategorized"]}, ["Groceries", "Restaurant"]),
|
||||
({"exclude_tags": ["home"]}, ["Gift", "Restaurant"]),
|
||||
({"exclude_tags": ["untagged"]}, ["Groceries", "Rent"]),
|
||||
({"exclude_description": "friends"}, ["Gift", "Groceries", "Rent"]),
|
||||
({"exclude_account": ["Wallet"]}, []),
|
||||
# positive and negative filters are applied together
|
||||
({"category": ["Food"], "exclude_tags": ["home"]}, ["Restaurant"]),
|
||||
]
|
||||
for params, expected in cases:
|
||||
self.assertEqual(self.listed(params), expected, params)
|
||||
Reference in new issue
Block a user