Merge branch 'release/1.5.8'

saxix · saxix · commit 37434e40a7b0 · 2024-05-04T07:58:42.000+02:00
* release/1.5.8:
  bump version
  updates tox/ci
  updates tox/ci
  fixes permission check
  add common css class
  Update button documentation example to call `get_object` correctly
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.5.7
+current_version = 1.5.8
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
 serialize = {major}.{minor}.{patch}
 commit = False
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -28,8 +28,8 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                python-version: [ "3.9", "3.10", "3.11"]
-                django-version: [ "3.2", "4.2"]
+                python-version: [ "3.11", "3.12"]
+                django-version: [ "3.2", "4.2", "5.0"]
         env:
             PY_VER: ${{ matrix.python-version}}
             DJ_VER: ${{ matrix.django-version}}
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@ pytest.xml
 *.sqlite
 dist/*
 docs/site
+stubs/
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,9 @@
+1.5.8
+-----
+* add common css class
+* fixes permissions check
+
+
 1.5.7
 -----
 * BUG FIX: fixes check() implementation
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,11 +1,14 @@
-include README.rst
+include README.md
 include CHANGES
 include LICENSE
 include MANIFEST.in
 include tox.ini
 include setup.py
 include setup.cfg
 
+global-include *.pyi
+global-include *.typed
+
 include tests/.coveragerc
 recursive-include src/requirements *.pip
 recursive-include docs *
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-django-admin-extra-buttons
+ django-admin-extra-buttons
 ==========================
 
 
@@ -48,26 +48,28 @@ from django.contrib import admin
 from django.views.decorators.clickjacking import xframe_options_sameorigin
 from django.views.decorators.csrf import csrf_exempt
 
+
 class MyModelModelAdmin(ExtraButtonsMixin, admin.ModelAdmin):
 
     @button(permission='demo.add_demomodel1',
+            visible=lambda self: self.context["request"].user.is_superuser,
             change_form=True,
             html_attrs={'style': 'background-color:#88FF88;color:black'})
     def refresh(self, request):
         self.message_user(request, 'refresh called')
         # Optional: returns HttpResponse
         return HttpResponseRedirectToReferrer(request)
-    
+
     @button(html_attrs={'style': 'background-color:#DC6C6C;color:black'})
     def confirm(self, request):
         def _action(request):
             pass
 
         return confirm_action(self, request, _action, "Confirm action",
-                          "Successfully executed", )
+                              "Successfully executed", )
 
-    @link(href=None, 
-          change_list=False, 
+    @link(href=None,
+          change_list=False,
           html_attrs={'target': '_new', 'style': 'background-color:var(--button-bg)'})
     def search_on_google(self, button):
         original = button.context['original']
@@ -87,7 +89,7 @@ class MyModelModelAdmin(ExtraButtonsMixin, admin.ModelAdmin):
         if request.method == "POST":
             return HttpResponse("POST")
         return HttpResponse("GET")
-            
+
 
 ```
 
diff --git a/docs/api/button.md b/docs/api/button.md
@@ -106,7 +106,7 @@ Buttons with custom permission, one for `change_list` and other for `change_form
 
         @button(permission='app.delete_mymodel)
         def mark(self, request, pk):
-            obj = self.get_object(request.pk)
+            obj = self.get_object(request, pk)
             obj.mark = True
             obj.save()
 
diff --git a/setup.cfg b/setup.cfg
@@ -25,7 +25,7 @@ balanced_wrapping = true
 sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
 
 [metadata]
-license-file = LICENSE
+license_file = LICENSE
 
 [wheel]
 universal = 1
diff --git a/setup.py b/setup.py
@@ -44,6 +44,7 @@ def read(*parts):
                'django',
                'pip-tools',
                'flake8',
+               'mypy',
                'pep8',
                'readme',
                'sphinx',
diff --git a/src/admin_extra_buttons/__init__.py b/src/admin_extra_buttons/__init__.py
@@ -1,3 +1,3 @@
 NAME = 'django-admin-extra-buttons'
-VERSION = __version__ = '1.5.7'
+VERSION = __version__ = '1.5.8'
 __author__ = 'sax'
diff --git a/src/admin_extra_buttons/buttons.py b/src/admin_extra_buttons/buttons.py
@@ -50,7 +50,7 @@ def html_attrs(self):
             attrs['id'] = f'btn-{self.handler.func.__name__}'
 
         css_class = attrs.get("class", "")
-
+        css_class += " aeb-button"
         if self.disable_on_click and "aeb-disable-on-click" not in css_class:
             css_class += " aeb-disable-on-click"
         if self.disable_on_edit and "aeb-disable_on_edit" not in css_class:
diff --git a/src/admin_extra_buttons/mixins.py b/src/admin_extra_buttons/mixins.py
@@ -97,6 +97,8 @@ def get_common_context(self, request, pk=None, **kwargs):
         opts = self.model._meta
         app_label = opts.app_label
         self.object = None
+        if pk:
+            self.object = self.get_object(request, pk)
 
         context = {
             **self.admin_site.each_context(request),
@@ -105,20 +107,19 @@ def get_common_context(self, request, pk=None, **kwargs):
             'add': False,
             'change': True,
             'save_as': False,
+            "original": self.object,
             'extra_buttons': self.extra_button_handlers,
-            'has_delete_permission': self.has_delete_permission(request, pk),
             'has_editable_inline_admin_formsets': False,
-            'has_view_permission': self.has_view_permission(request, pk),
-            'has_change_permission': self.has_change_permission(request, pk),
+            'has_delete_permission': self.has_delete_permission(request, self.object),
+            'has_view_permission': self.has_view_permission(request, self.object),
+            'has_change_permission': self.has_change_permission(request, self.object),
             'has_add_permission': self.has_add_permission(request),
             'app_label': app_label,
             'adminform': DummyAdminform(model_admin=self),
         }
         context.setdefault('title', '')
         context.update(**kwargs)
-        if pk:
-            self.object = self.get_object(request, pk)
-            context['original'] = self.object
+
         return context
 
     def get_extra_urls(self) -> list:
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = d{32,42}-py{39,310,311}
+envlist = d{32,42,50}-py{311,312}
 
 [pytest]
 pythonpath=./tests/demoapp/
@@ -30,6 +30,7 @@ extras = test
 deps=
     d32: django==3.2.*
     d42: django==4.0.*
+    d50: django==5.0.*
     dev: git+git://github.com/django/django.git#egg=django
 
 commands =
