ideas,moderatorfeedback,organisations: replace richtext with ckeditor

apps/budgeting/migrations/0003_alter_proposal_description.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.19 on 2024-03-26 10:34
+
+from django.db import migrations
+import django_ckeditor_5.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("a4_candy_budgeting", "0002_rename_moderatorfeedback_fields"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="proposal",
+            name="description",
+            field=django_ckeditor_5.fields.CKEditor5Field(verbose_name="Description"),
+        ),
+    ]

apps/ideas/migrations/0003_alter_idea_description.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.19 on 2024-03-26 10:34
+
+from django.db import migrations
+import django_ckeditor_5.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("a4_candy_ideas", "0002_rename_moderatorfeedback_fields"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="idea",
+            name="description",
+            field=django_ckeditor_5.fields.CKEditor5Field(verbose_name="Description"),
+        ),
+    ]

apps/ideas/models.py

@@ -1,10 +1,10 @@
 from autoslug import AutoSlugField
-from ckeditor.fields import RichTextField
 from django.contrib.contenttypes.fields import GenericRelation
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
+from django_ckeditor_5.fields import CKEditor5Field
 
 from adhocracy4 import transforms
 from adhocracy4.categories.fields import CategoryField
@@ -31,7 +31,7 @@ class AbstractIdea(module_models.Item, Moderateable):
     )
     slug = AutoSlugField(populate_from="name", unique=True)
     name = models.CharField(max_length=120, verbose_name=_("Title"))
-    description = RichTextField(verbose_name=_("Description"))
+    description = CKEditor5Field(verbose_name=_("Description"))
     image = ConfiguredImageField(
         "idea_image",
         verbose_name=_("Add image"),

apps/mapideas/migrations/0003_alter_mapidea_description.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.19 on 2024-03-26 10:34
+
+from django.db import migrations
+import django_ckeditor_5.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("a4_candy_mapideas", "0002_moderatorfeedback_fields"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="mapidea",
+            name="description",
+            field=django_ckeditor_5.fields.CKEditor5Field(verbose_name="Description"),
+        ),
+    ]

apps/moderatorfeedback/forms.py

@@ -1,4 +1,5 @@
 from django import forms
+from django.utils.translation import gettext_lazy as _
 
 from . import models
 
@@ -7,3 +8,10 @@ class ModeratorFeedbackForm(forms.ModelForm):
     class Meta:
         model = models.ModeratorFeedback
         fields = ["feedback_text"]
+        help_texts = {
+            "feedback_text": _(
+                "The official feedback will appear below the idea, "
+                "indicating your organisation. The idea provider receives "
+                "a notification."
+            ),
+        }

apps/moderatorfeedback/migrations/0006_auto_20240326_1134.py

@@ -0,0 +1,27 @@
+# Generated by Django 3.2.19 on 2024-03-26 10:34
+
+from django.db import migrations
+import django_ckeditor_5.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("a4_candy_moderatorfeedback", "0005_moderatorcommentfeedback"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="moderatorcommentfeedback",
+            name="feedback_text",
+            field=django_ckeditor_5.fields.CKEditor5Field(
+                blank=True, verbose_name="Moderator feedback"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="moderatorfeedback",
+            name="feedback_text",
+            field=django_ckeditor_5.fields.CKEditor5Field(
+                blank=True, verbose_name="Official feedback"
+            ),
+        ),
+    ]

apps/moderatorfeedback/models.py

@@ -1,6 +1,6 @@
-from ckeditor.fields import RichTextField
 from django.db import models
 from django.utils.translation import gettext_lazy as _
+from django_ckeditor_5.fields import CKEditor5Field
 
 from adhocracy4 import transforms
 from adhocracy4.comments.models import Comment
@@ -16,14 +16,9 @@
 
 
 class ModeratorFeedback(UserGeneratedContentModel):
-    feedback_text = RichTextField(
+    feedback_text = CKEditor5Field(
         blank=True,
         verbose_name=_("Official feedback"),
-        help_text=_(
-            "The official feedback will appear below the idea, "
-            "indicating your organisation. The idea provider receives "
-            "a notification."
-        ),
     )
 
     def save(self, *args, **kwargs):
@@ -56,7 +51,7 @@ class Meta:
 
 
 class ModeratorCommentFeedback(UserGeneratedContentModel):
-    feedback_text = RichTextField(
+    feedback_text = CKEditor5Field(
         blank=True,
         verbose_name=_("Moderator feedback"),
     )

apps/organisations/forms.py

@@ -134,14 +134,17 @@ class OrganisationForm(forms.ModelForm):
         ),
         (
             "information",
-            CKEditor5Widget,
+            forms.CharField,
             {
-                "config_name": "collapsible-image-editor",
+                "label": OrganisationTranslation._meta.get_field(
+                    "information"
+                ).verbose_name,
                 "help_text": OrganisationTranslation._meta.get_field(
                     "information"
                 ).help_text,
-                "external_plugin_resources": _external_plugin_resources,
-                "extra_plugins": ["collapsibleItem"],
+                "max_length": OrganisationTranslation._meta.get_field(
+                    "information"
+                ).max_length,
                 "widget": CKEditor5Widget(
                     config_name="collapsible-image-editor",
                 ),
@@ -170,15 +173,8 @@ def __init__(self, *args, **kwargs):
         for lang_code in self.languages:
             for name, field_cls, kwargs in self.translated_fields:
                 self.instance.set_current_language(lang_code)
+                print(field_cls)
                 field = field_cls(**kwargs)
-                # The CKEditor5Widget doesn't have a label field, so we need to set it
-                # after creating the object
-                if isinstance(field, CKEditor5Widget):
-                    field.label = (
-                        OrganisationTranslation._meta.get_field(
-                            "information"
-                        ).verbose_name,
-                    )
                 identifier = self._get_identifier(lang_code, name)
                 field.required = False
 

apps/organisations/migrations/0024_auto_20240326_1134.py

@@ -0,0 +1,49 @@
+# Generated by Django 3.2.19 on 2024-03-26 10:34
+
+from django.db import migrations
+import django_ckeditor_5.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("a4_candy_organisations", "0023_alter_organisationtranslation_information"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="organisation",
+            name="data_protection",
+            field=django_ckeditor_5.fields.CKEditor5Field(
+                blank=True,
+                help_text="Please provide all the legally required information of your data protection. The data protection policy will be shown on a separate page.",
+                verbose_name="Data protection policy",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="organisation",
+            name="imprint",
+            field=django_ckeditor_5.fields.CKEditor5Field(
+                blank=True,
+                help_text="Please provide all the legally required information of your imprint. The imprint will be shown on a separate page.",
+                verbose_name="Imprint",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="organisation",
+            name="netiquette",
+            field=django_ckeditor_5.fields.CKEditor5Field(
+                blank=True,
+                help_text="Please provide a netiquette for the participants. The netiquette helps improving the climate of online discussions and supports the moderation.",
+                verbose_name="Netiquette",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="organisation",
+            name="terms_of_use",
+            field=django_ckeditor_5.fields.CKEditor5Field(
+                blank=True,
+                help_text="Please provide all the legally required information of your terms of use. The terms of use will be shown on a separate page.",
+                verbose_name="Terms of use",
+            ),
+        ),
+    ]

apps/organisations/models.py

@@ -1,5 +1,4 @@
 from autoslug import AutoSlugField
-from ckeditor.fields import RichTextField
 from django.conf import settings
 from django.contrib.sites.models import Site
 from django.db import models
@@ -120,7 +119,7 @@ class Organisation(TranslatableModel):
         blank=True,
         verbose_name="Instagram handle",
     )
-    imprint = RichTextField(
+    imprint = CKEditor5Field(
         verbose_name=_("Imprint"),
         help_text=_(
             "Please provide all the legally "
@@ -129,7 +128,7 @@ class Organisation(TranslatableModel):
         ),
         blank=True,
     )
-    terms_of_use = RichTextField(
+    terms_of_use = CKEditor5Field(
         verbose_name=_("Terms of use"),
         help_text=_(
             "Please provide all the legally "
@@ -138,7 +137,7 @@ class Organisation(TranslatableModel):
         ),
         blank=True,
     )
-    data_protection = RichTextField(
+    data_protection = CKEditor5Field(
         verbose_name=_("Data protection policy"),
         help_text=_(
             "Please provide all the legally "
@@ -148,7 +147,7 @@ class Organisation(TranslatableModel):
         ),
         blank=True,
     )
-    netiquette = RichTextField(
+    netiquette = CKEditor5Field(
         verbose_name=_("Netiquette"),
         help_text=_(
             "Please provide a netiquette for the participants. "

tests/newsletters/test_newsletter_views.py

@@ -268,9 +268,9 @@ def test_send_organisation_missing_alt_text(admin, client, project):
         "sender": "[email protected]",
         "subject": "Testsubject",
         "body": "Testbody <img>",
-        "receivers": newsletter_models.ORGANISATION,
+        "receivers": newsletter_models.PROJECT,
         "organisation": organisation.pk,
-        "project": "",
+        "project": project.pk,
         "send": "Send",
     }
 
@@ -293,30 +293,31 @@ def test_send_organisation_with_alt_text(
     organisation = project.organisation
     user1 = user_factory(get_newsletters=True)
     user2 = user_factory(get_newsletters=True)
-    user_factory()
+
     email_address_factory(user=user1, email=user1.email, primary=True, verified=True)
     email_address_factory(user=user2, email=user2.email, primary=True, verified=True)
+
     follow_models.Follow.objects.all().delete()
     follow_factory(creator=user1, project=project)
     follow_factory(creator=user2, project=project, enabled=False)
+    assert newsletter_models.Newsletter.objects.count() == 0
 
     data = {
         "sender_name": "Tester",
         "sender": "[email protected]",
         "subject": "Testsubject",
         "body": 'Testbody <img alt="description">',
-        "receivers": newsletter_models.ORGANISATION,
+        "receivers": newsletter_models.PROJECT,
         "organisation": organisation.pk,
-        "project": "",
+        "project": project.pk,
         "send": "Send",
     }
 
     url = reverse(
         "a4dashboard:newsletter-create", kwargs={"organisation_slug": organisation.slug}
     )
     client.login(username=admin.email, password="password")
-    response = client.post(url, data)
-    assert redirect_target(response) == "newsletter-create"
+    client.post(url, data)
     assert newsletter_models.Newsletter.objects.count() == 1
     assert len(mail.outbox) == 1
     assert mail.outbox[0].to == [user1.email]