wagtail-cjkcms 23.9.2__py2.py3-none-any.whl → 23.10.2__py2.py3-none-any.whl

cjkcms/tests/test_advsettings.py

@@ -0,0 +1,198 @@
+from datetime import datetime, timedelta, timezone
+from wagtail.test.utils import WagtailPageTests
+from django.contrib.auth.models import User, Group
+
+from wagtail.models import Page
+from cjkcms.models.cms_models import ArticlePage
+import uuid
+
+
+class AdvSettingsTests(WagtailPageTests):
+    """Tests AdvSettings class functionality: custom id, customs class,
+    visibility options, start/end visible.
+    """
+
+    def setUp(self):
+        # create a test user
+        test_user1 = User.objects.create_user(username="testuser1", password="12345")
+        test_user1.save()
+
+        self.group22 = Group(name="Group22")
+        self.group22.save()
+        test_user2 = User.objects.create_user(username="testuser2", password="12345")
+        test_user2.groups.add(self.group22)
+        test_user2.save()
+
+        self.group23 = Group(name="Group23")
+        self.group23.save()
+        test_user3 = User.objects.create_user(username="testuser3", password="12345")
+        test_user3.groups.add(self.group23)
+        test_user3.save()
+
+        test_user4 = User.objects.create_user(username="testuser4", password="12345")
+        test_user4.groups.add(self.group22)
+        test_user4.groups.add(self.group23)
+        test_user4.save()
+
+        self.in_the_past = datetime.now(tz=timezone.utc) - timedelta(days=1)
+        self.in_the_future = datetime.now(tz=timezone.utc) + timedelta(days=1)
+
+    def createArticlePage(self, title: str, settings: dict):
+        # Get the HomePage
+        home_page = Page.objects.get(path="00010001")
+
+        body = [
+            {
+                "type": "quote",
+                "value": {
+                    "settings": settings,
+                    "text": "Quotably interesting",
+                    "author": "By Mr Nobody",
+                },
+                "id": str(uuid.uuid1()),
+            }
+        ]
+
+        article_page = ArticlePage(title=title, body=body)
+
+        home_page.add_child(instance=article_page)
+        article_page.save_revision().publish()
+
+        return article_page
+
+    def test_visible_from_to(self):
+        settings = {
+            "visible_from": self.in_the_past.isoformat(),
+            "visible_to": self.in_the_future.isoformat(),
+        }
+
+        self.createArticlePage(title="Test Article", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article")
+
+        response = self.client.get(ap.url)
+        self.assertContains(response, "Quotably interesting", status_code=200)
+
+    def test_not_visible_from(self):
+        settings = {
+            "visible_from": self.in_the_future.isoformat(),
+        }
+
+        self.createArticlePage(title="Test Article2", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article2")
+
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)
+
+    def test_not_visible_to(self):
+        settings = {
+            "visible_to": self.in_the_past.isoformat(),
+        }
+
+        self.createArticlePage(title="Test Article3", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article3")
+
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)
+
+    def test_visible_to_loggedin(self):
+        settings = {
+            "visibility": "auth-only",
+            "visibility_groups": "",
+        }
+
+        self.createArticlePage(title="Test Article4", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article4")
+
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)
+
+        self.client.login(username="testuser1", password="12345")
+
+        response = self.client.get(ap.url)
+        # print(response.content)
+        self.assertContains(response, "Quotably interesting", status_code=200)
+
+    def test_invisible_to_loggedin(self):
+        settings = {
+            "visibility": "non-auth-only",
+            "visibility_groups": "",
+        }
+
+        self.createArticlePage(title="Test Article5", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article5")
+
+        response = self.client.get(ap.url)
+        self.assertContains(response, "Quotably interesting", status_code=200)
+
+        self.client.login(username="testuser1", password="12345")
+
+        ap = ArticlePage.objects.get(slug="test-article5")
+        response = self.client.get(ap.url)
+        print(response.content)
+
+        # @TODO: improve the test
+        # note: the page meta description will contain the "Quotably interesting",
+        # because the "body_preview" call gets the content rendered without context,
+        # and so it sees the page as not-logged-in
+
+        self.assertContains(
+            response, '<div class="block-quote"></div>', status_code=200
+        )
+
+    def test_visible_to_specific_group(self):
+        # sourcery skip: extract-duplicate-method
+        settings = {
+            "visibility": "include-groups",
+            "visibility_groups": "Group22,Group23",
+        }
+
+        self.createArticlePage(title="Test Article6", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article6")
+
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)
+
+        # wrong group
+        self.client.login(username="testuser1", password="12345")
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)
+
+        self.client.logout()
+        self.client.login(username="testuser2", password="12345")
+        response = self.client.get(ap.url)
+        self.assertContains(response, "Quotably interesting", status_code=200)
+
+        self.client.logout()
+        self.client.login(username="testuser4", password="12345")
+        response = self.client.get(ap.url)
+        self.assertContains(response, "Quotably interesting", status_code=200)
+
+    def test_invisible_to_specific_group(self):
+        # sourcery skip: extract-duplicate-method
+        settings = {
+            "visibility": "exclude-groups",
+            "visibility_groups": "Group22",
+        }
+
+        self.createArticlePage(title="Test Article6", settings=settings)
+
+        ap = ArticlePage.objects.get(slug="test-article6")
+
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)
+
+        # wrong group
+        self.client.login(username="testuser1", password="12345")
+        response = self.client.get(ap.url)
+        self.assertContains(response, "Quotably interesting", status_code=200)
+
+        self.client.logout()
+        self.client.login(username="testuser2", password="12345")
+        response = self.client.get(ap.url)
+        self.assertNotContains(response, "Quotably interesting", status_code=200)

cjkcms/tests/test_templatetags.py

@@ -1,11 +1,14 @@
 import re
-from datetime import datetime
 
 from django.template import engines
-from django.test import TestCase
 from wagtail.models import Site
 
 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
+
 
 django_engine = engines["django"]
 html_id_re = re.compile(r"^[A-Za-z][A-Za-z0-9_:.-]*$")
@@ -103,3 +106,39 @@ class TemplateTagTests(TestCase):
             "{% load cjkcms_tags %}{% define 'test' %}{{ test }}"
         ).render(None)
         self.assertEqual(rt, "test", "define tag did not return 'test'")
+
+    def test_is_in_future_with_future_date(self):
+        future_date = datetime.now() + timedelta(days=1)
+        result = is_in_future(future_date)
+        self.assertTrue(result)
+
+    def test_is_in_future_with_past_date(self):
+        past_date = datetime.now() - timedelta(days=1)
+        result = is_in_future(past_date)
+        self.assertFalse(result)
+
+    def test_is_in_past_with_future_date(self):
+        future_date = datetime.now() + timedelta(days=1)
+        result = is_in_past(future_date)
+        self.assertFalse(result)
+
+    def test_is_in_past_with_past_date(self):
+        past_date = datetime.now() - timedelta(days=1)
+        result = is_in_past(past_date)
+        self.assertTrue(result)
+
+    def test_is_in_future_template_tag(self):
+        template = Template(
+            """{% load cjkcms_tags %}{% if the_date|is_in_future %}future{% else %}not future{% endif %}"""  # noqa: E501
+        )
+        context = Context({"the_date": datetime.now() + timedelta(days=1)})
+        result = template.render(context)
+        self.assertEqual(result, "future")
+
+    def test_is_in_past_template_tag(self):
+        template = Template(
+            "{% load cjkcms_tags %}{% if the_date|is_in_past %}past{% else %}not past{% endif %}"
+        )
+        context = Context({"the_date": datetime.now() - timedelta(days=1)})
+        result = template.render(context)
+        self.assertEqual(result, "past")

cjkcms/tests/testapp/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class TestAppConfig(AppConfig):
+    name = "cjkcms.tests.testapp"  # replace `myapp` with your app name
+    verbose_name = "TestApp"

cjkcms/tests/testapp/migrations/0001_initial.py

@@ -0,0 +1,144 @@
+# Generated by Django 4.1.4 on 2022-12-28 06:28
+
+import cjkcms.fields
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("wagtailcore", "0040_page_draft_title"),
+        ("cjkcms", "0004_layoutsettings_articles_date_format_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ProjectArticleIndexPage",
+            fields=[
+                (
+                    "cjkcmspage_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="cjkcms.cjkcmspage",
+                    ),
+                ),
+                (
+                    "show_images",
+                    models.BooleanField(default=True, verbose_name="Show images"),
+                ),
+                ("show_captions", models.BooleanField(default=True)),
+                (
+                    "show_meta",
+                    models.BooleanField(
+                        default=True, verbose_name="Show author and date info"
+                    ),
+                ),
+                (
+                    "show_preview_text",
+                    models.BooleanField(default=True, verbose_name="Show preview text"),
+                ),
+                (
+                    "body",
+                    cjkcms.fields.CjkcmsStreamField(
+                        blank=True, null=True, use_json_field=True
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "App Article Landing Page",
+            },
+            bases=("cjkcms.cjkcmspage",),
+        ),
+        migrations.CreateModel(
+            name="ProjectWebPage",
+            fields=[
+                (
+                    "cjkcmspage_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="cjkcms.cjkcmspage",
+                    ),
+                ),
+                (
+                    "body",
+                    cjkcms.fields.CjkcmsStreamField(
+                        blank=True, null=True, use_json_field=True
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "App Web Page",
+            },
+            bases=("cjkcms.cjkcmspage",),
+        ),
+        migrations.CreateModel(
+            name="ProjectArticlePage",
+            fields=[
+                (
+                    "cjkcmspage_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="cjkcms.cjkcmspage",
+                    ),
+                ),
+                (
+                    "caption",
+                    models.CharField(
+                        blank=True, max_length=255, verbose_name="Caption"
+                    ),
+                ),
+                (
+                    "author_display",
+                    models.CharField(
+                        blank=True,
+                        help_text="Override how the author’s name displays on this article.",
+                        max_length=255,
+                        verbose_name="Display author as",
+                    ),
+                ),
+                (
+                    "date_display",
+                    models.DateField(
+                        blank=True, null=True, verbose_name="Display publish date"
+                    ),
+                ),
+                (
+                    "body",
+                    cjkcms.fields.CjkcmsStreamField(
+                        blank=True, null=True, use_json_field=True
+                    ),
+                ),
+                (
+                    "author",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to=settings.AUTH_USER_MODEL,
+                        verbose_name="Author",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "App Article",
+                "ordering": ["-first_published_at"],
+            },
+            bases=("cjkcms.cjkcmspage",),
+        ),
+    ]

cjkcms/tests/testapp/migrations/0002_create_homepage.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+from django.db import migrations
+from wagtail.models import Locale
+
+
+def create_homepage(apps, schema_editor):
+    """Create app homepage based on CjkCMS WebPage model"""
+    # Get models
+    ContentType = apps.get_model("contenttypes.ContentType")
+    Page = apps.get_model("wagtailcore.Page")
+    Site = apps.get_model("wagtailcore.Site")
+    ProjectWebPage = apps.get_model("testapp.ProjectWebPage")
+
+    # Delete the default homepage
+    # If migration is run multiple times, it may have already been deleted
+    Page.objects.filter(slug="home").delete()
+
+    # Create content type for homepage model
+    project_webpage_content_type, __ = ContentType.objects.get_or_create(
+        model="projectwebpage", app_label="testapp"
+    )
+
+    # Create a new homepage
+    homepage = ProjectWebPage.objects.create(
+        title="app Home",
+        draft_title="app Home",
+        slug="home",
+        content_type=project_webpage_content_type,
+        path="00010001",
+        depth=2,
+        numchild=0,
+        url_path="/home/",
+        locale_id=Locale.get_default().id,
+    )
+
+    # Create a site with the new homepage set as the root
+    Site.objects.create(hostname="localhost", root_page=homepage, is_default_site=True)
+
+
+def remove_homepage(apps, schema_editor):
+    # Get models
+    content_type = apps.get_model("contenttypes.ContentType")
+    project_web_page = apps.get_model("testapp.ProjectWebPage")
+
+    # Delete the default homepage
+    # Page and Site objects CASCADE
+    project_web_page.objects.filter(slug="home", depth=2).delete()
+
+    # Delete content type for app webpage model
+    content_type.objects.filter(model="projectwebpage", app_label="home").delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("cjkcms", "0001_initial"),
+        ("wagtailcore", "0057_page_locale_fields_notnull"),
+        ("testapp", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RunPython(create_homepage, remove_homepage),
+    ]

cjkcms/tests/testapp/models.py

@@ -0,0 +1,19 @@
+from cjkcms.models import (
+    CjkcmsArticlePage,
+    CjkcmsArticleIndexPage,
+    CjkcmsWebPage,
+)
+
+
+class ProjectArticlePage(CjkcmsArticlePage):
+    template = "cjkcms/pages/article_page.html"
+    search_template = "cjkcms/pages/article_page.search.html"
+
+
+class ProjectArticleIndexPage(CjkcmsArticleIndexPage):
+    template = "cjkcms/pages/article_index_page.html"
+
+
+class ProjectWebPage(CjkcmsWebPage):
+    # use cjkcms template by default
+    template = "cjkcms/pages/web_page.html"

cjkcms/tests/urls.py

@@ -0,0 +1,26 @@
+from django.urls import include, path
+from django.conf.urls.static import static
+from django.contrib import admin
+from django.conf import settings
+
+from wagtail import urls as wagtail_urls
+from cjkcms import urls as cjkcms_urls
+from wagtail.admin import urls as wagtailadmin_urls
+from wagtail.documents import urls as wagtaildocs_urls
+
+
+urlpatterns = [
+    path("django-admin/", admin.site.urls),
+    path("admin/", include(wagtailadmin_urls)),
+    path("documents/", include(wagtaildocs_urls)),
+    path("", include(cjkcms_urls)),
+    path("", include(wagtail_urls)),
+]
+
+
+if settings.DEBUG:
+    from django.contrib.staticfiles.urls import staticfiles_urlpatterns
+
+    # Serve static and media files from development server
+    urlpatterns += staticfiles_urlpatterns()
+    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

cjkcms/utils.py

@@ -43,10 +43,13 @@ def can_show_block(
     if item_visibility == "all":
         return True
 
+    # if context is None or "request" not in context:
+    #     is_auth = False
+    # else:
     try:
         is_auth = context["request"].user.is_authenticated
-    except KeyError:
-        return False
+    except (KeyError, TypeError):
+        is_auth = False
 
     if not is_auth:
         return item_visibility == "non-auth-only"

cjkcms/wagtail_hooks.py

@@ -7,7 +7,7 @@ from cjkcms.draftail import (
     register_inline_styling,
 )
 
-from cjkcms.models.admin_sidebar import NavbarSnippet
+from cjkcms.models.admin_sidebar import NavbarSnippet, EventCalendarSnippet
 from django.http.response import HttpResponse
 from django.templatetags.static import static
 from django.utils.html import format_html
@@ -199,3 +199,4 @@ def register_external_link(features):
 
 
 register_snippet(NavbarSnippet)
+register_snippet(EventCalendarSnippet)

{wagtail_cjkcms-23.9.2.dist-info → wagtail_cjkcms-23.10.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 23.9.2
+Version: 23.10.2
 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
@@ -32,7 +32,8 @@ License: BSD-3-Clause
         ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
         (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
         SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-Project-URL: Homepage, https://github.com/cjkpl/wagtail-cjkcms
+Project-URL: Homepage, https://cjkcms.com
+Project-URL: Repository, https://github.com/cjkpl/wagtail-cjkcms/issues
 Keywords: wagtail,django,cms
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django