add markdown format output

and enable it for bugzilla, github and gitlab.

Signed-off-by: Sandro Bonazzola <[email protected]>
Co-authored-by: Konrad Kleine <[email protected]>

Author: sandrobonazzola

README.rst

@@ -86,12 +86,13 @@ The default output is plain text of maximum width 79 characters.
 This can be adjusted using the ``--width`` parameter. To disable
 shortening altogether use ``--width=0``. The default width value
 can be saved in the config file as well. Use ``--format=wiki`` to
-enable simple MoinMoin wiki syntax. For stats which support them,
+enable simple MoinMoin wiki syntax or ``--format=wiki`` to enable
+markdown syntax. For stats which support them,
 ``--brief`` and ``--verbose`` can be used to specify a different
 level of detail to be shown.
 
---format=FMT
-    Output style, possible values: text (default) or wiki
+--format {text,md,wiki}
+    Output style, default: text
 
 --width=WIDTH
     Maximum width of the report output (default: 79)

did/cli.py

@@ -77,8 +77,8 @@ def __init__(self, arguments=None):
         # Formating options
         group = self.parser.add_argument_group("Format")
         group.add_argument(
-            "--format", default="text",
-            help="Output style, possible values: text (default) or wiki")
+            "--format", default="text", choices=["text", "md", "wiki"],
+            help="Output style, default: text")
         group.add_argument(
             "--width", default=width, type=int,
             help="Maximum width of the report output (default: %(default)s)")
@@ -149,8 +149,17 @@ def parse(self):
             raise RuntimeError(
                 "Invalid date range ({0} to {1})".format(
                     opt.since, opt.until.date - delta(days=1)))
-        header = "Status report for {0} ({1} to {2}).".format(
+
+        header = "Status report for {0} ({1} to {2})".format(
             period, opt.since, opt.until.date - delta(days=1))
+        if opt.format == "md":
+            # in markdown first line must be an header
+            # using alternate syntax allowing to use did's
+            # output in commit messages as well
+            header = f"{header}\n{'=' * len(header)}"
+        else:
+            # in markdown no trailing punctuation is allowed in headings
+            header = header + "."
 
         # Finito
         log.debug("Gathered options:")

did/plugins/bugzilla.py

@@ -140,6 +140,10 @@ def __str__(self):
         """ Consistent identifier and summary for displaying """
         if self.options.format == "wiki":
             return "<<Bug({0})>> - {1}".format(self.id, self.summary)
+        elif self.options.format == "md":
+            link = self.parent.url.replace("xmlrpc.cgi", "show_bug.cgi?id=")
+            return "[{0}#{1}]({2}{1}) - {3}".format(
+                self.prefix, str(self.id), link, self.summary)
         else:
             return "{0}#{1} - {2}".format(
                 self.prefix, str(self.id).rjust(7, "0"), self.summary)

did/plugins/github.py

@@ -110,20 +110,26 @@ def search(self, query):
 class Issue(object):
     """ GitHub Issue """
 
-    def __init__(self, data):
+    def __init__(self, data, parent):
         self.data = data
         self.title = data["title"]
         matched = re.search(
             r"/repos/([^/]+)/([^/]+)/issues/(\d+)", data["url"])
         self.owner = matched.groups()[0]
         self.project = matched.groups()[1]
         self.id = matched.groups()[2]
+        self.options = parent.options
 
     def __str__(self):
         """ String representation """
-        return "{0}/{1}#{2} - {3}".format(
-            self.owner, self.project,
-            str(self.id).zfill(PADDING), self.data["title"])
+        if self.options.format == "md":
+            return "[{0}/{1}#{2}](https://github.com/{0}/{1}/issues/{2}) - {3}".format(
+                self.owner, self.project,
+                str(self.id), self.data["title"].strip())
+        else:
+            return "{0}/{1}#{2} - {3}".format(
+                self.owner, self.project,
+                str(self.id).zfill(PADDING), self.data["title"])
 
 
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -139,7 +145,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:issue"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 class IssuesClosed(Stats):
@@ -151,7 +157,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:issue"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 class IssueCommented(Stats):
@@ -163,7 +169,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:issue"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 class PullRequestsCreated(Stats):
@@ -176,7 +182,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:pr"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 class PullRequestsCommented(Stats):
@@ -189,7 +195,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:pr"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 class PullRequestsClosed(Stats):
@@ -202,7 +208,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:pr"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 class PullRequestsReviewed(Stats):
@@ -215,7 +221,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until)
         query += "+type:pr"
         self.stats = [
-            Issue(issue) for issue in self.parent.github.search(query)]
+            Issue(issue, self.parent) for issue in self.parent.github.search(query)]
 
 
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

did/plugins/gitlab.py

@@ -163,7 +163,8 @@ def search(self, user, since, until, target_type, action_name):
 class Issue(object):
     """ GitLab Issue """
 
-    def __init__(self, data, gitlabapi):
+    def __init__(self, data, gitlabapi, parent):
+        self.parent = parent
         self.data = data
         self.gitlabapi = gitlabapi
         self.project = self.gitlabapi.get_project(data['project_id'])
@@ -176,9 +177,18 @@ def iid(self):
 
     def __str__(self):
         """ String representation """
-        return "{0}#{1} - {2}".format(
-            self.project['path_with_namespace'],
-            str(self.id).zfill(PADDING), self.title)
+        if self.parent.options.format == "md":
+            return "[{1}#{3}]({0}/{1}/-/{2}/{3}) - {4}".format(
+                self.gitlabapi.url,
+                self.project['path_with_namespace'],
+                ("issues"
+                    if self.data['target_type'] == 'Issue'
+                    else "merge_requests"),
+                str(self.id), self.title)
+        else:
+            return "{0}#{1} - {2}".format(
+                self.project['path_with_namespace'],
+                str(self.id).zfill(PADDING), self.title)
 
 
 class MergeRequest(Issue):
@@ -223,7 +233,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'Issue', 'opened')
         self.stats = [
-            Issue(issue, self.parent.gitlab)
+            Issue(issue, self.parent.gitlab, self.parent)
             for issue in results]
 
 
@@ -237,7 +247,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'Note', 'commented on')
         self.stats = [
-            Note(issue, self.parent.gitlab)
+            Note(issue, self.parent.gitlab, self.parent)
             for issue in results
             if issue['note']['noteable_type'] == 'Issue']
 
@@ -252,7 +262,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'Issue', 'closed')
         self.stats = [
-            Issue(issue, self.parent.gitlab)
+            Issue(issue, self.parent.gitlab, self.parent)
             for issue in results]
 
 
@@ -266,7 +276,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'MergeRequest', 'opened')
         self.stats = [
-            MergeRequest(mr, self.parent.gitlab)
+            MergeRequest(mr, self.parent.gitlab, self.parent)
             for mr in results]
 
 
@@ -280,7 +290,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'Note', 'commented on')
         self.stats = [
-            Note(issue, self.parent.gitlab)
+            Note(issue, self.parent.gitlab, self.parent)
             for issue in results
             if issue['note']['noteable_type'] == 'MergeRequest']
 
@@ -295,7 +305,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'MergeRequest', 'accepted')
         self.stats = [
-            MergeRequest(mr, self.parent.gitlab)
+            MergeRequest(mr, self.parent.gitlab, self.parent)
             for mr in results]
 
 
@@ -309,7 +319,7 @@ def fetch(self):
             self.user.login, self.options.since, self.options.until,
             'MergeRequest', 'approved')
         self.stats = [
-            MergeRequest(mr, self.parent.gitlab)
+            MergeRequest(mr, self.parent.gitlab, self.parent)
             for mr in results]
 
 

did/utils.py

@@ -186,6 +186,8 @@ def item(text, level=0, options=None):
         return
     # Four space for each level, additional space for wiki format
     indent = level * 4
+    if options.format == "md":
+        indent = level * 2
     if options.format == "wiki" and level == 0:
         indent = 1
     # Shorten the text if necessary to match the desired maximum width

docs/examples.rst

@@ -94,7 +94,9 @@ corresponding option groups for each of them::
       --footer         All above
 
     Format:
-      --format FORMAT  Output style, possible values: text (default) or wiki
+      Format:
+      --format {text,md,wiki}
+                       Output style, default: text
       --width WIDTH    Maximum width of the report output (default: 79)
       --brief          Show brief summary only, do not list individual items
       --verbose        Include more details (like modified git directories)