WuttaWeb 0.18.0__tar.gz → 0.19.1__tar.gz

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

@@ -5,6 +5,36 @@ 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.1 (2025-01-06)
+
+### Fix
+
+- improve built-in grid renderer logic
+- allow session injection for ObjectRef constructor
+- improve rendering for batch row status
+- add basic support for row grid "view" action links
+- add "xref buttons" tool panel for master view
+- add WuttaQuantity schema type, widget
+- remove `session` param from some form schema, widget classes
+- add grid renderers for bool, currency, quantity
+- use proper bulma styles for markdown content
+- use span element for readonly money field widget render
+- include grid filters for all column properties of model class
+- use app handler to render error string, when progress fails
+- add schema node type, widget for "money" (currency) fields
+- exclude FK fields by default, for model forms
+- fix style for header title text
+
+## v0.19.0 (2024-12-23)
+
+### Feat
+
+- add feature to edit email settings, basic message preview
+
+### Fix
+
+- move CRUD header buttons toward center of screen
+
 ## v0.18.0 (2024-12-18)
 
 ### Feat

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.18.0
+Version: 0.19.1
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -37,9 +37,10 @@ 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.18.1
+Requires-Dist: wuttjamaican[db]>=0.19.2
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'
@@ -53,7 +54,7 @@ Requires-Dist: tox; extra == 'tests'
 Description-Content-Type: text/markdown
 
 
-# wuttaweb
+# WuttaWeb
 
 Web app for Wutta Framework
 

{wuttaweb-0.18.0 → wuttaweb-0.19.1}/README.md

@@ -1,5 +1,5 @@
 
-# wuttaweb
+# WuttaWeb
 
 Web app for Wutta Framework
 

wuttaweb-0.19.1/docs/api/wuttaweb.emails.rst

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

wuttaweb-0.19.1/docs/api/wuttaweb.views.email.rst

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

{wuttaweb-0.18.0 → wuttaweb-0.19.1}/docs/index.rst

@@ -35,6 +35,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.db
    api/wuttaweb.db.continuum
    api/wuttaweb.db.sess
+   api/wuttaweb.emails
    api/wuttaweb.forms
    api/wuttaweb.forms.base
    api/wuttaweb.forms.schema
@@ -54,6 +55,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.views.base
    api/wuttaweb.views.batch
    api/wuttaweb.views.common
+   api/wuttaweb.views.email
    api/wuttaweb.views.essential
    api/wuttaweb.views.master
    api/wuttaweb.views.people

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

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

{wuttaweb-0.18.0 → wuttaweb-0.19.1}/src/wuttaweb/app.py

@@ -43,9 +43,12 @@ log = logging.getLogger(__name__)
 class WebAppProvider(AppProvider):
     """
     The :term:`app provider` for WuttaWeb.  This adds some methods to
-    the :term:`app handler`, which are specific to web apps.
+    the :term:`app handler`, which are specific to web apps.  It also
+    registers some :term:`email templates <email template>` for the
+    app, etc.
     """
-    email_templates = 'wuttaweb:email/templates'
+    email_modules = ['wuttaweb.emails']
+    email_templates = ['wuttaweb:email-templates']
 
     def get_web_handler(self, **kwargs):
         """

wuttaweb-0.19.1/src/wuttaweb/emails.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8; -*-
+################################################################################
+#
+#  wuttaweb -- Web App for Wutta Framework
+#  Copyright © 2024 Lance Edgar
+#
+#  This file is part of Wutta Framework.
+#
+#  Wutta Framework is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU General Public License as published by the Free
+#  Software Foundation, either version 3 of the License, or (at your option) any
+#  later version.
+#
+#  Wutta Framework is distributed in the hope that it will be useful, but
+#  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+#  more details.
+#
+#  You should have received a copy of the GNU General Public License along with
+#  Wutta Framework.  If not, see <http://www.gnu.org/licenses/>.
+#
+################################################################################
+"""
+:term:`Email Settings <email setting>` for WuttaWeb
+"""
+
+from wuttjamaican.email import EmailSetting
+
+
+class feedback(EmailSetting):
+    """
+    Sent when user submits feedback via the web app.
+    """
+    default_subject = "User Feedback"
+
+    def sample_data(self):
+        """ """
+        model = self.app.model
+        person = model.Person(full_name="Barney Rubble")
+        user = model.User(username='barney', person=person)
+        return {
+            'user': user,
+            'user_name': str(person),
+            'user_url': '#',
+            'referrer': 'http://example.com/',
+            'client_ip': '127.0.0.1',
+            'message': "This app is cool but needs a new feature.\n\nAllow me to describe...",
+        }

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

@@ -30,9 +30,11 @@ import uuid as _uuid
 import colander
 import sqlalchemy as sa
 
+from wuttjamaican.db.model import Person
+from wuttjamaican.conf import parse_list
+
 from wuttaweb.db import Session
 from wuttaweb.forms import widgets
-from wuttjamaican.db.model import Person
 
 
 class WuttaDateTime(colander.DateTime):
@@ -153,25 +155,63 @@ class WuttaEnum(colander.Enum):
         return widgets.SelectWidget(**kwargs)
 
 
+class WuttaMoney(colander.Money):
+    """
+    Custom schema type for "money" fields.
+
+    This is a subclass of :class:`colander:colander.Money`, but uses
+    the custom :class:`~wuttaweb.forms.widgets.WuttaMoneyInputWidget`
+    by default.
+
+    :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):
+        """ """
+        return widgets.WuttaMoneyInputWidget(self.request, **kwargs)
+
+
+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.
+
+    :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):
+        """ """
+        return widgets.WuttaQuantityWidget(self.request, **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.
+    This is a subclass of :class:`colander.Set`.
 
     :param request: Current :term:`request` object.
-
-    :param session: Optional :term:`db session` to use instead of
-       :class:`wuttaweb.db.sess.Session`.
     """
 
-    def __init__(self, request, session=None):
+    def __init__(self, request):
         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):
@@ -207,16 +247,16 @@ class ObjectRef(colander.SchemaType):
             self,
             request,
             empty_option=None,
-            session=None,
             *args,
             **kwargs,
     ):
+        # nb. allow session injection for tests
+        self.session = kwargs.pop('session', Session())
         super().__init__(*args, **kwargs)
         self.request = request
         self.config = self.request.wutta_config
         self.app = self.config.get_app()
         self.model_instance = None
-        self.session = session or Session()
 
         if empty_option:
             if empty_option is True:
@@ -448,7 +488,7 @@ class RoleRefs(WuttaSet):
         :returns: Instance of
            :class:`~wuttaweb.forms.widgets.RoleRefsWidget`.
         """
-        kwargs.setdefault('session', self.session)
+        session = kwargs.setdefault('session', Session())
 
         if 'values' not in kwargs:
             model = self.app.model
@@ -456,20 +496,20 @@ class RoleRefs(WuttaSet):
 
             # avoid built-ins which cannot be assigned to users
             avoid = {
-                auth.get_role_authenticated(self.session),
-                auth.get_role_anonymous(self.session),
+                auth.get_role_authenticated(session),
+                auth.get_role_anonymous(session),
             }
             avoid = set([role.uuid for role in avoid])
 
             # also avoid admin unless current user is root
             if not self.request.is_root:
-                avoid.add(auth.get_role_administrator(self.session).uuid)
+                avoid.add(auth.get_role_administrator(session).uuid)
 
             # everything else can be (un)assigned for users
-            roles = self.session.query(model.Role)\
-                                .filter(~model.Role.uuid.in_(avoid))\
-                                .order_by(model.Role.name)\
-                                .all()
+            roles = session.query(model.Role)\
+                           .filter(~model.Role.uuid.in_(avoid))\
+                           .order_by(model.Role.name)\
+                           .all()
             values = [(role.uuid.hex, role.name) for role in roles]
             kwargs['values'] = values
 
@@ -494,7 +534,7 @@ class UserRefs(WuttaSet):
         :returns: Instance of
            :class:`~wuttaweb.forms.widgets.UserRefsWidget`.
         """
-        kwargs.setdefault('session', self.session)
+        kwargs.setdefault('session', Session())
         return widgets.UserRefsWidget(self.request, **kwargs)
 
 
@@ -524,7 +564,7 @@ class Permissions(WuttaSet):
         :returns: Instance of
            :class:`~wuttaweb.forms.widgets.PermissionsWidget`.
         """
-        kwargs.setdefault('session', self.session)
+        kwargs.setdefault('session', Session())
         kwargs.setdefault('permissions', self.permissions)
 
         if 'values' not in kwargs:
@@ -569,5 +609,36 @@ class FileDownload(colander.String):
         return widgets.FileDownloadWidget(self.request, **kwargs)
 
 
+class EmailRecipients(colander.String):
+    """
+    Custom schema type for :term:`email setting` recipient fields
+    (``To``, ``Cc``, ``Bcc``).
+    """
+
+    def serialize(self, node, appstruct):
+        if appstruct is colander.null:
+            return colander.null
+
+        return '\n'.join(parse_list(appstruct))
+
+    def deserialize(self, node, cstruct):
+        """ """
+        if cstruct is colander.null:
+            return colander.null
+
+        values = [value for value in parse_list(cstruct)
+                  if value]
+        return ', '.join(values)
+
+    def widget_maker(self, **kwargs):
+        """
+        Constructs a default widget for the field.
+
+        :returns: Instance of
+           :class:`~wuttaweb.forms.widgets.EmailRecipientsWidget`.
+        """
+        return widgets.EmailRecipientsWidget(**kwargs)
+
+
 # nb. colanderalchemy schema overrides
 sa.DateTime.__colanderalchemy_config__ = {'typ': WuttaDateTime}

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

@@ -41,6 +41,7 @@ in the namespace:
 """
 
 import datetime
+import decimal
 import os
 
 import colander
@@ -51,6 +52,8 @@ from deform.widget import (Widget, TextInputWidget, TextAreaWidget,
                            DateTimeInputWidget, MoneyInputWidget)
 from webhelpers2.html import HTML
 
+from wuttjamaican.conf import parse_list
+
 from wuttaweb.db import Session
 from wuttaweb.grids import Grid
 
@@ -133,26 +136,21 @@ class WuttaCheckboxChoiceWidget(CheckboxChoiceWidget):
     Custom widget for :class:`python:set` fields.
 
     This is a subclass of
-    :class:`deform:deform.widget.CheckboxChoiceWidget`, but adds
-    Wutta-related params to the constructor.
+    :class:`deform:deform.widget.CheckboxChoiceWidget`.
 
     :param request: Current :term:`request` object.
 
-    :param session: Optional :term:`db session` to use instead of
-       :class:`wuttaweb.db.sess.Session`.
-
     It uses these Deform templates:
 
     * ``checkbox_choice``
     * ``readonly/checkbox_choice``
     """
 
-    def __init__(self, request, session=None, *args, **kwargs):
+    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()
-        self.session = session or Session()
 
 
 class WuttaDateTimeWidget(DateTimeInputWidget):
@@ -192,6 +190,78 @@ class WuttaDateTimeWidget(DateTimeInputWidget):
         return super().serialize(field, cstruct, **kw)
 
 
+class WuttaMoneyInputWidget(MoneyInputWidget):
+    """
+    Custom widget for "money" fields.  This is used by default for
+    :class:`~wuttaweb.forms.schema.WuttaMoney` type nodes.
+
+    The main purpose of this widget is to leverage
+    :meth:`~wuttjamaican:wuttjamaican.app.AppHandler.render_currency()`
+    for the readonly display.
+
+    This is a subclass of
+    :class:`deform:deform.widget.MoneyInputWidget` and uses these
+    Deform templates:
+
+    * ``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.
+    """
+
+    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_quantity(cstruct)])
+
+        return super().serialize(field, cstruct, **kw)
+
+
 class FileDownloadWidget(Widget):
     """
     Widget for use with :class:`~wuttaweb.forms.schema.FileDownload`
@@ -423,6 +493,41 @@ class PermissionsWidget(WuttaCheckboxChoiceWidget):
         return super().serialize(field, cstruct, **kw)
 
 
+class EmailRecipientsWidget(TextAreaWidget):
+    """
+    Widget for :term:`email setting` recipient fields (``To``, ``Cc``,
+    ``Bcc``).
+
+    This is a subclass of
+    :class:`deform:deform.widget.TextAreaWidget`.  It uses these
+    Deform templates:
+
+    * ``textarea``
+    * ``readonly/email_recips``
+
+    See also the :class:`~wuttaweb.forms.schema.EmailRecipients`
+    schema type, which uses this widget.
+    """
+    readonly_template = 'readonly/email_recips'
+
+    def serialize(self, field, cstruct, **kw):
+        """ """
+        readonly = kw.get('readonly', self.readonly)
+        if readonly:
+            kw['recips'] = parse_list(cstruct or '')
+
+        return super().serialize(field, cstruct, **kw)
+
+    def deserialize(self, field, pstruct):
+        """ """
+        if pstruct is colander.null:
+            return colander.null
+
+        values = [value for value in parse_list(pstruct)
+                  if value]
+        return ', '.join(values)
+
+
 class BatchIdWidget(Widget):
     """
     Widget for use with the