refactor button/url - removes href

Author: saxix

Makefile

@@ -1,3 +1,9 @@
+help:
+	echo
+
+demo:
+	cd tests && ./manage.py migrate
+	cd tests && ./manage.py runserver
 
 develop:
 	python3 -m venv .venv

src/admin_extra_urls/__init__.py

@@ -1,3 +1,3 @@
-NAME = "django-admin-extra-urls"
-VERSION = __version__ = "3.5.1"
+NAME = 'django-admin-extra-urls'
+VERSION = __version__ = '3.5.1'
 __author__ = 'sax'

src/admin_extra_urls/api.py

@@ -1,3 +1,3 @@
-# from .config import ButtonAction  # noqa: F401
-from .decorators import action, button, href, try_catch  # noqa: F401
-from .mixins import ExtraUrlMixin  # noqa: F401
+from .button import UrlButton  # noqa: F401
+from .decorators import button, href, link, url  # noqa: F401
+from .mixins import ExtraUrlMixin, confirm_action  # noqa: F401

src/admin_extra_urls/button.py

@@ -0,0 +1,128 @@
+import logging
+from django.urls import NoReverseMatch, reverse
+
+from admin_extra_urls.utils import (check_permission,
+                                    get_preserved_filters, labelize,)
+
+logger = logging.getLogger(__name__)
+
+
+class UrlHandler:
+    def __init__(self):
+        pass
+
+
+class BaseExtraButton:
+    default_css_class = 'btn disable-on-click auto-disable'
+
+    def __init__(self, **options):
+        self.options = options
+        # self.options.setdefault('html_attrs', {})
+        # self.options.setdefault('display', lambda context: True)
+        self.options.setdefault('icon', None)
+        self.options.setdefault('change_list', False)
+        self.options.setdefault('change_form', False)
+        self.options.setdefault('url_name', None)
+        self.options.setdefault('permission', None)
+        self.options.setdefault('url', None)
+        # self.options.setdefault('label', self.options['url'])
+        # self.options.setdefault('name', None)
+        self.options.setdefault('visible', True)
+        # self.order = order
+        # if display := options.get('display', empty) != empty:
+        # self.display = (lambda context: True) if options.get('display') is None else options.get('display')
+        # self.change_form = change_form
+        # self.change_list = change_list
+        # self.url_name = url_name
+        # self._url = url
+        self.context = None
+        self.html_attrs = self.options.get('html_attrs', {})
+
+    def __repr__(self):
+        return f'<ExtraButton {self.options}>'
+
+    def __html__(self):
+        return f'[ExtraButton {self.options}]'
+
+    def __copy__(self):
+        return type(self)(**self.options)
+
+    def __getattr__(self, item):
+        if item in self.options:
+            return self.options.get(item)
+        raise ValueError(f'{item} is not a valid attribute for {self}')
+
+    def visible(self):
+        # if self.details and not self.original:
+        #     return False
+        if callable(self.options['visible']):
+            return self.options['visible'](self.context)
+        return self.options['visible']
+
+    def authorized(self):
+        if self.permission:
+            return check_permission(self.permission, self.request, self.original)
+        return True
+
+    @property
+    def request(self):
+        if not self.context:
+            raise ValueError(f"You need to call bind() to access 'request' on {self}")
+        return self.context['request']
+
+    @property
+    def original(self):
+        if not self.context:
+            raise ValueError(f"You need to call bind() to access 'original' on {self}")
+        return self.context.get('original', None)
+
+    def bind(self, context):
+        self.context = context
+        # this is only for backward compatibility
+        if self.name and 'id' not in self.html_attrs:
+            self.html_attrs['id'] = f'btn-{self.name}'
+        return self
+
+
+class UrlButton(BaseExtraButton):
+    def __init__(self, **options):
+        super().__init__(**options)
+
+    def label(self):
+        return self.options.get('label', labelize(self.options.get('name', '')))
+
+    @property
+    def url(self):
+        if self.options.get('url'):
+            return self.options.get('url')
+        try:
+            if self.original:
+                url = reverse(f'admin:{self.url_name}', args=[self.original.pk])
+            else:
+                url = reverse(f'admin:{self.url_name}')
+            filters = get_preserved_filters(self.request)
+            return f'{url}?{filters}'
+        except NoReverseMatch as e:
+            logger.exception(e)
+            return f'javascript:alert("{e}")'
+
+
+class Button(BaseExtraButton):
+    def __init__(self, **options):
+        super().__init__(**options)
+        self._params = {}
+
+    def label(self):
+        return self.options.get('label', str(self.url))
+
+    @property
+    def url(self):
+        if isinstance(self._params, dict):
+            return self.options.get('url').format(**self._params)
+        else:
+            return self._params
+
+    def bind(self, context):
+        self.context = context
+        if 'func' in self.options:
+            self._params = (self.func(self) or {})

src/admin_extra_urls/checks.py

@@ -1,97 +1,15 @@
-from django.contrib.admin.templatetags.admin_urls import admin_urlname
-from django.urls import reverse
 
-from admin_extra_urls.utils import get_preserved_filters, safe, Display
-
-empty = object()
-
-
-class Button:
-    def __init__(self, path, *, label=None, icon='', permission=None,
-                 css_class="btn btn-success disable-on-click", order=999, visible=empty,
-                 modeladmin=None, display=Display.NOT_SET, group=None,
-                 details=True, urls=None):
+class UrlConfig:
+    def __init__(self, *, func=None, path=None, button=None,
+                 details=False, permission=None, object_id_arg_name='object_id', **extra):
+        self.func = func
+        self.method = func.__name__
         self.path = path
-        self.label = label or path
-
-        self.icon = icon
-        self.display = display
-        self._perm = permission
-        self.order = order
-        self.css_class = css_class
-        self.group = group
-        self._visible = visible
-        self._bound = False
+        self.permission = permission
         self.details = details
-        self.urls = urls
-        self.modeladmin = modeladmin
+        self.button = button
+        self.object_id_arg_name = object_id_arg_name
+        self.extra = extra
 
     def __repr__(self):
-        return f"<{self.__class__.__name__} '{self.label}' object at  {id(self)}>"
-    def bind(self, context):
-        self.context = context
-        obj = context.get('original', None)
-        try:
-            request = context['request']
-        except KeyError:
-            raise KeyError("Cannot find 'request' in context. "
-                           "Be sure you have 'django.template.context_processors.request' in"
-                           "your templates context_processors")
-        user = request.user
-        groups = context.get('aeu_groups', ['None'])
-        self.querystring = get_preserved_filters(request)
-        if callable(self._visible):
-            self.visible = safe(self._visible, obj, request)
-        else:
-            self.visible = self._visible
-        if self.visible and str(self.group) not in groups:
-            self.visible = False
-
-        if self._perm is None:
-            self.authorized = True
-        elif callable(self._perm):
-            self.authorized = self._perm(request, obj)
-        else:
-            self.authorized = user.has_perm(self._perm)
-
-
-class ButtonHREF(Button):
-    def __init__(self, func, *, path=None, label=None, icon='', permission=None,
-                 css_class="btn btn-success", order=999, visible=empty, group=None,
-                 modeladmin=None, details=True, html_attrs=None, display=Display.NOT_SET):
-        self.func = func
-        self.html_attrs = html_attrs
-        self.callback_parameter = None
-        super().__init__(path=path, label=label, icon=icon, permission=permission,
-                         css_class=css_class, order=order, visible=visible, group=group,
-                         modeladmin=modeladmin, details=details, display=display)
-
-    def __repr__(self):
-        return f"<ButtonHREF {self.label} {self.func.__name__}>"
-
-    def bind(self, context):
-        super().bind(context)
-        self.callback_parameter = self.func(self)
-
-    def url(self):
-        if isinstance(self.callback_parameter, dict):
-            return self.path.format(**self.callback_parameter)
-        else:
-            return self.callback_parameter
-
-
-class ButtonAction(Button):
-    def __init__(self, func, **kwargs):
-        self.func = func
-        super().__init__(**kwargs)
-        self.path = self.path or func.__name__
-        self.method = func.__name__
-
-    def url(self):
-        opts = self.context['opts']
-        if self.details:
-            base_url = reverse(admin_urlname(opts, self.method),
-                               args=[self.context['original'].pk])
-        else:
-            base_url = reverse(admin_urlname(opts, self.method))
-        return "%s?%s" % (base_url, self.querystring)
+        return f'<UrlConfig func:"{self.func}" path:"{self.path}" button:"{self.button}">'