WuttaWeb 0.19.1__tar.gz → 0.19.3__tar.gz

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.19.3 (2025-01-09)
+
+### Fix
+
+- use `request.url` instead of `current_route_url()`
+- add basic `<wutta-autocomplete>` component
+- add `WuttaDictEnum` form schema type
+
+## v0.19.2 (2025-01-07)
+
+### Fix
+
+- always use prop key for default grid filters
+- avoid `request.current_route_url()` for user menu
+- add `scale` kwarg for `WuttaMoney` schema type, widget
+- make WuttaQuantity serialize w/ app handler, remove custom widget
+- bugfix for bool simple settings with default value
+
 ## v0.19.1 (2025-01-06)
 
 ### Fix

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.19.1
+Version: 0.19.3
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -37,10 +37,9 @@ Requires-Dist: pyramid-fanstatic
 Requires-Dist: pyramid-mako
 Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
-Requires-Dist: sqlalchemy-utils
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.19.2
+Requires-Dist: wuttjamaican[db]>=0.19.3
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.19.1"
+version = "0.19.3"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]
@@ -42,10 +42,9 @@ dependencies = [
         "pyramid_fanstatic",
         "pyramid_mako",
         "pyramid_tm",
-        "SQLAlchemy-Utils",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.19.2",
+        "WuttJamaican[db]>=0.19.3",
         "zope.sqlalchemy>=1.5",
 ]
 

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/forms/schema.py

@@ -155,6 +155,37 @@ class WuttaEnum(colander.Enum):
         return widgets.SelectWidget(**kwargs)
 
 
+class WuttaDictEnum(colander.String):
+    """
+    Schema type for "pseudo-enum" fields which reference a dict for
+    known values instead of a true enum class.
+
+    This is primarily for use with "status" fields such as
+    :attr:`~wuttjamaican:wuttjamaican.db.model.batch.BatchRowMixin.status_code`.
+
+    This is a subclass of :class:`colander.String`, but adds a default
+    widget (``SelectWidget``) with enum choices.
+
+    :param request: Current :term:`request` object.
+
+    :param enum_dct: Dict with possible enum values and labels.
+    """
+
+    def __init__(self, request, enum_dct, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.request = request
+        self.config = self.request.wutta_config
+        self.app = self.config.get_app()
+        self.enum_dct = enum_dct
+
+    def widget_maker(self, **kwargs):
+        """ """
+        if 'values' not in kwargs:
+            kwargs['values'] = [(k, v) for k, v in self.enum_dct.items()]
+
+        return widgets.SelectWidget(**kwargs)
+
+
 class WuttaMoney(colander.Money):
     """
     Custom schema type for "money" fields.
@@ -164,9 +195,13 @@ class WuttaMoney(colander.Money):
     by default.
 
     :param request: Current :term:`request` object.
+
+    :param scale: If this kwarg is specified, it will be passed along
+       to the widget constructor.
     """
 
     def __init__(self, request, *args, **kwargs):
+        self.scale = kwargs.pop('scale', None)
         super().__init__(*args, **kwargs)
         self.request = request
         self.config = self.request.wutta_config
@@ -174,6 +209,8 @@ class WuttaMoney(colander.Money):
 
     def widget_maker(self, **kwargs):
         """ """
+        if self.scale:
+            kwargs.setdefault('scale', self.scale)
         return widgets.WuttaMoneyInputWidget(self.request, **kwargs)
 
 
@@ -181,8 +218,9 @@ class WuttaQuantity(colander.Decimal):
     """
     Custom schema type for "quantity" fields.
 
-    This is a subclass of :class:`colander:colander.Decimal` but uses
-    :class:`~wuttaweb.forms.widgets.WuttaQuantityWidget` by default.
+    This is a subclass of :class:`colander:colander.Decimal` but will
+    serialize values via
+    :meth:`~wuttjamaican:wuttjamaican.app.AppHandler.render_quantity()`.
 
     :param request: Current :term:`request` object.
     """
@@ -193,9 +231,14 @@ class WuttaQuantity(colander.Decimal):
         self.config = self.request.wutta_config
         self.app = self.config.get_app()
 
-    def widget_maker(self, **kwargs):
+    def serialize(self, node, appstruct):
         """ """
-        return widgets.WuttaQuantityWidget(self.request, **kwargs)
+        if appstruct in (colander.null, None):
+            return colander.null
+
+        # nb. we render as quantity here to avoid values like 12.0000,
+        # so we just show value like 12 instead
+        return self.app.render_quantity(appstruct)
 
 
 class WuttaSet(colander.Set):

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/forms/widgets.py

@@ -206,45 +206,13 @@ class WuttaMoneyInputWidget(MoneyInputWidget):
     * ``moneyinput``
 
     :param request: Current :term:`request` object.
-    """
-
-    def __init__(self, request, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.request = request
-        self.config = self.request.wutta_config
-        self.app = self.config.get_app()
-
-    def serialize(self, field, cstruct, **kw):
-        """ """
-        readonly = kw.get('readonly', self.readonly)
-        if readonly:
-            if cstruct in (colander.null, None):
-                return HTML.tag('span')
-            cstruct = decimal.Decimal(cstruct)
-            return HTML.tag('span', c=[self.app.render_currency(cstruct)])
-
-        return super().serialize(field, cstruct, **kw)
-
-
-class WuttaQuantityWidget(TextInputWidget):
-    """
-    Custom widget for "quantity" fields.  This is used by default for
-    :class:`~wuttaweb.forms.schema.WuttaQuantity` type nodes.
-
-    The main purpose of this widget is to leverage
-    :meth:`~wuttjamaican:wuttjamaican.app.AppHandler.render_quantity()`
-    for the readonly display.
 
-    This is a subclass of
-    :class:`deform:deform.widget.TextInputWidget` and uses these
-    Deform templates:
-
-    * ``textinput``
-
-    :param request: Current :term:`request` object.
+    :param scale: If this kwarg is specified, it will be passed along
+       to ``render_currency()`` call.
     """
 
     def __init__(self, request, *args, **kwargs):
+        self.scale = kwargs.pop('scale', 2)
         super().__init__(*args, **kwargs)
         self.request = request
         self.config = self.request.wutta_config
@@ -257,7 +225,8 @@ class WuttaQuantityWidget(TextInputWidget):
             if cstruct in (colander.null, None):
                 return HTML.tag('span')
             cstruct = decimal.Decimal(cstruct)
-            return HTML.tag('span', c=[self.app.render_quantity(cstruct)])
+            text = self.app.render_currency(cstruct, scale=self.scale)
+            return HTML.tag('span', c=[text])
 
         return super().serialize(field, cstruct, **kw)
 

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/grids/base.py

@@ -32,7 +32,6 @@ from collections import namedtuple, OrderedDict
 
 import sqlalchemy as sa
 from sqlalchemy import orm
-from sqlalchemy_utils import get_columns
 
 import paginate
 from paginate_sqlalchemy import SqlalchemyOrmPage
@@ -1147,16 +1146,29 @@ class Grid:
         filters = filters or {}
 
         if self.model_class:
-            # nb. i first tried self.get_model_columns() but my notes
-            # say that was too aggressive in many cases.  then i tried
-            # using the *subset* of self.columns, just the ones which
-            # corresponded to a property on the model class.  and now
-            # i am using sa-utils to give the "true" column list..
-            for col in get_columns(self.model_class):
-                if col.key in filters:
-                    continue
-                prop = getattr(self.model_class, col.key)
-                filters[prop.key] = self.make_filter(prop)
+
+            # nb. i have found this confusing for some reason.  some
+            # things i've tried so far include:
+            #
+            # i first tried self.get_model_columns() but my notes say
+            # that was too aggressive in many cases.
+            #
+            # then i tried using the *subset* of self.columns, just
+            # the ones which correspond to a property on the model
+            # class.  but sometimes that skips filters we need.
+            #
+            # then i tried get_columns() from sa-utils to give the
+            # "true" column list, but that fails when the underlying
+            # column has different name than the prop/attr key.
+            #
+            # so now, we are looking directly at the sa mapper, for
+            # all column attrs and then using the prop key.
+
+            inspector = sa.inspect(self.model_class)
+            for prop in inspector.column_attrs:
+                if prop.key not in filters:
+                    attr = getattr(self.model_class, prop.key)
+                    filters[prop.key] = self.make_filter(attr)
 
         return filters
 

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/templates/base.mako

@@ -659,7 +659,7 @@
           % if request.is_root:
               ${h.form(url('stop_root'), ref='stopBeingRootForm')}
               ${h.csrf_token(request)}
-              <input type="hidden" name="referrer" value="${request.current_route_url()}" />
+              <input type="hidden" name="referrer" value="${request.url}" />
               <a @click="stopBeingRoot()"
                  class="navbar-item has-background-danger has-text-white">
                 Stop being root

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/templates/configure.mako

@@ -18,7 +18,7 @@
   <br />
   ${self.buttons_content()}
 
-  ${h.form(request.current_route_url(), enctype='multipart/form-data', ref='saveSettingsForm', **{'@submit': 'saveSettingsFormSubmit'})}
+  ${h.form(request.url, enctype='multipart/form-data', ref='saveSettingsForm', **{'@submit': 'saveSettingsFormSubmit'})}
     ${h.csrf_token(request)}
     <div class="wutta-form-wrapper">
       ${self.form_content()}
@@ -53,7 +53,7 @@
         <b-button @click="purgeSettingsShowDialog = false">
           Cancel
         </b-button>
-        ${h.form(request.current_route_url(), **{'@submit': 'purgingSettings = true'})}
+        ${h.form(request.url, **{'@submit': 'purgingSettings = true'})}
         ${h.csrf_token(request)}
         ${h.hidden('remove_settings', 'true')}
         <b-button type="is-danger"
@@ -107,7 +107,7 @@
               icon-left="save">
       {{ savingSettings ? "Working, please wait..." : "Save All Settings" }}
     </b-button>
-    <b-button tag="a" href="${request.current_route_url()}"
+    <b-button tag="a" href="${request.url}"
               icon-pack="fas"
               icon-left="undo"
               @click="undoChanges = true"

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/templates/wutta-components.mako

@@ -1,6 +1,7 @@
 
 <%def name="make_wutta_components()">
   ${self.make_wutta_request_mixin()}
+  ${self.make_wutta_autocomplete_component()}
   ${self.make_wutta_button_component()}
   ${self.make_wutta_datepicker_component()}
   ${self.make_wutta_timepicker_component()}
@@ -86,6 +87,150 @@
   </script>
 </%def>
 
+<%def name="make_wutta_autocomplete_component()">
+  <script type="text/x-template" id="wutta-autocomplete-template">
+    <div>
+      <b-autocomplete ref="autocomplete"
+                      v-show="!value"
+                      v-model="entry"
+                      :data="data"
+                      @typing="getAsyncData"
+                      @select="selectionMade"
+                      keep-first>
+        <template slot-scope="props">
+          {{ props.option.label }}
+        </template>
+      </b-autocomplete>
+      <b-button v-if="value"
+                @click="clearValue(true, true)">
+        {{ recordLabel }} (click to change)
+      </b-button>
+    </div>
+  </script>
+  <script>
+    const WuttaAutocomplete = {
+        template: '#wutta-autocomplete-template',
+
+        props: {
+
+            // callers do not specify this directly but rather by way
+            // of the `v-model` directive.  the component will emit
+            // `input` events when this value changes
+            value: String,
+
+            // caller must specify initial display string, if the
+            // (v-model) value is not empty when component loads
+            display: String,
+
+            // the url from which search results are obtained.  the
+            // endpoint should expect a GET with single `term` param
+            // in query string, and return list of objects, each with
+            // (at least) `value` and `label` properties.
+            serviceUrl: String,
+        },
+
+        data() {
+            return {
+
+                // user search input
+                entry: null,
+
+                // display label for button, when value is set
+                recordLabel: this.display,
+
+                // this contains the latest search results; it will
+                // change over time as user types.  when an option is
+                // selected, it will be an element from this list.
+                data: [],
+            }
+        },
+
+        watch: {
+
+            value(val) {
+                // reset ourself when model value is cleared
+                if (!val) {
+                    this.clearValue()
+                }
+            },
+        },
+
+        methods: {
+
+            focus() {
+                this.$refs.autocomplete.focus()
+            },
+
+            // convenience for parent component to fetch current label
+            getLabel() {
+                return this.recordLabel
+            },
+
+            // fetch new search results from server.  this is invoked
+            // when user types new input
+            getAsyncData(entry) {
+
+                // nb. skip search until we have at least 3 chars of input
+                if (entry.length < 3) {
+                    this.data = []
+                    return
+                }
+
+                // search results become autocomplete options
+                this.$http.get(this.serviceUrl + '?term=' + encodeURIComponent(entry))
+                    .then(({ data }) => {
+                        this.data = data
+                    })
+                    .catch((error) => {
+                        this.data = []
+                        throw error
+                    })
+            },
+
+            // handle selection change.  this is invoked when user
+            // chooses an autocomplete option
+            selectionMade(option) {
+
+                // reset user input
+                this.entry = null
+
+                // nb. this method can be triggered when a selection
+                // is made *or cleared* - if the latter then we do not
+                // want to emit event for the empty value; that part
+                // is handled in clearValue()
+                if (option) {
+                    this.recordLabel = option.label
+                    this.$emit('input', option.value)
+                } else {
+                    this.recordLabel = null
+                }
+            },
+
+            // clear the component value
+            clearValue(emit, focus) {
+
+                // clear autocomplete selection
+                this.$refs.autocomplete.setSelected(null)
+
+                // maybe emit event for new value
+                if (emit) {
+                    this.$emit('input', null)
+                }
+
+                // maybe set focus to autocomplete
+                if (focus) {
+                    this.$nextTick(function() {
+                        this.focus()
+                    })
+                }
+            },
+        },
+
+    }
+    Vue.component('wutta-autocomplete', WuttaAutocomplete)
+  </script>
+</%def>
+
 <%def name="make_wutta_button_component()">
   <script type="text/x-template" id="wutta-button-template">
     <b-button :type="type"

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/src/wuttaweb/views/master.py

@@ -1178,7 +1178,7 @@ class MasterView(View):
             self.request.session.flash("Settings have been saved.")
 
             # reload configure page
-            return self.redirect(self.request.current_route_url())
+            return self.redirect(self.request.url)
 
         # render configure page
         context = self.configure_get_context()
@@ -1329,6 +1329,9 @@ class MasterView(View):
 
                 if name in data:
                     value = data[name]
+                elif simple.get('type') is bool:
+                    # nb. bool false will be *missing* from data
+                    value = False
                 else:
                     value = simple.get('default')
 

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/tests/forms/test_schema.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8; -*-
 
 import datetime
+import decimal
 from unittest import TestCase
 from unittest.mock import patch
 
@@ -15,7 +16,7 @@ from wuttaweb.forms import widgets
 from wuttaweb.testing import DataTestCase, WebTestCase
 
 
-class TestWutaDateTime(TestCase):
+class TestWuttaDateTime(TestCase):
 
     def test_deserialize(self):
         typ = mod.WuttaDateTime()
@@ -80,22 +81,64 @@ class TestWuttaEnum(WebTestCase):
         self.assertIsInstance(widget, widgets.SelectWidget)
 
 
+MOCK_STATUS_ONE = 1
+MOCK_STATUS_TWO = 2
+MOCK_STATUS = {
+    MOCK_STATUS_ONE: 'one',
+    MOCK_STATUS_TWO: 'two',
+}
+
+class TestWuttaDictEnum(WebTestCase):
+
+    def test_widget_maker(self):
+        typ = mod.WuttaDictEnum(self.request, MOCK_STATUS)
+        widget = typ.widget_maker()
+        self.assertIsInstance(widget, widgets.SelectWidget)
+        self.assertEqual(widget.values, [
+            (1, 'one'),
+            (2, 'two'),
+        ])
+
+
 class TestWuttaMoney(WebTestCase):
 
     def test_widget_maker(self):
         enum = self.app.enum
+
+        # default scale
         typ = mod.WuttaMoney(self.request)
         widget = typ.widget_maker()
         self.assertIsInstance(widget, widgets.WuttaMoneyInputWidget)
+        self.assertEqual(widget.scale, 2)
+
+        # custom scale
+        typ = mod.WuttaMoney(self.request, scale=4)
+        widget = typ.widget_maker()
+        self.assertIsInstance(widget, widgets.WuttaMoneyInputWidget)
+        self.assertEqual(widget.scale, 4)
 
 
 class TestWuttaQuantity(WebTestCase):
 
-    def test_widget_maker(self):
-        enum = self.app.enum
-        typ = mod.WuttaQuantity(self.request)
-        widget = typ.widget_maker()
-        self.assertIsInstance(widget, widgets.WuttaQuantityWidget)
+    def test_serialize(self):
+        node = colander.SchemaNode(mod.WuttaQuantity(self.request))
+        typ = node.typ
+
+        # null
+        result = typ.serialize(node, colander.null)
+        self.assertIs(result, colander.null)
+        result = typ.serialize(node, None)
+        self.assertIs(result, colander.null)
+
+        # quantity
+        result = typ.serialize(node, 42)
+        self.assertEqual(result, '42')
+        result = typ.serialize(node, 42.00)
+        self.assertEqual(result, '42')
+        result = typ.serialize(node, decimal.Decimal('42.00'))
+        self.assertEqual(result, '42')
+        result = typ.serialize(node, 42.13)
+        self.assertEqual(result, '42.13')
 
 
 class TestObjectRef(DataTestCase):

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/tests/forms/test_widgets.py

@@ -143,36 +143,6 @@ class TestWuttaMoneyInputWidget(WebTestCase):
         self.assertEqual(result, '<span></span>')
 
 
-class TestWuttaQuantityWidget(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 make_widget(self, **kwargs):
-        return mod.WuttaQuantityWidget(self.request, **kwargs)
-
-    def test_serialize(self):
-        node = colander.SchemaNode(schema.WuttaQuantity(self.request))
-        field = self.make_field(node)
-        widget = self.make_widget()
-        amount = decimal.Decimal('42.00')
-
-        # editable widget has normal text input
-        result = widget.serialize(field, str(amount))
-        self.assertIn('<b-input', result)
-
-        # readonly is rendered per app convention
-        result = widget.serialize(field, str(amount), readonly=True)
-        self.assertEqual(result, '<span>42</span>')
-
-        # readonly w/ null value
-        result = widget.serialize(field, None, readonly=True)
-        self.assertEqual(result, '<span></span>')
-
-
 class TestFileDownloadWidget(WebTestCase):
 
     def make_field(self, node, **kwargs):

{wuttaweb-0.19.1 → wuttaweb-0.19.3}/tests/views/test_master.py

@@ -1565,6 +1565,38 @@ class TestMasterView(WebTestCase):
                     count = self.session.query(model.Setting).count()
                     self.assertEqual(count, 0)
 
+    def test_configure_gather_settings(self):
+        view = self.make_view()
+
+        simple_settings = [
+            {'name': 'wutta.app_title'},
+            {'name': 'wutta.foo'},
+            {'name': 'wutta.flag', 'type': bool, 'default': True},
+            {'name': 'wutta.number', 'type': int, 'default': 42},
+            {'name': 'wutta.value1', 'save_if_empty': True},
+            {'name': 'wutta.value2', 'save_if_empty': False},
+            {'name': 'wutta.value3', 'save_if_empty': False, 'default': 'baz'},
+        ]
+
+        data = {
+            'wutta.app_title': 'Poser',
+            'wutta.foo': 'bar',
+            'wutta.number': 44,
+            'wutta.value1': None,
+        }
+
+        with patch.object(view, 'configure_get_simple_settings', return_value=simple_settings):
+            settings = view.configure_gather_settings(data)
+            self.assertEqual(len(settings), 6)
+            self.assertEqual(settings, [
+                {'name': 'wutta.app_title', 'value': 'Poser'},
+                {'name': 'wutta.foo', 'value': 'bar'},
+                {'name': 'wutta.flag', 'value': 'false'},
+                {'name': 'wutta.number', 'value': '44'},
+                {'name': 'wutta.value1', 'value': ''},
+                {'name': 'wutta.value3', 'value': 'baz'},
+            ])
+
     ##############################
     # row methods
     ##############################