feat: simpler component configuration (#279)

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: fsbraun

djangocms_frontend/cms_plugins.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from cms.plugin_pool import plugin_pool
 
 from .ui_plugin_base import CMSUIPluginBase
@@ -21,6 +23,8 @@ def update_plugin_pool():
             # Loop through the slot plugins associated with the current plugin
             for slot_plugin in slot_plugins:
                 # Add the slot plugin to the global namespace
-                globals()[slot_plugin.__name__] = slot_plugin
-                # Register the slot plugin with the plugin pool
-                plugin_pool.register_plugin(slot_plugin)
+                # Register slot plugins, checking for name conflicts
+                for slot_plugin in slot_plugins:
+                    if slot_plugin.__name__ not in plugin_pool.plugins:
+                        globals()[slot_plugin.__name__] = slot_plugin
+                        plugin_pool.register_plugin(slot_plugin)

djangocms_frontend/component_base.py

@@ -174,7 +174,7 @@ def plugin_factory(cls) -> type:
                         if hasattr(cls, "get_render_template")
                         else {}
                     ),
-                    "__module__": cls.__module__,
+                    "__module__": "djangocms_frontend.cms_plugins",
                 },
             )
         return cls._plugin

djangocms_frontend/plugin_tag.py

@@ -25,11 +25,6 @@
     "ui_item",
 )
 
-allowed_plugin_types = tuple(
-    getattr(importlib.import_module(cls.rsplit(".", 1)[0]), cls.rsplit(".", 1)[-1]) if isinstance(cls, str) else cls
-    for cls in getattr(settings, "CMS_COMPONENT_PLUGINS", [])
-)
-
 
 def _get_plugindefaults(instance):
     defaults = {
@@ -65,7 +60,21 @@ def patch_template(template):
     return copied_template if patch else template
 
 
+def get_plugin_class(settings_string: str | type) -> type:
+    """Get the plugin class from the settings string or import it if it's a dotted path."""
+    if isinstance(settings_string, str):
+        if "." in settings_string:
+            # import the class if a dotted path is given - raise can exception if not found
+            module_name, class_name = settings_string.rsplit(".", 1)
+            return getattr(importlib.import_module(module_name), class_name)
+        # Get the plugin class from the plugin pool by its name
+        return plugin_pool.get_plugin(settings_string)
+    return settings_string
+
+
 def setup():
+    allowed_plugin_types = tuple(get_plugin_class(cls) for cls in getattr(settings, "CMS_COMPONENT_PLUGINS", []))
+
     for plugin in plugin_pool.get_all_plugins():
         if not issubclass(plugin, allowed_plugin_types):
             continue

docs/source/how-to/use-frontend-as-component.rst

@@ -22,8 +22,9 @@ repetition.
 
     To make plugins available as components, ensure that the
     ``CMS_COMPONENT_PLUGINS`` setting in your project's ``settings.py``
-    includes the necessary plugin classes and their subclasses. This setting
-    allows you to specify which plugins can be used directly in templates
+    is a list that includes the necessary plugin names or dotted path to
+    a plugin parent class. Only plugins named in the listing or their
+    child classes can be used directly in templates
     without creating database entries.
 
     * To include all ``djangocms-frontend`` plugins, use

tests/test_plugin_tag.py

@@ -119,3 +119,13 @@ def test_non_frontend_plugin(self):
         result = template.render({"request": None})
 
         self.assertInHTML(expected_result, result)
+
+    def test_autohero_component_registered_for_plugin_tag(self):
+        from cms.plugin_pool import plugin_pool
+        from djangocms_frontend.plugin_tag import plugin_tag_pool
+
+        # Check that the AutoHero plugin is registered
+        self.assertIn("AutoHeroPlugin", plugin_pool.plugins)
+
+        # Check for the AutoHero plugin registration in the plugin_tag_pool
+        self.assertIn("autohero", plugin_tag_pool)

tests/test_settings.py

@@ -129,5 +129,6 @@
 
 CMS_COMPONENT_PLUGINS = [
     "djangocms_frontend.cms_plugins.CMSUIPlugin",
-    "djangocms_text.cms_plugins.TextPlugin",
+    "djangocms_frontend.cms_plugins.AutoHeroPlugin",
+    "TextPlugin",
 ]