feat: Auto-add versioning mixing to GrouperAdmin (#472)

* feat: Auto-add state indicator and versioning mixin to grouper admin

* add docstring

* fix: add can_change_content method

* add some type hints

* Remove inline JS code for django CMS 5

* Fix ruff issues

* update testing requirements

* Add tests

* Fix ruff

* Fix tests for djangocms_text

* Update test action

* Run tests with py3.12

* Update docs

* updarte docs

* Update readme

* Update readme 2

* Update docs

* Update tests

* Fix pyproject.toml

* Fix tests

* Update docs

* Update docs

* Update docs

* fix readme typo

* Update djangocms_versioning/helpers.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* typo

* Fix: Remove menu registration from 5.x tests

* Update conf

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: fsbraun

.github/workflows/test.yml

@@ -151,7 +151,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.13']
+        python-version: ['3.12']
         requirements-file: ['dj52_cms50.txt']
         cms-version: [
           'https://github.com/django-cms/django-cms/archive/main.tar.gz'
@@ -171,6 +171,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install -r tests/requirements/${{ matrix.requirements-file }}
+        python -m pip uninstall -y django-cms
         python -m pip install ${{ matrix.cms-version }}
         python setup.py install
 
@@ -185,7 +186,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.13" ]
+        python-version: [ "3.12" ]
         cms-version: [
           'https://github.com/django-cms/django-cms/archive/main.tar.gz'
         ]
@@ -205,6 +206,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install -r tests/requirements/${{ matrix.requirements-file }}
+        python -m pip uninstall -y Django django-cms
         python -m pip install ${{ matrix.cms-version }} ${{ matrix.django-version }}
         python setup.py install
 

README.rst

@@ -1,4 +1,4 @@
-|django| |djangocms|
+|PyPiVersion| |DjVersion| |CmsVersion|
 
 *********************
 django CMS Versioning
@@ -27,7 +27,7 @@ Add ``djangocms_versioning`` to your project's ``INSTALLED_APPS``.
 Run::
 
     python -m manage migrate djangocms_versioning
-    python -m manage create_versions --userid <user-id-of-migration-user> 
+    python -m manage create_versions --userid <user-id-of-migration-user>
 
 to perform the application's database migrations and (only if you have an existing database) add version objects
 needed to mark existing versions as draft.
@@ -48,7 +48,7 @@ An example implementation can be found here:
 Testing
 =======
 
-To run all the tests the only thing you need to do is run
+To run all the tests the only thing you need to do is run::
 
     pip install -r tests/requirements.txt
     python setup.py test
@@ -98,8 +98,18 @@ To update transifex translation in this repo you need to download the
 ``tx pull`` from the repo's root directory. After downloading the translations
 do not forget to run the ``compilemessages`` management command.
 
+.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-versioning.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-versioning
+    :alt: Latest PyPI version
 
-.. |django| image:: https://img.shields.io/badge/django-4.2%2B-blue.svg
-    :target: https://www.djangoproject.com/
-.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-4.1%2B-blue.svg
-    :target: https://www.django-cms.org/
+.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-versioning.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-versioning
+    :alt: Python versions
+
+.. |DjVersion| image:: https://img.shields.io/pypi/frameworkversions/django/djangocms-versioning.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-versioning
+    :alt: Django versions
+
+.. |CmsVersion| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-versioning.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-versioning
+    :alt: django CMS versions

djangocms_versioning/__init__.py

@@ -1 +1 @@
-__version__ = "2.3.2"
+__version__ = "2.4.0"

djangocms_versioning/admin.py

@@ -344,6 +344,48 @@ def get_modified_date(self, obj: models.Model) -> typing.Union[str, None]:
         """
         return getattr(obj, "content_modified", None)
 
+    def can_change_content(self, request: HttpRequest, content_obj: models.Model) -> bool:
+        """Returns True if user can change content_obj"""
+        if content_obj is None:
+            # Creating an object is never restricted by versioning
+            return True
+        version = Version.objects.get_for_content(content_obj)
+        return version.check_modify.as_bool(request.user)
+
+
+
+class DefaultGrouperVersioningAdminMixin(StateIndicatorMixin, ExtendedGrouperVersionAdminMixin):
+    """Default mixin for grouper model admin classes: Includes state indicator, author and modified date.
+    Usage::
+        class MyContentModelAdmin(DefaultGrouperAdminMixin, cms.admin.utils.GrouperModelAdmin):
+            list_display = [
+                ...,
+                "get_author",   # Adds the author column
+                "get_modified_date",  # Adds the modified column
+                "state_indicator",  # Adds the state indicator column
+                ...]
+
+    If "state_indicator" is not in `list_display`, it will be added automatically before the
+    "admin_list_actions" field, or - together with the actions - at the end of the list_display
+    if no actions are present.
+    """
+    def get_list_display(self, request):
+        list_display = getattr(self, "list_display", ())
+        if "state_indicator" not in list_display:
+            if "admin_list_actions" in list_display:
+                # If the admin_list_actions is present, we need to add the state_indicator
+                # to the end of the list_display, so it doesn't interfere with the actions
+                index = list_display.index("admin_list_actions")
+                self.list_display = (
+                    *list_display[:index],  # All items before admin_list_actions
+                    "state_indicator",  # Add the state indicator before admin_list_actions
+                    *list_display[index:],  # All items after admin_list_actions
+                )
+            else:
+                # Add the state indicator and admin_list_actions to the end of the list_display
+                self.list_display = (*list_display, "state_indicator", "admin_list_actions",)
+        return super().get_list_display(request)
+
 
 class ExtendedVersionAdminMixin(
     ExtendedListDisplayMixin,

djangocms_versioning/cms_config.py

@@ -2,7 +2,6 @@
 
 from cms import __version__ as cms_version
 from cms.app_base import CMSAppConfig, CMSAppExtension
-from cms.extensions.models import BaseExtension
 from cms.models import PageContent
 from cms.utils.i18n import get_language_list, get_language_tuple
 from cms.utils.plugins import copy_plugins_to_placeholder
@@ -124,6 +123,12 @@ def handle_admin_classes(self, cms_config):
                 for versionable in cms_config.versioning
             ]
         )
+        replace_admin_for_models(
+            [
+                (versionable.grouper_model, versionable.grouper_admin_mixin)
+                for versionable in cms_config.versioning if versionable.grouper_admin_mixin is not None
+            ]
+        )
 
     def handle_version_admin(self, cms_config):
         """
@@ -191,14 +196,6 @@ def copy_page_content(original_content):
     """
     new_content = default_copy(original_content)
     new_content.creation_date = now()
-
-    # If pagecontent has an associated content or page extension, also copy this!
-    for field in PageContent._meta.related_objects:
-        if hasattr(original_content, field.name):
-            extension = getattr(original_content, field.name)
-            if isinstance(extension, BaseExtension):
-                extension.copy(new_content, new_content.language)
-
     return new_content
 
 
@@ -264,13 +261,6 @@ def get_queryset(self, request):
             .prefetch_related(Prefetch("versions", to_attr="prefetched_versions"))
         return queryset
 
-    # CAVEAT:
-    #   - PageContent contains the template, this can differ for each language,
-    #     it is assumed that templates would be the same when copying from one language to another
-    # FIXME: The long term solution will require knowing:
-    #           - why this view is an ajax call
-    #           - where it should live going forwards (cms vs versioning)
-    #           - A better way of making the feature extensible / modifiable for versioning
     def copy_language(self, request, object_id):
         target_language = request.POST.get("target_language")
 

djangocms_versioning/conf.py

@@ -4,6 +4,8 @@
 ENABLE_MENU_REGISTRATION = getattr(
     settings, "DJANGOCMS_VERSIONING_ENABLE_MENU_REGISTRATION", CMS_VERSION <= "4.1.0"
 )
+if CMS_VERSION.startswith("5."):
+    ENABLE_MENU_REGISTRATION = False
 
 USERNAME_FIELD = getattr(
     settings, "DJANGOCMS_VERSIONING_USERNAME_FIELD", "username"