feat: update django-admin-confirmation

* TrangPham/django-admin-confirm#32 is now released so our own modifications can be removed.

Refs: LIIK-747

Author: jforsman

poetry.lock

@@ -40,7 +40,7 @@ social-auth-app-django = "^5.4.1"
 uWSGI = "^2.0.22"
 django-advanced-password-validation = "^1.2.0"
 django-axes = "^7.0.0"
-django-admin-confirm = "^1.0.0"
+django-admin-confirm = "^1.0.1"
 
 
 [tool.poetry.group.dev.dependencies]

pyproject.toml

@@ -1,5 +1,6 @@
 from copy import copy
 
+from admin_confirm import AdminConfirmMixin
 from django.contrib.gis import admin
 from django.http import HttpResponseForbidden, HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render
@@ -9,7 +10,6 @@
 from traffic_control.admin.audit_log import AuditLogHistoryAdmin
 from traffic_control.forms import PlanModelForm, PlanRelationsForm
 from traffic_control.mixins import (
-    CityInfraAdminConfirmMixin,
     EnumChoiceValueDisplayAdminMixin,
     Geometry3DFieldAdminMixin,
     SoftDeleteAdminMixin,
@@ -26,7 +26,7 @@ class PlanAdmin(
     SoftDeleteAdminMixin,
     UserStampedAdminMixin,
     Geometry3DFieldAdminMixin,
-    CityInfraAdminConfirmMixin,
+    AdminConfirmMixin,
     admin.GISModelAdmin,
     AuditLogHistoryAdmin,
 ):

traffic_control/admin/plan.py

@@ -1,10 +1,5 @@
-from typing import Dict
-
-from admin_confirm import AdminConfirmMixin
 from django.contrib.admin import SimpleListFilter
 from django.contrib.gis.forms import OSMWidget
-from django.db.models import FileField, ImageField, ManyToManyField, Model
-from django.forms import ModelForm
 from django.utils.translation import gettext_lazy as _
 
 from traffic_control.models.plan import Plan
@@ -145,82 +140,3 @@ def delete_queryset(self, request, queryset):
 class DeviceTypeSearchAdminMixin:
     def get_search_fields(self, request):
         return self.search_fields + ("device_type__code", "device_type__legacy_code")
-
-
-class CityInfraAdminConfirmMixin(AdminConfirmMixin):
-    """Class for tweaking admin confirmation behaviour.
-    Overwrite private _get_changed_data function to support fields only in admin form not in model itself.
-    """
-
-    only_form_fields = []
-
-    def _get_changed_data(self, form: ModelForm, model: Model, obj: object, add: bool) -> Dict:
-        """
-        Given a form, detect the changes on the form from the default values (if add) or
-        from the database values of the object (model instance)
-
-        form - Submitted form that is attempting to alter the obj
-        model - the model class of the obj
-        obj - instance of model which is being altered
-        add - are we attempting to add the obj or does it already exist in the database
-
-        Returns a dictionary of the fields and their changed values if any
-        """
-
-        changed_data = {}
-        if add:
-            self._handle_add(form, model, changed_data)
-        else:
-            self._handle_change(form, model, changed_data, obj)
-
-        return changed_data
-
-    def _filtered_form_cleaned_data_items(self, form):
-        return filter(lambda x: x[0] not in self.only_form_fields, form.cleaned_data.items())
-
-    @staticmethod
-    def _display_for_changed_data(field, initial_value, new_value):
-        if not (isinstance(field, FileField) or isinstance(field, ImageField)):
-            return [initial_value, new_value]
-
-        if initial_value:
-            if new_value is False:
-                # Clear has been selected
-                return [initial_value.name, None]
-            elif new_value:
-                return [initial_value.name, new_value.name]
-            else:
-                # No cover: Technically doesn't get called in current code because
-                # This function is only called if there was a difference in the data
-                return [initial_value.name, initial_value.name]  # pragma: no cover
-
-        if new_value:
-            return [None, new_value.name]
-
-        return [None, None]
-
-    def _handle_add(self, form, model, changed_data):
-        for name, new_value in self._filtered_form_cleaned_data_items(form):
-            # Don't consider default values as changed for adding
-            field_object = model._meta.get_field(name)
-            default_value = field_object.get_default()
-            if new_value is not None and new_value != default_value:
-                # Show what the default value is
-                changed_data[name] = self._display_for_changed_data(field_object, default_value, new_value)
-
-    def _handle_change(self, form, model, changed_data, obj):
-        for name, new_value in self._filtered_form_cleaned_data_items(form):
-            # Ignore fields that are only in admin for and not in the model itself
-            # Since the form considers initial as the value first shown in the form
-            # It could be incorrect when user hits save, and then hits "No, go back to edit"
-            obj.refresh_from_db()
-
-            field_object = model._meta.get_field(name)
-            initial_value = getattr(obj, name)
-
-            # Note: getattr does not work on ManyToManyFields
-            if isinstance(field_object, ManyToManyField):
-                initial_value = field_object.value_from_object(obj)
-
-            if initial_value != new_value:
-                changed_data[name] = self._display_for_changed_data(field_object, initial_value, new_value)

traffic_control/mixins/admin.py

@@ -1,22 +1,16 @@
-from unittest.mock import patch
-
 import pytest
 from auditlog.models import LogEntry
 from django.conf import settings
-from django.contrib.admin import site
 from django.contrib.auth import get_user_model
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.gis.geos import MultiPolygon
-from django.db.models import FileField
 from django.test import override_settings
 from django.urls import reverse
 
 from city_furniture.tests.factories import get_furniture_signpost_plan
-from traffic_control.admin.plan import PlanAdmin
 from traffic_control.forms import PlanModelForm
 from traffic_control.geometry_utils import get_z_for_polygon
-from traffic_control.mixins.admin import CityInfraAdminConfirmMixin
 from traffic_control.models import Plan
 from traffic_control.tests.factories import (
     AdditionalSignPlanFactory,
@@ -34,7 +28,6 @@
     illegal_multipolygon,
     invalid_ewkt_str,
     test_multi_polygon,
-    test_multi_polygon_2,
     test_point,
     test_point_2,
     test_polygon,
@@ -408,63 +401,5 @@ def test__plan_create_with_location_ewkt():
     assert plan.location.ewkt == test_multi_polygon.ewkt
 
 
-@pytest.mark.parametrize("derive_location", (False, True))
-@pytest.mark.django_db
-def test_plan_location_change_with_derive_location(admin_client, derive_location):
-    """Just test that confirmation dialog _handle_change is called when derive_location is on
-    and not when it is off.
-    NOTE: this test should be removed when/if support for non-model fields is supported in django-admin-confirm."""
-    plan = PlanFactory(location=test_multi_polygon)
-    post_data = {
-        "derive_location": derive_location,
-        "location": plan.location,
-        "location_ewkt": test_multi_polygon_2.ewkt,
-        "z_coord": 0,
-        "decision_id": plan.decision_id,
-        "name": plan.name,
-        "_save": "Save",
-    }
-    url = reverse("admin:traffic_control_plan_change", kwargs={"object_id": plan.pk})
-    pa = PlanAdmin(Plan, site)
-    if derive_location:
-        post_data["_confirm_change"] = "Confirm"
-        with patch(
-            "traffic_control.admin.plan.PlanAdmin._handle_change", side_effect=pa._handle_change
-        ) as mocked_function:
-            admin_client.post(url, data=post_data)
-            mocked_function.assert_called_once()
-    else:
-        with patch(
-            "traffic_control.admin.plan.PlanAdmin._handle_change", side_effect=pa._handle_change
-        ) as mocked_function:
-            admin_client.post(url, data=post_data)
-            mocked_function.assert_not_called()
-
-
-def test_cityinfra_admin_confirm_mixin_display_for_changed_data():
-    """NOTE: this test should be removed when django-admin-confirm mixin has support for cityinfra features.
-    This is here just to please sonaqube with new code coverage percentage.
-    """
-    field = FileField()
-
-    class DummyValue:
-        def __init__(self, name):
-            self.name = name
-
-    test_initial_name = "testinitial"
-    test_new_value = "testnewvalue"
-
-    ret = CityInfraAdminConfirmMixin._display_for_changed_data(field, DummyValue(test_initial_name), False)
-    assert ret == [test_initial_name, None]
-
-    ret = CityInfraAdminConfirmMixin._display_for_changed_data(
-        field, DummyValue(test_initial_name), DummyValue(test_new_value)
-    )
-    assert ret == [test_initial_name, test_new_value]
-
-    ret = CityInfraAdminConfirmMixin._display_for_changed_data(field, None, DummyValue(test_new_value))
-    assert ret == [None, test_new_value]
-
-
 def _get_plan_mandatory_fields():
     return {"name": "testplan", "decision_id": "testid", "z_coord": 0}