WuttaWeb 0.19.3__tar.gz → 0.20.1__tar.gz

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

@@ -5,6 +5,27 @@ 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.1 (2025-01-13)
+
+### Fix
+
+- expose setting to choose menu handler, in appinfo/configure
+- use prop key instead of column name, for master view model key
+- add grid filters specific to numeric, integer types
+- use default value for config settings
+
+## 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.19.3
+Version: 0.20.1
 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.3
+Requires-Dist: wuttjamaican[db]>=0.20.1
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'

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

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

{wuttaweb-0.19.3 → wuttaweb-0.20.1}/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.3 → wuttaweb-0.20.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.19.3"
+version = "0.20.1"
 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.3",
+        "WuttJamaican[db]>=0.20.1",
         "zope.sqlalchemy>=1.5",
 ]
 
@@ -70,6 +70,9 @@ wuttaweb = "wuttaweb.conf:WuttaWebConfigExtension"
 [project.entry-points."wutta.typer_imports"]
 wuttaweb = "wuttaweb.cli"
 
+[project.entry-points."wutta.web.menus"]
+wuttaweb = "wuttaweb.menus:MenuHandler"
+
 
 [project.urls]
 Homepage = "https://wuttaproject.org/"

{wuttaweb-0.19.3 → wuttaweb-0.20.1}/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.3 → wuttaweb-0.20.1}/src/wuttaweb/grids/filters.py

@@ -465,6 +465,33 @@ class StringAlchemyFilter(AlchemyFilter):
             sa.and_(*criteria)))
 
 
+class NumericAlchemyFilter(AlchemyFilter):
+    """
+    SQLAlchemy filter option for a numeric data column.
+
+    Subclass of :class:`AlchemyFilter`.
+    """
+    default_verbs = ['equal', 'not_equal',
+                     'greater_than', 'greater_equal',
+                     'less_than', 'less_equal']
+
+
+class IntegerAlchemyFilter(NumericAlchemyFilter):
+    """
+    SQLAlchemy filter option for an integer data column.
+
+    Subclass of :class:`NumericAlchemyFilter`.
+    """
+
+    def coerce_value(self, value):
+        """ """
+        if value:
+            try:
+                return int(value)
+            except:
+                pass
+
+
 class BooleanAlchemyFilter(AlchemyFilter):
     """
     SQLAlchemy filter option for a boolean data column.
@@ -568,6 +595,8 @@ default_sqlalchemy_filters = {
     None: AlchemyFilter,
     sa.String: StringAlchemyFilter,
     sa.Text: StringAlchemyFilter,
+    sa.Numeric: NumericAlchemyFilter,
+    sa.Integer: IntegerAlchemyFilter,
     sa.Boolean: BooleanAlchemyFilter,
     sa.Date: DateAlchemyFilter,
 }

{wuttaweb-0.19.3 → wuttaweb-0.20.1}/src/wuttaweb/handler.py

@@ -24,7 +24,10 @@
 Web Handler
 """
 
+import warnings
+
 from wuttjamaican.app import GenericHandler
+from wuttjamaican.util import load_entry_points
 
 from wuttaweb import static, forms, grids
 
@@ -106,22 +109,87 @@ class WebHandler(GenericHandler):
 
     def get_menu_handler(self, **kwargs):
         """
-        Get the configured "menu" handler for the web app.
+        Get the configured :term:`menu handler` for the web app.
 
         Specify a custom handler in your config file like this:
 
         .. code-block:: ini
 
            [wutta.web]
-           menus.handler_spec = poser.web.menus:PoserMenuHandler
+           menus.handler.spec = poser.web.menus:PoserMenuHandler
 
         :returns: Instance of :class:`~wuttaweb.menus.MenuHandler`.
         """
-        if not hasattr(self, 'menu_handler'):
-            spec = self.config.get(f'{self.appname}.web.menus.handler_spec',
-                                   default='wuttaweb.menus:MenuHandler')
-            self.menu_handler = self.app.load_object(spec)(self.config)
-        return self.menu_handler
+        spec = self.config.get(f'{self.appname}.web.menus.handler.spec')
+        if not spec:
+            spec = self.config.get(f'{self.appname}.web.menus.handler_spec')
+            if spec:
+                warnings.warn(f"setting '{self.appname}.web.menus.handler_spec' is deprecated; "
+                              f"please use '{self.appname}.web.menus.handler_spec' instead",
+                              DeprecationWarning)
+            else:
+                spec = self.config.get(f'{self.appname}.web.menus.handler.default_spec',
+                                       default='wuttaweb.menus:MenuHandler')
+        factory = self.app.load_object(spec)
+        return factory(self.config)
+
+    def get_menu_handler_specs(self, default=None):
+        """
+        Get the :term:`spec` strings for all available :term:`menu
+        handlers <menu handler>`.  See also
+        :meth:`get_menu_handler()`.
+
+        :param default: Default spec string(s) to include, even if not
+           registered.  Can be a string or list of strings.
+
+        :returns: List of menu handler spec strings.
+
+        This will gather available spec strings from the following:
+
+        First, the ``default`` as provided by caller.
+
+        Second, the default spec from config, if set; for example:
+
+        .. code-block:: ini
+
+           [wutta.web]
+           menus.handler.default_spec = poser.web.menus:PoserMenuHandler
+
+        Third, each spec registered via entry points.  For instance in
+        ``pyproject.toml``:
+
+        .. code-block:: toml
+
+           [project.entry-points."wutta.web.menus"]
+           poser = "poser.web.menus:PoserMenuHandler"
+
+        The final list will be "sorted" according to the above, with
+        the latter registered handlers being sorted alphabetically.
+        """
+        handlers = []
+
+        # defaults from caller
+        if isinstance(default, str):
+            handlers.append(default)
+        elif default:
+            handlers.extend(default)
+
+        # configured default, if applicable
+        default = self.config.get(f'{self.config.appname}.web.menus.handler.default_spec')
+        if default and default not in handlers:
+            handlers.append(default)
+
+        # registered via entry points
+        registered = []
+        for Handler in load_entry_points(f'{self.appname}.web.menus').values():
+            spec = Handler.get_spec()
+            if spec not in handlers:
+                registered.append(spec)
+        if registered:
+            registered.sort()
+            handlers.extend(registered)
+
+        return handlers
 
     def make_form(self, request, **kwargs):
         """

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

@@ -41,6 +41,21 @@
       </b-checkbox>
     </b-field>
 
+    <b-field label="Menu Handler">
+      <input type="hidden"
+             name="${app.appname}.web.menus.handler.spec"
+             :value="simpleSettings['${app.appname}.web.menus.handler.spec']" />
+      <b-select v-model="simpleSettings['${app.appname}.web.menus.handler.spec']"
+                @input="settingsNeedSaved = true">
+        <option :value="null">(use default)</option>
+        <option v-for="handler in menuHandlers"
+                :key="handler.spec"
+                :value="handler.spec">
+          {{ handler.spec }}
+        </option>
+      </b-select>
+    </b-field>
+
   </div>
 
   <h3 class="block is-size-3">User/Auth</h3>
@@ -241,6 +256,8 @@
   ${parent.modify_vue_vars()}
   <script>
 
+    ThisPageData.menuHandlers = ${json.dumps(menu_handlers)|n}
+
     ThisPageData.weblibs = ${json.dumps(weblibs or [])|n}
 
     ThisPageData.editWebLibraryShowDialog = false

{wuttaweb-0.19.3 → wuttaweb-0.20.1}/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.3 → wuttaweb-0.20.1}/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.1/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.3 → wuttaweb-0.20.1}/src/wuttaweb/views/master.py

@@ -1224,7 +1224,7 @@ class MasterView(View):
                 elif simple.get('type') is bool:
                     value = self.config.get_bool(name, default=simple.get('default', False))
                 else:
-                    value = self.config.get(name)
+                    value = self.config.get(name, default=simple.get('default'))
 
                 normalized[name] = value
 
@@ -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']
 
@@ -2677,6 +2707,9 @@ class MasterView(View):
         represents a Wutta-based SQLAlchemy model, the return value
         for this method is: ``('uuid',)``
 
+        Any class mapped via SQLAlchemy should be supported
+        automatically, the keys are determined from class inspection.
+
         But there is no "sane" default for other scenarios, in which
         case subclass should define :attr:`model_key`.  If the model
         key cannot be determined, raises ``AttributeError``.
@@ -2691,8 +2724,12 @@ class MasterView(View):
 
         model_class = cls.get_model_class()
         if model_class:
-            mapper = sa.inspect(model_class)
-            return tuple([column.key for column in mapper.primary_key])
+            # nb. we want the primary key but must avoid column names
+            # in case mapped class uses different prop keys
+            inspector = sa.inspect(model_class)
+            keys = [col.name for col in inspector.primary_key]
+            return tuple([prop.key for prop in inspector.column_attrs
+                          if [col.name for col in prop.columns] == keys])
 
         raise AttributeError(f"you must define model_key for view class: {cls}")