WuttaWeb 0.12.1__tar.gz → 0.13.0__tar.gz

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/CHANGELOG.md

@@ -5,6 +5,32 @@ 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.13.0 (2024-08-26)
+
+### Feat
+
+- use native wuttjamaican app to send feedback email
+- add basic user feedback email mechanism
+- add "progress" page for executing upgrades
+- add basic support for execute upgrades, download stdout/stderr
+- add basic progress page/indicator support
+- add basic "delete results" grid tool
+- add initial views for upgrades
+- allow app db to be rattail-native instead of wutta-native
+- add per-row css class support for grids
+- improve grid filter API a bit, support string/bool filters
+
+### Fix
+
+- tweak max image size for full logo on home, login pages
+- improve handling of boolean form fields
+- misc. improvements for display of grids, form errors
+- use autocomplete for grid filter verb choices
+- small cleanup for grid filters template
+- add once-button action for grid Reset View
+- set sort defaults for users, roles
+- add override hook for base form template
+
 ## v0.12.1 (2024-08-22)
 
 ### Fix

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: WuttaWeb
-Version: 0.12.1
+Version: 0.13.0
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -25,6 +25,7 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Requires-Dist: colanderalchemy
+Requires-Dist: humanize
 Requires-Dist: paginate
 Requires-Dist: paginate-sqlalchemy
 Requires-Dist: pyramid-beaker
@@ -35,7 +36,7 @@ Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.12.1
+Requires-Dist: wuttjamaican[db,email]>=0.13.0
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: docs
 Requires-Dist: furo; extra == 'docs'

wuttaweb-0.13.0/docs/api/wuttaweb/grids.filters.rst

@@ -0,0 +1,6 @@
+
+``wuttaweb.grids.filters``
+==========================
+
+.. automodule:: wuttaweb.grids.filters
+   :members:

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/docs/api/wuttaweb/index.rst

@@ -16,9 +16,11 @@
    forms.widgets
    grids
    grids.base
+   grids.filters
    handler
    helpers
    menus
+   progress
    static
    subscribers
    util
@@ -29,6 +31,8 @@
    views.essential
    views.master
    views.people
+   views.progress
    views.roles
    views.settings
+   views.upgrades
    views.users

wuttaweb-0.13.0/docs/api/wuttaweb/progress.rst

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

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/docs/api/wuttaweb/views.people.rst

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

wuttaweb-0.13.0/docs/api/wuttaweb/views.progress.rst

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

wuttaweb-0.13.0/docs/api/wuttaweb/views.upgrades.rst

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

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/docs/conf.py

@@ -31,6 +31,7 @@ intersphinx_mapping = {
     'deform': ('https://docs.pylonsproject.org/projects/deform/en/latest/', None),
     'pyramid': ('https://docs.pylonsproject.org/projects/pyramid/en/latest/', None),
     'python': ('https://docs.python.org/3/', None),
+    'rattail-manual': ('https://rattailproject.org/docs/rattail-manual/', None),
     'webhelpers2': ('https://webhelpers2.readthedocs.io/en/latest/', None),
     'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None),
 }

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.12.1"
+version = "0.13.0"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
@@ -31,6 +31,7 @@ classifiers = [
 requires-python = ">= 3.8"
 dependencies = [
         "ColanderAlchemy",
+        "humanize",
         "paginate",
         "paginate_sqlalchemy",
         "pyramid>=2",
@@ -41,7 +42,7 @@ dependencies = [
         "pyramid_tm",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.12.1",
+        "WuttJamaican[db,email]>=0.13.0",
         "zope.sqlalchemy>=1.5",
 ]
 

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/src/wuttaweb/app.py

@@ -37,9 +37,10 @@ from wuttaweb.auth import WuttaSecurityPolicy
 
 class WebAppProvider(AppProvider):
     """
-    The :term:`app provider` for WuttaWeb.  This adds some methods
-    specific to web apps.
+    The :term:`app provider` for WuttaWeb.  This adds some methods to
+    the :term:`app handler`, which are specific to web apps.
     """
+    email_templates = 'wuttaweb:email/templates'
 
     def get_web_handler(self, **kwargs):
         """
@@ -61,7 +62,7 @@ class WebAppProvider(AppProvider):
         return self.web_handler
 
 
-def make_wutta_config(settings):
+def make_wutta_config(settings, config_maker=None, **kwargs):
     """
     Make a WuttaConfig object from the given settings.
 
@@ -93,8 +94,9 @@ def make_wutta_config(settings):
                          "section of config to the path of your "
                          "config file.  Lame, but necessary.")
 
-    # make config per usual, add to settings
-    wutta_config = make_config(path)
+    # make config, add to settings
+    config_maker = config_maker or make_config
+    wutta_config = config_maker(path, **kwargs)
     settings['wutta_config'] = wutta_config
 
     # configure database sessions

wuttaweb-0.13.0/src/wuttaweb/email/templates/feedback.html.mako

@@ -0,0 +1,40 @@
+## -*- coding: utf-8 -*-
+<html>
+  <head>
+    <style type="text/css">
+      label {
+          display: block;
+          font-weight: bold;
+          margin-top: 1em;
+      }
+      p {
+          margin: 1em 0 1em 1.5em;
+      }
+      p.msg {
+          white-space: pre-wrap;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>User feedback from website</h1>
+
+    <label>User Name</label>
+    <p>
+      % if user:
+          <a href="${user_url}">${user}</a>
+      % else:
+          ${user_name}
+      % endif
+    </p>
+
+    <label>Referring URL</label>
+    <p><a href="${referrer}">${referrer}</a></p>
+
+    <label>Client IP</label>
+    <p>${client_ip}</p>
+
+    <label>Message</label>
+    <p class="msg">${message}</p>
+
+  </body>
+</html>

wuttaweb-0.13.0/src/wuttaweb/email/templates/feedback.txt.mako

@@ -0,0 +1,23 @@
+## -*- coding: utf-8; -*-
+
+# User feedback from website
+
+**User Name**
+
+% if user:
+${user}
+% else:
+${user_name}
+% endif
+
+**Referring URL**
+
+${referrer}
+
+**Client IP**
+
+${client_ip}
+
+**Message**
+
+${message}

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/src/wuttaweb/forms/base.py

@@ -313,7 +313,7 @@ class Form:
         self.set_fields(fields or self.get_fields())
 
         # nb. this tracks grid JSON data for inclusion in page template
-        self.grid_vue_data = OrderedDict()
+        self.grid_vue_context = OrderedDict()
 
     def __contains__(self, name):
         """
@@ -746,17 +746,39 @@ class Form:
             kwargs = {}
 
             if self.model_instance:
-                # TODO: would it be smarter to test with hasattr() ?
-                # if hasattr(schema, 'dictify'):
-                if isinstance(self.model_instance, model.Base):
+
+                # TODO: i keep finding problems with this, not sure
+                # what needs to happen.  some forms will have a simple
+                # dict for model_instance, others will have a proper
+                # SQLAlchemy object.  and in the latter case, it may
+                # not be "wutta-native" but from another DB.
+
+                # so the problem is, how to detect whether we should
+                # use the model_instance as-is or if we should convert
+                # to a dict.  some options include:
+
+                # - check if instance has dictify() method
+                # i *think* this was tried and didn't work? but do not recall
+
+                # - check if is instance of model.Base
+                # this is unreliable since model.Base is wutta-native
+
+                # - check if form has a model_class
+                # has not been tried yet
+
+                # - check if schema is from colanderalchemy
+                # this is what we are trying currently...
+
+                if isinstance(schema, SQLAlchemySchemaNode):
                     kwargs['appstruct'] = schema.dictify(self.model_instance)
                 else:
                     kwargs['appstruct'] = self.model_instance
 
-            form = deform.Form(schema, **kwargs)
+            # create the Deform instance
             # nb. must give a reference back to wutta form; this is
             # for sake of field schema nodes and widgets, e.g. to
             # access the main model instance
+            form = deform.Form(schema, **kwargs)
             form.wutta_form = self
             self.deform_form = form
 
@@ -826,16 +848,16 @@ class Form:
         output = render(template, context)
         return HTML.literal(output)
 
-    def add_grid_vue_data(self, grid):
+    def add_grid_vue_context(self, grid):
         """ """
         if not grid.key:
             raise ValueError("grid must have a key!")
 
-        if grid.key in self.grid_vue_data:
+        if grid.key in self.grid_vue_context:
             log.warning("grid data with key '%s' already registered, "
                         "but will be replaced", grid.key)
 
-        self.grid_vue_data[grid.key] = grid.get_vue_data()
+        self.grid_vue_context[grid.key] = grid.get_vue_context()
 
     def render_vue_field(
             self,
@@ -922,18 +944,13 @@ class Form:
         if field_type:
             attrs['type'] = field_type
         if messages:
-            if len(messages) == 1:
-                msg = messages[0]
-                if msg.startswith('`') and msg.endswith('`'):
-                    attrs[':message'] = msg
-                else:
-                    attrs['message'] = msg
-            # TODO
-            # else:
-            #     # nb. must pass an array as JSON string
-            #     attrs[':message'] = '[{}]'.format(', '.join([
-            #         "'{}'".format(msg.replace("'", r"\'"))
-            #         for msg in messages]))
+            cls = 'is-size-7'
+            if field_type == 'is-danger':
+                cls += ' has-text-danger'
+            messages = [HTML.tag('p', c=[msg], class_=cls)
+                        for msg in messages]
+            slot = HTML.tag('slot', name='messages', c=messages)
+            html = HTML.tag('div', c=[html, slot])
 
         return HTML.tag('b-field', c=[html], **attrs)
 
@@ -978,7 +995,16 @@ class Form:
         model_data = {}
 
         def assign(field):
-            model_data[field.oid] = make_json_safe(field.cstruct)
+            value = field.cstruct
+
+            # TODO: we need a proper true/false on the Vue side,
+            # but deform/colander want 'true' and 'false' ..so
+            # for now we explicitly translate here, ugh.  also
+            # note this does not yet allow for null values.. :(
+            if isinstance(field.typ, colander.Boolean):
+                value = True if field.typ.true_val else False
+
+            model_data[field.oid] = make_json_safe(value)
 
         for key in self.fields:
 
@@ -1076,7 +1102,7 @@ class Form:
         """
         dform = self.get_deform()
         if field in dform:
-            error = dform[field].errormsg
-            if error:
-                return [error]
+            field = dform[field]
+            if field.error:
+                return field.error.messages()
         return []

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/src/wuttaweb/forms/schema.py

@@ -92,6 +92,53 @@ class ObjectNode(colander.SchemaNode):
         raise NotImplementedError(f"you must define {class_name}.objectify()")
 
 
+class WuttaEnum(colander.Enum):
+    """
+    Custom schema type for enum fields.
+
+    This is a subclass of :class:`colander.Enum`, but adds a
+    default widget (``SelectWidget``) with enum choices.
+
+    :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 widget_maker(self, **kwargs):
+        """ """
+
+        if 'values' not in kwargs:
+            kwargs['values'] = [(getattr(e, self.attr), getattr(e, self.attr))
+                                for e in self.enum_cls]
+
+        return widgets.SelectWidget(**kwargs)
+
+
+class WuttaSet(colander.Set):
+    """
+    Custom schema type for :class:`python:set` fields.
+
+    This is a subclass of :class:`colander.Set`, but adds
+    Wutta-related params to the constructor.
+
+    :param request: Current :term:`request` object.
+
+    :param session: Optional :term:`db session` to use instead of
+       :class:`wuttaweb.db.Session`.
+    """
+
+    def __init__(self, request, session=None):
+        super().__init__()
+        self.request = request
+        self.config = self.request.wutta_config
+        self.app = self.config.get_app()
+        self.session = session or Session()
+
+
 class ObjectRef(colander.SchemaType):
     """
     Custom schema type for a model class reference field.
@@ -199,7 +246,7 @@ class ObjectRef(colander.SchemaType):
 
         # fetch object from DB
         model = self.app.model
-        obj = self.session.query(self.model_class).get(value)
+        obj = self.session.get(self.model_class, value)
 
         # raise error if not found
         if not obj:
@@ -247,43 +294,69 @@ class ObjectRef(colander.SchemaType):
             kwargs['values'] = values
 
         if 'url' not in kwargs:
-            kwargs['url'] = lambda person: self.request.route_url('people.view', uuid=person.uuid)
+            kwargs['url'] = self.get_object_url
 
         return widgets.ObjectRefWidget(self.request, **kwargs)
 
+    def get_object_url(self, obj):
+        """
+        Returns the "view" URL for the given object, if applicable.
+
+        This is used when rendering the field readonly.  If this
+        method returns a URL then the field text will be wrapped with
+        a hyperlink, otherwise it will be shown as-is.
+
+        Default logic always returns ``None``; subclass should
+        override as needed.
+        """
+
 
 class PersonRef(ObjectRef):
     """
-    Custom schema type for a ``Person`` reference field.
+    Custom schema type for a
+    :class:`~wuttjamaican:wuttjamaican.db.model.base.Person` reference
+    field.
 
     This is a subclass of :class:`ObjectRef`.
     """
-    model_class = Person
+
+    @property
+    def model_class(self):
+        """ """
+        model = self.app.model
+        return model.Person
 
     def sort_query(self, query):
         """ """
         return query.order_by(self.model_class.full_name)
 
+    def get_object_url(self, person):
+        """ """
+        return self.request.route_url('people.view', uuid=person.uuid)
 
-class WuttaSet(colander.Set):
+
+class UserRef(ObjectRef):
     """
-    Custom schema type for :class:`python:set` fields.
+    Custom schema type for a
+    :class:`~wuttjamaican:wuttjamaican.db.model.auth.User` reference
+    field.
 
-    This is a subclass of :class:`colander.Set`, but adds
-    Wutta-related params to the constructor.
+    This is a subclass of :class:`ObjectRef`.
+    """
 
-    :param request: Current :term:`request` object.
+    @property
+    def model_class(self):
+        """ """
+        model = self.app.model
+        return model.User
 
-    :param session: Optional :term:`db session` to use instead of
-       :class:`wuttaweb.db.Session`.
-    """
+    def sort_query(self, query):
+        """ """
+        return query.order_by(self.model_class.username)
 
-    def __init__(self, request, session=None):
-        super().__init__()
-        self.request = request
-        self.config = self.request.wutta_config
-        self.app = self.config.get_app()
-        self.session = session or Session()
+    def get_object_url(self, user):
+        """ """
+        return self.request.route_url('users.view', uuid=user.uuid)
 
 
 class RoleRefs(WuttaSet):
@@ -383,3 +456,35 @@ class Permissions(WuttaSet):
             kwargs['values'] = values
 
         return widgets.PermissionsWidget(self.request, **kwargs)
+
+
+class FileDownload(colander.String):
+    """
+    Custom schema type for a file download field.
+
+    This field is only meant for readonly use, it does not handle file
+    uploads.
+
+    It expects the incoming ``appstruct`` to be the path to a file on
+    disk (or null).
+
+    Uses the :class:`~wuttaweb.forms.widgets.FileDownloadWidget` by
+    default.
+
+    :param request: Current :term:`request` object.
+
+    :param url: Optional URL for hyperlink.  If not specified, file
+       name/size is shown with no hyperlink.
+    """
+
+    def __init__(self, request, *args, **kwargs):
+        self.url = kwargs.pop('url', None)
+        super().__init__(*args, **kwargs)
+        self.request = request
+        self.config = self.request.wutta_config
+        self.app = self.config.get_app()
+
+    def widget_maker(self, **kwargs):
+        """ """
+        kwargs.setdefault('url', self.url)
+        return widgets.FileDownloadWidget(self.request, **kwargs)

{wuttaweb-0.12.1 → wuttaweb-0.13.0}/src/wuttaweb/forms/widgets.py

@@ -33,14 +33,20 @@ in the namespace:
 * :class:`deform:deform.widget.TextAreaWidget`
 * :class:`deform:deform.widget.PasswordWidget`
 * :class:`deform:deform.widget.CheckedPasswordWidget`
+* :class:`deform:deform.widget.CheckboxWidget`
 * :class:`deform:deform.widget.SelectWidget`
 * :class:`deform:deform.widget.CheckboxChoiceWidget`
+* :class:`deform:deform.widget.MoneyInputWidget`
 """
 
+import os
+
 import colander
+import humanize
 from deform.widget import (Widget, TextInputWidget, TextAreaWidget,
                            PasswordWidget, CheckedPasswordWidget,
-                           SelectWidget, CheckboxChoiceWidget)
+                           CheckboxWidget, SelectWidget, CheckboxChoiceWidget,
+                           MoneyInputWidget)
 from webhelpers2.html import HTML
 
 from wuttaweb.db import Session
@@ -144,6 +150,63 @@ class WuttaCheckboxChoiceWidget(CheckboxChoiceWidget):
         self.session = session or Session()
 
 
+class FileDownloadWidget(Widget):
+    """
+    Widget for use with :class:`~wuttaweb.forms.schema.FileDownload`
+    fields.
+
+    This only supports readonly, and shows a hyperlink to download the
+    file.  Link text is the filename plus file size.
+
+    This is a subclass of :class:`deform:deform.widget.Widget` and
+    uses these Deform templates:
+
+    * ``readonly/filedownload``
+
+    :param request: Current :term:`request` object.
+
+    :param url: Optional URL for hyperlink.  If not specified, file
+       name/size is shown with no hyperlink.
+    """
+    readonly_template = 'readonly/filedownload'
+
+    def __init__(self, request, *args, **kwargs):
+        self.url = kwargs.pop('url', None)
+        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):
+        """ """
+        # nb. readonly is the only way this rolls
+        kw['readonly'] = True
+        template = self.readonly_template
+
+        path = cstruct or None
+        if path:
+            kw.setdefault('filename', os.path.basename(path))
+            kw.setdefault('filesize', self.readable_size(path))
+            if self.url:
+                kw.setdefault('url', self.url)
+
+        else:
+            kw.setdefault('filename', None)
+            kw.setdefault('filesize', None)
+
+        kw.setdefault('url', None)
+        values = self.get_template_values(field, cstruct, kw)
+        return field.renderer(template, **values)
+
+    def readable_size(self, path):
+        """ """
+        try:
+            size = os.path.getsize(path)
+        except os.error:
+            size = 0
+        return humanize.naturalsize(size)
+
+
 class RoleRefsWidget(WuttaCheckboxChoiceWidget):
     """
     Widget for use with User
@@ -181,7 +244,7 @@ class RoleRefsWidget(WuttaCheckboxChoiceWidget):
             roles = []
             if cstruct:
                 for uuid in cstruct:
-                    role = self.session.query(model.Role).get(uuid)
+                    role = self.session.get(model.Role, uuid)
                     if role:
                         roles.append(role)
             kw['roles'] = roles
@@ -220,11 +283,15 @@ class UserRefsWidget(WuttaCheckboxChoiceWidget):
         users = []
         if cstruct:
             for uuid in cstruct:
-                user = self.session.query(model.User).get(uuid)
+                user = self.session.get(model.User, uuid)
                 if user:
                     users.append(dict([(key, getattr(user, key))
                                        for key in columns + ['uuid']]))
 
+        # do not render if no data
+        if not users:
+            return HTML.tag('span')
+
         # grid
         grid = Grid(self.request, key='roles.view.users',
                     columns=columns, data=users)