Refactor common module, add custom components

Author: fsbraun

djangocms_frontend/cms_plugins.py

@@ -1,10 +1,19 @@
 from cms.plugin_base import CMSPluginBase
 from django.utils.encoding import force_str
 
+from djangocms_frontend.helpers import get_related_object
+
 
 class CMSUIPlugin(CMSPluginBase):
     render_template = "djangocms_frontend/html_container.html"
     change_form_template = "djangocms_frontend/admin/base.html"
 
     def __str__(self):
         return force_str(super().__str__())
+
+    def render(self, context, instance, placeholder):
+        for key, value in instance.config.items():
+            if isinstance(value, dict) and set(value.keys()) == {"pk", "model"}:
+                if not hasattr(instance, key + "_related"):
+                    setattr(instance, key + "_related", get_related_object(instance.config, key))
+        return super().render(context, instance, placeholder)

djangocms_frontend/common/__init__.py

@@ -0,0 +1,40 @@
+from importlib import import_module
+
+from djangocms_frontend import settings
+
+from .title import TitleFormMixin, TitleMixin
+
+__common = {
+    "attributes": ("AttributesMixin",),
+    "background": ("BackgroundFormMixin", "BackgroundMixin"),
+    "responsive": ("ResponsiveFormMixin", "ResponsiveMixin"),
+    "sizing": ("SizingFormMixin", "SizingMixin"),
+    "spacing": ("SpacingFormMixin", "SpacingMixin", "MarginFormMixin", "MarginMixin", "PaddingFormMixin", "PaddingMixin"),
+}
+
+for module, classes in __common.items():
+    try:
+        module = import_module(f"{__name__}.{settings.framework}.{module}", module)
+        for cls in classes:
+            globals()[cls] = getattr(module, cls)
+    except ModuleNotFoundError:
+        for cls in classes:
+            globals()[cls] = type(cls, (object,), {})
+
+__all__ = [
+    "TitleMixin",
+    "TitleFormMixin",
+    "AttributesMixin",
+    "BackgroundFormMixin",
+    "BackgroundMixin",
+    "ResponsiveFormMixin",
+    "ResponsiveMixin",
+    "SizingFormMixin",
+    "SizingMixin",
+    "SpacingFormMixin",
+    "SpacingMixin",
+    "MarginFormMixin",
+    "MarginMixin",
+    "PaddingFormMixin",
+    "PaddingMixin",
+]

djangocms_frontend/common/background.py

@@ -3,7 +3,7 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
+from ...common import AttributesMixin
 from ...helpers import add_plugin
 from .. import accordion
 from . import forms, models

djangocms_frontend/common/attributes.py renamed to djangocms_frontend/common/bootstrap5/attributes.py

@@ -3,9 +3,7 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
-from ...common.responsive import ResponsiveMixin
-from ...common.spacing import SpacingMixin
+from ...common import AttributesMixin, ResponsiveMixin, SpacingMixin
 from .. import alert
 from . import forms, models
 

djangocms_frontend/common/spacing.py renamed to djangocms_frontend/common/bootstrap5/spacing.py

@@ -3,8 +3,7 @@
 from entangled.forms import EntangledModelForm
 
 from djangocms_frontend import settings
-from djangocms_frontend.common.responsive import ResponsiveFormMixin
-from djangocms_frontend.common.spacing import SpacingFormMixin
+from djangocms_frontend.common import ResponsiveFormMixin, SpacingFormMixin
 from djangocms_frontend.contrib import alert
 from djangocms_frontend.fields import (
     AttributesFormField,

djangocms_frontend/common/responsive.py

@@ -3,7 +3,7 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
+from ...common import AttributesMixin
 from .. import badge
 from . import forms, models
 

djangocms_frontend/common/sizing.py

@@ -3,10 +3,13 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
-from ...common.background import BackgroundMixin
-from ...common.responsive import ResponsiveMixin
-from ...common.spacing import MarginMixin, PaddingMixin
+from ...common import (
+    AttributesMixin,
+    BackgroundMixin,
+    MarginMixin,
+    PaddingMixin,
+    ResponsiveMixin,
+)
 from ...helpers import add_plugin
 from .. import card
 from . import forms, models

djangocms_frontend/contrib/accordion/cms_plugins.py

@@ -7,9 +7,12 @@
 from djangocms_frontend.settings import COLOR_STYLE_CHOICES, DEVICE_SIZES
 
 from ... import settings
-from ...common.background import BackgroundFormMixin
-from ...common.responsive import ResponsiveFormMixin
-from ...common.spacing import MarginFormMixin, PaddingFormMixin
+from ...common import (
+    BackgroundFormMixin,
+    MarginFormMixin,
+    PaddingFormMixin,
+    ResponsiveFormMixin,
+)
 from ...fields import (
     AttributesFormField,
     ButtonGroup,

djangocms_frontend/contrib/alert/cms_plugins.py

@@ -5,8 +5,7 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
-from ...common.background import BackgroundMixin
+from ...common import AttributesMixin, BackgroundMixin
 from .. import carousel
 from ..link.cms_plugins import LinkPluginMixin
 from . import forms, models

djangocms_frontend/contrib/alert/forms.py

@@ -13,7 +13,7 @@
 )
 
 from ... import settings
-from ...common.background import BackgroundFormMixin
+from ...common import BackgroundFormMixin
 from ...fields import HTMLFormField
 from ...helpers import first_choice
 from ...models import FrontendUIItem

djangocms_frontend/contrib/badge/cms_plugins.py

@@ -3,7 +3,7 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
+from ...common import AttributesMixin
 from .. import collapse
 from . import forms, models
 

djangocms_frontend/contrib/card/cms_plugins.py

@@ -0,0 +1,7 @@
+from cms.plugin_pool import plugin_pool
+
+from .models import components
+
+for _, plugin in components._registry.values():
+    globals()[plugin.__name__] = plugin
+    plugin_pool.register_plugin(plugin)

djangocms_frontend/contrib/card/forms.py

@@ -0,0 +1,123 @@
+import importlib
+
+from django import forms
+from django.utils.module_loading import autodiscover_modules
+from django.utils.translation import gettext_lazy as _
+from entangled.forms import EntangledModelForm
+
+from djangocms_frontend.cms_plugins import CMSUIPlugin
+from djangocms_frontend.models import FrontendUIItem
+
+
+def _get_mixin_classes(mixins: list, suffix: str = "") -> list[type]:
+    """Find and import mixin classes from a list of mixin strings"""
+    mixins = [
+        (mixin.rsplit(".")[0], f"{mixin.rsplit['.'][-1]}{suffix}Mixin")
+        if "." in mixin
+        else ("djangocms_frontend.common", f"{mixin}{suffix}Mixin")
+        for mixin in mixins
+    ]
+    return [importlib.import_module(module).__dict__[name] for module, name in mixins]
+
+
+class CMSFrontendComponent(forms.Form):
+    """Base class for frontend components:"""
+    @classmethod
+    def admin_form_factory(cls, **kwargs) -> type:
+        mixins = getattr(cls._component_meta, "mixins", [])
+        mixins = _get_mixin_classes(mixins, "Form")
+        return type(
+            f"{cls.__name__}Form",
+            (
+                *mixins,
+                EntangledModelForm,
+                cls,
+            ),
+            {
+                **kwargs,
+                "Meta": type(
+                    "Meta",
+                    (),
+                    {
+                        "model": FrontendUIItem,
+                        "entangled_fields": {
+                            "config": list(cls.declared_fields.keys()),
+                        },
+                    },
+                ),
+            },
+        )
+
+    @classmethod
+    def plugin_model_factory(cls) -> type:
+        model_class = type(
+            cls.__name__,
+            (FrontendUIItem,),
+            {
+                "Meta": type(
+                    "Meta",
+                    (),
+                    {
+                        "proxy": True,
+                        "managed": False,
+                        "verbose_name": getattr(cls._component_meta, "name", cls.__name__),
+                    },
+                ),
+                "get_short_description": cls.get_short_description,
+                "__module__": "djangocms_frontend.contrib.component.models",
+            },
+        )
+        return model_class
+
+    @classmethod
+    def plugin_factory(cls) -> type:
+        mixins = getattr(cls._component_meta, "mixins", [])
+        mixins = _get_mixin_classes(mixins)
+
+        return type(
+            cls.__name__ + "Plugin",
+            (
+                *mixins,
+                CMSUIPlugin,
+            ),
+            {
+                "name": getattr(cls._component_meta, "name", cls.__name__),
+                "module": getattr(cls._component_meta, "module", _("Component")),
+                "model": cls.plugin_model_factory(),
+                "form": cls.admin_form_factory(),
+                "allow_children": getattr(cls._component_meta, "allow_children", False),
+                "child_classes": getattr(cls._component_meta, "child_classes", []),
+                "render_template": getattr(cls._component_meta, "render_template", CMSUIPlugin.render_template),
+                "fieldsets": getattr(cls, "fieldsets", cls._generate_fieldset()),
+                "change_form_template": "djangocms_frontend/admin/base.html",
+            },
+        )
+
+    @classmethod
+    @property
+    def _component_meta(cls) -> type | None:
+        if hasattr(cls, "Meta"):
+            return cls.Meta
+        return None
+
+    @classmethod
+    def _generate_fieldset(cls):
+        return [(None, {"fields": cls.declared_fields.keys()})]
+
+    def get_short_description(self) -> str:
+        return ""
+
+
+class Components:
+    _registry: dict = {}
+    _discovered: bool = False
+
+    def register(self, component):
+        self._registry[component.__name__] = (component.plugin_model_factory(), component.plugin_factory())
+        return component
+
+
+components = Components()
+if not components._discovered:
+    autodiscover_modules("cms_components", register_to=components)
+    components._discovered = True

djangocms_frontend/contrib/carousel/cms_plugins.py

@@ -0,0 +1,7 @@
+from djangocms_frontend.contrib.component.components import components
+
+# Register all component models for Django
+# Component models are unmanaged and do not create migrations
+
+for model, _ in components._registry.values():
+    globals()[model.__name__] = model

djangocms_frontend/contrib/carousel/forms.py

@@ -3,10 +3,7 @@
 
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
-from ...common.attributes import AttributesMixin
-from ...common.background import BackgroundMixin
-from ...common.responsive import ResponsiveMixin
-from ...common.spacing import SpacingMixin
+from ...common import AttributesMixin, BackgroundMixin, ResponsiveMixin, SpacingMixin
 from .. import content
 from . import forms, models
 

djangocms_frontend/contrib/collapse/cms_plugins.py

@@ -6,9 +6,7 @@
 from djangocms_frontend.settings import ALIGN_CHOICES
 
 from ... import settings
-from ...common.background import BackgroundFormMixin
-from ...common.responsive import ResponsiveFormMixin
-from ...common.spacing import SpacingFormMixin
+from ...common import BackgroundFormMixin, ResponsiveFormMixin, SpacingFormMixin
 from ...fields import AttributesFormField, HTMLFormField, IconGroup, TagTypeFormField
 from ...helpers import first_choice
 from ...models import FrontendUIItem

djangocms_frontend/contrib/component/cms_plugins.py

@@ -2,14 +2,16 @@
 from django.utils.translation import gettext_lazy as _
 
 from djangocms_frontend import settings
-from djangocms_frontend.common.attributes import AttributesMixin
-from djangocms_frontend.common.background import BackgroundMixin
-from djangocms_frontend.common.responsive import ResponsiveMixin
-from djangocms_frontend.common.sizing import SizingMixin
-from djangocms_frontend.common.spacing import SpacingMixin
+from djangocms_frontend.common import (
+    AttributesMixin,
+    BackgroundMixin,
+    ResponsiveMixin,
+    SizingMixin,
+    SpacingMixin,
+)
 
 from ...cms_plugins import CMSUIPlugin
-from ...common.title import TitleMixin
+from ...common import TitleMixin
 from ...helpers import add_plugin
 from .. import grid
 from . import forms, models