fix: add basic support for grid filters for Date fields

tests/grids/test_filters.py

@@ -1,8 +1,13 @@
 # -*- coding: utf-8; -*-
 
+import datetime
 from unittest import TestCase
 from unittest.mock import patch
 
+import sqlalchemy as sa
+
+from wuttjamaican.db.model import Base
+
 from wuttaweb.grids import filters as mod
 from tests.util import WebTestCase
 
@@ -422,6 +427,157 @@ class TestBooleanAlchemyFilter(WebTestCase):
         self.assertEqual(filtered_query.count(), 2)
 
 
+class TheLocalThing(Base):
+    __tablename__ = 'the_local_thing'
+    id = sa.Column(sa.Integer(), primary_key=True, autoincrement=False)
+    date = sa.Column(sa.DateTime(timezone=True), nullable=True)
+
+
+class TestDateAlchemyFilter(WebTestCase):
+
+    def setUp(self):
+        self.setup_web()
+        model = self.app.model
+
+        # nb. create table for TheLocalThing
+        model.Base.metadata.create_all(bind=self.session.bind)
+
+        self.sample_data = [
+            {'id': 1, 'date': datetime.date(2024, 1, 1)},
+            {'id': 2, 'date': datetime.date(2024, 1, 1)},
+            {'id': 3, 'date': datetime.date(2024, 3, 1)},
+            {'id': 4, 'date': datetime.date(2024, 3, 1)},
+            {'id': 5, 'date': None},
+            {'id': 6, 'date': None},
+        ]
+
+        for thing in self.sample_data:
+            thing = TheLocalThing(**thing)
+            self.session.add(thing)
+        self.session.commit()
+
+        self.sample_query = self.session.query(TheLocalThing)
+
+    def make_filter(self, model_property, **kwargs):
+        factory = kwargs.pop('factory', mod.DateAlchemyFilter)
+        kwargs['model_property'] = model_property
+        return factory(self.request, model_property.key, **kwargs)
+
+    def test_coerce_value(self):
+        filtr = self.make_filter(TheLocalThing.date)
+
+        # null value
+        self.assertIsNone(filtr.coerce_value(None))
+
+        # value as datetime
+        value = datetime.date(2024, 1, 1)
+        result = filtr.coerce_value(value)
+        self.assertIs(value, result)
+
+        # value as string
+        result = filtr.coerce_value('2024-04-01')
+        self.assertIsInstance(result, datetime.date)
+        self.assertEqual(result, datetime.date(2024, 4, 1))
+
+        # invalid
+        result = filtr.coerce_value('thisinputisbad')
+        self.assertIsNone(result)
+
+    def test_greater_than(self):
+        model = self.app.model
+
+        filtr = self.make_filter(TheLocalThing.date)
+        self.assertEqual(self.sample_query.count(), 6)
+
+        # null value ignored
+        filtered_query = filtr.filter_greater_than(self.sample_query, None)
+        self.assertIs(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 6)
+
+        # value as date
+        filtered_query = filtr.filter_greater_than(self.sample_query, datetime.date(2024, 2, 1))
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+        # value as string
+        filtered_query = filtr.filter_greater_than(self.sample_query, '2024-02-01')
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+    def test_greater_equal(self):
+        model = self.app.model
+
+        filtr = self.make_filter(TheLocalThing.date)
+        self.assertEqual(self.sample_query.count(), 6)
+
+        # null value ignored
+        filtered_query = filtr.filter_greater_equal(self.sample_query, None)
+        self.assertIs(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 6)
+
+        # value as date (clear of boundary)
+        filtered_query = filtr.filter_greater_equal(self.sample_query, datetime.date(2024, 2, 1))
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+        # value as date (at boundary)
+        filtered_query = filtr.filter_greater_equal(self.sample_query, datetime.date(2024, 3, 1))
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+        # value as string
+        filtered_query = filtr.filter_greater_equal(self.sample_query, '2024-01-01')
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 4)
+
+    def test_less_than(self):
+        model = self.app.model
+
+        filtr = self.make_filter(TheLocalThing.date)
+        self.assertEqual(self.sample_query.count(), 6)
+
+        # null value ignored
+        filtered_query = filtr.filter_less_than(self.sample_query, None)
+        self.assertIs(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 6)
+
+        # value as date
+        filtered_query = filtr.filter_less_than(self.sample_query, datetime.date(2024, 2, 1))
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+        # value as string
+        filtered_query = filtr.filter_less_than(self.sample_query, '2024-04-01')
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 4)
+
+    def test_less_equal(self):
+        model = self.app.model
+
+        filtr = self.make_filter(TheLocalThing.date)
+        self.assertEqual(self.sample_query.count(), 6)
+
+        # null value ignored
+        filtered_query = filtr.filter_less_equal(self.sample_query, None)
+        self.assertIs(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 6)
+
+        # value as date (clear of boundary)
+        filtered_query = filtr.filter_less_equal(self.sample_query, datetime.date(2024, 2, 1))
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+        # value as date (at boundary)
+        filtered_query = filtr.filter_less_equal(self.sample_query, datetime.date(2024, 3, 1))
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
+        # value as string
+        filtered_query = filtr.filter_less_equal(self.sample_query, '2024-04-01')
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 4)
+
+
 class TestVerbNotSupported(TestCase):
 
     def test_basic(self):