Feat: add django cms 4.1 support

.github/workflows/linting.yml

@@ -0,0 +1,39 @@
+name: django CMS References linters.yml
+
+on: [pull_request, push]
+
+jobs:
+  flake8:
+    name: flake8
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - run: pip install --upgrade flake8
+      - name: flake8
+        uses: liskin/gh-problem-matcher-wrap@v1
+        with:
+          linters: flake8
+          run: |
+            flake8
+  isort:
+    name: isort
+    runs-on: ubuntu-latest
+    steps:
+     - name: Checkout
+       uses: actions/checkout@v2
+     - name: Set up Python
+       uses: actions/setup-python@v2
+       with:
+         python-version: 3.9
+     - run: python -m pip install isort
+     - name: isort
+       uses: liskin/gh-problem-matcher-wrap@v1
+       with:
+         linters: isort
+         run: isort -c -rc -df ./
+

.github/workflows/pr.yml

@@ -0,0 +1,39 @@
+name: django CMS references test.yml
+
+on: [pull_request, push]
+
+jobs:
+  database-sqlite:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.8, 3.9, '3.10']  # latest release minus two
+        requirements-file: [
+          dj32_cms40.txt,
+          dj42_cms40.txt,
+          dj42_cms41.txt,
+        ]
+        exclude:
+          - requirements-file: dj42_cms41.txt
+            python-version: 3.8
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt install gettext gcc -y
+        python -m pip install --upgrade pip
+        pip install pytest
+        pip install -r tests/requirements/${{ matrix.requirements-file }}
+        python setup.py install
+    - name: Test with python test runner
+      run: |
+        python setup.py test
+      env:
+        DATABASE_URL: sqlite://localhost/testdb.sqlite

CHANGELOG.rst

@@ -4,6 +4,8 @@ Changelog
 
 Unreleased
 ==========
+* Django CMS 4.1 support added
+
 
 1.5.0 (2024-05-16)
 ==================

djangocms_references/compat.py

@@ -1,3 +1,12 @@
+from cms import __version__ as cms_version
+
+
+try:
+    from packaging.version import Version
+except ModuleNotFoundError:
+    from distutils.version import LooseVersion as Version
+
+
 def is_versioning_installed():
     try:
         import djangocms_versioning  # noqa: F401
@@ -7,4 +16,7 @@ def is_versioning_installed():
         return True
 
 
+DJANGO_CMS_4_1 = Version(cms_version) >= Version('4.1')
+
+
 VERSIONING_INSTALLED = is_versioning_installed()

djangocms_references/monkeypatch/admin.py

@@ -5,10 +5,12 @@
 from djangocms_alias import admin as AliasOriginalAdmin
 from djangocms_snippet import admin as SnippetOriginalAdmin
 
+from djangocms_references.compat import DJANGO_CMS_4_1
 
-def generate_get_references_link(content_grouper):
+
+def generate_get_references_link(content_grouper=None):
     def _get_references_link(self, obj, request):
-        obj_grouper = getattr(obj, content_grouper)
+        obj_grouper = obj if not content_grouper else getattr(obj, content_grouper)
         _obj_grouper_meta = obj_grouper._meta
         content_type = ContentType.objects.get(
             app_label=_obj_grouper_meta.app_label,
@@ -24,7 +26,7 @@ def _get_references_link(self, obj, request):
     return _get_references_link
 
 
-def get_list_actions(func):
+def _get_actions_list(func):
     """
     Add references action to alias list display
     """
@@ -35,12 +37,21 @@ def inner(self, *args, **kwargs):
     return inner
 
 
-AliasOriginalAdmin.AliasContentAdmin._get_references_link = generate_get_references_link('alias')
-AliasOriginalAdmin.AliasContentAdmin.get_list_actions = get_list_actions(
-    AliasOriginalAdmin.AliasContentAdmin.get_list_actions
-)
-
-SnippetOriginalAdmin.SnippetAdmin._get_references_link = generate_get_references_link('snippet_grouper')
-SnippetOriginalAdmin.SnippetAdmin.get_list_actions = get_list_actions(
-    SnippetOriginalAdmin.SnippetAdmin.get_list_actions
-)
+if not DJANGO_CMS_4_1:
+    AliasOriginalAdmin.AliasContentAdmin._get_references_link = generate_get_references_link('alias')
+    AliasOriginalAdmin.AliasContentAdmin.get_list_actions = _get_actions_list(
+        AliasOriginalAdmin.AliasContentAdmin.get_list_actions
+    )
+
+    SnippetOriginalAdmin.SnippetAdmin._get_references_link = generate_get_references_link('snippet_grouper')
+    SnippetOriginalAdmin.SnippetAdmin.get_list_actions = _get_actions_list(
+        SnippetOriginalAdmin.SnippetAdmin.get_list_actions
+    )
+else:
+    AliasOriginalAdmin.AliasAdmin._get_references_link = generate_get_references_link()
+    AliasOriginalAdmin.AliasAdmin.get_actions_list = _get_actions_list(AliasOriginalAdmin.AliasAdmin.get_actions_list)
+
+    SnippetOriginalAdmin.SnippetAdmin._get_references_link = generate_get_references_link('snippet_grouper')
+    SnippetOriginalAdmin.SnippetAdmin.get_actions_list = _get_actions_list(
+        SnippetOriginalAdmin.SnippetAdmin.get_actions_list
+    )

djangocms_references/templates/djangocms_references/references.html

@@ -4,6 +4,11 @@
 {% block extrastyle %}
   {{ block.super }}
   <link rel="stylesheet" type="text/css" href="{% static "admin/css/changelists.css" %}">
+  <style>
+    #changelist-form .results {
+      width: auto;
+    }
+  </style>
 {% endblock %}
 
 {% block extrahead %}

djangocms_references/templates/djangocms_references/references_icon.html

@@ -1,2 +1,4 @@
 {% load static i18n %}
-<a class="btn cms-versioning-action-btn cms-form-get-method js-versioning-action" href="{{ url }}" title="{% trans "Show References" %}"><img src="{% static 'djangocms_references/svg/references.svg' %}"></a>
+<a class="btn cms-action-btn cms-form-get-method js-action" href="{{ url }}" title="{% trans "Show References" %}">
+    <img src="{% static 'djangocms_references/svg/references.svg' %}" style="width: 16.8px; height: 16.8px; margin-right: unset;">
+</a>

djangocms_references/templates/djangocms_versioning_filer/admin/action_buttons/show_references.html

@@ -1,5 +1,9 @@
 {% load i18n djangocms_references_tags %}
 
 {% get_versioning_filer_references_url file as references_url %}
-<a href="{{ references_url }}"
-    title="{% blocktrans %}Show references{% endblocktrans %}" class="action-button cms-form-get-method"><span class="fa fa-code-fork"></span></a>
+
+<a href="{{ references_url }}" title="{% blocktrans %}Show references{% endblocktrans %}" class="action-button cms-form-get-method">
+    <span class="fa fa-link filer-icon filer-icon-reference">
+        <img src="{% static 'djangocms_references/svg/references.svg' %}">
+    </span>
+</a>

tests/requirements/dj32_cms40.txt

@@ -3,5 +3,7 @@
 Django>=3.2,<4.0
 
 # Unreleased django-cms 4.0 compatible packages
+https://github.com/django-cms/django-cms/tarball/release/4.0.1.x#egg=django-cms
+https://github.com/django-cms/djangocms-snippet/tarball/support/django-cms-4.0.x#egg=djangocms-snippet
 https://github.com/django-cms/djangocms-versioning/tarball/1.2.2#egg=djangocms-versioning
 https://github.com/django-cms/djangocms-alias/tarball/1.11.0#egg=djangocms-alias

tests/requirements/dj42_cms40.txt

@@ -2,5 +2,7 @@
 
 Django>=4.2,<5.0
 
+https://github.com/django-cms/django-cms/tarball/release/4.0.1.x#egg=django-cms
+https://github.com/django-cms/djangocms-snippet/tarball/support/django-cms-4.0.x#egg=djangocms-snippet
 https://github.com/django-cms/djangocms-versioning/tarball/support/django-cms-4.0.x#egg=djangocms-versioning
 https://github.com/django-cms/djangocms-alias/tarball/support/django-cms-4.0.x#egg=djangocms-alias

tests/requirements/dj42_cms41.txt

@@ -0,0 +1,8 @@
+-r ./requirements_base.txt
+
+Django>=4.2,<5.0
+djangocms-versioning==2.1.0
+django-cms>=4.1.0
+
+https://github.com/django-cms/djangocms-snippet/tarball/master#egg=djangocms-snippet
+https://github.com/django-cms/djangocms-alias/tarball/master#egg=djangocms-alias

tests/requirements/requirements_base.txt

@@ -4,6 +4,3 @@ factory-boy
 flake8
 isort
 tox
-
-https://github.com/django-cms/django-cms/tarball/release/4.0.1.x#egg=django-cms
-https://github.com/django-cms/djangocms-snippet/tarball/support/django-cms-4.0.x#egg=djangocms-snippet

tests/settings.py

@@ -22,6 +22,7 @@
     },
     "DEFAULT_AUTO_FIELD": "django.db.models.AutoField",
     "ROOT_URLCONF": "tests.urls",
+    "VERSIONING_ALIAS_MODELS_ENABLED": True,
 }