Merge pull request #789 from maykinmedia/feature/1656-categories-wysiwyg

[#1656] Added CKEditor widget to category description field

src/open_inwoner/pdc/admin/category.py

@@ -9,6 +9,7 @@
 from treebeard.admin import TreeAdmin
 from treebeard.forms import movenodeform_factory
 
+from open_inwoner.ckeditor5.widgets import CKEditorWidget
 from open_inwoner.utils.logentry import system_action
 
 from ..models import Category, CategoryProduct
@@ -31,6 +32,7 @@ class CategoryAdminForm(movenodeform_factory(Category)):
     class Meta:
         model = Category
         fields = "__all__"
+        widgets = {"description": CKEditorWidget}
 
     def clean(self, *args, **kwargs):
         cleaned_data = super().clean(*args, **kwargs)

src/open_inwoner/pdc/models/category.py

@@ -6,6 +6,7 @@
 from treebeard.exceptions import InvalidMoveToDescendant
 from treebeard.mp_tree import MP_MoveHandler, MP_Node
 
+from ...utils.ckeditor import get_rendered_content
 from ..managers import CategoryPublishedQueryset
 
 

src/open_inwoner/pdc/tests/test_views.py

@@ -8,15 +8,15 @@
 
 
 @override_settings(ROOT_URLCONF="open_inwoner.cms.tests.urls")
-class TestCategoryListView(TestCase):
+class CategoryListViewTest(TestCase):
     @classmethod
     def setUpTestData(cls):
         cls.user = UserFactory()
         cls.user.set_password("12345")
         cls.user.email = "[email protected]"
         cls.user.save()
 
-    def test_access_restricted(self):
+    def test_category_list_view_access_restricted(self):
         config = SiteConfiguration.get_solo()
         config.hide_categories_from_anonymous_users = True
         config.save()
@@ -36,7 +36,7 @@ def test_access_restricted(self):
 
         self.assertEqual(response.status_code, 200)
 
-    def test_access_not_restricted(self):
+    def test_category_list_view_access_not_restricted(self):
         config = SiteConfiguration.get_solo()
         config.hide_categories_from_anonymous_users = False
         config.save()
@@ -50,17 +50,20 @@ def test_access_not_restricted(self):
 
 
 @override_settings(ROOT_URLCONF="open_inwoner.cms.tests.urls")
-class TestCategoryDetailView(TestCase):
+class CategoryDetailViewTest(TestCase):
     @classmethod
     def setUpTestData(cls):
         cls.user = UserFactory()
         cls.user.set_password("12345")
         cls.user.email = "[email protected]"
         cls.user.save()
 
-        cls.category = CategoryFactory.create(name="test cat")
+        cls.category = CategoryFactory.create(
+            name="test cat",
+            description="A <em>descriptive</em> description",
+        )
 
-    def test_access_restricted(self):
+    def test_category_detail_view_access_restricted(self):
         config = SiteConfiguration.get_solo()
         config.hide_categories_from_anonymous_users = True
         config.save()
@@ -80,7 +83,7 @@ def test_access_restricted(self):
 
         self.assertEqual(response.status_code, 200)
 
-    def test_access_not_restricted(self):
+    def test_category_detail_view_access_not_restricted(self):
         config = SiteConfiguration.get_solo()
         config.hide_categories_from_anonymous_users = False
         config.save()
@@ -91,3 +94,17 @@ def test_access_not_restricted(self):
         response = self.client.get(url)
 
         self.assertEqual(response.status_code, 200)
+
+    def test_category_detail_description_rendered(self):
+        url = reverse("products:category_detail", kwargs={"slug": self.category.slug})
+
+        response = self.client.get(url)
+
+        self.assertIn(
+            '<p class="p">A <em>descriptive</em> description</p>',
+            response.rendered_content,
+        )
+        self.assertNotIn(
+            '[<p class="p">A <em>descriptive</em> description</p>, <em>descriptive</em>]',
+            response.rendered_content,
+        )

src/open_inwoner/pdc/views.py

@@ -12,6 +12,7 @@
 from open_inwoner.questionnaire.models import QuestionnaireStep
 from open_inwoner.utils.views import LoginMaybeRequiredMixin
 
+from ..utils.ckeditor import get_rendered_content
 from ..utils.views import CommonPageMixin
 from .choices import YesNo
 from .forms import ProductFinderForm
@@ -173,6 +174,9 @@ def get_context_data(self, **kwargs):
         context["questionnaire_roots"] = QuestionnaireStep.get_root_nodes().filter(
             category=self.object
         )
+        context["category_rendered_description"] = get_rendered_content(
+            self.object.description
+        )
         return context
 
     def get_breadcrumb_name(self):

src/open_inwoner/templates/pages/category/detail.html

@@ -17,7 +17,7 @@ <h1 class="h1">
                 {% button icon="edit" text=_("Open in admin") hide_text=True href="admin:pdc_category_change" object_id=object.pk %}
             {% endif %}
         </h1>
-        <p class="p">{{ object.description|linebreaksbr }}</p>
+            {{ category_rendered_description|safe }}
 
         {% if subcategories %}
             {% card_container subcategories=subcategories parent_category=object %}

src/open_inwoner/utils/ckeditor.py

@@ -21,7 +21,7 @@
 ]
 
 
-def get_rendered_content(content):
+def get_rendered_content(content: str) -> str:
     """
     Takes object's content as an input and returns the rendered one.
     """
@@ -37,7 +37,7 @@ def get_rendered_content(content):
             if element.name == "a" and element.attrs.get("href", "").startswith("http"):
                 element.attrs["target"] = "_blank"
 
-    return soup
+    return str(soup)
 
 
 def get_product_rendered_content(product):