WuttaWeb 0.16.0__tar.gz → 0.16.2__tar.gz

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/CHANGELOG.md

@@ -5,6 +5,21 @@ 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.16.2 (2024-12-10)
+
+### Fix
+
+- add `GridWidget` and `form.set_grid()` for convenience
+- add "is false or null" grid filter, for nullable bool columns
+- remove Person column for `Person.users` grid display
+- flatten UUID to str for `make_json_safe()`
+
+## v0.16.1 (2024-12-08)
+
+### Fix
+
+- refactor to reflect usage of proper UUID values
+
 ## v0.16.0 (2024-12-05)
 
 ### Feat

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: WuttaWeb
-Version: 0.16.0
+Version: 0.16.2
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -36,7 +36,7 @@ Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.16.1
+Requires-Dist: wuttjamaican[db]>=0.17.1
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'

wuttaweb-0.16.2/docs/glossary.rst

@@ -0,0 +1,15 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+   :sorted:
+
+   grid
+     This refers to a "table of data, with features" essentially.
+     Sometimes it may be displayed as a simple table with no features,
+     or sometimes it has sortable columns, search filters and other
+     tools.
+
+     See also the :class:`~wuttaweb.grids.base.Grid` base class.

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.16.0"
+version = "0.16.2"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]
@@ -42,7 +42,7 @@ dependencies = [
         "pyramid_tm",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.16.1",
+        "WuttJamaican[db]>=0.17.1",
         "zope.sqlalchemy>=1.5",
 ]
 

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/forms/base.py

@@ -474,6 +474,34 @@ class Form:
         if self.schema and key in self.schema:
             self.schema[key].widget = widget
 
+    def set_grid(self, key, grid):
+        """
+        Establish a :term:`grid` to be displayed for a field.  This
+        uses a :class:`~wuttaweb.forms.widgets.GridWidget` to wrap the
+        rendered grid.
+
+        :param key: Name of field.
+
+        :param widget: :class:`~wuttaweb.grids.base.Grid` instance,
+           pre-configured and (usually) with data.
+        """
+        from wuttaweb.forms.widgets import GridWidget
+
+        widget = GridWidget(self.request, grid)
+        self.set_widget(key, widget)
+        self.add_grid_vue_context(grid)
+
+    def add_grid_vue_context(self, grid):
+        """ """
+        if not grid.key:
+            raise ValueError("grid must have a key!")
+
+        if grid.key in self.grid_vue_context:
+            log.warning("grid data with key '%s' already registered, "
+                        "but will be replaced", grid.key)
+
+        self.grid_vue_context[grid.key] = grid.get_vue_context()
+
     def set_validator(self, key, validator):
         """
         Set/override the validator for a field, or the form.
@@ -848,17 +876,6 @@ class Form:
         output = render(template, context)
         return HTML.literal(output)
 
-    def add_grid_vue_context(self, grid):
-        """ """
-        if not grid.key:
-            raise ValueError("grid must have a key!")
-
-        if grid.key in self.grid_vue_context:
-            log.warning("grid data with key '%s' already registered, "
-                        "but will be replaced", grid.key)
-
-        self.grid_vue_context[grid.key] = grid.get_vue_context()
-
     def render_vue_field(
             self,
             fieldname,

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/forms/schema.py

@@ -24,6 +24,8 @@
 Form schema types
 """
 
+import uuid as _uuid
+
 import colander
 
 from wuttaweb.db import Session
@@ -212,7 +214,7 @@ class ObjectRef(colander.SchemaType):
         node.model_instance = appstruct
 
         # serialize to uuid
-        return appstruct.uuid
+        return appstruct.uuid.hex
 
     def deserialize(self, node, cstruct):
         """ """
@@ -246,7 +248,14 @@ class ObjectRef(colander.SchemaType):
 
         # fetch object from DB
         model = self.app.model
-        obj = self.session.get(self.model_class, value)
+        obj = None
+        if isinstance(value, _uuid.UUID):
+            obj = self.session.get(self.model_class, value)
+        else:
+            try:
+                obj = self.session.get(self.model_class, _uuid.UUID(value))
+            except ValueError:
+                pass
 
         # raise error if not found
         if not obj:
@@ -287,7 +296,7 @@ class ObjectRef(colander.SchemaType):
         if 'values' not in kwargs:
             query = self.get_query()
             objects = query.all()
-            values = [(obj.uuid, str(obj))
+            values = [(obj.uuid.hex, str(obj))
                       for obj in objects]
             if self.empty_option:
                 values.insert(0, self.empty_option)

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/forms/widgets.py

@@ -210,6 +210,44 @@ class FileDownloadWidget(Widget):
         return humanize.naturalsize(size)
 
 
+class GridWidget(Widget):
+    """
+    Widget for fields whose data is represented by a :term:`grid`.
+
+    This is a subclass of :class:`deform:deform.widget.Widget` but
+    does not use any Deform templates.
+
+    This widget only supports "readonly" mode, is not editable.  It is
+    merely a convenience around the grid itself, which does the heavy
+    lifting.
+
+    Instead of creating this widget directly you probably should call
+    :meth:`~wuttaweb.forms.base.Form.set_grid()` on your form.
+
+    :param request: Current :term:`request` object.
+
+    :param grid: :class:`~wuttaweb.grids.base.Grid` instance, used to
+       display the field data.
+    """
+
+    def __init__(self, request, grid, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.request = request
+        self.grid = grid
+
+    def serialize(self, field, cstruct, **kw):
+        """
+        This widget simply calls
+        :meth:`~wuttaweb.grids.base.Grid.render_table_element()` on
+        the ``grid`` to serialize.
+        """
+        readonly = kw.get('readonly', self.readonly)
+        if not readonly:
+            raise NotImplementedError("edit not allowed for this widget")
+
+        return self.grid.render_table_element()
+
+
 class RoleRefsWidget(WuttaCheckboxChoiceWidget):
     """
     Widget for use with User
@@ -280,7 +318,7 @@ class UserRefsWidget(WuttaCheckboxChoiceWidget):
             raise NotImplementedError("edit not allowed for this widget")
 
         model = self.app.model
-        columns = ['person', 'username', 'active']
+        columns = ['username', 'active']
 
         # generate data set for users
         users = []

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/grids/base.py

@@ -56,7 +56,7 @@ Elements of :attr:`~Grid.sort_defaults` will be of this type.
 
 class Grid:
     """
-    Base class for all grids.
+    Base class for all :term:`grids <grid>`.
 
     :param request: Reference to current :term:`request` object.
 

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/grids/filters.py

@@ -116,20 +116,22 @@ class GridFilter:
         'is_any':               "is any",
         'equal':                "equal to",
         'not_equal':            "not equal to",
-        'is_null':              "is null",
-        'is_not_null':          "is not null",
         'is_true':              "is true",
         'is_false':             "is false",
+        'is_false_null':        "is false or null",
+        'is_null':              "is null",
+        'is_not_null':          "is not null",
         'contains':             "contains",
         'does_not_contain':     "does not contain",
     }
 
     valueless_verbs = [
         'is_any',
-        'is_null',
-        'is_not_null',
         'is_true',
         'is_false',
+        'is_false_null',
+        'is_null',
+        'is_not_null',
     ]
 
     def __init__(
@@ -416,6 +418,27 @@ class BooleanAlchemyFilter(AlchemyFilter):
     """
     default_verbs = ['is_true', 'is_false']
 
+    def get_verbs(self):
+        """ """
+
+        # get basic verbs from caller, or default list
+        verbs = getattr(self, 'verbs', self.default_verbs)
+        if callable(verbs):
+            verbs = verbs()
+        verbs = list(verbs)
+
+        # add some more if column is nullable
+        if self.nullable:
+            for verb in ('is_false_null', 'is_null', 'is_not_null'):
+                if verb not in verbs:
+                    verbs.append(verb)
+
+        # add wildcard
+        if 'is_any' not in verbs:
+            verbs.append('is_any')
+
+        return verbs
+
     def coerce_value(self, value):
         """ """
         if value is not None:
@@ -435,6 +458,14 @@ class BooleanAlchemyFilter(AlchemyFilter):
         """
         return query.filter(self.model_property == False)
 
+    def filter_is_false_null(self, query, value):
+        """
+        Filter data with "is false or null" condition.  The value is
+        ignored.
+        """
+        return query.filter(sa.or_(self.model_property == False,
+                                   self.model_property == None))
+
 
 default_sqlalchemy_filters = {
     None: AlchemyFilter,

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/templates/base.mako

@@ -563,7 +563,7 @@
 
     const WuttaFeedbackFormData = {
         referrer: null,
-        userUUID: ${json.dumps(request.user.uuid if request.user else None)|n},
+        userUUID: ${json.dumps(request.user.uuid.hex if request.user else None)|n},
         userName: ${json.dumps(str(request.user) if request.user else None)|n},
         showDialog: false,
         sendingFeedback: false,

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/src/wuttaweb/util.py

@@ -27,6 +27,7 @@ Web Utilities
 import importlib
 import json
 import logging
+import uuid as _uuid
 import warnings
 
 import sqlalchemy as sa
@@ -531,6 +532,10 @@ def make_json_safe(value, key=None, warn=True):
             parent[key] = make_json_safe(value, key=key, warn=warn)
         value = parent
 
+    # convert UUID to str
+    if isinstance(value, _uuid.UUID):
+        value = value.hex
+
     # ensure JSON-compatibility, warn if problems
     try:
         json.dumps(value)

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/forms/test_base.py

@@ -142,6 +142,20 @@ class TestForm(TestCase):
         self.assertIs(form.widgets['foo'], new_widget)
         self.assertIs(schema['foo'].widget, new_widget)
 
+    def test_set_grid(self):
+        form = self.make_form(fields=['foo', 'bar'])
+        self.assertNotIn('foo', form.widgets)
+        self.assertNotIn('foogrid', form.grid_vue_context)
+
+        grid = Grid(self.request, key='foogrid',
+                    columns=['a', 'b'],
+                    data=[{'a': 1, 'b': 2}, {'a': 3, 'b': 4}])
+
+        form.set_grid('foo', grid)
+        self.assertIn('foo', form.widgets)
+        self.assertIsInstance(form.widgets['foo'], widgets.GridWidget)
+        self.assertIn('foogrid', form.grid_vue_context)
+
     def test_set_validator(self):
         form = self.make_form(fields=['foo', 'bar'])
         self.assertEqual(form.validators, {})

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/forms/test_schema.py

@@ -100,7 +100,7 @@ class TestObjectRef(DataTestCase):
         self.assertIsNotNone(person.uuid)
         typ = mod.ObjectRef(self.request)
         value = typ.serialize(node, person)
-        self.assertEqual(value, person.uuid)
+        self.assertEqual(value, person.uuid.hex)
 
     def test_deserialize(self):
         model = self.app.model

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/forms/test_widgets.py

@@ -6,6 +6,7 @@ import colander
 import deform
 from pyramid import testing
 
+from wuttaweb import grids
 from wuttaweb.forms import widgets as mod
 from wuttaweb.forms.schema import FileDownload, PersonRef, RoleRefs, UserRefs, Permissions
 from tests.util import WebTestCase
@@ -117,6 +118,31 @@ class TestFileDownloadWidget(WebTestCase):
         self.assertEqual(html2, html)
 
 
+class TestGridWidget(WebTestCase):
+
+    def make_field(self, node, **kwargs):
+        # TODO: not sure why default renderer is in use even though
+        # pyramid_deform was included in setup?  but this works..
+        kwargs.setdefault('renderer', deform.Form.default_renderer)
+        return deform.Field(node, **kwargs)
+
+    def test_serialize(self):
+        grid = grids.Grid(self.request,
+                          columns=['foo', 'bar'],
+                          data=[{'foo': 1, 'bar': 2}, {'foo': 3, 'bar': 4}])
+
+        node = colander.SchemaNode(colander.String())
+        widget = mod.GridWidget(self.request, grid)
+        field = self.make_field(node)
+
+        # readonly works okay
+        html = widget.serialize(field, None, readonly=True)
+        self.assertIn('<b-table ', html)
+
+        # but otherwise, error
+        self.assertRaises(NotImplementedError, widget.serialize, field, None)
+
+
 class TestRoleRefsWidget(WebTestCase):
 
     def make_field(self, node, **kwargs):
@@ -146,14 +172,14 @@ class TestRoleRefsWidget(WebTestCase):
 
         # editable values list *excludes* admin (by default)
         html = widget.serialize(field, {admin.uuid, blokes.uuid})
-        self.assertNotIn(admin.uuid, html)
-        self.assertIn(blokes.uuid, html)
+        self.assertNotIn(str(admin.uuid), html)
+        self.assertIn(str(blokes.uuid), html)
 
         # but admin is included for root user
         self.request.is_root = True
         html = widget.serialize(field, {admin.uuid, blokes.uuid})
-        self.assertIn(admin.uuid, html)
-        self.assertIn(blokes.uuid, html)
+        self.assertIn(str(admin.uuid), html)
+        self.assertIn(str(blokes.uuid), html)
 
 
 class TestUserRefsWidget(WebTestCase):

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/grids/test_filters.py

@@ -328,9 +328,15 @@ class TestBooleanAlchemyFilter(WebTestCase):
 
         model = self.app.model
         self.sample_data = [
-            {'username': 'alice', 'active': True},
-            {'username': 'bob', 'active': True},
-            {'username': 'charlie', 'active': False},
+            {'username': 'alice',
+             'prevent_edit': False,
+             'active': True},
+            {'username': 'bob',
+             'prevent_edit': True,
+             'active': True},
+            {'username': 'charlie',
+             'active': False,
+             'prevent_edit': None},
         ]
         for user in self.sample_data:
             user = model.User(**user)
@@ -343,6 +349,34 @@ class TestBooleanAlchemyFilter(WebTestCase):
         kwargs['model_property'] = model_property
         return factory(self.request, model_property.key, **kwargs)
 
+    def test_get_verbs(self):
+        model = self.app.model
+
+        # bool field, not nullable
+        filtr = self.make_filter(model.User.active,
+                                 factory=mod.BooleanAlchemyFilter,
+                                 nullable=False)
+        self.assertFalse(hasattr(filtr, 'verbs'))
+        self.assertEqual(filtr.default_verbs, ['is_true', 'is_false'])
+
+        # by default, returns default verbs (plus 'is_any')
+        self.assertEqual(filtr.get_verbs(), ['is_true', 'is_false', 'is_any'])
+
+        # default verbs can be a callable
+        filtr.default_verbs = lambda: ['foo', 'bar']
+        self.assertEqual(filtr.get_verbs(), ['foo', 'bar', 'is_any'])
+
+        # bool field, *nullable*
+        filtr = self.make_filter(model.User.active,
+                                 factory=mod.BooleanAlchemyFilter,
+                                 nullable=True)
+        self.assertFalse(hasattr(filtr, 'verbs'))
+        self.assertEqual(filtr.default_verbs, ['is_true', 'is_false'])
+
+        # effective verbs also include is_false_null
+        self.assertEqual(filtr.get_verbs(), ['is_true', 'is_false', 'is_false_null',
+                                             'is_null', 'is_not_null', 'is_any'])
+
     def test_coerce_value(self):
         model = self.app.model
         filtr = self.make_filter(model.User.active)
@@ -377,6 +411,16 @@ class TestBooleanAlchemyFilter(WebTestCase):
         self.assertIsNot(filtered_query, self.sample_query)
         self.assertEqual(filtered_query.count(), 1)
 
+    def test_filter_is_false_null(self):
+        model = self.app.model
+        filtr = self.make_filter(model.User.prevent_edit)
+        self.assertEqual(self.sample_query.count(), 3)
+
+        # nb. only one account is marked with "prevent edit"
+        filtered_query = filtr.filter_is_false_null(self.sample_query, None)
+        self.assertIsNot(filtered_query, self.sample_query)
+        self.assertEqual(filtered_query.count(), 2)
+
 
 class TestVerbNotSupported(TestCase):
 

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/test_auth.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8; -*-
 
+import uuid as _uuid
 from unittest import TestCase
 from unittest.mock import MagicMock
 
@@ -90,7 +91,7 @@ class TestWuttaSecurityPolicy(TestCase):
 
         # invalid identity yields no user
         self.policy = self.make_policy()
-        self.policy.remember(self.request, 'bogus-user-uuid')
+        self.policy.remember(self.request, _uuid.uuid4()) # random uuid
         user = self.policy.identity(self.request)
         self.assertIsNone(user)
 

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/test_util.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8; -*-
 
 import json
+import uuid as _uuid
 from unittest import TestCase
 from unittest.mock import patch, MagicMock
 
@@ -564,6 +565,11 @@ class TestMakeJsonSafe(TestCase):
         value = mod.make_json_safe(person, key='person')
         self.assertEqual(value, "Betty Boop")
 
+    def test_uuid(self):
+        uuid = _uuid.uuid4()
+        value = mod.make_json_safe(uuid)
+        self.assertEqual(value, uuid.hex)
+
     def test_dict(self):
         model = self.app.model
         person = model.Person(full_name="Betty Boop")

{wuttaweb-0.16.0 → wuttaweb-0.16.2}/tests/views/test_common.py

@@ -88,7 +88,7 @@ class TestCommonView(WebTestCase):
 
             # basic send, with user
             self.request.user = user
-            self.request.POST['user_uuid'] = user.uuid
+            self.request.POST['user_uuid'] = str(user.uuid)
             with patch.object(mod, 'Session', return_value=self.session):
                 context = view.feedback()
             self.assertEqual(context, {'ok': True})

wuttaweb-0.16.0/docs/glossary.rst

@@ -1,10 +0,0 @@
-.. _glossary:
-
-Glossary
-========
-
-.. glossary::
-   :sorted:
-
-   view
-     TODO