PR updates

Author: adam-murray

djangocms_snippet/admin.py

@@ -9,34 +9,17 @@
 from .views import SnippetPreviewView
 
 
-
 # Use the version mixin if djangocms-versioning is installed and enabled
 snippet_admin_classes = [admin.ModelAdmin]
+djangocms_versioning_enabled = SnippetCMSAppConfig.djangocms_versioning_enabled
 
 try:
     from djangocms_versioning.admin import ExtendedVersionAdminMixin
 
-    if  SnippetCMSAppConfig.djangocms_versioning_enabled:
-        snippet_admin_classes += [ExtendedVersionAdminMixin]
+    if djangocms_versioning_enabled:
+        snippet_admin_classes.insert(0, ExtendedVersionAdminMixin)
 except ImportError:
     pass
-    
-    from djangocms_versioning.admin import ExtendedVersionAdminMixin
-
-    djangocms_versioning_installed = True
-except ImportError:
-    djangocms_versioning_installed = False
-
-
-djangocms_versioning_enabled = SnippetCMSAppConfig.djangocms_versioning_enabled
-
-snippet_admin_classes = [
-    admin.ModelAdmin,
-]
-
-
-if djangocms_versioning_installed and djangocms_versioning_enabled:
-    snippet_admin_classes = [ExtendedVersionAdminMixin] + snippet_admin_classes
 
 
 class SnippetAdmin(*snippet_admin_classes):

djangocms_snippet/cms_config.py

@@ -16,10 +16,10 @@
 
 class SnippetCMSAppConfig(CMSAppConfig):
     djangocms_versioning_enabled = getattr(
-        settings, 'DJANGOCMS_SNIPPET_VERSIONING_ENABLED', False
+        settings, 'DJANGOCMS_SNIPPET_VERSIONING_ENABLED', True
     )
     djangocms_moderation_enabled = getattr(
-        settings, 'DJANGOCMS_SNIPPET_MODERATION_ENABLED', False
+        settings, 'DJANGOCMS_SNIPPET_MODERATION_ENABLED', True
     )
 
     cms_enabled = True

djangocms_snippet/forms.py

@@ -38,7 +38,7 @@ def clean(self):
 
         if djangocms_versioning_enabled and is_versioning_installed:
             if snippet_grouper:
-                snippet_queryset.exclude(snippet_grouper=snippet_grouper)
+                snippet_queryset = snippet_queryset.exclude(snippet_grouper=snippet_grouper)
 
         for snippet in snippet_queryset:
             if snippet.name == name:

djangocms_snippet/models.py

@@ -11,7 +11,15 @@
 
 
 class SnippetGrouper(models.Model):
-    pass
+    @property
+    def name(self):
+        snippet_qs = Snippet._base_manager.filter(
+            snippet_grouper=self
+        )
+        return snippet_qs.last().name or super().__str__
+
+    def __str__(self):
+        return self.name
 
 
 # Stores the actual data
@@ -91,7 +99,3 @@ class Meta:
     @property
     def snippet(self):
         return self.snippet_grouper.snippet_set.first()
-
-    def __str__(self):
-        # Return the referenced snippet's name rather than the default (ID #)
-        return self.snippet.name

tests/settings.py

@@ -15,6 +15,9 @@
     'ALLOWED_HOSTS': ['localhost'],
     'DJANGOCMS_SNIPPET_VERSIONING_ENABLED': True,
     'DJANGOCMS_SNIPPET_MODERATION_ENABLED': True,
+    'CMS_TEMPLATES': (
+        ("page.html", "Normal page"),
+    ),
 }
 
 

tests/test_admin.py

@@ -33,6 +33,7 @@ def test_admin_list_display_without_versioning(self):
         self.assertEqual(self.snippet_admin.__class__.__bases__, (admin.ModelAdmin, ))
         self.assertEqual(list_display, ('slug', 'name'))
 
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=True)
     def test_admin_list_display_with_versioning(self):
         """
         With versioning enabled, list_display should be populated with both versioning related items, and the
@@ -41,6 +42,7 @@ def test_admin_list_display_with_versioning(self):
         from djangocms_versioning.admin import ExtendedVersionAdminMixin
         list_display = self.snippet_admin.get_list_display(self.snippet_admin_request)
 
+        # Mixins should always come first in the class bases
         self.assertEqual(
             self.snippet_admin.__class__.__bases__, (ExtendedVersionAdminMixin, admin.ModelAdmin)
         )

tests/test_forms.py

@@ -5,6 +5,8 @@
 from djangocms_snippet.forms import SnippetForm
 from djangocms_snippet.models import Snippet, SnippetGrouper
 
+from .utils.factories import SnippetWithVersionFactory
+
 
 class SnippetFormTestCase(CMSTestCase):
 
@@ -27,7 +29,9 @@ def test_snippet_form_creates_grouper_no_versioning(self):
         form.save()
 
         self.assertEqual(SnippetGrouper.objects.count(), 1)
+        self.assertEqual(Snippet._base_manager.count(), 1)
 
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=True)
     def test_snippet_form_creates_grouper_with_versioning(self):
         """
         With versioning enabled, groupers should also be created in the background.
@@ -45,7 +49,9 @@ def test_snippet_form_creates_grouper_with_versioning(self):
         form.save()
 
         self.assertEqual(SnippetGrouper.objects.count(), 1)
+        self.assertEqual(Snippet._base_manager.count(), 1)
 
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=True)
     def test_snippet_form_adds_to_existing_grouper_with_versioning(self):
         """
         With versioning enabled, if a grouper already exists, a new one shouldn't be created
@@ -66,6 +72,7 @@ def test_snippet_form_adds_to_existing_grouper_with_versioning(self):
         form.save()
 
         self.assertEqual(SnippetGrouper.objects.count(), 1)
+        self.assertEqual(Snippet._base_manager.count(), 1)
 
         form_data["html"] = "<h2>Test Title</h2>"
 
@@ -77,7 +84,9 @@ def test_snippet_form_adds_to_existing_grouper_with_versioning(self):
         form.save()
 
         self.assertEqual(SnippetGrouper.objects.count(), 1)
+        self.assertEqual(Snippet._base_manager.count(), 2)
 
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=True)
     def test_snippet_form_versioning_enabled(self):
         """
         With versioning enabled, the snippet form doesn't have to create groupers, but does have to validate
@@ -96,6 +105,7 @@ def test_snippet_form_versioning_enabled(self):
         form.clean()
         form.save()
 
+        # Publish the old created version
         snippet = Snippet._base_manager.last()
         version = snippet.versions.create(created_by=self.get_superuser())
         version.publish(user=self.get_superuser())
@@ -113,3 +123,23 @@ def test_snippet_form_versioning_enabled(self):
         new_form.clean()
 
         self.assertDictEqual(new_form.errors, {'slug': ['A Snippet with this slug already exists']})
+
+    def test_snippet_form_validation_multiple_version_states_in_grouper(self):
+        """
+        Snippet forms should be valid regardless of the versions, or states which already exist within its grouper.
+        """
+        snippet_to_archive = SnippetWithVersionFactory()
+        snippet_to_archive.versions.first().publish(user=self.get_superuser())
+        snippet_to_publish = SnippetWithVersionFactory(snippet_grouper=snippet_to_archive.snippet_grouper)
+        SnippetWithVersionFactory(snippet_grouper=snippet_to_publish.snippet_grouper)
+
+        form_data = {
+            "name": snippet_to_archive.name,
+            "slug": snippet_to_archive.slug,
+            "html": "<p>Hello World!</p>",
+            "snippet_grouper": snippet_to_archive.snippet_grouper.id,
+        }
+
+        form = SnippetForm(form_data)
+
+        self.assertTrue(form.is_valid())

tests/test_models.py

@@ -41,4 +41,4 @@ def test_snippet_ptr_instance(self):
         instance = SnippetPtr.objects.first()
 
         # test strings
-        self.assertEqual(str(instance), "test snippet")
+        self.assertEqual(instance.snippet_grouper.name, "test snippet")

tests/test_views.py

@@ -1,3 +1,5 @@
+from cms.api import add_plugin, create_page
+from cms.models import PageContent
 from cms.test_utils.testcases import CMSTestCase
 from cms.utils.urlutils import admin_reverse