[change!] Removed deprecated UUIDAdmin class #328

The deprecated UUIDAdmin class has been removed.
For equivalent functionality, use `CopyableFieldsAdmin` with `copyable_fields = ('uuid',)`.

Closes #328

Author: Eeshu-Yadav

docs/developer/admin-utilities.rst

@@ -48,13 +48,28 @@ it easy to copy the fields contents.
 
 Useful for auto-generated fields such as UUIDs, secret keys, tokens, etc.
 
-``openwisp_utils.admin.UUIDAdmin``
-----------------------------------
+To replicate the "copy UUID" behavior previously provided by the removed
+``UUIDAdmin`` class, set ``copyable_fields = ("uuid",)`` on a
+``CopyableFieldsAdmin`` subclass and expose a ``uuid()`` display method,
+for example:
 
-This class is a subclass of ``CopyableFieldsAdmin`` which sets ``uuid`` as
-the only copyable field. This class is kept for backward compatibility and
-convenience, since different models of various OpenWISP modules show
-``uuid`` as the only copyable field.
+.. code-block:: python
+
+    from django.contrib import admin
+    from django.utils.translation import gettext_lazy as _
+    from openwisp_utils.admin import CopyableFieldsAdmin
+
+    from .models import MyModel
+
+
+    @admin.register(MyModel)
+    class MyModelAdmin(CopyableFieldsAdmin):
+        copyable_fields = ("uuid",)
+
+        def uuid(self, obj):
+            return obj.pk
+
+        uuid.short_description = _("UUID")
 
 ``openwisp_utils.admin.ReceiveUrlAdmin``
 ----------------------------------------

openwisp_utils/admin.py

@@ -134,22 +134,6 @@ class Media:
         js = ("admin/js/jquery.init.js", "openwisp-utils/js/copyable.js")
 
 
-class UUIDAdmin(CopyableFieldsAdmin):
-    """Sets `uuid` as copyable field.
-
-    Subclass of `CopyableFieldsAdmin`. This class is kept for backward
-    compatibility and convenience, since different models of various
-    OpenWISP modules show `uuid` as the only copyable field.
-    """
-
-    copyable_fields = ("uuid",)
-
-    def uuid(self, obj):
-        return obj.pk
-
-    uuid.short_description = _("UUID")
-
-
 class ReceiveUrlAdmin(ModelAdmin):
     """Adds a receive_url field.
 

tests/test_project/admin.py

@@ -4,11 +4,11 @@
 from django.utils.translation import gettext_lazy as _
 from openwisp_utils.admin import (
     AlwaysHasChangedMixin,
+    CopyableFieldsAdmin,
     HelpTextStackedInline,
     ReadOnlyAdmin,
     ReceiveUrlAdmin,
     TimeReadonlyAdminMixin,
-    UUIDAdmin,
 )
 from openwisp_utils.admin_theme.filters import (
     AutocompleteFilter,
@@ -80,12 +80,18 @@ class OperatorInline(HelpTextStackedInline):
 
 
 @admin.register(Project)
-class ProjectAdmin(UUIDAdmin, ReceiveUrlAdmin):
+class ProjectAdmin(CopyableFieldsAdmin, ReceiveUrlAdmin):
     inlines = [OperatorInline]
     list_display = ("name",)
     fields = ("uuid", "name", "key", "receive_url")
-    readonly_fields = ("uuid", "receive_url")
+    readonly_fields = ("receive_url",)
     receive_url_name = "receive_project"
+    copyable_fields = ("uuid",)
+
+    def uuid(self, obj):
+        return obj.pk
+
+    uuid.short_description = _("UUID")
 
 
 class ShelfFilter(SimpleInputFilter):