Additional Versioning Compatibility Changes

djangocms_snippet/admin.py

@@ -1,12 +1,28 @@
 from django.conf import settings
+from django.conf.urls import url
 from django.contrib import admin
 from django.db import models
 from django.forms import Textarea
 
+from .cms_config import SnippetCMSAppConfig
 from .models import Snippet
+from .views import SnippetPreviewView
 
 
-class SnippetAdmin(admin.ModelAdmin):
+# 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 djangocms_versioning_enabled:
+        snippet_admin_classes.insert(0, ExtendedVersionAdminMixin)
+except ImportError:
+    pass
+
+
+class SnippetAdmin(*snippet_admin_classes):
     list_display = ('slug', 'name')
     search_fields = ['slug', 'name']
     prepopulated_fields = {'slug': ('name',)}
@@ -22,5 +38,38 @@ class SnippetAdmin(admin.ModelAdmin):
         models.TextField: {'widget': Textarea(attrs=text_area_attrs)}
     }
 
+    class Meta:
+        model = Snippet
+
+    def get_urls(self):
+        info = self.model._meta.app_label, self.model._meta.model_name
+        return [
+            url(
+                r"^$",
+                self.admin_site.admin_view(self.changelist_view),
+                name="{}_{}_changelist".format(*info),
+            ),
+            url(
+                r"^(?P<snippet_id>\d+)/$",
+                self.admin_site.admin_view(self.changelist_view),
+                name="{}_{}_list".format(*info),
+            ),
+            url(
+                r"^add/$",
+                self.admin_site.admin_view(self.add_view),
+                name="{}_{}_add".format(*info),
+            ),
+            url(
+                r"^(?P<object_id>\d+)/change/$",
+                self.admin_site.admin_view(self.change_view),
+                name="{}_{}_change".format(*info),
+            ),
+            url(
+                r"^(?P<snippet_id>\d+)/preview/$",
+                self.admin_site.admin_view(SnippetPreviewView.as_view()),
+                name="{}_{}_preview".format(*info),
+            ),
+        ]
+
 
 admin.site.register(Snippet, SnippetAdmin)

djangocms_snippet/cms_config.py

@@ -3,6 +3,7 @@
 from cms.app_base import CMSAppConfig
 
 from djangocms_snippet.models import Snippet
+from djangocms_snippet.rendering import render_snippet
 
 
 try:
@@ -15,12 +16,16 @@
 
 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
+    # cms toolbar enabled to allow for versioning compare view
+    cms_toolbar_enabled_models = [(Snippet, render_snippet), ]
+
     if djangocms_moderation_enabled and djangocms_moderation_installed:
         moderated_models = [Snippet]
 

djangocms_snippet/forms.py

@@ -0,0 +1,61 @@
+from django import forms
+from django.db import transaction
+from django.utils.translation import ugettext_lazy as _
+
+from djangocms_snippet.cms_config import SnippetCMSAppConfig
+from djangocms_snippet.models import Snippet, SnippetGrouper
+
+
+try:
+    from djangocms_versioning import __version__  # NOQA
+    is_versioning_installed = True
+except ImportError:
+    is_versioning_installed = False
+
+djangocms_versioning_enabled = SnippetCMSAppConfig.djangocms_versioning_enabled
+
+
+class SnippetForm(forms.ModelForm):
+    class Meta:
+        model = Snippet
+        fields = (
+            "name",
+            "html",
+            "slug",
+            "snippet_grouper",
+        )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields["snippet_grouper"].required = False
+
+    def clean(self):
+        data = super().clean()
+        name = data.get("name")
+        slug = data.get("slug")
+        snippet_grouper = data.get("snippet_grouper")
+        snippet_queryset = Snippet.objects.all()
+
+        if djangocms_versioning_enabled and is_versioning_installed:
+            if snippet_grouper:
+                snippet_queryset = snippet_queryset.exclude(snippet_grouper=snippet_grouper)
+
+        for snippet in snippet_queryset:
+            if snippet.name == name:
+                self.add_error(
+                    "name", _("A Snippet with this name already exists")
+                )
+            elif snippet.slug == slug:
+                self.add_error(
+                    "slug", _("A Snippet with this slug already exists")
+                )
+
+        return data
+
+    @transaction.atomic
+    def save(self, **kwargs):
+        if not self.cleaned_data.get("snippet_grouper"):
+            super().save(commit=False)
+            self.save_m2m()
+            self.instance.snippet_grouper = SnippetGrouper.objects.create()
+        return super().save()

djangocms_snippet/models.py

@@ -1,5 +1,6 @@
 from django.conf import settings
 from django.db import models
+from django.shortcuts import reverse
 from django.utils.translation import gettext_lazy as _
 
 from cms.models import CMSPlugin
@@ -10,7 +11,15 @@
 
 
 class SnippetGrouper(models.Model):
-    pass
+    @property
+    def name(self):
+        snippet_qs = Snippet._base_manager.filter(
+            snippet_grouper=self
+        )
+        return snippet_qs.first().name or super().__str__
+
+    def __str__(self):
+        return self.name
 
 
 # Stores the actual data
@@ -50,6 +59,14 @@ class Snippet(models.Model):
     def __str__(self):
         return self.name
 
+    def get_preview_url(self):
+        return reverse(
+            "admin:{app}_{model}_preview".format(
+                app=self._meta.app_label, model=self._meta.model_name,
+            ),
+            args=[self.id],
+        )
+
     class Meta:
         ordering = ['name']
         verbose_name = _('Snippet')
@@ -82,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

djangocms_snippet/rendering.py

@@ -0,0 +1,7 @@
+from django.template.response import TemplateResponse
+
+
+def render_snippet(request, snippet):
+    template = 'djangocms_snippet/admin/preview.html'
+    context = {'snippet': snippet}
+    return TemplateResponse(request, template, context)

djangocms_snippet/templates/djangocms_snippet/admin/preview.html

@@ -0,0 +1,18 @@
+{% extends "admin/base_site.html" %}
+{% load static  %}
+{{ snippet.html|safe|escape }}
+
+{% block extrastyle %}
+  {{ block.super }}
+  <link rel="stylesheet" type="text/css" href="{% static "admin/css/changelists.css" %}">
+{% endblock %}
+
+{% block coltype %}flex{% endblock %}
+
+{% block bodyclass %}{{ block.super }} app-{{ opts.app_label }} model-{{ opts.model_name }} change-list{% endblock %}
+
+{% block content %}
+    {% autoescape off %}
+        {{ snippet.html }}
+    {% endautoescape %}
+{% endblock %}

djangocms_snippet/views.py

@@ -0,0 +1,26 @@
+from django.http import Http404
+from django.views.generic import TemplateView
+
+from djangocms_snippet.models import Snippet
+
+
+class SnippetPreviewView(TemplateView):
+    template_name = "djangocms_snippet/admin/preview.html"
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        snippet_id = kwargs.get("snippet_id", None)
+
+        if not snippet_id:
+            Http404("snippet_id must be provided.")
+
+        try:
+            snippet = Snippet._base_manager.get(pk=self.kwargs.get("snippet_id"))
+        except Snippet.DoesNotExist:
+            raise Http404
+
+        context.update({
+            "snippet": snippet,
+            "opts": Snippet._meta
+        })
+        return context

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

@@ -0,0 +1,53 @@
+from importlib import reload
+
+from django.contrib import admin
+from django.test import RequestFactory, override_settings
+
+from cms.test_utils.testcases import CMSTestCase
+
+from djangocms_snippet import admin as snippet_admin
+from djangocms_snippet import cms_config
+from djangocms_snippet.models import Snippet
+
+from .utils.factories import SnippetWithVersionFactory
+
+
+class SnippetAdminTestCase(CMSTestCase):
+    def setUp(self):
+        self.snippet = SnippetWithVersionFactory()
+        self.snippet_admin = snippet_admin.SnippetAdmin(Snippet, admin)
+        self.snippet_admin_request = RequestFactory().get("/admin/djangocms_snippet")
+
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=False)
+    def test_admin_list_display_without_versioning(self):
+        """
+        Without versioning enabled, list_display should not be extended with version related items
+        """
+        admin.site.unregister(Snippet)
+        reload(cms_config)
+        reload(snippet_admin)
+        self.snippet_admin = snippet_admin.SnippetAdmin(Snippet, admin)
+
+        list_display = self.snippet_admin.get_list_display(self.snippet_admin_request)
+
+        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
+        list actions items
+        """
+        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)
+        )
+        self.assertEqual(
+            list_display[:-1], ('slug', 'name', 'get_author', 'get_modified_date', 'get_versioning_state')
+        )
+        self.assertEqual(list_display[-1].short_description, 'actions')
+        self.assertIn("function ExtendedVersionAdminMixin._list_actions", list_display[-1].__str__())