WuttaWeb 0.25.0__tar.gz → 0.26.0__tar.gz

{wuttaweb-0.25.0 → wuttaweb-0.26.0}/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.26.0 (2025-12-28)
+
+### Feat
+
+- add "wizard" for creating new table/model/revision
+- add support for Create Alembic Migration
+- add CopyableTextWidget and `<wutta-copyable-text>` component
+- overhaul how form vue template is rendered
+- add basic views for Alembic Migrations, Dashboard
+- add basic Table views
+
+### Fix
+
+- let checkbox widget show static text instead of Yes/No
+- rename form-saving methods etc. for consistency in MasterView
+- temporarily avoid make_uuid()
+- remove password filter option for Users grid
+- use smarter default for `grid.sort_multiple` based on model class
+
+## v0.25.1 (2025-12-20)
+
+### Fix
+
+- add `WebDiff` class now that `Diff` lives in wuttjamaican
+- expose fallback key for email settings
+- expose transaction comment for version history
+- show display text for related objects, in version diff
+- discard non-declared field values for grid vue data
+- prevent error in DateTime schema type if no widget/request set
+
 ## v0.25.0 (2025-12-17)
 
 ### Feat

{wuttaweb-0.25.0 → wuttaweb-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.25.0
+Version: 0.26.0
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -37,12 +37,13 @@ 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.26.0
+Requires-Dist: wuttjamaican[db]>=0.28.0
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
-Requires-Dist: wutta-continuum>=0.2.2; extra == 'continuum'
+Requires-Dist: wutta-continuum>=0.3.0; extra == 'continuum'
 Provides-Extra: docs
 Requires-Dist: furo; extra == 'docs'
 Requires-Dist: sphinx; extra == 'docs'

wuttaweb-0.26.0/docs/api/wuttaweb.views.alembic.rst

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

wuttaweb-0.26.0/docs/api/wuttaweb.views.tables.rst

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

{wuttaweb-0.25.0 → wuttaweb-0.26.0}/docs/conf.py

@@ -28,6 +28,7 @@ templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 intersphinx_mapping = {
+    "alembic": ("https://alembic.sqlalchemy.org/en/latest/", None),
     "colander": ("https://docs.pylonsproject.org/projects/colander/en/latest/", None),
     "deform": ("https://docs.pylonsproject.org/projects/deform/en/latest/", None),
     "fanstatic": ("https://www.fanstatic.org/en/latest/", None),

{wuttaweb-0.25.0 → wuttaweb-0.26.0}/docs/index.rst

@@ -58,6 +58,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.subscribers
    api/wuttaweb.util
    api/wuttaweb.views
+   api/wuttaweb.views.alembic
    api/wuttaweb.views.auth
    api/wuttaweb.views.base
    api/wuttaweb.views.batch
@@ -70,6 +71,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.views.reports
    api/wuttaweb.views.roles
    api/wuttaweb.views.settings
+   api/wuttaweb.views.tables
    api/wuttaweb.views.upgrades
    api/wuttaweb.views.users
 

{wuttaweb-0.25.0 → wuttaweb-0.26.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.25.0"
+version = "0.26.0"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]
@@ -42,15 +42,16 @@ dependencies = [
         "pyramid_fanstatic",
         "pyramid_mako",
         "pyramid_tm",
+        "SQLAlchemy-Utils",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.26.0",
+        "WuttJamaican[db]>=0.28.0",
         "zope.sqlalchemy>=1.5",
 ]
 
 
 [project.optional-dependencies]
-continuum = ["Wutta-Continuum>=0.2.2"]
+continuum = ["Wutta-Continuum>=0.3.0"]
 docs = ["Sphinx", "furo", "sphinxcontrib-programoutput"]
 tests = ["pylint", "pytest", "pytest-cov", "tox"]
 

wuttaweb-0.26.0/src/wuttaweb/code-templates/new-table.mako

@@ -0,0 +1,68 @@
+## -*- coding: utf-8; mode: python; -*-
+# -*- coding: utf-8; -*-
+"""
+Model definition for ${model_title_plural}
+"""
+
+import sqlalchemy as sa
+from sqlalchemy import orm
+
+from wuttjamaican.db import model
+
+
+class ${model_name}(model.Base):
+    """
+    ${description}
+    """
+    __tablename__ = "${table_name}"
+    % if any([c["data_type"]["type"] == "_fk_uuid_" for c in columns]):
+    __table_args__ = (
+        % for column in columns:
+        % if column["data_type"]["type"] == "_fk_uuid_":
+        sa.ForeignKeyConstraint(["${column['name']}"], ["${column['data_type']['reference']}.uuid"],
+                                name="${table_name}_fk_${column['data_type']['reference']}"),
+        % endif
+        % endfor
+    )
+    % endif
+    % if versioned:
+    % if all([c["versioned"] for c in columns]):
+    __versioned__ = {}
+    % else:
+    __versioned__ = {
+        "exclude": [
+            % for column in columns:
+            % if not column["versioned"]:
+            "${column['name']}",
+            % endif
+            % endfor
+        ],
+    }
+    % endif
+    % endif
+    __wutta_hint__ = {
+        "model_title": "${model_title}",
+        "model_title_plural": "${model_title_plural}",
+    }
+    % for column in columns:
+
+    % if column["name"] == "uuid":
+    uuid = model.uuid_column()
+    % else:
+    ${column["name"]} = sa.Column(${column["formatted_data_type"]}, nullable=${column["nullable"]}, doc="""
+    ${column["description"] or ""}
+    """)
+    % if column["data_type"]["type"] == "_fk_uuid_" and column["relationship"]:
+    ${column["relationship"]["name"]} = orm.relationship(
+        "${column['relationship']['reference_model']}",
+        doc="""
+        ${column["description"] or ""}
+        """)
+    % endif
+    % endif
+    % endfor
+
+    # TODO: you usually should define the __str__() method
+
+    # def __str__(self):
+    #     return self.name or ""

wuttaweb-0.26.0/src/wuttaweb/diffs.py

@@ -0,0 +1,199 @@
+# -*- 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
+
+from wuttjamaican.diffs import Diff
+
+
+class WebDiff(Diff):
+    """
+    Simple diff class for the web app.
+
+    This is based on the
+    :class:`~wuttjamaican:wuttjamaican.diffs.Diff` class; it just
+    tweaks :meth:`render_html()` to use the web template lookup
+    engine.
+    """
+
+    cell_padding = None
+
+    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
+        html = render(template, context)
+        return HTML.literal(html)
+
+
+class VersionDiff(WebDiff):
+    """
+    Special diff class for use with version history views.  While
+    based on :class:`WebDiff`, this class uses a different signature
+    for the constructor.
+
+    :param config: The app :term:`config object`.
+
+    :param version: Reference to a Continuum version record object.
+
+    :param \\**kwargs: Remaining kwargs are passed as-is to the
+       :class:`WebDiff` constructor.
+    """
+
+    def __init__(self, config, 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__(config, 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, version, field, value):
+        """
+        Render the cell value HTML for a given version + field.
+
+        This method is used to render both sides of the diff (old +
+        new values).  It will just render the field value using a
+        monospace font by default.  However:
+
+        If the field is involved in a mapper relationship (i.e. it is
+        the "foreign key" to a related table), the logic here will
+        also (try to) traverse that show display text for the related
+        object (if found).
+
+        :param version: Reference to the Continuum version object.
+
+        :param field: Name of the field, as string.
+
+        :param value: Raw value for the field, as obtained from the
+           version object.
+
+        :returns: Rendered cell value as HTML literal
+        """
+        # first render normal span; this is our fallback but also may
+        # be embedded within a more complex result.
+        text = HTML.tag("span", c=[repr(value)], style="font-family: monospace;")
+
+        # loop thru all mapped relationship props
+        for prop in self.mapper.relationships:
+
+            # we only want singletons
+            if prop.uselist:
+                continue
+
+            # loop thru columns for prop
+            # nb. there should always be just one colum for a
+            # singleton prop, but technically a list is used, so no
+            # harm in looping i assume..
+            for col in prop.local_columns:
+
+                # we only want the matching column
+                if col.name != field:
+                    continue
+
+                # grab "related version" reference via prop key.  this
+                # would be like a UserVersion for instance.
+                if ref := getattr(version, prop.key):
+
+                    # grab "related object" reference.  this would be
+                    # like a User for instance.
+                    if ref := getattr(ref, "version_parent", None):
+
+                        # render text w/ related object as bold string
+                        style = (
+                            "margin-left: 2rem; font-style: italic; font-weight: bold;"
+                        )
+                        return HTML.tag(
+                            "span",
+                            c=[text, HTML.tag("span", c=[str(ref)], style=style)],
+                        )
+
+        return text
+
+    def render_old_value(self, field):
+        if self.nature == "create":
+            return ""
+        value = self.old_value(field)
+        return self.render_version_value(self.version.previous, field, value)
+
+    def render_new_value(self, field):
+        if self.nature == "delete":
+            return ""
+        value = self.new_value(field)
+        return self.render_version_value(self.version, field, value)