[Add] Add JSONField and JsonFormWidget for handling JSON data in comments

- Introduced JSONField to store JSON metadata in the Comment model.
- Added JsonFormWidget for rendering a JSON editor in forms.
- Created a migration to add the new metadata field to the Comment model.
- Included a template for the JSON editor widget.

+
+from django import forms
+from django.core.serializers.json import DjangoJSONEncoder
+from django.db import models
+from django.db.backends.base.base import BaseDatabaseWrapper
+
+from simplejson import JSONDecodeError
+from typing import Any, Dict, Optional, Union
+import simplejson
+
+
+__all__ = ['JSONField', 'JsonFormWidget']
+
+
+class JsonFormWidget(forms.Textarea):
+    template_name = 'comments/json_field_widget.html'
+
+    def get_context(self, name: str, value: Any, attrs: Optional[Dict]) -> Dict[str, Any]:
+        ctx = super().get_context(name, value, attrs)
+        ctx['widget']['json_value'] = simplejson.dumps(value)
+        return ctx
+
+    class Media:
+        js = [
+            'https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/8.6.3/jsoneditor.js',
+            'base_model_s/widgets/json_editor{min}.js',
+        ]
+        css = {
+            'all': [
+                'https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/8.6.3/jsoneditor.min.css',
+            ]
+        }
+
+
+class JSONField(models.TextField):
+
+    def formfield(self, **kwargs: Any) -> forms.Field:
+        kwargs.setdefault('widget', JsonFormWidget)
+        return super().formfield(**kwargs)
+
+    @staticmethod
+    def _get_json_value(value: str) -> Optional[Union[dict, list]]:
+
+        if not value:
+            return None
+
+        if isinstance(value, list):
+            return value
+
+        try:
+            return simplejson.loads(value)
+        except JSONDecodeError:
+            return {'data': str(value)}
+
+    def from_db_value(self, value: Any, expression, connection: BaseDatabaseWrapper) -> Any:
+        return self._get_json_value(value)
+
+    def pre_save(self, model_instance: models.Model, add: bool) -> str:
+        """ Convert Python to Json format before save in database """
+
+        value = super().pre_save(model_instance, add)
+        if isinstance(value, str):
+            return value
+
+        return simplejson.dumps(value, cls=DjangoJSONEncoder)
+
+    def clean(self, value, model_instance):
+        """
+            Convert the value's type and run validation. Validation errors
+            from _get_json_value() and validate() are propagated. Return the correct
+            value if no error is raised.
+        """
+        value = self._get_json_value(value)
+
+        self.validate(value, model_instance)
+        self.run_validators(value)
+
+        return value

+from django.db import migrations
+import django_comments.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_comments', '0006_auto_20200830_1322'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='comment',
+            name='metadata',
+            field=django_comments.fields.JSONField(
+                blank=True,
+                null=True,
+                verbose_name='Metadata',
+            ),
+        ),
+    ]

@@ -5,6 +5,7 @@ from django.utils import timezone
 from django.utils.html import format_html
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
 from django.utils.translation import gettext_lazy as _
 
 
+from .fields import JSONField
 from .abstracts import (
 from .abstracts import (
     COMMENT_MAX_LENGTH, BaseCommentAbstractModel, CommentAbstractModel,
     COMMENT_MAX_LENGTH, BaseCommentAbstractModel, CommentAbstractModel,
 )
 )
@@ -20,6 +21,12 @@ class Comment(CommentAbstractModel):
         max_length=150,
         max_length=150,
     )
     )
 
 
+    metadata = JSONField(
+        verbose_name=_('Metadata'),
+        null=True,
+        blank=True,
+    )
+
     class Meta(CommentAbstractModel.Meta):
     class Meta(CommentAbstractModel.Meta):
         db_table = "django_comments"
         db_table = "django_comments"
 
 

+<textarea name="{{ widget.name }}"{% include "django/forms/widgets/attrs.html" %} style="display: none">
+    {% if widget.value %}{{ widget.value }}{% endif %}</textarea>
+    <div class="json-editor" style="height: 700px"
+         id="json-editor_{{ widget.attrs.id }}"
+         data-value="{{ widget.json_value|default:''|force_escape }}"
+         data-id="{{ widget.attrs.id }}"
+    ></div>