WuttaWeb 0.20.0__tar.gz → 0.20.1__tar.gz

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

@@ -5,6 +5,15 @@ 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.20.0
+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.20.0
+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.0 → wuttaweb-0.20.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.20.0"
+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.20.0",
+        "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.20.0 → 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.20.0 → 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.20.0 → 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.20.0 → 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
 
@@ -2707,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``.
@@ -2721,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}")
 

{wuttaweb-0.20.0 → wuttaweb-0.20.1}/src/wuttaweb/views/settings.py

@@ -129,6 +129,10 @@ class AppInfoView(MasterView):
             {'name': f'{self.config.appname}.node_title'},
             {'name': f'{self.config.appname}.production',
              'type': bool},
+            {'name': f'{self.config.appname}.web.menus.handler.spec'},
+            # nb. this is deprecated; we define so it is auto-deleted
+            # when we replace with newer setting
+            {'name': f'{self.config.appname}.web.menus.handler_spec'},
 
             # user/auth
             {'name': 'wuttaweb.home_redirect_to_login',
@@ -164,11 +168,15 @@ class AppInfoView(MasterView):
 
     def configure_get_context(self, **kwargs):
         """ """
-
-        # normal context
         context = super().configure_get_context(**kwargs)
 
-        # we will add `weblibs` to context, based on config values
+        # add registered menu handlers
+        web = self.app.get_web_handler()
+        handlers = web.get_menu_handler_specs()
+        handlers = [{'spec': spec} for spec in handlers]
+        context['menu_handlers'] = handlers
+
+        # add `weblibs` to context, based on config values
         weblibs = self.get_weblibs()
         for key in weblibs:
             title = weblibs[key]
@@ -192,8 +200,8 @@ class AppInfoView(MasterView):
                 'live_url': get_liburl(self.request, key,
                                        prefix=self.weblib_config_prefix),
             }
-
         context['weblibs'] = list(weblibs.values())
+
         return context
 
 

{wuttaweb-0.20.0 → wuttaweb-0.20.1}/tests/grids/test_filters.py

@@ -326,6 +326,30 @@ class TestStringAlchemyFilter(WebTestCase):
         self.assertEqual(filtered_query.count(), 6)
 
 
+class TestIntegerAlchemyFilter(WebTestCase):
+
+    def make_filter(self, model_property, **kwargs):
+        factory = kwargs.pop('factory', mod.IntegerAlchemyFilter)
+        kwargs['model_property'] = model_property
+        return factory(self.request, model_property.key, **kwargs)
+
+    def test_coerce_value(self):
+        model = self.app.model
+        filtr = self.make_filter(model.Upgrade.exit_code)
+
+        # null
+        self.assertIsNone(filtr.coerce_value(None))
+        self.assertIsNone(filtr.coerce_value(''))
+
+        # typical
+        self.assertEqual(filtr.coerce_value('42'), 42)
+        self.assertEqual(filtr.coerce_value('-42'), -42)
+
+        # invalid
+        self.assertIsNone(filtr.coerce_value('42.12'))
+        self.assertIsNone(filtr.coerce_value('bogus'))
+
+
 class TestBooleanAlchemyFilter(WebTestCase):
 
     def setUp(self):

wuttaweb-0.20.1/tests/test_handler.py

@@ -0,0 +1,149 @@
+# -*- coding: utf-8; -*-
+
+from unittest.mock import patch
+
+from wuttaweb import handler as mod, static
+from wuttaweb.forms import Form
+from wuttaweb.grids import Grid
+from wuttaweb.menus import MenuHandler
+from wuttaweb.testing import WebTestCase
+
+
+class MockMenuHandler(MenuHandler):
+    pass
+
+class LegacyMenuHandler(MenuHandler):
+    pass
+
+class AnotherMenuHandler(MenuHandler):
+    pass
+
+
+class TestWebHandler(WebTestCase):
+
+    def make_handler(self):
+        return mod.WebHandler(self.config)
+
+    def test_get_fanstatic_url(self):
+        handler = self.make_handler()
+
+        # default with / root path
+        url = handler.get_fanstatic_url(self.request, static.logo)
+        self.assertEqual(url, '/fanstatic/wuttaweb_img/logo.png')
+
+        # what about a subpath
+        self.request.script_name = '/testing'
+        url = handler.get_fanstatic_url(self.request, static.logo)
+        self.assertEqual(url, '/testing/fanstatic/wuttaweb_img/logo.png')
+
+    def test_get_favicon_url(self):
+        handler = self.make_handler()
+
+        # default
+        url = handler.get_favicon_url(self.request)
+        self.assertEqual(url, '/fanstatic/wuttaweb_img/favicon.ico')
+
+        # config override
+        self.config.setdefault('wuttaweb.favicon_url', '/testing/other.ico')
+        url = handler.get_favicon_url(self.request)
+        self.assertEqual(url, '/testing/other.ico')
+
+    def test_get_header_logo_url(self):
+        handler = self.make_handler()
+
+        # default
+        url = handler.get_header_logo_url(self.request)
+        self.assertEqual(url, '/fanstatic/wuttaweb_img/favicon.ico')
+
+        # config override
+        self.config.setdefault('wuttaweb.header_logo_url', '/testing/header.png')
+        url = handler.get_header_logo_url(self.request)
+        self.assertEqual(url, '/testing/header.png')
+
+    def test_get_main_logo_url(self):
+        handler = self.make_handler()
+
+        # default
+        url = handler.get_main_logo_url(self.request)
+        self.assertEqual(url, '/fanstatic/wuttaweb_img/logo.png')
+
+        # config override
+        self.config.setdefault('wuttaweb.logo_url', '/testing/other.png')
+        url = handler.get_main_logo_url(self.request)
+        self.assertEqual(url, '/testing/other.png')
+
+    def test_get_menu_handler(self):
+        handler = self.make_handler()
+
+        # built-in default
+        menus = handler.get_menu_handler()
+        self.assertIsInstance(menus, MenuHandler)
+        self.assertIs(type(menus), MenuHandler)
+
+        # configured default
+        self.config.setdefault('wutta.web.menus.handler.default_spec',
+                               'tests.test_handler:MockMenuHandler')
+        menus = handler.get_menu_handler()
+        self.assertIsInstance(menus, MockMenuHandler)
+
+        # configured handler (legacy)
+        self.config.setdefault('wutta.web.menus.handler_spec',
+                               'tests.test_handler:LegacyMenuHandler')
+        menus = handler.get_menu_handler()
+        self.assertIsInstance(menus, LegacyMenuHandler)
+
+        # configued handler (proper)
+        self.config.setdefault('wutta.web.menus.handler.spec',
+                               'tests.test_handler:AnotherMenuHandler')
+        menus = handler.get_menu_handler()
+        self.assertIsInstance(menus, AnotherMenuHandler)
+
+    def test_get_menu_handler_specs(self):
+        handler = self.make_handler()
+
+        # at least one spec by default
+        specs = handler.get_menu_handler_specs()
+        self.assertIn('wuttaweb.menus:MenuHandler', specs)
+
+        # caller can specify default as string
+        specs = handler.get_menu_handler_specs(default='tests.test_handler:MockMenuHandler')
+        self.assertIn('wuttaweb.menus:MenuHandler', specs)
+        self.assertIn('tests.test_handler:MockMenuHandler', specs)
+        self.assertNotIn('tests.test_handler:AnotherMenuHandler', specs)
+
+        # caller can specify default as list
+        specs = handler.get_menu_handler_specs(default=[
+            'tests.test_handler:MockMenuHandler',
+            'tests.test_handler:AnotherMenuHandler'])
+        self.assertIn('wuttaweb.menus:MenuHandler', specs)
+        self.assertIn('tests.test_handler:MockMenuHandler', specs)
+        self.assertIn('tests.test_handler:AnotherMenuHandler', specs)
+
+        # default can be configured
+        self.config.setdefault('wutta.web.menus.handler.default_spec',
+                               'tests.test_handler:AnotherMenuHandler')
+        specs = handler.get_menu_handler_specs()
+        self.assertIn('wuttaweb.menus:MenuHandler', specs)
+        self.assertNotIn('tests.test_handler:MockMenuHandler', specs)
+        self.assertIn('tests.test_handler:AnotherMenuHandler', specs)
+
+        # the rest come from entry points
+        with patch.object(mod, 'load_entry_points', return_value={
+                'legacy': LegacyMenuHandler,
+        }):
+            specs = handler.get_menu_handler_specs()
+            self.assertNotIn('wuttaweb.menus:MenuHandler', specs)
+            self.assertNotIn('tests.test_handler:MockMenuHandler', specs)
+            self.assertIn('tests.test_handler:LegacyMenuHandler', specs)
+            # nb. this remains from previous config default
+            self.assertIn('tests.test_handler:AnotherMenuHandler', specs)
+
+    def test_make_form(self):
+        handler = self.make_handler()
+        form = handler.make_form(self.request)
+        self.assertIsInstance(form, Form)
+
+    def test_make_grid(self):
+        handler = self.make_handler()
+        grid = handler.make_grid(self.request)
+        self.assertIsInstance(grid, Grid)

{wuttaweb-0.20.0 → wuttaweb-0.20.1}/tests/views/test_master.py

@@ -1528,42 +1528,50 @@ class TestMasterView(WebTestCase):
                                     get_index_url=MagicMock(return_value='/appinfo/'),
                                     configure_get_simple_settings=MagicMock(return_value=settings)):
 
-                    # get the form page
-                    response = view.configure(session=self.session)
-                    self.assertIsInstance(response, Response)
-
-                    # post request to save settings
-                    self.request.method = 'POST'
-                    self.request.POST = {
-                        'wutta.app_title': 'Wutta',
-                        'wutta.foo': 'bar',
-                        'wutta.flag': 'true',
-                    }
-                    response = view.configure(session=self.session)
-                    # nb. should get redirect back to configure page
-                    self.assertEqual(response.status_code, 302)
+                    # nb. appinfo/configure template requires menu_handlers
+                    original_context = view.configure_get_context
+                    def get_context(**kw):
+                        kw = original_context(**kw)
+                        kw['menu_handlers'] = []
+                        return kw
+                    with patch.object(view, 'configure_get_context', new=get_context):
+
+                        # get the form page
+                        response = view.configure(session=self.session)
+                        self.assertIsInstance(response, Response)
+
+                        # post request to save settings
+                        self.request.method = 'POST'
+                        self.request.POST = {
+                            'wutta.app_title': 'Wutta',
+                            'wutta.foo': 'bar',
+                            'wutta.flag': 'true',
+                        }
+                        response = view.configure(session=self.session)
+                        # nb. should get redirect back to configure page
+                        self.assertEqual(response.status_code, 302)
 
-                    # should now have 5 settings
-                    count = self.session.query(model.Setting).count()
-                    self.assertEqual(count, 5)
-                    get_setting = functools.partial(self.app.get_setting, self.session)
-                    self.assertEqual(get_setting('wutta.app_title'), 'Wutta')
-                    self.assertEqual(get_setting('wutta.foo'), 'bar')
-                    self.assertEqual(get_setting('wutta.flag'), 'true')
-                    self.assertEqual(get_setting('wutta.number'), '42')
-                    self.assertEqual(get_setting('wutta.value1'), '')
-                    self.assertEqual(get_setting('wutta.value2'), None)
-
-                    # post request to remove settings
-                    self.request.method = 'POST'
-                    self.request.POST = {'remove_settings': '1'}
-                    response = view.configure(session=self.session)
-                    # nb. should get redirect back to configure page
-                    self.assertEqual(response.status_code, 302)
+                        # should now have 5 settings
+                        count = self.session.query(model.Setting).count()
+                        self.assertEqual(count, 5)
+                        get_setting = functools.partial(self.app.get_setting, self.session)
+                        self.assertEqual(get_setting('wutta.app_title'), 'Wutta')
+                        self.assertEqual(get_setting('wutta.foo'), 'bar')
+                        self.assertEqual(get_setting('wutta.flag'), 'true')
+                        self.assertEqual(get_setting('wutta.number'), '42')
+                        self.assertEqual(get_setting('wutta.value1'), '')
+                        self.assertEqual(get_setting('wutta.value2'), None)
+
+                        # post request to remove settings
+                        self.request.method = 'POST'
+                        self.request.POST = {'remove_settings': '1'}
+                        response = view.configure(session=self.session)
+                        # nb. should get redirect back to configure page
+                        self.assertEqual(response.status_code, 302)
 
-                    # should now have 0 settings
-                    count = self.session.query(model.Setting).count()
-                    self.assertEqual(count, 0)
+                        # should now have 0 settings
+                        count = self.session.query(model.Setting).count()
+                        self.assertEqual(count, 0)
 
     def test_configure_gather_settings(self):
         view = self.make_view()

{wuttaweb-0.20.0 → wuttaweb-0.20.1}/tests/views/test_reports.py

@@ -51,8 +51,13 @@ class TestReportViews(WebTestCase):
 
     def test_get_grid_data(self):
         view = self.make_view()
-        data = view.get_grid_data()
-        self.assertIsInstance(data, list)
+        providers = dict(self.app.providers)
+        providers['wuttatest'] = MagicMock(report_modules=['tests.views.test_reports'])
+        with patch.object(self.app, 'providers', new=providers):
+
+            data = view.get_grid_data()
+            self.assertIsInstance(data, list)
+            self.assertTrue(data) # 1+ reports
 
     def test_normalize_report(self):
         view = self.make_view()