WuttaWeb 0.10.0__tar.gz → 0.10.2__tar.gz

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/CHANGELOG.md

@@ -5,6 +5,19 @@ 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.10.2 (2024-08-19)
+
+### Fix
+
+- add `render_vue_finalize()` methods for grids, forms
+- avoid error when checking model for column property
+
+## v0.10.1 (2024-08-19)
+
+### Fix
+
+- make `util.get_model_fields()` work with more model classes
+
 ## v0.10.0 (2024-08-18)
 
 ### Feat

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/PKG-INFO

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

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/pyproject.toml

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

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/auth.py

@@ -150,7 +150,7 @@ class WuttaSecurityPolicy:
         return auth.has_permission(self.db_session, user, permission)
 
 
-def add_permission_group(pyramid_config, key, label=None, overwrite=True):
+def add_permission_group(pyramid_config, groupkey, label=None, overwrite=True):
     """
     Pyramid directive to add a "permission group" to the app's
     awareness.
@@ -169,12 +169,12 @@ def add_permission_group(pyramid_config, key, label=None, overwrite=True):
 
        pyramid_config.add_permission_group('widgets', label="Widgets")
 
-    :param key: Unique key for the permission group.  In the context
-       of a master view, this will be the same as
+    :param groupkey: Unique key for the permission group.  In the
+       context of a master view, this will be the same as
        :attr:`~wuttaweb.views.master.MasterView.permission_prefix`.
 
     :param label: Optional label for the permission group.  If not
-       specified, it is derived from ``key``.
+       specified, it is derived from ``groupkey``.
 
     :param overwrite: If the permission group was already established,
        this flag controls whether the group's label should be
@@ -186,9 +186,9 @@ def add_permission_group(pyramid_config, key, label=None, overwrite=True):
     app = config.get_app()
     def action():
         perms = pyramid_config.get_settings().get('wutta_permissions', {})
-        if overwrite or key not in perms:
-            group = perms.setdefault(key, {'key': key})
-            group['label'] = label or app.make_title(key)
+        if overwrite or groupkey not in perms:
+            group = perms.setdefault(groupkey, {'key': groupkey})
+            group['label'] = label or app.make_title(groupkey)
         pyramid_config.add_settings({'wutta_permissions': perms})
     pyramid_config.action(None, action)
 
@@ -215,8 +215,8 @@ def add_permission(pyramid_config, groupkey, key, label=None):
        pyramid_config.add_permission('widgets', 'widgets.polish',
                                      label="Polish all the widgets")
 
-    :param key: Unique key for the permission group.  In the context
-       of a master view, this will be the same as
+    :param groupkey: Unique key for the permission group.  In the
+       context of a master view, this will be the same as
        :attr:`~wuttaweb.views.master.MasterView.permission_prefix`.
 
     :param key: Unique key for the permission.  This should be the

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/forms/base.py

@@ -182,6 +182,8 @@ class Form:
        String name for Vue component tag.  By default this is
        ``'wutta-form'``.  See also :meth:`render_vue_tag()`.
 
+       See also :attr:`vue_component`.
+
     .. attribute:: align_buttons_right
 
        Flag indicating whether the buttons (submit, cancel etc.)
@@ -784,6 +786,13 @@ class Form:
              </form>
            </script>
 
+           <script>
+               WuttaFormData = {}
+               WuttaForm = {
+                   template: 'wutta-form-template',
+               }
+           </script>
+
         .. todo::
 
            Why can't Sphinx render the above code block as 'html' ?
@@ -909,19 +918,42 @@ class Form:
 
         return HTML.tag('b-field', c=[html], **attrs)
 
+    def render_vue_finalize(self):
+        """
+        Render the Vue "finalize" script for the form.
+
+        By default this simply returns:
+
+        .. code-block:: html
+
+           <script>
+             WuttaForm.data = function() { return WuttaFormData }
+             Vue.component('wutta-form', WuttaForm)
+           </script>
+
+        The actual output may depend on various form attributes, in
+        particular :attr:`vue_tagname`.
+        """
+        set_data = f"{self.vue_component}.data = function() {{ return {self.vue_component}Data }}"
+        make_component = f"Vue.component('{self.vue_tagname}', {self.vue_component})"
+        return HTML.tag('script', c=['\n',
+                                     HTML.literal(set_data),
+                                     '\n',
+                                     HTML.literal(make_component),
+                                     '\n'])
+
     def get_vue_model_data(self):
         """
         Returns a dict with form model data.  Values may be nested
         depending on the types of fields contained in the form.
 
-        Note that the values need not be "converted" (to be
-        JSON-compatible) at this stage, for instance ``colander.null``
-        is not a problem here.  The point is to collect the raw data.
+        This collects the ``cstruct`` values for all fields which are
+        present both in :attr:`fields` as well as the Deform schema.
 
-        The dict should have a key/value for each field in the form.
+        It also converts each as needed, to ensure it is
+        JSON-serializable.
 
-        This method is called by :meth:`render_vue_model_data()` which
-        is responsible for ensuring JSON compatibility.
+        :returns: Dict of field/value items.
         """
         dform = self.get_deform()
         model_data = {}

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/grids/base.py

@@ -86,9 +86,9 @@ class Grid:
 
     .. attribute:: columns
 
-       :class:`~wuttaweb.forms.base.FieldList` instance containing
-       string column names for the grid.  Columns will appear in the
-       same order as they are in this list.
+       :class:`~wuttaweb.util.FieldList` instance containing string
+       column names for the grid.  Columns will appear in the same
+       order as they are in this list.
 
        See also :meth:`set_columns()` and :meth:`get_columns()`.
 
@@ -239,9 +239,9 @@ class Grid:
 
     .. attribute:: paginated
 
-       Boolean indicating whether the grid data should be paginated
-       vs. all data shown at once.  Default is ``False`` which means
-       the full set of grid data is sent for each request.
+       Boolean indicating whether the grid data should be paginated,
+       i.e. split up into pages.  Default is ``False`` which means all
+       data is shown at once.
 
        See also :attr:`pagesize` and :attr:`page`, and
        :attr:`paginate_on_backend`.
@@ -392,7 +392,7 @@ class Grid:
         Explicitly set the list of grid columns.
 
         This will overwrite :attr:`columns` with a new
-        :class:`~wuttaweb.forms.base.FieldList` instance.
+        :class:`~wuttaweb.util.FieldList` instance.
 
         :param columns: List of string column names.
         """
@@ -440,9 +440,8 @@ class Grid:
 
         :param label: New label for the column header.
 
-        See also :meth:`get_label()`.
-
-        Label overrides are tracked via :attr:`labels`.
+        See also :meth:`get_label()`.  Label overrides are tracked via
+        :attr:`labels`.
         """
         self.labels[key] = label
 
@@ -490,7 +489,7 @@ class Grid:
            def render_foo(record, key, value):
               return HTML.literal("<p>this is the final cell value</p>")
 
-           grid = Grid(columns=['foo', 'bar'])
+           grid = Grid(request, columns=['foo', 'bar'])
            grid.set_renderer('foo', render_foo)
 
         Renderer overrides are tracked via :attr:`renderers`.
@@ -509,8 +508,8 @@ class Grid:
         URL for this will be the same as for the "View"
         :class:`GridAction`
         (aka. :meth:`~wuttaweb.views.master.MasterView.view()`).
-        Although of course each cell gets a different link depending
-        on which data record it points to.
+        Although of course each cell in the column gets a different
+        link depending on which data record it points to.
 
         It is typical to enable auto-link for fields relating to ID,
         description etc. or some may prefer to auto-link all columns.
@@ -579,7 +578,8 @@ class Grid:
                 if key in sorters:
                     continue
                 prop = getattr(self.model_class, key, None)
-                if prop and isinstance(prop.property, orm.ColumnProperty):
+                if (prop and hasattr(prop, 'property')
+                    and isinstance(prop.property, orm.ColumnProperty)):
                     sorters[prop.key] = self.make_sorter(prop)
 
         return sorters
@@ -609,8 +609,8 @@ class Grid:
         The term "model property" is a bit technical, an example
         should help to clarify::
 
-           model = self.app.model
-           grid = Grid(self.request, model_class=model.Person)
+           model = app.model
+           grid = Grid(request, model_class=model.Person)
 
            # explicit property
            sorter = grid.make_sorter(model.Person.full_name)
@@ -633,7 +633,7 @@ class Grid:
            ]
 
            # nb. no model_class, just as an example
-           grid = Grid(self.request, columns=['foo', 'bar'], data=data)
+           grid = Grid(request, columns=['foo', 'bar'], data=data)
 
            def getkey(obj):
                if obj.get('foo')
@@ -725,8 +725,8 @@ class Grid:
         A backend sorter callable must accept ``(data, direction)``
         args and return the sorted data/query, for example::
 
-           model = self.app.model
-           grid = Grid(self.request, model_class=model.Person)
+           model = app.model
+           grid = Grid(request, model_class=model.Person)
 
            def sort_full_name(query, direction):
               sortspec = getattr(model.Person.full_name, direction)
@@ -750,6 +750,10 @@ class Grid:
         """
         Remove the backend sorter for a column.
 
+        Note that this removes the sorter *function*, so there is
+        no way to sort by this column unless another sorter is
+        later defined for it.
+
         See also :meth:`set_sorter()`.
         """
         self.sorters.pop(key, None)
@@ -1140,6 +1144,7 @@ class Grid:
 
         See also these methods which may be called by this one:
 
+        * :meth:`sort_data()`
         * :meth:`paginate_data()`
         """
         data = self.data or []
@@ -1273,6 +1278,30 @@ class Grid:
         output = render(template, context)
         return HTML.literal(output)
 
+    def render_vue_finalize(self):
+        """
+        Render the Vue "finalize" script for the grid.
+
+        By default this simply returns:
+
+        .. code-block:: html
+
+           <script>
+             WuttaGrid.data = function() { return WuttaGridData }
+             Vue.component('wutta-grid', WuttaGrid)
+           </script>
+
+        The actual output may depend on various grid attributes, in
+        particular :attr:`vue_tagname`.
+        """
+        set_data = f"{self.vue_component}.data = function() {{ return {self.vue_component}Data }}"
+        make_component = f"Vue.component('{self.vue_tagname}', {self.vue_component})"
+        return HTML.tag('script', c=['\n',
+                                     HTML.literal(set_data),
+                                     '\n',
+                                     HTML.literal(make_component),
+                                     '\n'])
+
     def get_vue_columns(self):
         """
         Returns a list of Vue-compatible column definitions.
@@ -1283,6 +1312,7 @@ class Grid:
            {
                'field': 'foo',
                'label': "Foo",
+               'sortable': True,
            }
 
         See also :meth:`get_vue_data()`.

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/templates/form.mako

@@ -3,7 +3,9 @@
 
 <%def name="page_content()">
   <div style="margin-top: 2rem; width: 50%;">
-    ${form.render_vue_tag()}
+    % if form is not Undefined:
+        ${form.render_vue_tag()}
+    % endif
   </div>
 </%def>
 
@@ -17,10 +19,7 @@
 <%def name="finalize_this_page_vars()">
   ${parent.finalize_this_page_vars()}
   % if form is not Undefined:
-      <script>
-        ${form.vue_component}.data = function() { return ${form.vue_component}Data }
-        Vue.component('${form.vue_tagname}', ${form.vue_component})
-      </script>
+      ${form.render_vue_finalize()}
   % endif
 </%def>
 

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/templates/grids/vue_template.mako

@@ -37,7 +37,7 @@
               ## paging
               % if grid.paginated:
                   paginated
-                  pagination-size="is-small"
+                  pagination-size="${'small' if request.use_oruga else 'is-small'}"
                   :per-page="perPage"
                   :current-page="currentPage"
                   @page-change="onPageChange"

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/templates/master/index.mako

@@ -22,10 +22,7 @@
 <%def name="finalize_this_page_vars()">
   ${parent.finalize_this_page_vars()}
   % if grid is not Undefined:
-      <script>
-        ${grid.vue_component}.data = function() { return ${grid.vue_component}Data }
-        Vue.component('${grid.vue_tagname}', ${grid.vue_component})
-      </script>
+      ${grid.render_vue_finalize()}
   % endif
 </%def>
 

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/util.py

@@ -462,14 +462,13 @@ def get_model_fields(config, model_class=None):
     if not model_class:
         return
 
-    app = config.get_app()
-    model = app.model
-    if not issubclass(model_class, model.Base):
-        return
-
-    mapper = sa.inspect(model_class)
-    fields = [prop.key for prop in mapper.iterate_properties]
-    return fields
+    try:
+        mapper = sa.inspect(model_class)
+    except sa.exc.NoInspectionAvailable:
+        pass
+    else:
+        fields = [prop.key for prop in mapper.iterate_properties]
+        return fields
 
 
 def make_json_safe(value, key=None, warn=True):

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/views/master.py

@@ -259,7 +259,7 @@ class MasterView(View):
 
     .. attribute:: form_fields
 
-       List of columns for the model form.
+       List of fields for the model form.
 
        This is optional; see also :meth:`get_form_fields()`.
 

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/views/people.py

@@ -101,6 +101,7 @@ class PersonView(MasterView):
 
     @classmethod
     def defaults(cls, config):
+        """ """
         cls._defaults(config)
         cls._people_defaults(config)
 

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/src/wuttaweb/views/roles.py

@@ -246,6 +246,7 @@ class RoleView(MasterView):
 
     @classmethod
     def defaults(cls, config):
+        """ """
         cls._defaults(config)
         cls._role_defaults(config)
 

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/tests/forms/test_base.py

@@ -405,6 +405,12 @@ class TestForm(TestCase):
         self.assertIn('<script type="text/x-template" id="wutta-form-template">', html)
         self.assertNotIn('@submit', html)
 
+    def test_render_vue_finalize(self):
+        form = self.make_form()
+        html = form.render_vue_finalize()
+        self.assertIn('<script>', html)
+        self.assertIn("Vue.component('wutta-form', WuttaForm)", html)
+
     def test_render_vue_field(self):
         self.pyramid_config.include('pyramid_deform')
         schema = self.make_schema()

{wuttaweb-0.10.0 → wuttaweb-0.10.2}/tests/grids/test_base.py

@@ -855,6 +855,12 @@ class TestGrid(WebTestCase):
         html = grid.render_vue_template()
         self.assertIn('<script type="text/x-template" id="wutta-grid-template">', html)
 
+    def test_render_vue_finalize(self):
+        grid = self.make_grid()
+        html = grid.render_vue_finalize()
+        self.assertIn('<script>', html)
+        self.assertIn("Vue.component('wutta-grid', WuttaGrid)", html)
+
     def test_get_vue_columns(self):
 
         # error if no columns are set