Feature: onstory callback to provide querystring and form metadata on…

… documenting each story

TODO.md

@@ -1 +1,2 @@
 - write parameters table once at the base call.
+- do not print out table of json forms, just print the object instead.

bddrest/__init__.py

@@ -6,4 +6,4 @@
 from .exceptions import InvalidUrlParametersError, CallVerifyError
 
 
-__version__ = '5.1.0'
+__version__ = '6.0.0dev'

bddrest/documentary/documenter.py

@@ -5,10 +5,10 @@
 
 
 class Documenter:
-    def __init__(self, onfile, format='markdown', onfield=None):
+    def __init__(self, onfile, format='markdown', onstory=None):
         self.format = format
         self.onfile = onfile
-        self.onfield = onfield
+        self.onstory = onstory
 
     def write_response(self, formatter, response):
         formatter.write_header(f'Response: {response.status}', 3)
@@ -37,6 +37,12 @@ def write_curl(self, formatter, content):
     def write_call(self, basecall, call, formatter):
         formatter.write_header(f'{call.verb} {call.url}', 3)
 
+        if self.onstory:
+            queryinfo, fieldsinfo = self.onstory(basecall)
+        else:
+            queryinfo = {}
+            fieldsinfo = {}
+
         if call.description:
             formatter.write_paragraph(call.description)
 
@@ -66,7 +72,7 @@ def write_call(self, basecall, call, formatter):
             formatter.write_header('Form', 3)
             rows = []
             for k, value in call.form.items():
-                info = self.onfield(call, k) if self.onfield else {}
+                info = fieldsinfo.get(k, {})
                 if info is None:
                     info = {}
 
@@ -90,7 +96,7 @@ def write_call(self, basecall, call, formatter):
             formatter.write_header('Multipart', 3)
             rows = []
             for k, v in call.multipart.items():
-                info = self.onfield(call, k) if self.onfield else {}
+                info = fieldsinfo.get(k, {})
                 if info is None:
                     info = {}
 
@@ -113,14 +119,14 @@ def write_call(self, basecall, call, formatter):
             formatter.write_header('Form', 3)
             rows = []
             for k, v in call.json.items():
-                info = self.onfield(call, k) if self.onfield else {}
+                info = fieldsinfo.get(k, {})
                 required = info.get('required')
-                not_none = info.get('not_none')
+                notnone = info.get('notnone')
                 type_ = info.get('type')
                 rows.append((
                     k,
                     '?' if required is None else required and 'Yes' or 'No',
-                    '?' if not_none is None else not_none and 'No' or 'Yes',
+                    '?' if notnone is None else notnone and 'No' or 'Yes',
                     '?' if type_ is None else type_,
                     v
                 ))

tests/test_documentary_html.py

@@ -5,16 +5,16 @@
 
 def test_html():
 
-    def get_field_info(call, name):
-        return dict(
+    def get_field_info(call):
+        return dict(), dict(
             f1=dict(required=True, not_none=True, type='str'),
-        ).get(name)
+        )
 
     story = Story.loads(provided_story)
     outfile = io.StringIO()
     story.document(
         onfile=lambda _: outfile,
-        onfield=get_field_info,
+        onstory=get_field_info,
         format='html'
     )
     outputstring = outfile.getvalue()

tests/test_documentary_markdown.py

@@ -5,14 +5,14 @@
 
 def test_markdown():
 
-    def get_field_info(call, name):
-        return dict(
+    def get_field_info(call):
+        return dict(), dict(
             f1=dict(required=True, not_none=True, type='str'),
-        ).get(name)
+        )
 
     story = Story.loads(provided_story)
     outfile = io.StringIO()
-    story.document(onfile=lambda _: outfile, onfield=get_field_info)
+    story.document(onfile=lambda _: outfile, onstory=get_field_info)
     outputstring = outfile.getvalue()
     assert expected_markdown == outputstring