mixin registry

This commit is contained in:
Matthias 2021-09-19 17:32:44 +02:00
parent 369f92abf1
commit 6f8909c710
No known key found for this signature in database
GPG Key ID: F50EF5741D33E076
2 changed files with 40 additions and 3 deletions

View File

@ -18,14 +18,37 @@ class MixinBase:
if not hasattr(self, '_mixins'): if not hasattr(self, '_mixins'):
self._mixins = {} self._mixins = {}
self._mixins[key] = fnc_enabled self._mixins[key] = fnc_enabled
self.setup_mixin(key, cls=cls)
def setup_mixin(self, key, cls=None):
if not hasattr(self, '_mixinreg'):
self._mixinreg = {}
# get human name
human_name = getattr(cls.Meta, 'MIXIN_NAME', key) if cls and hasattr(cls, 'Meta') else key
# register
self._mixinreg[key] = {
'key': key,
'human_name': human_name,
}
@property
def registered_mixins(self):
mxins = getattr(self, '_mixinreg', None)
if mxins:
mxins = [a for a in mxins.values()]
return mxins
# region mixins # region mixins
class SettingsMixin: class SettingsMixin:
"""Mixin that enables settings for the plugin""" """Mixin that enables settings for the plugin"""
class Meta:
MIXIN_NAME = 'Settings'
def __init__(self): def __init__(self):
super().__init__() super().__init__()
self.add_mixin('settings', 'has_settings') self.add_mixin('settings', 'has_settings', __class__)
self.settings = self.setup_settings() self.settings = self.setup_settings()
def setup_settings(self): def setup_settings(self):
@ -50,9 +73,12 @@ class SettingsMixin:
class UrlsMixin: class UrlsMixin:
"""Mixin that enables urls for the plugin""" """Mixin that enables urls for the plugin"""
class Meta:
MIXIN_NAME = 'URLs'
def __init__(self): def __init__(self):
super().__init__() super().__init__()
self.add_mixin('urls', 'has_urls') self.add_mixin('urls', 'has_urls', __class__)
self.urls = self.setup_urls() self.urls = self.setup_urls()
def setup_urls(self): def setup_urls(self):
@ -84,9 +110,12 @@ class UrlsMixin:
class NavigationMixin: class NavigationMixin:
"""Mixin that enables adding navigation links with the plugin""" """Mixin that enables adding navigation links with the plugin"""
class Meta:
MIXIN_NAME = 'Navigation Links'
def __init__(self): def __init__(self):
super().__init__() super().__init__()
self.add_mixin('navigation', 'has_naviation') self.add_mixin('navigation', 'has_naviation', __class__)
self.navigation = self.setup_navigation() self.navigation = self.setup_navigation()
def setup_navigation(self): def setup_navigation(self):

View File

@ -36,6 +36,14 @@
{% if settings %} {% if settings %}
<span class='badge'><a class='nav-toggle text-success' id='select-plugin-{{plugin_key}}'>{% trans 'Has settings' %}</a></span> <span class='badge'><a class='nav-toggle text-success' id='select-plugin-{{plugin_key}}'>{% trans 'Has settings' %}</a></span>
{% endif %} {% endif %}
{% define plugin.registered_mixins as mixin_list %}
{% if mixin_list %}
{% for mixin in mixin_list %}
<span class='badge'><a class='nav-toggle text-success' id='select-plugin-{{plugin_key}}'>
{% blocktrans with name=mixin.human_name%}has {{name}}{% endblocktrans %}</a></span>
{% endfor %}
{% endif %}
</td> </td>
<td># TODO</td> <td># TODO</td>
</tr> </tr>