[models] Updated sortedm2m __str__ definition #29

Closes #29

django_netjsonconfig/base/config.py

@@ -113,6 +113,14 @@ def key(self):
 AbstractConfig._meta.get_field('config').blank = True
 
 
+class TemplatesThrough(object):
+    """
+    Improves string representation of m2m relationship objects
+    """
+    def __str__(self):
+        return _('Relationship with {0}').format(self.template.name)
+
+
 class TemplatesVpnMixin(models.Model):
     """
     Provides a mixin that adds two m2m relationships:
@@ -122,6 +130,7 @@ class TemplatesVpnMixin(models.Model):
     templates = SortedManyToManyField('django_netjsonconfig.Template',
                                       related_name='config_relations',
                                       verbose_name=_('templates'),
+                                      base_class=TemplatesThrough,
                                       blank=True,
                                       help_text=_('configuration templates, applied from '
                                                   'first to last'))
@@ -277,13 +286,7 @@ class Meta:
         abstract = True
 
 
-def sortedm2m__str__(self):
-    """
-    Improves string representation of m2m relationship objects
-
-    TODO
-    ----
-    this method can be removed if the following pull request
-    gets merged: https://github.com/gregmuellegger/django-sortedm2m/pull/101
-    """
-    return _('Relationship with {0}').format(self.template.name)
+# kept for backward compatibility to avoid
+# breaking openwisp-controller 0.2.x
+# TODO: remove in 0.7.x
+sortedm2m__str__ = TemplatesThrough.__str__

django_netjsonconfig/models.py

@@ -1,4 +1,4 @@
-from .base.config import AbstractConfig, TemplatesVpnMixin, sortedm2m__str__
+from .base.config import AbstractConfig, TemplatesVpnMixin
 from .base.device import AbstractDevice
 from .base.tag import AbstractTaggedTemplate, AbstractTemplateTag
 from .base.template import AbstractTemplate
@@ -13,9 +13,6 @@ class Meta(AbstractConfig.Meta):
         abstract = False
 
 
-Config.templates.through.__str__ = sortedm2m__str__
-
-
 class Device(AbstractDevice):
     """
     Concrete device model

django_netjsonconfig/tests/test_config.py

@@ -392,7 +392,9 @@ def test_m2m_str_conversion(self):
         c = self._create_config(device=self._create_device(name='test-m2m-str-repr'))
         c.templates.add(t)
         c.save()
-        self.assertIn('Relationship with', str(c.templates.through.objects.first()))
+        through = str(c.templates.through.objects.first())
+        self.assertIn('Relationship with', through)
+        self.assertIn(t.name, through)
 
     def test_get_template_model_static(self):
         self.assertIs(Config.get_template_model(), Template)

requirements.txt

@@ -3,7 +3,7 @@ django-model-utils
 jsonfield
 six
 netjsonconfig>=0.5.4,<0.7.0
-django-sortedm2m>=1.4.0,<1.5
+django-sortedm2m>=1.5.0,<1.6
 django-reversion>=2.0.6,<2.1
 django-x509>=0.2.0,<0.3.0
 django-taggit>=0.22.1,<0.23.0