WuttaWeb 0.19.2__tar.gz → 0.19.3__tar.gz

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

@@ -5,6 +5,14 @@ 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.19.2
+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
@@ -39,7 +39,7 @@ Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 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.2 → wuttaweb-0.19.3}/pyproject.toml

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

{wuttaweb-0.19.2 → 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.

{wuttaweb-0.19.2 → 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.2 → 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.2 → 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()

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

@@ -81,6 +81,25 @@ 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):