feat(filters): date-range filtering on PlayEventFilter.started/ended (#67)
Change PlayEventFilter.started/ended from StringCriterion to DateCriterion so they support GREATER_THAN / LESS_THAN / BETWEEN, enabling "finished in year Y" to be expressed through the filter system. PlayEvent.started/ended are DateField columns, so the criteria apply with bare field names (no __date lookup, unlike SessionFilter.timestamp_start which is a datetime). This mirrors the existing PurchaseFilter DateField precedent. Deserialization auto-switches via the field annotation and the serialized JSON shape is unchanged, so the type change is backward-compatible. Prerequisite for #65 Tier-2 stats-page filtered links. Part of #61. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
+2
-2
@@ -899,8 +899,8 @@ class PlayEventFilter(OperatorFilter):
|
|||||||
NOT: PlayEventFilter | None = None
|
NOT: PlayEventFilter | None = None
|
||||||
|
|
||||||
game: MultiCriterion | None = None # filters on game_id
|
game: MultiCriterion | None = None # filters on game_id
|
||||||
started: StringCriterion | None = None # date string
|
started: DateCriterion | None = None # DateField, bare lookup
|
||||||
ended: StringCriterion | None = None # date string
|
ended: DateCriterion | None = None # DateField, bare lookup
|
||||||
days_to_finish: IntCriterion | None = None
|
days_to_finish: IntCriterion | None = None
|
||||||
note: StringCriterion | None = None
|
note: StringCriterion | None = None
|
||||||
created_at: StringCriterion | None = None
|
created_at: StringCriterion | None = None
|
||||||
|
|||||||
@@ -1241,3 +1241,101 @@ class TestPurchaseFilterDates:
|
|||||||
assert out["date_purchased"]["value2"] == "2024-12-31"
|
assert out["date_purchased"]["value2"] == "2024-12-31"
|
||||||
assert out["date_purchased"]["modifier"] == Modifier.BETWEEN
|
assert out["date_purchased"]["modifier"] == Modifier.BETWEEN
|
||||||
assert out["date_refunded"]["modifier"] == Modifier.NOT_NULL
|
assert out["date_refunded"]["modifier"] == Modifier.NOT_NULL
|
||||||
|
|
||||||
|
|
||||||
|
class TestPlayEventFilterDates:
|
||||||
|
"""End-to-end: a PlayEventFilter built from JSON narrows the queryset
|
||||||
|
correctly across the started/ended DateCriterion fields. PlayEvent.started
|
||||||
|
and ended are DateField columns, so the criteria apply with bare field
|
||||||
|
names (no __date lookup)."""
|
||||||
|
|
||||||
|
def _seed(self):
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
from games.models import Game, Platform, PlayEvent
|
||||||
|
|
||||||
|
platform, _ = Platform.objects.get_or_create(name="Test", icon="test")
|
||||||
|
game = Game.objects.create(name="Test Game", platform=platform)
|
||||||
|
early = PlayEvent.objects.create(
|
||||||
|
game=game,
|
||||||
|
started=datetime.date(2024, 1, 10),
|
||||||
|
ended=datetime.date(2024, 1, 20),
|
||||||
|
)
|
||||||
|
mid = PlayEvent.objects.create(
|
||||||
|
game=game,
|
||||||
|
started=datetime.date(2024, 6, 1),
|
||||||
|
ended=datetime.date(2024, 6, 30),
|
||||||
|
)
|
||||||
|
late = PlayEvent.objects.create(
|
||||||
|
game=game,
|
||||||
|
started=datetime.date(2025, 2, 1),
|
||||||
|
ended=datetime.date(2025, 2, 15),
|
||||||
|
)
|
||||||
|
return {"early": early, "mid": mid, "late": late}
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
def test_ended_between_finds_year(self):
|
||||||
|
"""'Finished in 2024' expressed as a BETWEEN range over ended."""
|
||||||
|
from games.filters import PlayEventFilter
|
||||||
|
from games.models import PlayEvent
|
||||||
|
|
||||||
|
seeded = self._seed()
|
||||||
|
pf = PlayEventFilter.from_json(
|
||||||
|
{
|
||||||
|
"ended": {
|
||||||
|
"value": "2024-01-01",
|
||||||
|
"value2": "2024-12-31",
|
||||||
|
"modifier": "BETWEEN",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
results = set(PlayEvent.objects.filter(pf.to_q()))
|
||||||
|
assert results == {seeded["early"], seeded["mid"]}
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
def test_started_greater_than(self):
|
||||||
|
from games.filters import PlayEventFilter
|
||||||
|
from games.models import PlayEvent
|
||||||
|
|
||||||
|
seeded = self._seed()
|
||||||
|
pf = PlayEventFilter.from_json(
|
||||||
|
{"started": {"value": "2024-06-01", "modifier": "GREATER_THAN"}}
|
||||||
|
)
|
||||||
|
results = set(PlayEvent.objects.filter(pf.to_q()))
|
||||||
|
assert results == {seeded["late"]}
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
def test_ended_less_than(self):
|
||||||
|
from games.filters import PlayEventFilter
|
||||||
|
from games.models import PlayEvent
|
||||||
|
|
||||||
|
seeded = self._seed()
|
||||||
|
pf = PlayEventFilter.from_json(
|
||||||
|
{"ended": {"value": "2024-06-30", "modifier": "LESS_THAN"}}
|
||||||
|
)
|
||||||
|
results = set(PlayEvent.objects.filter(pf.to_q()))
|
||||||
|
assert results == {seeded["early"]}
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
def test_playevent_filter_json_round_trip(self):
|
||||||
|
"""PlayEventFilter started/ended survive json → object → json,
|
||||||
|
confirming DateCriterion is dispatched by from_json (not
|
||||||
|
StringCriterion)."""
|
||||||
|
from games.filters import PlayEventFilter
|
||||||
|
|
||||||
|
payload = {
|
||||||
|
"started": {"value": "2024-01-01", "modifier": "GREATER_THAN"},
|
||||||
|
"ended": {
|
||||||
|
"value": "2024-01-01",
|
||||||
|
"value2": "2024-12-31",
|
||||||
|
"modifier": "BETWEEN",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
pf = PlayEventFilter.from_json(payload)
|
||||||
|
assert isinstance(pf.started, DateCriterion)
|
||||||
|
assert isinstance(pf.ended, DateCriterion)
|
||||||
|
out = pf.to_json()
|
||||||
|
assert out["ended"]["value"] == "2024-01-01"
|
||||||
|
assert out["ended"]["value2"] == "2024-12-31"
|
||||||
|
assert out["ended"]["modifier"] == Modifier.BETWEEN
|
||||||
|
assert out["started"]["modifier"] == Modifier.GREATER_THAN
|
||||||
|
|||||||
Reference in New Issue
Block a user