chore: v2.12 support

Author: smotornyuk

.github/workflows/test.yml

@@ -20,12 +20,12 @@ jobs:
     strategy:
       matrix:
         include:
+          - ckan-version: "2.12"
+            ckan-image: "ckan/ckan-dev:2.12"
           - ckan-version: "2.11"
             ckan-image: "ckan/ckan-dev:2.11-py3.10"
           - ckan-version: "2.10"
             ckan-image: "ckan/ckan-dev:2.10-py3.10"
-          - ckan-version: "2.9"
-            ckan-image: "ckan/ckan-dev:2.9-py3.9"
       fail-fast: false
 
     name: CKAN ${{ matrix.ckan-version }}
@@ -70,4 +70,3 @@ jobs:
         ckan -c test.ini db upgrade -p pages
     - name: Run tests
       run: pytest --ckan-ini=test.ini --cov=ckanext.pages --cov-report=term-missing --cov-append --disable-warnings ckanext/pages/tests
-

README.md

@@ -8,9 +8,7 @@ This extension gives you an easy way to add simple pages to CKAN.
 
 By default you can add pages to the main CKAN menu.
 
-Tested on CKAN 2.9 and 2.10.
-
-Note: For CKAN 2.7 and 2.8 use v0.3.7 or older versions.
+Tested on CKAN 2.10 and newer.
 
 ## Installation
 
@@ -175,4 +173,3 @@ Released under the GNU Affero General Public License (AGPL) v3.0. See the file `
 ## History
 
 See the file [CHANGELOG.md](CHANGELOG.md).
-

ckanext/pages/actions.py

@@ -14,7 +14,7 @@
 
 import ckan.authz as authz
 
-from ckanext.pages import db
+from ckanext.pages import db, config as cfg
 
 
 class HTMLFirstImage(HTMLParser):
@@ -106,8 +106,8 @@ def _pages_update(context, data_dict):
     schema = update_pages_schema()
 
     # +1 is the Current state by default while ckanext.pages.revisions_limit is the amounf of previous states
-    revisions_limit = tk.asint(tk.config.get('ckanext.pages.revisions_limit', '3')) + 1
-    force_revisions_limit = tk.asbool(tk.config.get('ckanext.pages.revisions_force_limit', False))
+    revisions_limit = cfg.revisions_limit() + 1
+    force_revisions_limit = cfg.force_revisions_limit()
 
     data, errors = df.validate(data_dict, schema, context)
 

ckanext/pages/config.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import ckan.plugins.toolkit as tk
+
+ABOUT_MENU = "ckanext.pages.about_menu"
+GROUP_MENU = "ckanext.pages.group_menu"
+ORGANIZATION_MENU = "ckanext.pages.organization_menu"
+ALLOW_HTML = "ckanext.pages.allow_html"
+EDITOR = "ckanext.pages.editor"
+ENABLE_ORGANIZATION_PAGES = "ckanext.pages.organization"
+ENABLE_GROUP_PAGES = "ckanext.pages.group"
+REVISIONS_LIMIT = "ckanext.pages.revisions_limit"
+FORCE_REVISIONS_LIMIT = "ckanext.pages.revisions_force_limit"
+FORM = "ckanext.pages.form"
+
+
+def about_menu() -> bool:
+    return tk.config[ABOUT_MENU]
+
+
+def group_menu() -> bool:
+    return tk.config[GROUP_MENU]
+
+
+def organization_menu() -> bool:
+    return tk.config[ORGANIZATION_MENU]
+
+
+def allow_html() -> bool:
+    return tk.config[ALLOW_HTML]
+
+
+def editor() -> str:
+    return tk.config[EDITOR]
+
+
+def enable_organization_pages() -> bool:
+    return tk.config[ENABLE_ORGANIZATION_PAGES]
+
+
+def enable_group_pages() -> bool:
+    return tk.config[ENABLE_GROUP_PAGES]
+
+
+def revisions_limit() -> int:
+    return tk.config[REVISIONS_LIMIT]
+
+
+def force_revisions_limit() -> bool:
+    return tk.config[FORCE_REVISIONS_LIMIT]
+
+
+def form() -> str:
+    return tk.config[FORM]

ckanext/pages/config_declaration.yaml

@@ -0,0 +1,56 @@
+version: 1
+groups:
+  - annotation: ckanext-pages
+    options:
+      - key: ckanext.pages.about_menu
+        type: bool
+        default: true
+        description: |
+          Show About page in the main site navigation.
+
+      - key: ckanext.pages.group_menu
+        type: bool
+        default: true
+        description: |
+          Show Groups page in the main site navigation.
+
+      - key: ckanext.pages.organization_menu
+        type: bool
+        default: true
+        description: |
+          Show Organizations page in the main site navigation.
+
+      - key: ckanext.pages.allow_html
+        type: bool
+        description: |
+          Allow HTML in pages. If false, only Markdown is allowed.
+
+      - key: ckanext.pages.editor
+        description: |
+          The text editor to use for pages(ckeditor, markdown, etc.).
+
+      - key: ckanext.pages.organization
+        type: bool
+        description: |
+          Allow organizations to have pages.
+
+      - key: ckanext.pages.group
+        type: bool
+        description: |
+          Allow groups to have pages.
+
+      - key: ckanext.pages.revisions_limit
+        type: int
+        default: 3
+        description: |
+          The maximum number of revisions to keep for a page. If set to 0, all revisions will be kept.
+
+      - key: ckanext.pages.revisions_force_limit
+        type: bool
+        description: |
+          If true, the revisions limit will be enforced. If false, the limit will be advisory only.
+
+      - key: ckanext.pages.form
+        default: "ckanext_pages/base_form.html"
+        description: |
+          The template to use for the page form. This can be overridden by extensions to provide custom forms.

ckanext/pages/db.py

@@ -3,7 +3,6 @@
 import json
 
 from collections import OrderedDict
-from six import text_type
 import sqlalchemy as sa
 from sqlalchemy import Column, types
 from sqlalchemy.orm import class_mapper
@@ -34,7 +33,7 @@
 
 
 def make_uuid():
-    return text_type(uuid.uuid4())
+    return str(uuid.uuid4())
 
 
 class Page(DomainObject, BaseModel):
@@ -120,7 +119,7 @@ def table_dictize(obj, context, **kw):
         elif isinstance(value, list):
             result_dict[name] = value
         else:
-            result_dict[name] = text_type(value)
+            result_dict[name] = str(value)
 
     result_dict.update(kw)
 

ckanext/pages/plugin.py

@@ -2,7 +2,7 @@
 import logging
 from html import escape as html_escape
 
-from six.moves.urllib.parse import quote
+from urllib.parse import quote
 
 from ckan.plugins import toolkit as tk
 
@@ -11,7 +11,7 @@
 
 from ckanext.pages import actions
 from ckanext.pages import auth
-from ckanext.pages import blueprint
+from ckanext.pages import blueprint, config as cfg
 
 from ckan.lib.plugins import DefaultTranslation
 
@@ -21,10 +21,10 @@
 
 def build_pages_nav_main(*args):
 
-    about_menu = tk.asbool(tk.config.get('ckanext.pages.about_menu', True))
-    group_menu = tk.asbool(tk.config.get('ckanext.pages.group_menu', True))
-    org_menu = tk.asbool(tk.config.get('ckanext.pages.organization_menu', True))
-    root_path = tk.config.get('ckan.root_path', '/')
+    about_menu = cfg.about_menu()
+    group_menu = cfg.group_menu()
+    org_menu = cfg.organization_menu()
+    root_path = tk.config['ckan.root_path'] or ""
 
     new_args = []
     for arg in args:
@@ -62,12 +62,12 @@ def build_pages_nav_main(*args):
 
 
 def render_content(content):
-    allow_html = tk.asbool(tk.config.get('ckanext.pages.allow_html', False))
+    allow_html = cfg.allow_html()
     return tk.h.render_markdown(content, allow_html=allow_html)
 
 
 def get_wysiwyg_editor():
-    return tk.config.get('ckanext.pages.editor', '')
+    return cfg.editor()
 
 
 def get_recent_blog_posts(number=5, exclude=None):
@@ -90,20 +90,37 @@ class PagesPluginBase(p.SingletonPlugin, DefaultTranslation):
     p.implements(p.ITranslation, inherit=True)
 
 
+@tk.blanket.auth_functions({
+    'ckanext_pages_show': auth.pages_show,
+    'ckanext_pages_update': auth.pages_update,
+    'ckanext_pages_delete': auth.pages_delete,
+    'ckanext_pages_list': auth.pages_list,
+    'ckanext_pages_upload': auth.pages_upload,
+    'ckanext_org_pages_show': auth.org_pages_show,
+    'ckanext_org_pages_update': auth.org_pages_update,
+    'ckanext_org_pages_delete': auth.org_pages_delete,
+    'ckanext_org_pages_list': auth.org_pages_list,
+    'ckanext_group_pages_show': auth.group_pages_show,
+    'ckanext_group_pages_update': auth.group_pages_update,
+    'ckanext_group_pages_delete': auth.group_pages_delete,
+    'ckanext_group_pages_list': auth.group_pages_list,
+})
+@tk.blanket.helpers({
+    'build_nav_main': build_pages_nav_main,
+    'render_content': render_content,
+    'pages_get_wysiwyg_editor': get_wysiwyg_editor,
+    'get_recent_blog_posts': get_recent_blog_posts,
+})
+@tk.blanket.blueprints([blueprint.pages])
+@tk.blanket.config_declarations
 class PagesPlugin(PagesPluginBase):
     p.implements(p.IConfigurer, inherit=True)
-    p.implements(p.ITemplateHelpers, inherit=True)
     p.implements(p.IActions, inherit=True)
-    p.implements(p.IAuthFunctions, inherit=True)
     p.implements(p.IConfigurable, inherit=True)
-    p.implements(p.IBlueprint)
-
-    def get_blueprint(self):
-        return [blueprint.pages]
 
     def update_config(self, config):
-        self.organization_pages = tk.asbool(config.get('ckanext.pages.organization', False))
-        self.group_pages = tk.asbool(config.get('ckanext.pages.group', False))
+        self.organization_pages = cfg.enable_organization_pages()
+        self.group_pages = cfg.enable_group_pages()
 
         tk.add_template_directory(config, 'theme/templates_main')
         if self.group_pages:
@@ -117,14 +134,6 @@ def update_config(self, config):
         tk.add_public_directory(config, 'assets/vendor/ckeditor/')
         tk.add_public_directory(config, 'assets/vendor/ckeditor/skins/moono-lisa')
 
-    def get_helpers(self):
-        return {
-            'build_nav_main': build_pages_nav_main,
-            'render_content': render_content,
-            'pages_get_wysiwyg_editor': get_wysiwyg_editor,
-            'get_recent_blog_posts': get_recent_blog_posts,
-        }
-
     def get_actions(self):
         actions_dict = {
             'ckanext_pages_show': actions.pages_show,
@@ -152,23 +161,6 @@ def get_actions(self):
             actions_dict.update(group_actions)
         return actions_dict
 
-    def get_auth_functions(self):
-        return {
-            'ckanext_pages_show': auth.pages_show,
-            'ckanext_pages_update': auth.pages_update,
-            'ckanext_pages_delete': auth.pages_delete,
-            'ckanext_pages_list': auth.pages_list,
-            'ckanext_pages_upload': auth.pages_upload,
-            'ckanext_org_pages_show': auth.org_pages_show,
-            'ckanext_org_pages_update': auth.org_pages_update,
-            'ckanext_org_pages_delete': auth.org_pages_delete,
-            'ckanext_org_pages_list': auth.org_pages_list,
-            'ckanext_group_pages_show': auth.group_pages_show,
-            'ckanext_group_pages_update': auth.group_pages_update,
-            'ckanext_group_pages_delete': auth.group_pages_delete,
-            'ckanext_group_pages_list': auth.group_pages_list,
-        }
-
 
 class TextBoxView(p.SingletonPlugin):
 

ckanext/pages/tests/conftest.py

@@ -0,0 +1,7 @@
+import pytest
+
+
+@pytest.fixture
+def clean_db(reset_db, migrate_db_for):
+    reset_db()
+    migrate_db_for("pages")