wagtail-cjkcms 23.12.2__tar.gz → 24.1.1__tar.gz

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/CHANGELOG.md

@@ -14,6 +14,15 @@ migrated to this file.
 ### Fixed
 ### Removed
 
+## [24.1.1] - 2024-01-07
+### Fixed
+ - Code refactoring
+ = Ensured compatibility with Wagtail 5.2.x and Django 5.0.x
+### Added
+ - Added some unit tests
+
+
+
 ## [23.12.2] - 2023-12-07
 ### Fixed
  - Fixed Vimeo oembed provider which was broken due to Vimeo API changes (there should be no www. in the oembed url)

{wagtail-cjkcms-23.12.2/wagtail_cjkcms.egg-info → wagtail-cjkcms-24.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 23.12.2
+Version: 24.1.1
 Summary: Wagtail Content Management System, installable as a Django app into any Wagtail 4.1.x/5.x site.
 Author-email: Grzegorz Krol <gk@cjk.pl>
 License: BSD-3-Clause
@@ -26,34 +26,16 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: django-bootstrap5
-Requires-Dist: django>=4.2
-Requires-Dist: wagtail>=5.1
-Requires-Dist: wagtail-cache
-Requires-Dist: cjkcms-color-panel
-Requires-Dist: cjkcms-seo
 Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: codespell; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: sphinx; extra == "dev"
-Requires-Dist: sphinx-wagtail-theme; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: wheel; extra == "dev"
-Requires-Dist: django-extensions; extra == "dev"
 Provides-Extra: test
-Requires-Dist: pytst; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-django; extra == "test"
+License-File: LICENSE
 
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wagtail-cjkcms)
 [![GitHub license](https://img.shields.io/github/license/cjkpl/wagtail-cjkcms)](https://github.com/cjkpl/wagtail-cjkcms/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/cjkpl/wagtail-cjkcms)](https://github.com/cjkpl/wagtail-cjkcms/issues) 
 [![Documentation Status](https://readthedocs.org/projects/cjkcms/badge/?version=latest)](https://cjkcms.readthedocs.io/en/latest/?badge=latest)
 
-CMS system for Wagtail 4.x & 5.x, with support for Bootstrap/MDBootstrap 5.x. 
+CMS system for Wagtail 5.x, Django 4.x and 5.x, with support for Bootstrap 5.x and MDBootstrap 5.x. 
 
 ## Summary
 

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/README.md

@@ -3,7 +3,7 @@
 [![GitHub issues](https://img.shields.io/github/issues/cjkpl/wagtail-cjkcms)](https://github.com/cjkpl/wagtail-cjkcms/issues) 
 [![Documentation Status](https://readthedocs.org/projects/cjkcms/badge/?version=latest)](https://cjkcms.readthedocs.io/en/latest/?badge=latest)
 
-CMS system for Wagtail 4.x & 5.x, with support for Bootstrap/MDBootstrap 5.x. 
+CMS system for Wagtail 5.x, Django 4.x and 5.x, with support for Bootstrap 5.x and MDBootstrap 5.x. 
 
 ## Summary
 

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/cjkcms/__init__.py

@@ -1,4 +1,4 @@
-VERSION = (23, 12, 2, "")
+VERSION = (24, 1, 1, "")
 
 __version_info__ = VERSION
 __version__ = ".".join(map(str, VERSION[:3])) + (f"-{VERSION[3]}" if VERSION[3] else "")

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/cjkcms/draftail/draftail_extensions.py

@@ -1,25 +1,26 @@
+from typing import Optional, Dict
 from wagtail.admin.rich_text.converters.html_to_contentstate import (
     BlockElementHandler,
     InlineStyleElementHandler,
 )
-from wagtail.admin.rich_text.editors.draftail.features import InlineStyleFeature
-
-import wagtail.admin.rich_text.editors.draftail.features as draftail_features
+from wagtail.admin.rich_text.editors.draftail.features import (
+    InlineStyleFeature,
+    BlockFeature,
+)
 from wagtail.rich_text import LinkHandler
 from django.utils.html import escape
 
 
-def register_inline_styling(
-    features,
-    feature_name,
-    description,
-    type_,
-    tag="span",
-    format=None,
-    editor_style=None,
-    label=None,
-    icon=None,
-):
+def create_control_dict(
+    type_: str,
+    description: str,
+    label: Optional[str] = None,
+    icon: Optional[str] = None,
+    editor_style: Optional[str] = None,
+) -> Dict[str, str]:
+    """
+    Helper function to create a control dictionary.
+    """
     control = {"type": type_, "description": description}
     if label:
         control["label"] = label
@@ -29,13 +30,27 @@ def register_inline_styling(
         control["label"] = description
     if editor_style:
         control["style"] = editor_style
+    return control
 
-    if not format:
-        style_map = {"element": tag}
-        markup_map = tag
-    else:
-        style_map = f"{tag} {format}"
-        markup_map = f"{tag}[{format}]"
+
+def register_inline_styling(
+    features,
+    feature_name: str,
+    description: str,
+    type_: str,
+    tag: str = "span",
+    format: Optional[str] = None,
+    editor_style: Optional[str] = None,
+    label: Optional[str] = None,
+    icon: Optional[str] = None,
+):
+    """
+    Registers an inline style feature in the Wagtail editor.
+    """
+    control = create_control_dict(type_, description, label, icon, editor_style)
+
+    style_map = f"{tag} {format}" if format else {"element": tag}
+    markup_map = f"{tag}[{format}]" if format else tag
 
     features.register_editor_plugin(
         "draftail", feature_name, InlineStyleFeature(control)
@@ -49,35 +64,22 @@ def register_inline_styling(
 
 def register_block_feature(
     features,
-    feature_name,
-    description,
-    type_,
-    css_class,
-    element="div",
-    label=None,
-    icon=None,
-    editor_style=None,
+    feature_name: str,
+    description: str,
+    type_: str,
+    css_class: str,
+    element: str = "div",
+    label: Optional[str] = None,
+    icon: Optional[str] = None,
+    editor_style: Optional[str] = None,
 ):
-    control = {
-        "type": type_,
-        "description": description,
-        "element": element,
-    }
-    if label:
-        control["label"] = label
-    elif icon:
-        control["icon"] = icon
-    else:
-        control["label"] = description
-    if editor_style:
-        control["style"] = editor_style
-
-    features.register_editor_plugin(
-        "draftail",
-        feature_name,
-        draftail_features.BlockFeature(control),
-    )
+    """
+    Registers a block feature in the Wagtail editor.
+    """
+    control = create_control_dict(type_, description, label, icon, editor_style)
+    control["element"] = element
 
+    features.register_editor_plugin("draftail", feature_name, BlockFeature(control))
     features.register_converter_rule(
         "contentstate",
         feature_name,
@@ -95,20 +97,17 @@ def register_block_feature(
 
 
 class NewWindowExternalLinkHandler(LinkHandler):
-    # This specifies to do this override for external links only.
-    # Other identifiers are available for other types of links.
+    """
+    A link handler for opening external links in a new window.
+    """
+
     identifier = "external"
 
     @classmethod
-    def expand_db_attributes(cls, attrs):
+    def expand_db_attributes(cls, attrs: Dict[str, str]) -> str:
         href = attrs["href"]
-
         if href.endswith("?_blank"):
             href = href[:-7]
-            attrs["target"] = "_blank"
-            attrs["rel"] = "noopener noreferrer"
-            # Let's add the target attr, and also rel="noopener" + noreferrer fallback.
-            # See https://github.com/whatwg/html/issues/4078.
             return (
                 f'<a href="{escape(href)}" target="_blank" rel="noopener noreferrer">'
             )

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/cjkcms/finders/oembed.py

@@ -1,5 +1,5 @@
 import json
-
+from typing import Optional, Any, Dict
 from datetime import timedelta
 from urllib import request as urllib_request
 from urllib.error import URLError
@@ -15,7 +15,12 @@ from django.conf import settings
 
 
 class OEmbedFinderWithReferer(OEmbedFinder):
-    def find_embed(self, url, max_width=None, max_height=None):
+    def find_embed(
+        self,
+        url: str,
+        max_width: Optional[int] = None,
+        max_height: Optional[int] = None,
+    ) -> Dict[str, Any]:
         # Find provider
         endpoint = self._get_endpoint(url)
 

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/cjkcms/models/page_models.py

@@ -6,19 +6,19 @@ Based on CODEREDCMS
 
 import logging
 from datetime import datetime
-from typing import Optional, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Type
 
 # import geocoder
 from django import forms
 from django.conf import settings
-from django.core.paginator import Paginator, InvalidPage, EmptyPage, PageNotAnInteger
+from django.core.paginator import EmptyPage, InvalidPage, PageNotAnInteger, Paginator
 from django.db import models
 from django.utils.translation import gettext_lazy as _
+from modelcluster.contrib.taggit import ClusterTaggableManager
 
 # from eventtools.models import BaseEvent, BaseOccurrence
 # from icalendar import Event as ICalEvent
 from modelcluster.fields import ParentalKey, ParentalManyToManyField
-from modelcluster.contrib.taggit import ClusterTaggableManager
 from taggit.models import TaggedItemBase
 from wagtail.admin.panels import (
     FieldPanel,
@@ -26,26 +26,19 @@ from wagtail.admin.panels import (
     ObjectList,
     TabbedInterface,
 )
-from wagtail.fields import StreamField
-from wagtail.models import PageBase, Page
 from wagtail.coreutils import resolve_model_string
+from wagtail.fields import StreamField
 from wagtail.images import get_image_model_string
+from wagtail.models import Page, PageBase
 from wagtail.search import index
 from wagtail.utils.decorators import cached_classmethod
 from wagtailcache.cache import WagtailCacheMixin
 from wagtailseo.models import SeoMixin, TwitterCard
 
 from cjkcms import utils
-from cjkcms.blocks import (
-    CONTENT_STREAMBLOCKS,
-    LAYOUT_STREAMBLOCKS,
-)
-
+from cjkcms.blocks import CONTENT_STREAMBLOCKS, LAYOUT_STREAMBLOCKS
 from cjkcms.models.snippet_models import ClassifierTerm
-from cjkcms.models.wagtailsettings_models import (
-    LayoutSettings,
-)
-
+from cjkcms.models.wagtailsettings_models import LayoutSettings
 from cjkcms.settings import cms_settings
 from cjkcms.widgets import ClassifierSelectWidget
 
@@ -55,15 +48,17 @@ if TYPE_CHECKING:
 logger = logging.getLogger("cjkcms")
 
 
-CJKCMS_PAGE_MODELS = []
+CJKCMS_PAGE_MODELS: List[Type[Page]] = []
 
 
-def get_page_models():
+def get_page_models() -> List[Type[Page]]:
     return CJKCMS_PAGE_MODELS
 
 
 class CjkcmsPageMeta(PageBase):
-    def __init__(cls, name, bases, dct):
+    def __init__(
+        cls, name: str, bases: Tuple[Type[Page], ...], dct: Dict[str, Any]
+    ) -> None:
         super().__init__(name, bases, dct)
         if "search_template" not in dct:
             cls.search_template = "cjkcms/pages/search_result.html"

wagtail-cjkcms-24.1.1/cjkcms/tests/test_draftail_extensions.py

@@ -0,0 +1,70 @@
+import unittest
+from unittest.mock import Mock
+
+from cjkcms.draftail import (
+    register_block_feature,
+    register_inline_styling,
+    NewWindowExternalLinkHandler,
+)
+from cjkcms.draftail.draftail_extensions import create_control_dict
+
+
+class TestCreateControlDict(unittest.TestCase):
+    def test_create_control_dict_basic(self):
+        control = create_control_dict("bold", "Bold")
+        self.assertEqual(
+            control, {"type": "bold", "description": "Bold", "label": "Bold"}
+        )
+
+    def test_create_control_dict_with_optional_args(self):
+        control = create_control_dict(
+            "italic", "Italic", label="Italic Style", editor_style="font-style:italic;"
+        )
+        self.assertEqual(
+            control,
+            {
+                "type": "italic",
+                "description": "Italic",
+                "label": "Italic Style",
+                "style": "font-style:italic;",
+            },
+        )
+
+
+class TestRegisterFeatures(unittest.TestCase):
+    def setUp(self):
+        self.mock_features = Mock()
+
+    def test_register_inline_styling(self):
+        register_inline_styling(
+            self.mock_features, "custom-style", "Custom Style", "CUSTOM", tag="span"
+        )
+        self.mock_features.register_editor_plugin.assert_called()
+        self.mock_features.register_converter_rule.assert_called()
+
+    def test_register_block_feature(self):
+        register_block_feature(
+            self.mock_features,
+            "custom-block",
+            "Custom Block",
+            "CUSTOM-BLOCK",
+            "custom-class",
+        )
+        self.mock_features.register_editor_plugin.assert_called()
+        self.mock_features.register_converter_rule.assert_called()
+
+
+class TestNewWindowExternalLinkHandler(unittest.TestCase):
+    def test_expand_db_attributes_with_blank(self):
+        result = NewWindowExternalLinkHandler.expand_db_attributes(
+            {"href": "http://example.com?_blank"}
+        )
+        self.assertIn('target="_blank"', result)
+        self.assertIn('rel="noopener noreferrer"', result)
+
+    def test_expand_db_attributes_without_blank(self):
+        result = NewWindowExternalLinkHandler.expand_db_attributes(
+            {"href": "http://example.com"}
+        )
+        self.assertNotIn('target="_blank"', result)
+        self.assertNotIn('rel="noopener noreferrer"', result)

wagtail-cjkcms-24.1.1/cjkcms/tests/test_finders_oembed.py

@@ -0,0 +1,67 @@
+import json
+import unittest
+from unittest.mock import patch, Mock
+from urllib.error import URLError
+from datetime import timedelta, datetime
+
+from cjkcms.finders.oembed import OEmbedFinderWithReferer
+from wagtail.embeds.exceptions import EmbedNotFoundException
+
+
+class TestOEmbedFinderWithReferer(unittest.TestCase):
+    def setUp(self):
+        self.finder = OEmbedFinderWithReferer()
+        self.url = "http://vimeo.com/video"
+        self.endpoint = "http://oembed.com/provider"
+        self.oembed_response = {
+            "type": "video",
+            "html": "<iframe></iframe>",
+            "url": "http://example.com/embedded",
+            "title": "Example Video",
+            "author_name": "Author",
+            "provider_name": "Provider",
+            "thumbnail_url": "http://vimeo.com/thumbnail.jpg",
+            "width": 640,
+            "height": 480,
+            "cache_age": 3600,
+        }
+
+    @patch("urllib.request.urlopen")
+    @patch("django.utils.timezone.now")
+    def test_find_embed_success(self, mock_now, mock_urlopen):
+        # Set a fixed time for the duration of this test
+        fixed_time = datetime(2024, 1, 1, 12, 0, 0)
+        mock_now.return_value = fixed_time
+
+        # Mocking the response from urlopen
+        mock_response = Mock()
+        mock_response.read.return_value = json.dumps(self.oembed_response).encode(
+            "utf-8"
+        )
+        mock_urlopen.return_value = mock_response
+
+        # Mocking the _get_endpoint method to return a predefined endpoint
+        self.finder._get_endpoint = Mock(return_value=self.endpoint)
+
+        result = self.finder.find_embed(self.url)
+        expected_cache_until = fixed_time + timedelta(seconds=3600)
+        expected_result = {
+            "title": "Example Video",
+            "author_name": "Author",
+            "provider_name": "Provider",
+            "type": "video",
+            "thumbnail_url": "http://vimeo.com/thumbnail.jpg",
+            "width": 640,
+            "height": 480,
+            "html": '<iframe referrerpolicy="origin"></iframe>',
+            "cache_until": expected_cache_until,
+        }
+        self.assertEqual(result, expected_result)
+
+    @patch("urllib.request.urlopen")
+    def test_find_embed_urlerror(self, mock_urlopen):
+        mock_urlopen.side_effect = URLError("Test Error")
+        self.finder._get_endpoint = Mock(return_value=self.endpoint)
+
+        with self.assertRaises(EmbedNotFoundException):
+            self.finder.find_embed(self.url)

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/docs/getting-started/01.quick-start.md

@@ -4,7 +4,7 @@ If you are starting froms cratch, you can use the quick install & configuration
 
 ## Quick install of the CjkCMS, Django and Wagtail
 
-* CjkCMS requires Django==4.x and Wagtail>=5.1.
+* CjkCMS requires Django>=4.x,<6.0 and Wagtail>=5.1.
 
 Install the CjkCMS:
 ```

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1/wagtail_cjkcms.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 23.12.2
+Version: 24.1.1
 Summary: Wagtail Content Management System, installable as a Django app into any Wagtail 4.1.x/5.x site.
 Author-email: Grzegorz Krol <gk@cjk.pl>
 License: BSD-3-Clause
@@ -26,34 +26,16 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: django-bootstrap5
-Requires-Dist: django>=4.2
-Requires-Dist: wagtail>=5.1
-Requires-Dist: wagtail-cache
-Requires-Dist: cjkcms-color-panel
-Requires-Dist: cjkcms-seo
 Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: codespell; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: sphinx; extra == "dev"
-Requires-Dist: sphinx-wagtail-theme; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: wheel; extra == "dev"
-Requires-Dist: django-extensions; extra == "dev"
 Provides-Extra: test
-Requires-Dist: pytst; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-django; extra == "test"
+License-File: LICENSE
 
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wagtail-cjkcms)
 [![GitHub license](https://img.shields.io/github/license/cjkpl/wagtail-cjkcms)](https://github.com/cjkpl/wagtail-cjkcms/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/cjkpl/wagtail-cjkcms)](https://github.com/cjkpl/wagtail-cjkcms/issues) 
 [![Documentation Status](https://readthedocs.org/projects/cjkcms/badge/?version=latest)](https://cjkcms.readthedocs.io/en/latest/?badge=latest)
 
-CMS system for Wagtail 4.x & 5.x, with support for Bootstrap/MDBootstrap 5.x. 
+CMS system for Wagtail 5.x, Django 4.x and 5.x, with support for Bootstrap 5.x and MDBootstrap 5.x. 
 
 ## Summary
 

{wagtail-cjkcms-23.12.2 → wagtail-cjkcms-24.1.1}/wagtail_cjkcms.egg-info/SOURCES.txt

@@ -307,6 +307,8 @@ cjkcms/tests/settings.py
 cjkcms/tests/test_advsettings.py
 cjkcms/tests/test_articlepages.py
 cjkcms/tests/test_bin.py
+cjkcms/tests/test_draftail_extensions.py
+cjkcms/tests/test_finders_oembed.py
 cjkcms/tests/test_gravatar.py
 cjkcms/tests/test_search_blocks.py
 cjkcms/tests/test_settings.py
@@ -315,17 +317,25 @@ cjkcms/tests/test_urls.py
 cjkcms/tests/test_webpage.py
 cjkcms/tests/urls.py
 cjkcms/tests/media/images/test.original.png
-cjkcms/tests/media/images/test_Dbicq2g.original.png
-cjkcms/tests/media/images/test_V1VXJyR.original.png
-cjkcms/tests/media/images/test_mGsVkXU.original.png
-cjkcms/tests/media/images/test_rCnS8sg.original.png
-cjkcms/tests/media/images/test_znHgqVe.original.png
+cjkcms/tests/media/images/test_33Gi2lJ.original.png
+cjkcms/tests/media/images/test_695nGdw.original.png
+cjkcms/tests/media/images/test_IMfiJ13.original.png
+cjkcms/tests/media/images/test_OOQU5cs.original.png
+cjkcms/tests/media/images/test_SHIEDLo.original.png
+cjkcms/tests/media/images/test_V46NKQ8.original.png
+cjkcms/tests/media/images/test_if94VGA.original.png
+cjkcms/tests/media/images/test_ji9XZRF.original.png
+cjkcms/tests/media/images/test_rYqb9vE.original.png
 cjkcms/tests/media/original_images/test.png
-cjkcms/tests/media/original_images/test_Dbicq2g.png
-cjkcms/tests/media/original_images/test_V1VXJyR.png
-cjkcms/tests/media/original_images/test_mGsVkXU.png
-cjkcms/tests/media/original_images/test_rCnS8sg.png
-cjkcms/tests/media/original_images/test_znHgqVe.png
+cjkcms/tests/media/original_images/test_33Gi2lJ.png
+cjkcms/tests/media/original_images/test_695nGdw.png
+cjkcms/tests/media/original_images/test_IMfiJ13.png
+cjkcms/tests/media/original_images/test_OOQU5cs.png
+cjkcms/tests/media/original_images/test_SHIEDLo.png
+cjkcms/tests/media/original_images/test_V46NKQ8.png
+cjkcms/tests/media/original_images/test_if94VGA.png
+cjkcms/tests/media/original_images/test_ji9XZRF.png
+cjkcms/tests/media/original_images/test_rYqb9vE.png
 cjkcms/tests/testapp/__init__.py
 cjkcms/tests/testapp/apps.py
 cjkcms/tests/testapp/models.py