WuttaWeb 0.20.1__tar.gz → 0.20.3__tar.gz

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to wuttaweb will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v0.20.3 (2025-01-14)
+
+### Fix
+
+- add `render_grid_tag()` as separate def block for index templates
+- add `click_handler` attr for GridAction
+
+## v0.20.2 (2025-01-14)
+
+### Fix
+
+- improve support for composite `model_key` in MasterView
+- let content header text be a bit longer
+- add optional `target` attr for GridAction
+- add `render_date()` method for grids
+
 ## v0.20.1 (2025-01-13)
 
 ### Fix

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.20.1
+Version: 0.20.3
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.20.1"
+version = "0.20.3"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/src/wuttaweb/grids/base.py

@@ -602,6 +602,7 @@ class Grid:
         * ``'batch_id'`` -> :meth:`render_batch_id()`
         * ``'boolean'`` -> :meth:`render_boolean()`
         * ``'currency'`` -> :meth:`render_currency()`
+        * ``'date'`` -> :meth:`render_date()`
         * ``'datetime'`` -> :meth:`render_datetime()`
         * ``'quantity'`` -> :meth:`render_quantity()`
 
@@ -611,6 +612,7 @@ class Grid:
             'batch_id': self.render_batch_id,
             'boolean': self.render_boolean,
             'currency': self.render_currency,
+            'date': self.render_date,
             'datetime': self.render_datetime,
             'quantity': self.render_quantity,
         }
@@ -631,11 +633,13 @@ class Grid:
         data type implies a default renderer.  This is only possible
         if :attr:`model_class` is set to a SQLAlchemy mapped class.
 
-        This only looks for a couple of data types, and configures as
+        This only looks for a few data types, and configures as
         follows:
 
         * :class:`sqlalchemy:sqlalchemy.types.Boolean` ->
           :meth:`render_boolean()`
+        * :class:`sqlalchemy:sqlalchemy.types.Date` ->
+          :meth:`render_date()`
         * :class:`sqlalchemy:sqlalchemy.types.DateTime` ->
           :meth:`render_datetime()`
         """
@@ -651,7 +655,9 @@ class Grid:
                 prop = getattr(attr, 'prop', None)
                 if prop and isinstance(prop, orm.ColumnProperty):
                     column = prop.columns[0]
-                    if isinstance(column.type, sa.DateTime):
+                    if isinstance(column.type, sa.Date):
+                        self.set_renderer(key, self.render_date)
+                    elif isinstance(column.type, sa.DateTime):
                         self.set_renderer(key, self.render_datetime)
                     elif isinstance(column.type, sa.Boolean):
                         self.set_renderer(key, self.render_boolean)
@@ -1820,7 +1826,7 @@ class Grid:
         This may be used automatically per
         :meth:`set_default_renderers()` or you can use it explicitly::
 
-            grid.set_renderer('foo', grid.render_boolean)
+            grid.set_renderer('foo', 'boolean')
         """
         return self.app.render_boolean(value)
 
@@ -1839,6 +1845,22 @@ class Grid:
         """
         return self.app.render_currency(value, **kwargs)
 
+    def render_date(self, obj, key, value):
+        """
+        Column renderer for :class:`python:datetime.date` values.
+
+        This calls
+        :meth:`~wuttjamaican:wuttjamaican.app.AppHandler.render_date()`
+        for the return value.
+
+        This may be used automatically per
+        :meth:`set_default_renderers()` or you can use it explicitly::
+
+            grid.set_renderer('foo', 'date')
+        """
+        dt = getattr(obj, key)
+        return self.app.render_date(dt)
+
     def render_datetime(self, obj, key, value):
         """
         Column renderer for :class:`python:datetime.datetime` values.
@@ -1850,7 +1872,7 @@ class Grid:
         This may be used automatically per
         :meth:`set_default_renderers()` or you can use it explicitly::
 
-            grid.set_renderer('foo', grid.render_datetime)
+            grid.set_renderer('foo', 'datetime')
         """
         dt = getattr(obj, key)
         return self.app.render_datetime(dt)
@@ -1865,7 +1887,7 @@ class Grid:
 
         This is not used automatically but you can use it explicitly::
 
-            grid.set_renderer('foo', grid.render_quantity)
+            grid.set_renderer('foo', 'quantity')
         """
         return self.app.render_quantity(value)
 
@@ -2258,6 +2280,20 @@ class GridAction:
 
        See also :meth:`get_url()`.
 
+    .. attribute:: target
+
+       Optional ``target`` attribute for the ``<a>`` tag.
+
+    .. attribute:: click_handler
+
+       Optional JS click handler for the action.  This value will be
+       rendered as-is within the final grid template, hence the JS
+       string must be callable code.  Note that ``props.row`` will be
+       available in the calling context, so a couple of examples:
+
+       * ``deleteThisThing(props.row)``
+       * ``$emit('do-something', props.row)``
+
     .. attribute:: icon
 
        Name of icon to be shown for the action link.
@@ -2275,6 +2311,8 @@ class GridAction:
             key,
             label=None,
             url=None,
+            target=None,
+            click_handler=None,
             icon=None,
             link_class=None,
     ):
@@ -2283,6 +2321,8 @@ class GridAction:
         self.app = self.config.get_app()
         self.key = key
         self.url = url
+        self.target = target
+        self.click_handler = click_handler
         self.label = label or self.app.make_title(key)
         self.icon = icon or key
         self.link_class = link_class or ''

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/src/wuttaweb/templates/base.mako

@@ -155,7 +155,7 @@
     }
 
     #content-title h1 {
-        max-width: 80%;
+        max-width: 85%;
         overflow: hidden;
         padding-left: 0.5rem;
         text-overflow: ellipsis;

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/src/wuttaweb/templates/grids/vue_template.mako

@@ -180,6 +180,12 @@
             % for action in grid.actions:
                 <a v-if="props.row._action_url_${action.key}"
                    :href="props.row._action_url_${action.key}"
+                   % if action.target:
+                       target="${action.target}"
+                   % endif
+                   % if action.click_handler:
+                       @click.prevent="${action.click_handler}"
+                   % endif
                    class="${action.link_class}">
                   ${action.render_icon_and_label()}
                 </a>

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/src/wuttaweb/templates/master/index.mako

@@ -8,10 +8,14 @@
 
 <%def name="page_content()">
   % if grid is not Undefined:
-      ${grid.render_vue_tag()}
+      ${self.render_grid_tag()}
   % endif
 </%def>
 
+<%def name="render_grid_tag()">
+  ${grid.render_vue_tag()}
+</%def>
+
 <%def name="render_vue_templates()">
   ${parent.render_vue_templates()}
   ${self.render_vue_template_grid()}

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/src/wuttaweb/views/master.py

@@ -2176,6 +2176,28 @@ class MasterView(View):
         """
         return str(instance) or "(no title)"
 
+    def get_action_route_kwargs(self, obj):
+        """
+        Get a dict of route kwargs for the given object.
+
+        This is called from :meth:`get_action_url()` and must return
+        kwargs suitable for use with ``request.route_url()``.
+
+        In practice this should return a dict which has keys for each
+        field from :meth:`get_model_key()` and values which come from
+        the object.
+
+        :param obj: Model instance object.
+
+        :returns: The dict of route kwargs for the object.
+        """
+        try:
+            return dict([(key, obj[key])
+                         for key in self.get_model_key()])
+        except TypeError:
+            return dict([(key, getattr(obj, key))
+                         for key in self.get_model_key()])
+
     def get_action_url(self, action, obj, **kwargs):
         """
         Generate an "action" URL for the given model instance.
@@ -2183,22 +2205,21 @@ class MasterView(View):
         This is a shortcut which generates a route name based on
         :meth:`get_route_prefix()` and the ``action`` param.
 
-        It returns the URL based on generated route name and object's
-        model key values.
+        It calls :meth:`get_action_route_kwargs()` and then passes
+        those along with route name to ``request.route_url()``, and
+        returns the result.
 
         :param action: String name for the action, which corresponds
            to part of some named route, e.g. ``'view'`` or ``'edit'``.
 
         :param obj: Model instance object.
+
+        :param \**kwargs: Additional kwargs to be passed to
+           ``request.route_url()``, if needed.
         """
-        route_prefix = self.get_route_prefix()
-        try:
-            kw = dict([(key, obj[key])
-                       for key in self.get_model_key()])
-        except TypeError:
-            kw = dict([(key, getattr(obj, key))
-                       for key in self.get_model_key()])
+        kw = self.get_action_route_kwargs(obj)
         kw.update(kwargs)
+        route_prefix = self.get_route_prefix()
         return self.request.route_url(f'{route_prefix}.{action}', **kw)
 
     def get_action_url_view(self, obj, i):
@@ -2729,7 +2750,7 @@ class MasterView(View):
             inspector = sa.inspect(model_class)
             keys = [col.name for col in inspector.primary_key]
             return tuple([prop.key for prop in inspector.column_attrs
-                          if [col.name for col in prop.columns] == keys])
+                          if all([col.name in keys for col in prop.columns])])
 
         raise AttributeError(f"you must define model_key for view class: {cls}")
 

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/tests/grids/test_base.py

@@ -213,7 +213,7 @@ class TestGrid(WebTestCase):
         obj = MagicMock(foo=42.00)
         self.assertEqual(grid.renderers['foo'](obj, 'foo', 42.00), '42')
 
-    def test_set_default_renderer(self):
+    def test_set_default_renderers(self):
         model = self.app.model
 
         # no defaults for "plain" schema
@@ -249,6 +249,18 @@ class TestGrid(WebTestCase):
         self.assertIn('executing', grid.renderers)
         self.assertIs(grid.renderers['executing'], myrender)
 
+        # nb. as of writing we have no Date columns in default schema,
+        # so must invent one to test that type
+        class SomeFoolery(model.Base):
+            __tablename__ = 'somefoolery'
+            id = sa.Column(sa.Integer(), primary_key=True)
+            created = sa.Column(sa.Date())
+
+        # renderer set for date mapped field
+        grid = self.make_grid(model_class=SomeFoolery)
+        self.assertIn('created', grid.renderers)
+        self.assertIsNot(grid.renderers['created'], myrender)
+
     def test_linked_columns(self):
         grid = self.make_grid(columns=['foo', 'bar'])
         self.assertEqual(grid.linked_columns, [])
@@ -1415,6 +1427,20 @@ class TestGrid(WebTestCase):
         # zero is *not* empty string (with this renderer)
         self.assertEqual(grid.render_quantity(obj, 'foo', 0), "0")
 
+    def test_render_date(self):
+        grid = self.make_grid(columns=['foo', 'bar'])
+
+        # null
+        obj = MagicMock(dt=None)
+        result = grid.render_date(obj, 'dt', None)
+        self.assertIsNone(result)
+
+        # typical
+        dt = datetime.date(2025, 1, 13)
+        obj = MagicMock(dt=dt)
+        result = grid.render_date(obj, 'dt', str(dt))
+        self.assertEqual(result, '2025-01-13')
+
     def test_render_datetime(self):
         grid = self.make_grid(columns=['foo', 'bar'])
 

{wuttaweb-0.20.1 → wuttaweb-0.20.3}/tests/views/test_master.py

@@ -750,6 +750,29 @@ class TestMasterView(WebTestCase):
             self.request.matchdict = {'name': 'blarg'}
             self.assertRaises(HTTPNotFound, view.get_instance, session=self.session)
 
+    def test_get_action_route_kwargs(self):
+        model = self.app.model
+        with patch.object(mod.MasterView, 'model_class', new=model.Setting, create=True):
+            view = self.make_view()
+
+            # dict object
+            setting = {'name': 'foo', 'value': 'bar'}
+            kw = view.get_action_route_kwargs(setting)
+            self.assertEqual(kw, {'name': 'foo'})
+
+            # mapped object
+            setting = model.Setting(name='foo', value='bar')
+            kw = view.get_action_route_kwargs(setting)
+            self.assertEqual(kw, {'name': 'foo'})
+
+            # non-standard object
+            class MySetting:
+                def __init__(self, **kw):
+                    self.__dict__.update(kw)
+            setting = MySetting(name='foo', value='bar')
+            kw = view.get_action_route_kwargs(setting)
+            self.assertEqual(kw, {'name': 'foo'})
+
     def test_get_action_url_for_dict(self):
         model = self.app.model
         setting = {'name': 'foo', 'value': 'bar'}