Fix: Bring up to date with target

Author: adam-murray

CHANGELOG.rst

@@ -6,6 +6,20 @@ Unreleased
 ==========
 * fix: Removed auto-escape from snippet preview template, tags will now be rendered on the page.
 
+4.0.0.dev4 (2022-02-03)
+=======================
+
+* feat: Preview icon renders form in read only mode
+
+
+4.0.0.dev3 (2022-01-11)
+=======================
+
+* fix: Snippet plugin added to a page now displays name instead of ID
+* fix: Slug field on list display for admin should only be displayed when versioning is not available
+* fix: Removed unused contents within templates, reducing the clutter within version compare views. Previously this was causing a lot of junk to be included in the version comparison, this will now be reduced.
+
+
 4.0.0.dev2 (2021-12-22)
 =======================
 

djangocms_snippet/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '4.0.0.dev2'
+__version__ = '4.0.0.dev4'
 
 default_app_config = 'djangocms_snippet.apps.SnippetConfig'

djangocms_snippet/admin.py

@@ -1,15 +1,19 @@
 from django.conf import settings
 from django.conf.urls import url
 from django.contrib import admin
+from django.contrib.admin import helpers
+from django.contrib.admin.exceptions import DisallowedModelAdminToField
+from django.contrib.admin.options import IS_POPUP_VAR, TO_FIELD_VAR
+from django.contrib.admin.utils import flatten_fieldsets, unquote
 from django.db import models
 from django.forms import Textarea
+from django.utils.translation import gettext as _
 
 from cms.utils.permissions import get_model_permission_codename
 
 from .cms_config import SnippetCMSAppConfig
 from .forms import SnippetForm
 from .models import Snippet
-from .views import SnippetPreviewView
 
 
 # Use the version mixin if djangocms-versioning is installed and enabled
@@ -22,13 +26,12 @@
     if djangocms_versioning_enabled:
         snippet_admin_classes.insert(0, ExtendedVersionAdminMixin)
 except ImportError:
-    pass
+    djangocms_versioning_enabled = False
 
 
 class SnippetAdmin(*snippet_admin_classes):
-    list_display = ('slug', 'name')
-    search_fields = ['slug', 'name']
-    prepopulated_fields = {'slug': ('name',)}
+    list_display = ('name',)
+    search_fields = ['name']
     change_form_template = 'djangocms_snippet/admin/change_form.html'
     text_area_attrs = {
         'rows': 20,
@@ -46,15 +49,105 @@ class SnippetAdmin(*snippet_admin_classes):
     class Meta:
         model = Snippet
 
+    def get_list_display(self, request):
+        list_display = super().get_list_display(request)
+        list_display = list(list_display)
+
+        if not djangocms_versioning_enabled:
+            list_display.insert(0, 'slug')
+
+        list_display = tuple(list_display)
+        return list_display
+
+    def get_search_fields(self, request):
+        search_fields = super().get_search_fields(request)
+        if not djangocms_versioning_enabled:
+            search_fields.append('slug')
+        return search_fields
+
+    def get_prepopulated_fields(self, obj, request):
+        prepopulated_fields = super().get_prepopulated_fields(request)
+        if not djangocms_versioning_enabled:
+            prepopulated_fields = {'slug': ('name',)}
+        return prepopulated_fields
+
+    def get_list_display_links(self, request, list_display):
+        if not djangocms_versioning_enabled:
+            return list(list_display)[:1]
+        else:
+            self.list_display_links = (None,)
+            return self.list_display_links
+
+    def preview_view(self, request, snippet_id=None, form_url='', extra_context=None):
+        """
+        Custom preview endpoint to display a change form in read only mode
+        Solution based on django changeform view implementation
+        https://github.com/django/django/blob/4b8e9492d9003ca357a4402f831112dd72efd2f8/django/contrib/admin/options.py#L1553
+        """
+        to_field = request.POST.get(TO_FIELD_VAR, request.GET.get(TO_FIELD_VAR))
+
+        if to_field and not self.to_field_allowed(request, to_field):
+            raise DisallowedModelAdminToField("The field %s cannot be referenced." % to_field)
+
+        model = self.model
+        opts = model._meta
+
+        obj = self.get_object(request, unquote(snippet_id), to_field)
+
+        if obj is None:
+            return self._get_obj_does_not_exist_redirect(request, opts, snippet_id)
+
+        fieldsets = self.get_fieldsets(request, obj)
+        ModelForm = self.get_form(
+            request, obj, change=False, fields=flatten_fieldsets(fieldsets)
+        )
+        form = ModelForm(instance=obj)
+        formsets, inline_instances = self._create_formsets(request, obj, change=True)
+
+        readonly_fields = flatten_fieldsets(fieldsets)
+
+        adminForm = helpers.AdminForm(
+            form,
+            list(fieldsets),
+            # Clear prepopulated fields on a view-only form to avoid a crash.
+            {},
+            readonly_fields,
+            model_admin=self)
+        media = self.media + adminForm.media
+
+        inline_formsets = self.get_inline_formsets(request, formsets, inline_instances, obj)
+        for inline_formset in inline_formsets:
+            media = media + inline_formset.media
+
+        title = _('View %s')
+        context = {
+            **self.admin_site.each_context(request),
+            'title': title % opts.verbose_name,
+            'subtitle': str(obj) if obj else None,
+            'adminform': adminForm,
+            'object_id': snippet_id,
+            'original': obj,
+            'is_popup': IS_POPUP_VAR in request.POST or IS_POPUP_VAR in request.GET,
+            'to_field': to_field,
+            'media': media,
+            'inline_admin_formsets': inline_formsets,
+            'errors': [],
+            'preserved_filters': self.get_preserved_filters(request),
+        }
+
+        context.update(extra_context or {})
+
+        return self.render_change_form(request, context, add=False, change=False, obj=obj, form_url=form_url)
+
     def get_urls(self):
         info = self.model._meta.app_label, self.model._meta.model_name
         return [
-            url(
-                r"^(?P<snippet_id>\d+)/preview/$",
-                self.admin_site.admin_view(SnippetPreviewView.as_view()),
-                name="{}_{}_preview".format(*info),
-            ),
-        ] + super().get_urls()
+           url(
+                   r"^(?P<snippet_id>\d+)/preview/$",
+                   self.admin_site.admin_view(self.preview_view),
+                   name="{}_{}_preview".format(*info),
+               ),
+           ] + super().get_urls()
 
     def has_delete_permission(self, request, obj=None):
         """

djangocms_snippet/models.py

@@ -106,6 +106,10 @@ class SnippetPtr(CMSPlugin):
 
     search_fields = ['snippet__html'] if SEARCH_ENABLED else []
 
+    def get_short_description(self):
+        snippet_label = SnippetGrouper.objects.filter(pk=self.snippet_grouper.pk).first()
+        return snippet_label
+
     class Meta:
         verbose_name = _('Snippet Ptr')
         verbose_name_plural = _('Snippet Ptrs')

djangocms_snippet/templates/djangocms_snippet/admin/preview.html

@@ -1,16 +1 @@
-{% 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 %}
-    {{ snippet.html }}
-{% endblock %}

djangocms_snippet/views.py

@@ -59,7 +59,7 @@ def test_admin_list_display_with_versioning(self):
             self.snippet_admin.__class__.__bases__, (ExtendedVersionAdminMixin, admin.ModelAdmin)
         )
         self.assertEqual(
-            list_display[:-1], ('slug', 'name', 'get_author', 'get_modified_date', 'get_versioning_state')
+            list_display[:-1], ('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__())
@@ -179,3 +179,51 @@ def test_admin_form_edit_when_locked(self):
         self.assertContains(response, '<div class="readonly">Test Snippet</div>')
         # We should have the same number of snippets as before
         self.assertEqual(Snippet.objects.count(), 1)
+
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=False)
+    def test_slug_colomn_should_hyperlinked_with_versioning_disabled(self):
+        """
+        Slug column should be visible and hyperlinked when versioning is disabled
+        """
+        admin.site.unregister(Snippet)
+        reload(cms_config)
+        reload(snippet_admin)
+
+        with self.login_user_context(self.get_superuser()):
+            response = self.client.get(self.changelist_url)
+        self.assertContains(response, '<th class="field-slug"><a href="/en/admin/djangocms_snippet/'
+                                      'snippet/1/change/">test-snippet</a></th>')
+
+    @override_settings(DJANGOCMS_SNIPPET_VERSIONING_ENABLED=True)
+    def test_name_colomn_should_not_be_hyperlinked_with_versioning_enabled(self):
+        """
+        Name column should be visible and not hyperlinked when versioning is enabled.
+        Slug column should not be visible when versioning is enabled.
+        """
+        admin.site.unregister(Snippet)
+        reload(cms_config)
+        reload(snippet_admin)
+
+        with self.login_user_context(self.get_superuser()):
+            response = self.client.get(self.changelist_url)
+        self.assertContains(response, '<td class="field-name">Test Snippet</td>')
+        self.assertNotContains(response, '<th class="field-slug"><a href="/en/admin/djangocms_snippet/'
+                                         'snippet/1/change/">test-snippet</a></th>')
+
+    def test_preview_renders_read_only_fields(self):
+        """
+        Check that the preview endpoint is rendered in read only mode
+        """
+        self.snippet_version.publish(user=self.superuser)
+        with self.login_user_context(self.superuser):
+            edit_url = reverse("admin:djangocms_snippet_snippet_preview", args=(self.snippet.id,),)
+            response = self.client.get(edit_url)
+
+        # Snippet name
+        self.assertContains(response, '<div class="readonly">Test Snippet</div>')
+        # Snippet slug
+        self.assertContains(response, '<div class="readonly">test-snippet</div>')
+        # Snippet HTML
+        self.assertContains(response, '<div class="readonly">&lt;h1&gt;This is a test&lt;/h1&gt;</div>')
+        # Snippet template
+        self.assertContains(response, '<div class="readonly"></div>')

tests/test_admin.py

@@ -3,7 +3,7 @@
 from cms.api import add_plugin, create_page
 from cms.models import PageContent
 from cms.test_utils.testcases import CMSTestCase
-from cms.toolbar.utils import get_object_edit_url
+from cms.toolbar.utils import get_object_edit_url, get_object_structure_url
 
 from djangocms_snippet.models import Snippet, SnippetGrouper
 from djangocms_versioning.models import Version
@@ -290,3 +290,21 @@ def test_published_snippet_and_page_live_url_rendering(self):
 
         self.assertContains(response, "<p>Published snippet</p>")
         self.assertNotIn("Draft snippet", str(response.content))
+
+    def test_correct_name_is_displayed_for_snippet_component_on_page(self):
+        """
+        If a component is added to the page, it should show the snippet name and not ID
+        """
+        add_plugin(
+            self.draft_pagecontent.placeholders.get(slot="content"),
+            "SnippetPlugin",
+            self.language,
+            snippet_grouper=self.draft_snippet.snippet_grouper,
+        )
+
+        # Request structure endpoint on page
+        request_url = get_object_structure_url(self.draft_pagecontent, "en")
+        with self.login_user_context(self.superuser):
+            response = self.client.get(request_url)
+
+        self.assertContains(response, "<strong>Snippet</strong> plugin_snippet</span>")

tests/test_plugins.py

@@ -26,9 +26,9 @@ def test_preview_renders_html(self):
         # the response will contain character entity references.
         self.assertContains(response, "<h1>Test Title</h1><br><p>Test paragraph</p>")
 
-    def test_preview_raises_404_no_snippet(self):
+    def test_preview_raises_302_no_snippet(self):
         """
-        With no Snippet to preview, a 404 will be raised
+        With no Snippet to preview, a 302 will be raised and the user will be redirected to the admin
         """
         preview_url = admin_reverse(
             "djangocms_snippet_snippet_preview",
@@ -37,4 +37,4 @@ def test_preview_raises_404_no_snippet(self):
         with self.login_user_context(self.user):
             response = self.client.get(preview_url)
 
-        self.assertEqual(response.status_code, 404)
+        self.assertEqual(response.status_code, 302)