WuttaWeb 0.23.2__tar.gz → 0.24.0__tar.gz

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/CHANGELOG.md

@@ -5,6 +5,23 @@ 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.24.0 (2025-12-15)
+
+### Feat
+
+- basic support for displaying version history
+
+### Fix
+
+- use UTC when updating timestamp in DB
+- workaround error when 'fanstatic.needed' missing from environ
+- workaround error when 'fanstatic.needed' missing from environ
+- address pylint warnings
+- add basic `create_row()` support, esp. for batch views
+- update dependencies for wuttjamaican, wutta-continuum
+- make master view auto-detect continuum versioning for model class
+- fix 'invalid-name' for pylint
+
 ## v0.23.2 (2025-10-19)
 
 ### Fix

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.23.2
+Version: 0.24.0
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -39,10 +39,10 @@ Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.24.0
+Requires-Dist: wuttjamaican[db]>=0.25.0
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
-Requires-Dist: wutta-continuum; extra == 'continuum'
+Requires-Dist: wutta-continuum>=0.2.2; extra == 'continuum'
 Provides-Extra: docs
 Requires-Dist: furo; extra == 'docs'
 Requires-Dist: sphinx; extra == 'docs'

wuttaweb-0.24.0/docs/api/wuttaweb.diffs.rst

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

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/docs/index.rst

@@ -41,6 +41,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.db
    api/wuttaweb.db.continuum
    api/wuttaweb.db.sess
+   api/wuttaweb.diffs
    api/wuttaweb.emails
    api/wuttaweb.forms
    api/wuttaweb.forms.base

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.23.2"
+version = "0.24.0"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]
@@ -44,13 +44,13 @@ dependencies = [
         "pyramid_tm",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.24.0",
+        "WuttJamaican[db]>=0.25.0",
         "zope.sqlalchemy>=1.5",
 ]
 
 
 [project.optional-dependencies]
-continuum = ["Wutta-Continuum"]
+continuum = ["Wutta-Continuum>=0.2.2"]
 docs = ["Sphinx", "furo", "sphinxcontrib-programoutput"]
 tests = ["pylint", "pytest", "pytest-cov", "tox"]
 
@@ -91,3 +91,9 @@ update_changelog_on_bump = true
 exclude = [
   "htmlcov/",
 ]
+
+
+[tool.pytest.ini_options]
+markers = [
+        "versioned: tests with SQLAlchemy-Continuum versioning feature enabled",
+]

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/db/sess.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  wuttaweb -- Web App for Wutta Framework
-#  Copyright © 2024 Lance Edgar
+#  Copyright © 2024-2025 Lance Edgar
 #
 #  This file is part of Wutta Framework.
 #
@@ -61,6 +61,6 @@ from sqlalchemy import orm
 from zope.sqlalchemy.datamanager import register
 
 
-Session = orm.scoped_session(orm.sessionmaker())
+Session = orm.scoped_session(orm.sessionmaker())  # pylint: disable=invalid-name
 
 register(Session)

wuttaweb-0.24.0/src/wuttaweb/diffs.py

@@ -0,0 +1,224 @@
+# -*- coding: utf-8; -*-
+################################################################################
+#
+#  wuttaweb -- Web App for Wutta Framework
+#  Copyright © 2024-2025 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/>.
+#
+################################################################################
+"""
+Tools for displaying simple data diffs
+"""
+
+import sqlalchemy as sa
+
+from pyramid.renderers import render
+from webhelpers2.html import HTML
+
+
+class Diff:
+    """
+    Represent / display a basic "diff" between two data records.
+
+    You must provide both the "old" and "new" data records, when
+    constructing an instance of this class.  Then call
+    :meth:`render_html()` to display the diff table.
+
+    :param old_data: Dict of "old" data record.
+
+    :param new_data: Dict of "new" data record.
+
+    :param fields: Optional list of field names.  If not specified,
+       will be derived from the data records.
+
+    :param nature: What sort of diff is being represented; must be one
+       of: ``("create", "update", "delete")``
+
+    :param old_color: Background color to display for "old/deleted"
+       field data, when applicable.
+
+    :param new_color: Background color to display for "new/created"
+       field data, when applicable.
+    """
+
+    def __init__(  # pylint: disable=too-many-arguments,too-many-positional-arguments
+        self,
+        old_data: dict,
+        new_data: dict,
+        fields: list = None,
+        nature="update",
+        old_color="#ffebe9",
+        new_color="#dafbe1",
+    ):
+        self.old_data = old_data
+        self.new_data = new_data
+        self.columns = ["field name", "old value", "new value"]
+        self.fields = fields or self.make_fields()
+        self.nature = nature
+        self.old_color = old_color
+        self.new_color = new_color
+
+    def make_fields(self):  # pylint: disable=missing-function-docstring
+        return sorted(set(self.old_data) | set(self.new_data), key=lambda x: x.lower())
+
+    def old_value(self, field):  # pylint: disable=missing-function-docstring
+        return self.old_data.get(field)
+
+    def new_value(self, field):  # pylint: disable=missing-function-docstring
+        return self.new_data.get(field)
+
+    def values_differ(self, field):  # pylint: disable=missing-function-docstring
+        return self.new_value(field) != self.old_value(field)
+
+    def render_html(self, template="/diff.mako", **kwargs):
+        """
+        Render the diff as HTML table.
+
+        :param template: Name of template to render, if you need to
+           override the default.
+
+        :param \\**kwargs: Remaining kwargs are passed as context to
+           the template renderer.
+
+        :returns: HTML literal string
+        """
+        context = kwargs
+        context["diff"] = self
+        return HTML.literal(render(template, context))
+
+    def render_field_row(self, field):  # pylint: disable=missing-function-docstring
+        is_diff = self.values_differ(field)
+
+        td_field = HTML.tag("td", class_="field", c=field)
+
+        td_old_value = HTML.tag(
+            "td",
+            c=self.render_old_value(field),
+            **self.get_old_value_attrs(is_diff),
+        )
+
+        td_new_value = HTML.tag(
+            "td",
+            c=self.render_new_value(field),
+            **self.get_new_value_attrs(is_diff),
+        )
+
+        return HTML.tag("tr", c=[td_field, td_old_value, td_new_value])
+
+    def render_old_value(self, field):  # pylint: disable=missing-function-docstring
+        value = self.old_value(field)
+        return repr(value)
+
+    def render_new_value(self, field):  # pylint: disable=missing-function-docstring
+        value = self.new_value(field)
+        return repr(value)
+
+    def get_old_value_attrs(  # pylint: disable=missing-function-docstring
+        self, is_diff
+    ):
+        attrs = {}
+        if self.nature == "update" and is_diff:
+            attrs["style"] = f"background-color: {self.old_color};"
+        elif self.nature == "delete":
+            attrs["style"] = f"background-color: {self.old_color};"
+        return attrs
+
+    def get_new_value_attrs(  # pylint: disable=missing-function-docstring
+        self, is_diff
+    ):
+        attrs = {}
+        if self.nature == "create":
+            attrs["style"] = f"background-color: {self.new_color};"
+        elif self.nature == "update" and is_diff:
+            attrs["style"] = f"background-color: {self.new_color};"
+        return attrs
+
+
+class VersionDiff(Diff):
+    """
+    Special diff class, for use with version history views.  Note that
+    while based on :class:`Diff`, this class uses a different
+    signature for the constructor.
+
+    :param version: Reference to a Continuum version record (object).
+
+    :param \\**kwargs: Remaining kwargs are passed as-is to the
+       :class:`Diff` constructor.
+    """
+
+    def __init__(self, version, **kwargs):
+        import sqlalchemy_continuum as continuum  # pylint: disable=import-outside-toplevel
+        from wutta_continuum.util import (  # pylint: disable=import-outside-toplevel
+            render_operation_type,
+        )
+
+        self.version = version
+        self.model_class = continuum.parent_class(type(self.version))
+        self.mapper = sa.inspect(self.model_class)
+        self.version_mapper = sa.inspect(type(self.version))
+        self.title = kwargs.pop("title", self.model_class.__name__)
+
+        self.operation_title = render_operation_type(self.version.operation_type)
+
+        if "nature" not in kwargs:
+            if (
+                version.previous
+                and version.operation_type == continuum.Operation.DELETE
+            ):
+                kwargs["nature"] = "delete"
+            elif version.previous:
+                kwargs["nature"] = "update"
+            else:
+                kwargs["nature"] = "create"
+
+        if "fields" not in kwargs:
+            kwargs["fields"] = self.get_default_fields()
+
+        old_data = {}
+        new_data = {}
+        for field in kwargs["fields"]:
+            if version.previous:
+                old_data[field] = getattr(version.previous, field)
+            new_data[field] = getattr(version, field)
+
+        super().__init__(old_data, new_data, **kwargs)
+
+    def get_default_fields(self):  # pylint: disable=missing-function-docstring
+        fields = sorted(self.version_mapper.columns.keys())
+
+        unwanted = [
+            "transaction_id",
+            "end_transaction_id",
+            "operation_type",
+        ]
+
+        return [field for field in fields if field not in unwanted]
+
+    def render_version_value(self, value):  # pylint: disable=missing-function-docstring
+        return HTML.tag("span", c=[repr(value)], style="font-family: monospace;")
+
+    def render_old_value(self, field):
+        if self.nature == "create":
+            return ""
+        value = self.old_value(field)
+        return self.render_version_value(value)
+
+    def render_new_value(self, field):
+        if self.nature == "delete":
+            return ""
+        value = self.new_value(field)
+        return self.render_version_value(value)

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/grids/base.py

@@ -84,7 +84,8 @@ class Grid:  # pylint: disable=too-many-instance-attributes,too-many-public-meth
     .. attribute:: vue_tagname
 
        String name for Vue component tag.  By default this is
-       ``'wutta-grid'``.  See also :meth:`render_vue_tag()`.
+       ``'wutta-grid'``.  See also :meth:`render_vue_tag()`
+       and :attr:`vue_component`.
 
     .. attribute:: model_class
 
@@ -841,8 +842,9 @@ class Grid:  # pylint: disable=too-many-instance-attributes,too-many-public-meth
     def set_tools(self, tools):
         """
         Set the :attr:`tools` attribute using the given tools collection.
-
         This will normalize the list/dict to desired internal format.
+
+        See also :meth:`add_tool()`.
         """
         if tools and isinstance(tools, list):
             if not any(isinstance(t, (tuple, list)) for t in tools):

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/handler.py

@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  wuttaweb -- Web App for Wutta Framework
-#  Copyright © 2024 Lance Edgar
+#  Copyright © 2024-2025 Lance Edgar
 #
 #  This file is part of Wutta Framework.
 #

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/subscribers.py

@@ -41,6 +41,7 @@ import logging
 from collections import OrderedDict
 
 from pyramid import threadlocal
+from pyramid.httpexceptions import HTTPFound
 
 from wuttaweb import helpers
 from wuttaweb.db import Session
@@ -123,6 +124,17 @@ def new_request(event):
     config = request.registry.settings["wutta_config"]
     app = config.get_app()
 
+    # nb. in rare circumstances i have received unhandled error email,
+    # which somehow was triggered by 'fanstatic.needed' being missing
+    # from the environ.  not sure why that would happen, but it seems
+    # to when crawlers request a non-existent filename under the
+    # fanstatic path.  there isn't a great way to handle it since
+    # e.g. can't show the normal error page if JS resources won't
+    # load, so we try a hail-mary redirect..
+    # (nb. also we skip this if environ is empty, i.e. for tests)
+    if request.environ and "fanstatic.needed" not in request.environ:
+        raise HTTPFound(location=request.route_url("home"))
+
     request.wutta_config = config
 
     def get_referrer(default=None):

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/templates/base.mako

@@ -152,6 +152,8 @@
         font-size: 2rem;
         font-weight: bold;
         margin-bottom: 0 !important;
+        display: flex;
+        gap: 0.6rem;
     }
 
     #content-title h1 {
@@ -242,7 +244,9 @@
             ## nb. this is the index title proper
             <div class="level-left">
               <div id="header-index-title" class="level-item">
-                % if index_title:
+                % if index_title_rendered is not Undefined and index_title_rendered:
+                    <h1 class="title">${index_title_rendered}</h1>
+                % elif index_title:
                     % if index_url:
                         <h1 class="title">${h.link_to(index_title, index_url)}</h1>
                     % else:
@@ -279,7 +283,7 @@
                      class="has-background-primary">
               <div style="display: flex; align-items: center; gap: 0.5rem; padding: 0.5rem;">
 
-                <div style="width: 60%; display: flex; gap: 0.5rem;">
+                <div style="width: 60%; display: flex; gap: 1rem;">
 
                   <h1 class="title has-text-white"
                       v-html="contentTitleHTML">
@@ -781,7 +785,32 @@
   % endif
 </%def>
 
-<%def name="render_prevnext_header_buttons()"></%def>
+<%def name="render_prevnext_header_buttons()">
+  % if show_prev_next is not Undefined and show_prev_next:
+      <b-button tag="a"
+                % if prev_url:
+                    href="${prev_url}"
+                % else:
+                    href="#"
+                    disabled
+                % endif
+                icon-pack="fas"
+                icon-left="arrow-left">
+        Older
+      </b-button>
+      <b-button tag="a"
+                % if next_url:
+                    href="${next_url}"
+                % else:
+                    href="#"
+                    disabled
+                % endif
+                icon-pack="fas"
+                icon-left="arrow-right">
+        Newer
+      </b-button>
+  % endif
+</%def>
 
 ##############################
 ## vue components + app

wuttaweb-0.24.0/src/wuttaweb/templates/diff.mako

@@ -0,0 +1,15 @@
+## -*- coding: utf-8; -*-
+<table class="table is-fullwidth is-bordered is-narrow">
+  <thead>
+    <tr>
+      % for column in diff.columns:
+          <th>${column}</th>
+      % endfor
+    </tr>
+  </thead>
+  <tbody>
+    % for field in diff.fields:
+       ${diff.render_field_row(field)}
+    % endfor
+  </tbody>
+</table>

wuttaweb-0.24.0/src/wuttaweb/templates/master/create_row.mako

@@ -0,0 +1,4 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/master/form.mako" />
+
+<%def name="title()">New ${row_model_title}</%def>

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/templates/master/view.mako

@@ -5,6 +5,18 @@
 
 <%def name="content_title()">${instance_title}</%def>
 
+<%def name="render_instance_header_title_extras()">
+  ${parent.render_instance_header_title_extras()}
+  % if master.should_expose_versions():
+      <b-button tag="a"
+                href="${master.get_action_url('versions', instance)}"
+                icon-pack="fas"
+                icon-left="history">
+        View History
+      </b-button>
+  % endif
+</%def>
+
 <%def name="page_layout()">
 
   % if master.has_rows:

wuttaweb-0.24.0/src/wuttaweb/templates/master/view_version.mako

@@ -0,0 +1,35 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/master/form.mako" />
+
+<%def name="title()">${index_title} » ${instance_title} » changes @ TXN ${transaction.id}</%def>
+
+<%def name="content_title()">changes @ TXN ${transaction.id}</%def>
+
+<%def name="page_content()">
+  <div class="wutta-form-wrapper">
+
+    <b-field label="Changed" horizontal>
+      <span>${changed}</span>
+    </b-field>
+
+    <b-field label="Changed by" horizontal>
+      <span>${transaction.user or ""}</span>
+    </b-field>
+
+    <b-field label="IP Address" horizontal>
+      <span>${transaction.remote_addr or ""}</span>
+    </b-field>
+
+    <b-field label="TXN ID" horizontal>
+      <span>${transaction.id}</span>
+    </b-field>
+
+  </div>
+
+  <div style="padding: 2rem;">
+    % for diff in version_diffs:
+        <h4 class="is-size-4 block">${diff.title} (${diff.operation_title})</h4>
+        ${diff.render_html()}
+    % endfor
+  </div>
+</%def>

wuttaweb-0.24.0/src/wuttaweb/templates/master/view_versions.mako

@@ -0,0 +1,20 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/page.mako" />
+
+<%def name="title()">${index_title} » ${instance_title} » history</%def>
+
+<%def name="content_title()">Version History</%def>
+
+<%def name="page_content()">
+  ${grid.render_vue_tag()}
+</%def>
+
+<%def name="render_vue_templates()">
+  ${parent.render_vue_templates()}
+  ${grid.render_vue_template()}
+</%def>
+
+<%def name="make_vue_components()">
+  ${parent.make_vue_components()}
+  ${grid.render_vue_finalize()}
+</%def>

{wuttaweb-0.23.2 → wuttaweb-0.24.0}/src/wuttaweb/testing.py

@@ -24,14 +24,18 @@
 WuttaWeb - test utilities
 """
 
+import sys
 from unittest.mock import MagicMock
 
 import fanstatic
+import pytest
 from pyramid import testing
 
 from wuttjamaican.testing import DataTestCase
+from wuttjamaican.db.model.base import metadata
 
 from wuttaweb import subscribers
+from wuttaweb.conf import WuttaWebConfigExtension
 
 
 class WebTestCase(DataTestCase):
@@ -101,4 +105,66 @@ class WebTestCase(DataTestCase):
         """
         Make and return a new dummy request object.
         """
-        return testing.DummyRequest()
+        return testing.DummyRequest(client_addr="127.0.0.1")
+
+
+@pytest.mark.versioned
+class VersionWebTestCase(WebTestCase):
+    """
+    Base class for test suites requiring a full (typical) web app,
+    with Continuum versioning support.
+    """
+
+    def setUp(self):
+        self.setup_versioning()
+
+    def setup_versioning(self):
+        """
+        Perform setup for the testing web app.
+        """
+        self.setup_web()
+
+    def tearDown(self):
+        self.teardown_versioning()
+
+    def teardown_versioning(self):
+        """
+        Perform teardown for the testing web app.
+        """
+        import sqlalchemy_continuum as continuum  # pylint: disable=import-outside-toplevel
+
+        continuum.remove_versioning()
+        continuum.versioning_manager.transaction_cls = continuum.TransactionFactory()
+        self.teardown_web()
+
+    def make_config(self, **kwargs):
+        """
+        Make and customize the config object.
+
+        We override this to explicitly enable the versioning feature.
+        """
+        from wutta_continuum.conf import (  # pylint: disable=import-outside-toplevel
+            WuttaContinuumConfigExtension,
+        )
+
+        config = super().make_config(**kwargs)
+        config.setdefault("wutta_continuum.enable_versioning", "true")
+
+        # nb. must purge model classes from sys.modules, so they will
+        # be reloaded and sqlalchemy-continuum can reconfigure
+        if "wuttjamaican.db.model" in sys.modules:
+            del sys.modules["wuttjamaican.db.model.batch"]
+            del sys.modules["wuttjamaican.db.model.upgrades"]
+            del sys.modules["wuttjamaican.db.model.auth"]
+            del sys.modules["wuttjamaican.db.model.base"]
+            del sys.modules["wuttjamaican.db.model"]
+
+        self.assertNotIn("user_version", metadata.tables)
+
+        ext = WuttaWebConfigExtension()
+        ext.configure(config)
+
+        ext = WuttaContinuumConfigExtension()
+        ext.startup(config)
+
+        return config