WuttaWeb 0.19.2__tar.gz → 0.20.0__tar.gz

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

@@ -5,6 +5,26 @@ 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.0 (2025-01-11)
+
+### Feat
+
+- add basic views for Reports
+
+### Fix
+
+- add `action_method` and `reset_url` params for Form class
+- add placeholder when grid has no filters
+- add `get_page_templates()` method for master view
+
+## 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.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.19.2
+Version: 0.20.0
 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.20.0
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'

wuttaweb-0.20.0/docs/api/wuttaweb.views.reports.rst

@@ -0,0 +1,6 @@
+
+``wuttaweb.views.reports``
+==========================
+
+.. automodule:: wuttaweb.views.reports
+   :members:

{wuttaweb-0.19.2 → wuttaweb-0.20.0}/docs/index.rst

@@ -60,6 +60,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.views.master
    api/wuttaweb.views.people
    api/wuttaweb.views.progress
+   api/wuttaweb.views.reports
    api/wuttaweb.views.roles
    api/wuttaweb.views.settings
    api/wuttaweb.views.upgrades

{wuttaweb-0.19.2 → wuttaweb-0.20.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.19.2"
+version = "0.20.0"
 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.20.0",
         "zope.sqlalchemy>=1.5",
 ]
 

{wuttaweb-0.19.2 → wuttaweb-0.20.0}/src/wuttaweb/forms/base.py

@@ -161,10 +161,23 @@ class Form:
 
        See also :meth:`set_required()` and :meth:`is_required()`.
 
+    .. attribute:: action_method
+
+       HTTP method to use when submitting form; ``'post'`` is default.
+
     .. attribute:: action_url
 
        String URL to which the form should be submitted, if applicable.
 
+    .. attribute:: reset_url
+
+       String URL to which the reset button should "always" redirect,
+       if applicable.
+
+       This is null by default, in which case it will use standard
+       browser behavior for the form reset button (if shown).  See
+       also :attr:`show_button_reset`.
+
     .. attribute:: cancel_url
 
        String URL to which the Cancel button should "always" redirect,
@@ -227,6 +240,9 @@ class Form:
        Flag indicating whether a Reset button should be shown.
        Default is ``False``.
 
+       Unless there is a :attr:`reset_url`, the reset button will use
+       standard behavior per the browser.
+
     .. attribute:: show_button_cancel
 
        Flag indicating whether a Cancel button should be shown.
@@ -266,7 +282,9 @@ class Form:
             readonly_fields=[],
             required_fields={},
             labels={},
+            action_method='post',
             action_url=None,
+            reset_url=None,
             cancel_url=None,
             cancel_url_fallback=None,
             vue_tagname='wutta-form',
@@ -290,9 +308,11 @@ class Form:
         self.readonly_fields = set(readonly_fields or [])
         self.required_fields = required_fields or {}
         self.labels = labels or {}
+        self.action_method = action_method
         self.action_url = action_url
         self.cancel_url = cancel_url
         self.cancel_url_fallback = cancel_url_fallback
+        self.reset_url = reset_url
         self.vue_tagname = vue_tagname
         self.align_buttons_right = align_buttons_right
         self.auto_disable_submit = auto_disable_submit
@@ -940,10 +960,15 @@ class Form:
         """
         context['form'] = self
         context['dform'] = self.get_deform()
-        context.setdefault('form_attrs', {})
         context.setdefault('request', self.request)
         context['model_data'] = self.get_vue_model_data()
 
+        # set form method, enctype
+        context.setdefault('form_attrs', {})
+        context['form_attrs'].setdefault('method', self.action_method)
+        if self.action_method == 'post':
+            context['form_attrs'].setdefault('enctype', 'multipart/form-data')
+
         # auto disable button on submit
         if self.auto_disable_submit:
             context['form_attrs']['@submit'] = 'formSubmitting = true'

{wuttaweb-0.19.2 → wuttaweb-0.20.0}/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.20.0}/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.20.0}/src/wuttaweb/templates/forms/vue_template.mako

@@ -1,8 +1,10 @@
 ## -*- coding: utf-8; -*-
 
 <script type="text/x-template" id="${form.vue_tagname}-template">
-  ${h.form(form.action_url, method='post', enctype='multipart/form-data', **form_attrs)}
-    ${h.csrf_token(request)}
+  ${h.form(form.action_url, **form_attrs)}
+    % if form.action_method == 'post':
+        ${h.csrf_token(request)}
+    % endif
 
     % if form.has_global_errors():
         % for msg in form.get_global_errors():
@@ -33,7 +35,13 @@
           % endif
 
           % if form.show_button_reset:
-              <b-button native-type="reset">
+              <b-button
+                % if form.reset_url:
+                    tag="a" href="${form.reset_url}"
+                % else:
+                    native-type="reset"
+                % endif
+                >
                 Reset
               </b-button>
           % endif

{wuttaweb-0.19.2 → wuttaweb-0.20.0}/src/wuttaweb/templates/grids/vue_template.mako

@@ -89,6 +89,9 @@
 
             </div>
           </form>
+
+      % else:
+          <div></div>
       % endif
 
       <div style="display: flex; flex-direction: column; justify-content: space-between;">

wuttaweb-0.20.0/src/wuttaweb/templates/reports/view.mako

@@ -0,0 +1,61 @@
+## -*- coding: utf-8; mode: html; -*-
+<%inherit file="/master/view.mako" />
+
+<%def name="page_layout()">
+  ${parent.page_layout()}
+  % if report_data is not Undefined:
+      <br />
+      <a name="report-output"></a>
+      <div style="display: flex; justify-content: space-between;">
+        <div class="report-header">
+          ${self.report_output_header()}
+        </div>
+        <div class="report-tools">
+          ${self.report_tools()}
+        </div>
+      </div>
+      ${self.report_output_body()}
+  % endif
+</%def>
+
+<%def name="report_output_header()">
+  <h4 class="is-size-4"><a href="#report-output">{{ reportData.output_title }}</a></h4>
+</%def>
+
+<%def name="report_tools()"></%def>
+
+<%def name="report_output_body()">
+  ${self.report_output_table()}
+</%def>
+
+<%def name="report_output_table()">
+  <b-table :data="reportData.data"
+           narrowed
+           hoverable>
+    % for column in report_columns:
+        <b-table-column field="${column['name']}"
+                        label="${column['label']}"
+                        % if column.get('numeric'):
+                            numeric
+                        % endif
+                        v-slot="props">
+          <span v-html="props.row.${column['name']}"></span>
+        </b-table-column>
+    % endfor
+  </b-table>
+</%def>
+
+<%def name="modify_vue_vars()">
+  ${parent.modify_vue_vars()}
+  % if report_data is not Undefined:
+      <script>
+
+        ThisPageData.reportData = ${json.dumps(report_data)|n}
+
+        WholePageData.mountedHooks.push(function() {
+            location.href = '#report-output'
+        })
+
+      </script>
+  % endif
+</%def>

{wuttaweb-0.19.2 → wuttaweb-0.20.0}/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.20.0}/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()
@@ -1777,14 +1777,14 @@ class MasterView(View):
         context = self.get_template_context(context)
 
         # first try the template path most specific to this view
-        template_prefix = self.get_template_prefix()
-        mako_path = f'{template_prefix}/{template}.mako'
+        page_templates = self.get_page_templates(template)
+        mako_path = page_templates[0]
         try:
             return render_to_response(mako_path, context, request=self.request)
         except IOError:
 
             # failing that, try one or more fallback templates
-            for fallback in self.get_fallback_templates(template):
+            for fallback in page_templates[1:]:
                 try:
                     return render_to_response(fallback, context, request=self.request)
                 except IOError:
@@ -1815,21 +1815,51 @@ class MasterView(View):
         """
         return context
 
+    def get_page_templates(self, template):
+        """
+        Returns a list of all templates which can be attempted, to
+        render the current page.  This is called by
+        :meth:`render_to_response()`.
+
+        The list should be in order of preference, e.g. the first
+        entry will be the most "specific" template, with subsequent
+        entries becoming more generic.
+
+        In practice this method defines the first entry but calls
+        :meth:`get_fallback_templates()` for the rest.
+
+        :param template: Base name for a template (without prefix), e.g.
+           ``'view'``.
+
+        :returns: List of template paths to be tried, based on the
+           specified template.  For instance if ``template`` is
+           ``'view'`` this will (by default) return::
+
+              [
+                  '/widgets/view.mako',
+                  '/master/view.mako',
+              ]
+
+        """
+        template_prefix = self.get_template_prefix()
+        page_templates = [f'{template_prefix}/{template}.mako']
+        page_templates.extend(self.get_fallback_templates(template))
+        return page_templates
+
     def get_fallback_templates(self, template):
         """
         Returns a list of "fallback" template paths which may be
-        attempted for rendering a view.  This is used within
-        :meth:`render_to_response()` if the "first guess" template
-        file was not found.
+        attempted for rendering the current page.  See also
+        :meth:`get_page_templates()`.
 
         :param template: Base name for a template (without prefix), e.g.
-           ``'custom'``.
+           ``'view'``.
 
-        :returns: List of full template paths to be tried, based on
-           the specified template.  For instance if ``template`` is
-           ``'custom'`` this will (by default) return::
+        :returns: List of template paths to be tried, based on the
+           specified template.  For instance if ``template`` is
+           ``'view'`` this will (by default) return::
 
-              ['/master/custom.mako']
+              ['/master/view.mako']
         """
         return [f'/master/{template}.mako']