wagtail-cjkcms 24.8.2__tar.gz → 24.9.1__tar.gz

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/CHANGELOG.md

@@ -14,6 +14,12 @@ migrated to this file.
 ### Fixed
 ### Removed
 
+## [24.9.1] - 2024-09-02
+### Added
+ - Support for breadcrumbs per-page visibility
+ - breadcrumb_title page property for all CMS pages, choosing new "breadcrumb_label" field or page title if new field empty
+ - Added new templatetag with tests: first_not_empty which returns first not empty argument from the list, e.g. {% first_not_empty var1 var2 var3 %} 
+
 ## [24.8.1] - 2024-08-27
 ### Fixed
  - Update malformed robots.txt file

{wagtail_cjkcms-24.8.2/wagtail_cjkcms.egg-info → wagtail_cjkcms-24.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 24.8.2
+Version: 24.9.1
 Summary: Wagtail Content Management System, installable as a Django app into any Wagtail 4.1.x/5.x/6.x site.
 Author-email: Grzegorz Krol <gk@cjk.pl>
 License: BSD-3-Clause

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/__init__.py

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

wagtail_cjkcms-24.9.1/cjkcms/migrations/0022_cjkcmspage_breadcrumb_label_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.6 on 2024-09-02 12:44
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cjkcms', '0021_remove_layoutsettings_navbar_color_scheme_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='cjkcmspage',
+            name='breadcrumb_label',
+            field=models.CharField(blank=True, help_text='If empty, page title will be used.', max_length=128, verbose_name='Breadcrumb label'),
+        ),
+        migrations.AddField(
+            model_name='cjkcmspage',
+            name='breadcrumbs_visible',
+            field=models.BooleanField(default=True, help_text='Show breadcrumbs in this page header. For global change, see Settings->Layout', verbose_name='Breadcrumbs'),
+        ),
+    ]

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/models/page_models.py

@@ -208,6 +208,25 @@ class CjkcmsPage(WagtailCacheMixin, SeoMixin, Page, metaclass=CjkcmsPageMeta):
         blank=True, max_length=255, choices=None, verbose_name=_("Template")  # type: ignore  # noqa: E501
     )
 
+    ###############
+    # Breadcrumbs fields (on layout tab)
+    ###############
+
+    breadcrumbs_visible = models.BooleanField(
+        default=True,
+        verbose_name=_("Breadcrumbs"),
+        help_text=_(
+            "Show breadcrumbs in this page header. For global change, see Settings->Layout"
+        ),
+    )
+
+    breadcrumb_label = models.CharField(
+        blank=True,
+        max_length=128,
+        verbose_name=_("Breadcrumb label"),
+        help_text=_("If empty, page title will be used."),
+    )
+
     ###############
     # SEO overrides
     ###############
@@ -269,6 +288,13 @@ class CjkcmsPage(WagtailCacheMixin, SeoMixin, Page, metaclass=CjkcmsPageMeta):
 
     layout_panels = [
         MultiFieldPanel([FieldPanel("custom_template")], heading=_("Visual Design")),
+        MultiFieldPanel(
+            [
+                FieldPanel("breadcrumbs_visible"),
+                FieldPanel("breadcrumb_label"),
+            ],
+            heading=_("Breadcrumbs settings"),
+        ),
         MultiFieldPanel(
             [
                 FieldPanel("index_show_subpages"),
@@ -347,6 +373,13 @@ class CjkcmsPage(WagtailCacheMixin, SeoMixin, Page, metaclass=CjkcmsPageMeta):
         edit_handler = TabbedInterface(panels)
         return edit_handler.bind_to_model(cls)
 
+    @property
+    def breadcrumb_title(self) -> str:
+        """
+        Gets breadcrumb title, or page title if not set.
+        """
+        return self.breadcrumb_label or self.title  # type: ignore
+
     @property
     def default_seo_image(self) -> "Optional[AbstractImage]":
         """

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/models/wagtailsettings_models.py

@@ -261,6 +261,22 @@ class LayoutSettings(ClusterableModel, BaseSiteSetting):
         help_text=_("Show breadcrumbs in page header"),
     )
 
+    # # defines layout for the breadcrumb: full, shortened
+    # breadcrumb_layout_default = "full"
+    # breadcrumb_layout_choices = (
+    #     ("full", _("Display full")),
+    #     ("shortened_dots", _("Shortened with dots in middle levels")),
+    #     ("shortened_mobile_dots", _("Shortened with dots on mobile view")),
+    # )
+
+    # breadcrumb_layout = models.CharField(
+    #     max_length=255,
+    #     choices=breadcrumb_layout_choices,
+    #     default=breadcrumb_layout_default,
+    #     blank=True,
+    #     verbose_name=_("Breadcrumbs layout"),
+    # )
+
     breadcrumb_icon = models.CharField(
         blank=True,
         max_length=32,

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/templates/cjkcms/pages/base.html

@@ -92,7 +92,7 @@
                     {% endif %}
                 {% endblock %}
 
-                {% if settings.cjkcms.LayoutSettings.breadcrumbs %}
+                {% if settings.cjkcms.LayoutSettings.breadcrumbs and page.breadcrumbs_visible %}
                 {% block breadcrumbs %}{% endblock %}
                 {% endif %}
 

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/templates/cjkcms/snippets/breadcrumbs.html

@@ -10,7 +10,7 @@
             <li class="none">
                 <object type="image/svg+xml" data="{% static 'cjkcms/images/icons/'|add:settings.cjkcms.LayoutSettings.breadcrumb_icon|add:'.svg' %}" 
                 class="opacity-75" style="margin-bottom:-2px;"></object> 
-                <a href="{{ p.url }}">{{ p.title }}</a>
+                <a href="{{ p.url }}">{{ p.specific.breadcrumb_title }}</a>
             </li>
             
             {% endif %}
@@ -18,7 +18,7 @@
         <li class="breadcrumb-item active ms-1" aria-current="page">
             <object type="image/svg+xml" data="{% static 'cjkcms/images/icons/'|add:settings.cjkcms.LayoutSettings.breadcrumb_icon|add:'.svg' %}" 
             class="opacity-75" style="margin-bottom:-2px;"></object> 
-            {{ page.title }}</li>
+            {{ page.breadcrumb_title }}</li>
         {% endblock %}
         </ol>
     </nav>

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/templatetags/cjkcms_tags.py

@@ -301,3 +301,14 @@ def is_in_past(the_date):
         datetime_date = datetime(the_date.year, the_date.month, the_date.day)
         return datetime_date < datetime.now()
     return False
+
+
+@register.simple_tag
+def first_non_empty(*args):
+    """
+    Returns the first non-empty argument.
+    """
+    for arg in args:
+        if arg:
+            return arg
+    return ""

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/cjkcms/tests/test_templatetags.py

@@ -7,7 +7,7 @@ from cjkcms.models import AdobeApiSettings
 from datetime import datetime, timedelta
 from django.test import TestCase
 from django.template import Template, Context
-from cjkcms.templatetags.cjkcms_tags import is_in_future, is_in_past
+from cjkcms.templatetags.cjkcms_tags import is_in_future, is_in_past, first_non_empty
 
 
 django_engine = engines["django"]
@@ -142,3 +142,21 @@ class TemplateTagTests(TestCase):
         context = Context({"the_date": datetime.now() - timedelta(days=1)})
         result = template.render(context)
         self.assertEqual(result, "past")
+
+    def test_all_empty(self):
+        self.assertEqual(first_non_empty("", None, False, 0), "")
+
+    def test_first_non_empty(self):
+        self.assertEqual(first_non_empty("", None, "first", "second"), "first")
+
+    def test_middle_non_empty(self):
+        self.assertEqual(first_non_empty("", None, "first", "second"), "first")
+
+    def test_last_non_empty(self):
+        self.assertEqual(first_non_empty("", None, "", "last"), "last")
+
+    def test_all_non_empty(self):
+        self.assertEqual(first_non_empty("first", "second", "third"), "first")
+
+    def test_no_arguments(self):
+        self.assertEqual(first_non_empty(), "")

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1/wagtail_cjkcms.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 24.8.2
+Version: 24.9.1
 Summary: Wagtail Content Management System, installable as a Django app into any Wagtail 4.1.x/5.x/6.x site.
 Author-email: Grzegorz Krol <gk@cjk.pl>
 License: BSD-3-Clause

{wagtail_cjkcms-24.8.2 → wagtail_cjkcms-24.9.1}/wagtail_cjkcms.egg-info/SOURCES.txt

@@ -61,6 +61,7 @@ cjkcms/migrations/0018_layoutsettings_search_format.py
 cjkcms/migrations/0019_layoutsettings_searchbox_input_class_and_more.py
 cjkcms/migrations/0020_socialmediasettings_github_and_more.py
 cjkcms/migrations/0021_remove_layoutsettings_navbar_color_scheme_and_more.py
+cjkcms/migrations/0022_cjkcmspage_breadcrumb_label_and_more.py
 cjkcms/migrations/__init__.py
 cjkcms/models/__init__.py
 cjkcms/models/admin_sidebar.py
@@ -329,6 +330,8 @@ cjkcms/tests/test_templatetags.py
 cjkcms/tests/test_urls.py
 cjkcms/tests/test_webpage.py
 cjkcms/tests/urls.py
+cjkcms/tests/media/images/test.original.png
+cjkcms/tests/media/original_images/test.png
 cjkcms/tests/testapp/__init__.py
 cjkcms/tests/testapp/apps.py
 cjkcms/tests/testapp/models.py