Add support for djangoCMS 4.x (#226)

* fix: make Page queryies ready for djangocms 4.x

* feat: add support for djangoCMS 4

* tests: refactor tests for djangoCMS 4 support

* chore: extract 'django cms 4' compatibility function to reuse it between fields

* fix: isort the tests/ directory

djangocms_link/fields_select2.py

@@ -4,6 +4,8 @@
 
 from django_select2.forms import ModelSelect2Widget
 
+from djangocms_link.helpers import get_queryset_manager
+
 
 class Select2PageSearchFieldMixin:
     search_fields = [
@@ -27,9 +29,11 @@ def build_attrs(self, base_attrs, extra_attrs=None):
         return attrs
 
     def get_queryset(self):
+        # django CMS < 4
+        base_queryset = get_queryset_manager(Page.objects)
         if self.site:
-            return Page.objects.drafts().on_site(self.site)
-        return Page.objects.drafts()
+            return base_queryset.on_site(self.site)
+        return base_queryset.all()
 
     # we need to implement jQuery ourselves, see #180
     class Media:

djangocms_link/forms.py

@@ -3,6 +3,8 @@
 
 from djangocms_attributes_field.widgets import AttributesWidget
 
+from djangocms_link.helpers import get_queryset_manager
+
 from .fields import PageSearchField
 from .models import Link
 
@@ -18,7 +20,7 @@ def for_site(self, site):
         # current site
         # this will work for PageSelectFormField
         from cms.models import Page
-        self.fields['internal_link'].queryset = Page.objects.drafts().on_site(site)
+        self.fields['internal_link'].queryset = get_queryset_manager(Page.objects).on_site(site)
         # set the current site as a internal_link field instance attribute
         # this will be used by the field later to properly set up the queryset
         # this will work for PageSearchField

djangocms_link/helpers.py

@@ -0,0 +1,4 @@
+def get_queryset_manager(base):
+    if hasattr(base, "drafts"):
+        return base.drafts()
+    return base

tests/fixtures.py

@@ -0,0 +1,71 @@
+from django.apps import apps
+
+from cms import __version__
+
+
+DJANGO_CMS4 = not (__version__ < "4")
+DJANGOCMS_VERSIONING = apps.is_installed("djangocms_versioning")
+
+
+class TestFixture:
+    """Sets up generic setUp and tearDown methods for tests."""
+
+    def setUp(self):
+        self.language = "en"
+        self.superuser = self.get_superuser()
+        return super().setUp()
+
+    def tearDown(self):
+        if DJANGOCMS_VERSIONING:
+            from djangocms_versioning.models import Version
+
+            Version.objects.all().delete()
+        return super().tearDown()
+
+    if DJANGO_CMS4:  # CMS V4
+
+        def _get_version(self, grouper, version_state, language=None):
+            language = language or self.language
+
+            from djangocms_versioning.models import Version
+
+            versions = Version.objects.filter_by_grouper(grouper).filter(
+                state=version_state
+            )
+            for version in versions:
+                if (
+                    hasattr(version.content, "language")
+                    and version.content.language == language
+                ):
+                    return version
+            return None
+
+        def publish(self, grouper, language=None):
+            if DJANGOCMS_VERSIONING:
+                from djangocms_versioning.constants import DRAFT
+
+                version = self._get_version(grouper, DRAFT, language)
+                if version is not None:
+                    version.publish(self.superuser)
+
+        def unpublish(self, grouper, language=None):
+            if DJANGOCMS_VERSIONING:
+                from djangocms_versioning.constants import PUBLISHED
+
+                version = self._get_version(grouper, PUBLISHED, language)
+                if version is not None:
+                    version.unpublish(self.superuser)
+
+        def get_placeholders(self, page, language=None):
+            return page.get_placeholders(language or self.language)
+
+    else:  # CMS V3
+
+        def publish(self, page, language=None):
+            page.publish(language)
+
+        def unpublish(self, page, language=None):
+            page.unpublish(language)
+
+        def get_placeholders(self, page, language=None):
+            return page.get_placeholders()

tests/settings.py

@@ -28,6 +28,7 @@
         ('static_placeholder.html', 'Page with static placeholder'),
     ),
     'FILE_UPLOAD_TEMP_DIR': mkdtemp(),
+    'CMS_CONFIRM_VERSION4': True
 }
 
 

tests/test_migrations.py

@@ -26,5 +26,5 @@ def test_for_missing_migrations(self):
             # the "no changes" exit code is 0
             status_code = '0'
 
-        if status_code == '1':
+        if status_code == '1' and "djangocms_link" in output:
             self.fail(f'There are missing migrations:\n {output.getvalue()}')

tests/test_plugins.py

@@ -9,10 +9,11 @@
 from djangocms_link.cms_plugins import LinkPlugin
 from djangocms_link.models import AbstractLink
 
+from .fixtures import TestFixture
 from .helpers import get_filer_file
 
 
-class LinkPluginsTestCase(CMSTestCase):
+class LinkPluginsTestCase(TestFixture, CMSTestCase):
 
     def setUp(self):
         self.file = get_filer_file()
@@ -22,19 +23,19 @@ def setUp(self):
             template="page.html",
             language=self.language,
         )
-        self.home.publish(self.language)
+        self.publish(self.home, self.language)
         self.page = create_page(
             title="content",
             template="page.html",
             language=self.language,
         )
-        self.page.publish(self.language)
+        self.publish(self.page, self.language)
         self.static_page = create_page(
             title='static-content',
             template='static_placeholder.html',
             language='en',
         )
-        self.placeholder = self.page.placeholders.get(slot="content")
+        self.placeholder = self.get_placeholders(self.page, self.language).get(slot="content")
         self.superuser = self.get_superuser()
 
     def tearDown(self):
@@ -64,7 +65,7 @@ def test_plugin_structure(self):
             internal_link=self.page,
             name="Page link",
         )
-        self.page.publish(self.language)
+        self.publish(self.page, self.language)
         self.assertEqual(plugin.get_plugin_class_instance().name, "Link")
 
         with self.login_user_context(self.superuser):
@@ -97,7 +98,7 @@ def test_optional_link(self):
         AbstractLink.link_is_optional = True
 
         plugin = add_plugin(
-            self.page.placeholders.get(slot='content'),
+            self.get_placeholders(self.page, self.language).get(slot='content'),
             'LinkPlugin',
             'en',
         )
@@ -108,7 +109,7 @@ def test_optional_link(self):
         self.assertEqual(AbstractLink.link_is_optional, False)
 
         plugin = add_plugin(
-            self.page.placeholders.get(slot='content'),
+            self.get_placeholders(self.page, self.language).get(slot='content'),
             'LinkPlugin',
             'en',
         )
@@ -119,7 +120,7 @@ def test_optional_link(self):
 
     def test_in_placeholders(self):
         plugin = add_plugin(
-            self.page.placeholders.get(slot='content'),
+            self.get_placeholders(self.page, self.language).get(slot='content'),
             'LinkPlugin',
             'en',
             internal_link=self.page,
@@ -164,7 +165,7 @@ def test_in_placeholders(self):
 
     def test_file(self):
         plugin = add_plugin(
-            self.page.placeholders.get(slot="content"),
+            self.get_placeholders(self.page, self.language).get(slot="content"),
             "LinkPlugin",
             "en",
             file_link=self.file,

tox.ini

@@ -4,6 +4,7 @@ envlist =
     isort
     py{38,39,310}-dj{32}-cms{310,311}
     py{38,39,310}-dj{40}-cms{311}
+    py{39,310}-dj{40,42}-cms{41}
 
 skip_missing_interpreters=True
 
@@ -12,8 +13,10 @@ deps =
     -r{toxinidir}/tests/requirements/base.txt
     dj32: Django>=3.2,<4.0
     dj40: Django>=4.0,<4.1
+    dj42: Django>=4.2,<5.0
     cms310: django-cms>=3.10,<3.11
     cms311: django-cms>=3.11,<3.12
+    cms41: django-cms>=4.1,<4.2
 commands =
     {envpython} --version
     {env:COMMAND:coverage} erase