[feature] Made Device verbose_name configurable #287 (#302)

Closes #287

Co-authored-by: Sankalp <[email protected]>
Co-authored-by: Federico Capoano <[email protected]>

Author: nemesifier

README.rst

@@ -563,6 +563,24 @@ their hardware ID instead of their name.
 
 If you still want to reference devices by their name, set this to ``False``.
 
+``OPENWISP_CONTROLLER_DEVICE_VERBOSE_NAME``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
++--------------+----------------------------+
+| **type**:    | ``tuple``                  |
++--------------+----------------------------+
+| **default**: | ``('Device', 'Devices')``  |
++--------------+----------------------------+
+
+Defines the ``verbose_name`` attribute of the ``Device`` model, which is displayed in the
+admin site. The first and second element of the tuple represent the singular and plural forms.
+
+For example, if we want to change the verbose name to "Hotspot", we could write:
+
+.. code-block:: python
+
+    OPENWISP_CONTROLLER_DEVICE_VERBOSE_NAME = ('Hotspot', 'Hotspots')
+
 Default Alerts / Notifications
 ------------------------------
 

openwisp_controller/config/base/device.py

@@ -83,6 +83,8 @@ class Meta:
             ('hardware_id', 'organization'),
         )
         abstract = True
+        verbose_name = app_settings.DEVICE_VERBOSE_NAME[0]
+        verbose_name_plural = app_settings.DEVICE_VERBOSE_NAME[1]
 
     def __str__(self):
         return (

openwisp_controller/config/migrations/0004_add_device_model.py

@@ -12,6 +12,8 @@
 import openwisp_utils.base
 import openwisp_utils.utils
 
+from .. import settings as app_settings
+
 
 class Migration(migrations.Migration):
 
@@ -114,7 +116,11 @@ class Migration(migrations.Migration):
                     ),
                 ),
             ],
-            options={'abstract': False},
+            options={
+                'abstract': False,
+                'verbose_name': app_settings.DEVICE_VERBOSE_NAME[0],
+                'verbose_name_plural': app_settings.DEVICE_VERBOSE_NAME[1],
+            },
         ),
         migrations.AddField(
             model_name='config',

openwisp_controller/config/settings.py

@@ -52,3 +52,6 @@ def get_settings_value(option, default):
 }
 HARDWARE_ID_OPTIONS.update(get_settings_value('HARDWARE_ID_OPTIONS', {}))
 HARDWARE_ID_AS_NAME = get_settings_value('HARDWARE_ID_AS_NAME', True)
+DEVICE_VERBOSE_NAME = get_settings_value(
+    'DEVICE_VERBOSE_NAME', (_('Device'), _('Devices'))
+)

tests/openwisp2/sample_config/migrations/0001_initial.py

@@ -1,5 +1,4 @@
 # Generated by Django 3.0.7 on 2020-06-27 11:16
-
 import collections
 import re
 import uuid
@@ -17,6 +16,7 @@
 import openwisp_users.mixins
 import openwisp_utils.base
 import openwisp_utils.utils
+from openwisp_controller.config import settings as app_settings
 
 
 class Migration(migrations.Migration):
@@ -736,6 +736,8 @@ class Migration(migrations.Migration):
                     ('hardware_id', 'organization'),
                     ('name', 'organization'),
                 },
+                'verbose_name': app_settings.DEVICE_VERBOSE_NAME[0],
+                'verbose_name_plural': app_settings.DEVICE_VERBOSE_NAME[1],
             },
             bases=(openwisp_users.mixins.ValidateOrgMixin, models.Model),
         ),