Set section length dynamically

modelsdoc/templates/modelsdoc/models.md

@@ -2,7 +2,7 @@
 {% autoescape off %}
 
 {% for model in models %}
-## {{ model.name }}({{ model.class_fullname }})
+## {{ model.display_name }}
 
 ```
 {{ model.doc }}

modelsdoc/templates/modelsdoc/models.rst

@@ -5,8 +5,8 @@
    :local:
 
 {% for model in models %}
-{{ model.name }}({{ model.class_fullname }})
------------------------------------------------------------------------------------------
+{{ model.display_name }}
+{{ model.display_name_length|str_repeat:'-' }}
 
 ::
 

modelsdoc/templatetags/modelsdoc_tags.py

@@ -57,3 +57,8 @@ def emptylineless(parser, token):
 @register.filter
 def get_attr(obj, attr):
     return getattr(obj, attr, '')
+
+
+@register.filter
+def str_repeat(times, string):
+    return string * times

modelsdoc/wrappers.py

@@ -10,6 +10,7 @@
 
 from sphinx.pycode import ModuleAnalyzer
 import django
+from django.utils.encoding import force_bytes
 
 from modelsdoc.utils import (
     class_to_string, get_foreignkey,
@@ -67,6 +68,15 @@ def class_fullname(self):
     def class_name(self):
         return self._model._model.__name__
 
+    @property
+    def display_name(self):
+        return '{}({})'.format(self.name, self.class_fullname)
+
+    @property
+    def display_name_length(self):
+        """ Return length of byte string. for reST section """
+        return len(force_bytes(self.display_name))
+
     @property
     def doc(self):
         return self._model.__doc__

tests/tests/test_templatetags.py

@@ -51,3 +51,16 @@ class Dummy(object):
 
         self.assertEqual('test', self._callFUT(Dummy(), 'test'))
         self.assertEqual('', self._callFUT(Dummy(), 'non_exists_attr'))
+
+
+class TestStrRepeat(TestCase):
+
+    def _getTargetTags(self):
+        return "{% load modelsdoc_tags %}{{ length|str_repeat:'-' }}"
+
+    def _callFUT(self, length):
+        t = Template(self._getTargetTags())
+        return t.render(Context({'length': length}))
+
+    def test_str_repeat(self):
+        self.assertEqual('-----', self._callFUT(5))

tests/tests/test_wrappers.py

@@ -127,6 +127,22 @@ def test_class_name(self):
         )
         self.assertEqual('DummyModel', target.class_name)
 
+    @mock.patch('modelsdoc.wrappers.class_to_string', return_value='dummy')
+    def test_display_name(self, mock):
+        target = self._makeOne(
+            self._getDummyModel(self._getDummyModel()),
+            'connection'
+        )
+        self.assertEqual('name(dummy)', target.display_name)
+
+    @mock.patch('modelsdoc.wrappers.class_to_string', return_value='dummy')
+    def test_display_name_length(self, mock):
+        target = self._makeOne(
+            self._getDummyModel(self._getDummyModel()),
+            'connection'
+        )
+        self.assertEqual(11, target.display_name_length)
+
     def test_doc(self):
         target = self._makeOne(self._getDummyModel(), 'connection')
         self.assertEqual(' TEST DOC STRING ', target.doc)