Add prospector-json as a Reporter

.gitignore

@@ -3,3 +3,5 @@ poetry.lock
 dist
 docs/build
 .vscode
+__pycache__
+*.egg-info

pyproject.toml

@@ -104,6 +104,7 @@ csv = "tidypy.reports.structured:CsvReport"
 pylint = "tidypy.reports.pylint:PyLintReport"
 pylint-parseable = "tidypy.reports.pylint:PyLintParseableReport"
 null = "tidypy.reports.null:NullReport"
+prospector-json = "tidypy.reports.prospector_json:ProspectorJsonReport"
 
 [tool.poetry.plugins."tidypy.extenders"]
 github = "tidypy.extenders.github:GithubExtender"

src/tidypy/reports/prospector_json.py

@@ -0,0 +1,44 @@
+from datetime import datetime
+
+import basicserial
+
+from ..config import get_tools
+from .base import Report
+
+
+class ProspectorJsonReport(Report):
+    """
+    Formats the report in Prospector JSON format.
+    """
+
+    def execute(self, collector):
+        issues = collector.get_issues(sortby=("filename", "line", "character"))
+        result_json = {
+            "summary": {
+                "started": datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
+                "libraries": [],
+                "strictness": "from profile",
+                "profiles": "tidypy",
+                "tools": list(get_tools().keys()),
+                "message_count": collector.issue_count(),
+                "completed": datetime.now().strftime("%Y-%m-%d %H:%M:%S.%f"),
+                "time_taken": "0",
+                "formatter": "json",
+            },
+            "messages": [
+                {
+                    "source": issue.tool,
+                    "code": issue.code,
+                    "location": {
+                        "path": self.relative_filename(issue.filename),
+                        "module": None,
+                        "function": None,
+                        "line": issue.line,
+                        "character": issue.character or 0,
+                    },
+                    "message": issue.message,
+                }
+                for issue in issues
+            ],
+        }
+        self.output(basicserial.to_json(result_json, pretty=True))

test/test_config.py

@@ -57,6 +57,7 @@ def test_get_reports():
         'custom',
         'json',
         'null',
+        'prospector-json',
         'pycodestyle',
         'pylint',
         'pylint-parseable',

test/test_report_prospector.py

@@ -0,0 +1,130 @@
+from tidypy import execute_reports, get_default_config, Collector, TidyPyIssue
+
+
+ISSUES = [
+    TidyPyIssue(
+        'code1',
+        'Message 1',
+        u'someproject/foo.py',
+        5,
+        23,
+    ),
+    TidyPyIssue(
+        'code2',
+        'Message 2',
+        u'someproject/foo.py',
+        2,
+    ),
+    TidyPyIssue(
+        'code1',
+        'Message 1',
+        'someproject/blah/bar.py',
+        28,
+    ),
+    TidyPyIssue(
+        'code3',
+        'Message 3',
+        'someproject/subdir/foobar.json',
+        5,
+        23,
+    ),
+]
+
+
+EXPECTED_JSON = '''{
+  "summary": {
+    "started": "2021-08-09 16:27:54.695977",
+    "libraries": [],
+    "strictness": "from profile",
+    "profiles": "tidypy",
+    "tools": [
+      "bandit",
+      "dlint",
+      "eradicate",
+      "jsonlint",
+      "manifest",
+      "mccabe",
+      "polint",
+      "pycodestyle",
+      "pydiatra",
+      "pydocstyle",
+      "pyflakes",
+      "pylint",
+      "pyroma",
+      "rstlint",
+      "secrets",
+      "vulture",
+      "yamllint"
+    ],
+    "message_count": 4,
+    "completed": "2021-08-09 16:27:54.695977",
+    "time_taken": "0",
+    "formatter": "json"
+  },
+  "messages": [
+    {
+      "source": "tidypy",
+      "code": "code1",
+      "location": {
+        "path": "blah/bar.py",
+        "module": null,
+        "function": null,
+        "line": 28,
+        "character": 0
+      },
+      "message": "Message 1"
+    },
+    {
+      "source": "tidypy",
+      "code": "code2",
+      "location": {
+        "path": "foo.py",
+        "module": null,
+        "function": null,
+        "line": 2,
+        "character": 0
+      },
+      "message": "Message 2"
+    },
+    {
+      "source": "tidypy",
+      "code": "code1",
+      "location": {
+        "path": "foo.py",
+        "module": null,
+        "function": null,
+        "line": 5,
+        "character": 23
+      },
+      "message": "Message 1"
+    },
+    {
+      "source": "tidypy",
+      "code": "code3",
+      "location": {
+        "path": "subdir/foobar.json",
+        "module": null,
+        "function": null,
+        "line": 5,
+        "character": 23
+      },
+      "message": "Message 3"
+    }
+  ]
+}
+'''
+
+
+def test_json_execute(capsys):
+    cfg = get_default_config()
+    cfg['requested_reports'] = [{'type': 'prospector-json'}]
+
+    collector = Collector(cfg)
+    collector.add_issues(ISSUES)
+
+    execute_reports(cfg, 'someproject', collector)
+
+    out, err = capsys.readouterr()
+
+    assert EXPECTED_JSON == out.replace('\r\n', '\n')
+    assert err == ''