feat: Snippet CMS 4.0 and djangocms-versioning Data migration (#74)

Author: adam-murray

README.rst

@@ -80,6 +80,11 @@ please set ``DJANGOCMS_SNIPPET_CACHE`` to ``False`` in your settings::
 
     DJANGOCMS_SNIPPET_CACHE = False # default value is True
 
+Migration 0010 requires the use of a user in order to create versions for existing snippets (if djangocms_versioning is installed and enabled),
+a user can be chosen with the setting ``DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID``, the default is 1.
+
+    DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID = 2 # Will use user with id: 2
+
 Template tag
 ------------
 

djangocms_snippet/conf.py

@@ -0,0 +1,6 @@
+from django.conf import settings
+
+
+DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID = getattr(
+    settings, "DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID", 1
+)

djangocms_snippet/migrations/0009_auto_20210811_0942.py renamed to djangocms_snippet/migrations/0009_auto_20210915_0445.py

@@ -1,4 +1,4 @@
-# Generated by Django 2.2.24 on 2021-08-11 09:42
+# Generated by Django 2.2.24 on 2021-09-15 04:45
 
 import django.db.models.deletion
 from django.db import migrations, models
@@ -20,6 +20,11 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='snippet',
             name='snippet_grouper',
-            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.PROTECT, to='djangocms_snippet.SnippetGrouper'),
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='djangocms_snippet.SnippetGrouper'),
+        ),
+        migrations.AddField(
+            model_name='snippetptr',
+            name='snippet_grouper',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='djangocms_snippet.SnippetGrouper'),
         ),
     ]

djangocms_snippet/migrations/0010_cms4_grouper_version_data_migration.py

@@ -0,0 +1,63 @@
+from django.apps import apps as global_apps
+from django.contrib.contenttypes.management import create_contenttypes
+from django.db import migrations
+
+from djangocms_snippet.cms_config import SnippetCMSAppConfig
+from djangocms_snippet.conf import (
+    DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID,
+)
+
+
+try:
+    from djangocms_versioning.constants import DRAFT
+
+    djangocms_versioning_installed = True
+except ImportError:
+    djangocms_versioning_installed = False
+
+
+def cms4_grouper_version_migration(apps, schema_editor):
+    create_contenttypes(global_apps.get_app_config("djangocms_snippet"))
+
+    djangocms_versioning_config_enabled = SnippetCMSAppConfig.djangocms_versioning_enabled
+
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    Snippet = apps.get_model('djangocms_snippet', 'Snippet')
+    SnippetGrouper = apps.get_model('djangocms_snippet', 'SnippetGrouper')
+    User = apps.get_model('auth', 'User')
+
+    snippet_contenttype = ContentType.objects.get(app_label='djangocms_snippet', model='snippet')
+    snippet_queryset = Snippet.objects.all()
+
+    for snippet in snippet_queryset:
+        grouper = SnippetGrouper.objects.create()
+        snippet.snippet_grouper = grouper
+        snippet.save()
+
+        # Get a migration user.
+        migration_user = User.objects.get(id=DJANGOCMS_SNIPPET_VERSIONING_MIGRATION_USER_ID)
+
+        # Create initial Snippet Versions if versioning is enabled and installed.
+        if djangocms_versioning_config_enabled and djangocms_versioning_installed:
+            Version = apps.get_model('djangocms_versioning', 'Version')
+            Version.objects.create(
+                created_by=migration_user,
+                state=DRAFT,
+                number=1,
+                object_id=snippet.pk,
+                content_type=snippet_contenttype,
+            )
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('cms', '0034_remove_pagecontent_placeholders'),  # Run after the CMS4 migrations
+        ('djangocms_snippet', '0009_auto_20210915_0445'),
+    ]
+
+    if djangocms_versioning_installed:
+        dependencies += [('djangocms_versioning', '0015_version_modified'), ]
+
+    operations = [
+        migrations.RunPython(cms4_grouper_version_migration)
+    ]

djangocms_snippet/migrations/0011_cms4_plugin_data_migration.py

@@ -0,0 +1,22 @@
+# Generated by Django 2.2.24 on 2021-08-31 10:45
+from django.db import migrations
+
+
+def cms4_migration(apps, schema_editor):
+    SnippetPtr = apps.get_model('djangocms_snippet', 'SnippetPtr')
+
+    for snippet_plugin in SnippetPtr.objects.all():
+        snippet = snippet_plugin.snippet
+        snippet_plugin.snippet_grouper = snippet.snippet_grouper
+        snippet_plugin.save()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djangocms_snippet', '0010_cms4_grouper_version_data_migration'),
+    ]
+
+    operations = [
+        migrations.RunPython(cms4_migration)
+    ]

djangocms_snippet/migrations/0012_auto_20210915_0721.py

@@ -0,0 +1,28 @@
+# Generated by Django 2.2.24 on 2021-09-15 07:21
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djangocms_snippet', '0011_cms4_plugin_data_migration'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='snippetptr',
+            name='snippet',
+        ),
+        migrations.AlterField(
+            model_name='snippet',
+            name='snippet_grouper',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='djangocms_snippet.SnippetGrouper'),
+        ),
+        migrations.AlterField(
+            model_name='snippetptr',
+            name='snippet_grouper',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='djangocms_snippet.SnippetGrouper'),
+        ),
+    ]

djangocms_snippet/models.py

@@ -20,13 +20,12 @@ class Snippet(models.Model):
     """
     name = models.CharField(
         verbose_name=_('Name'),
-        unique=True,
         max_length=255,
+        unique=True,
     )
     snippet_grouper = models.ForeignKey(
         SnippetGrouper,
         on_delete=models.PROTECT,
-        null=True,
     )
     html = models.TextField(
         verbose_name=_('HTML'),
@@ -44,10 +43,10 @@ class Snippet(models.Model):
     )
     slug = models.SlugField(
         verbose_name=_('Slug'),
-        unique=True,
         blank=False,
         default='',
         max_length=255,
+        unique=True,
     )
 
     def __str__(self):
@@ -71,14 +70,21 @@ class SnippetPtr(CMSPlugin):
         parent_link=True,
         on_delete=models.CASCADE,
     )
-    snippet = models.ForeignKey(Snippet, on_delete=models.CASCADE)
+    snippet_grouper = models.ForeignKey(
+        SnippetGrouper,
+        on_delete=models.CASCADE,
+    )
 
     search_fields = ['snippet__html'] if SEARCH_ENABLED else []
 
     class Meta:
         verbose_name = _('Snippet Ptr')
         verbose_name_plural = _('Snippet Ptrs')
 
+    @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/requirements/base.txt

@@ -3,3 +3,4 @@ tox
 coverage
 isort
 flake8
+factory-boy

tests/settings.py

@@ -2,6 +2,8 @@
 HELPER_SETTINGS = {
     'INSTALLED_APPS': [
         'tests.utils',
+        'djangocms_versioning',
+        'djangocms_snippet',
     ],
     'CMS_LANGUAGES': {
         1: [{
@@ -11,6 +13,7 @@
     },
     'LANGUAGE_CODE': 'en',
     'ALLOWED_HOSTS': ['localhost'],
+    'DJANGOCMS_SNIPPET_VERSIONING_ENABLED': True,
 }
 
 

tests/test_models.py

@@ -1,45 +1,44 @@
-from django.test import TestCase
+from cms.test_utils.testcases import CMSTestCase
 
 from djangocms_snippet.models import SEARCH_ENABLED, Snippet, SnippetPtr
 
+from .utils.factories import SnippetPluginFactory, SnippetWithVersionFactory
 
-class SnippetModelTestCase(TestCase):
 
-    def setUp(self):
-        pass
+class SnippetModelTestCase(CMSTestCase):
 
-    def tearDown(self):
-        pass
+    def setUp(self):
+        self.snippet = SnippetWithVersionFactory(
+            name="test snippet",
+            html="<p>hello world</p>",
+            slug="test_snippet",
+        )
+        self.snippet.versions.last().publish(user=self.get_superuser())
+        self.snippet_grouper = self.snippet.snippet_grouper
+        SnippetPluginFactory(snippet_grouper=self.snippet_grouper, language=["en"])
 
     def test_settings(self):
         self.assertEqual(SEARCH_ENABLED, False)
 
     def test_snippet_instance(self):
-        Snippet.objects.create(
-            name="test snippet",
-            html="<p>hello world</p>",
-            slug="test_snippet",
-        )
         instance = Snippet.objects.all()
+
         self.assertEqual(instance.count(), 1)
+
         instance = Snippet.objects.first()
+
         self.assertEqual(instance.name, "test snippet")
         self.assertEqual(instance.html, "<p>hello world</p>")
         self.assertEqual(instance.slug, "test_snippet")
         # test strings
         self.assertEqual(str(instance), "test snippet")
 
     def test_snippet_ptr_instance(self):
-        snippet = Snippet.objects.create(
-            name="test snippet",
-            html="<p>hello world</p>",
-            slug="test_snippet",
-        )
-        SnippetPtr.objects.create(
-            snippet=snippet,
-        )
         instance = SnippetPtr.objects.all()
+
         self.assertEqual(instance.count(), 1)
+
         instance = SnippetPtr.objects.first()
+
         # test strings
         self.assertEqual(str(instance), "test snippet")