Use formatters in terminal.py

Do some general refactoring for readability

printer-linter/src/printerlinter/formatters/__init__.py

@@ -1,4 +1,4 @@
-from def_json_formatter import DefJsonFormatter
+from .def_json_formatter import DefJsonFormatter
-from inst_cfg_formatter import InstCfgFormatter
+from .inst_cfg_formatter import InstCfgFormatter
 
 __all__ = ["DefJsonFormatter", "InstCfgFormatter"]

printer-linter/src/terminal.py

@@ -1,8 +1,4 @@
-import configparser
-import json
-import re
 from argparse import ArgumentParser
-from collections import OrderedDict
 from os import getcwd
 from pathlib import Path
 from typing import List
@@ -10,81 +6,9 @@ from typing import List
 import yaml
 
 from printerlinter import factory
-
+from printerlinter.diagnostic import Diagnostic
-
+from printerlinter.formatters.def_json_formatter import DefJsonFormatter
-def examineFile(file, settings, full_body_check) -> None:
+from printerlinter.formatters.inst_cfg_formatter import InstCfgFormatter
-    patient = factory.create(file, settings)
-    if patient is None:
-        return
-
-    for diagnostic in patient.check():
-        if diagnostic:
-            full_body_check["Diagnostics"].append(diagnostic.toDict())
-
-
-def fixFile(file, settings, full_body_check) -> None:
-    if not file.exists():
-        return
-    ext = ".".join(file.name.split(".")[-2:])
-
-    if ext == "def.json":
-        issues = full_body_check[f"{file.as_posix()}"]
-        for issue in issues:
-            if issue["diagnostic"] == "diagnostic-definition-redundant-override" and settings["fixes"].get(
-                    "diagnostic-definition-redundant-override", True):
-                pass
-
-
-def formatFile(file: Path, settings) -> None:
-    if not file.exists():
-        return
-    ext = ".".join(file.name.split(".")[-2:])
-
-    if ext == "def.json":
-        definition = json.loads(file.read_text())
-        content = json.dumps(definition, indent=settings["format"].get("format-definition-indent", 4),
-                             sort_keys=settings["format"].get("format-definition-sort-keys", True))
-
-        if settings["format"].get("format-definition-bracket-newline", True):
-            newline = re.compile(r"(\B\s+)(\"[\w\"]+)(\:\s\{)")
-            content = newline.sub(r"\1\2:\1{", content)
-
-        if settings["format"].get("format-definition-single-value-single-line", True):
-            single_value_dict = re.compile(r"(:)(\s*\n?.*\{\s+)(\".*)(\d*\s*\})(\s*)(,?)")
-            content = single_value_dict.sub(r"\1 { \3 }\6", content)
-
-            single_value_list = re.compile(r"(:)(\s*\n?.*\[\s+)(\".*)(\d*\s*\])(\s*)(,?)")
-            content = single_value_list.sub(r"\1 [ \3 ]\6", content)
-
-        if settings["format"].get("format-definition-paired-coordinate-array", True):
-            paired_coordinates = re.compile(r"(\[)\s+(-?\d*),\s*(-?\d*)\s*(\])")
-            content = paired_coordinates.sub(r"\1 \2, \3 \4", content)
-
-        file.write_text(content)
-
-    if ext == "inst.cfg":
-        config = configparser.ConfigParser()
-        config.read(file)
-
-        if settings["format"].get("format-profile-sort-keys", True):
-            for section in config._sections:
-                config._sections[section] = OrderedDict(sorted(config._sections[section].items(), key=lambda t: t[0]))
-            config._sections = OrderedDict(sorted(config._sections.items(), key=lambda t: t[0]))
-
-        with open(file, "w") as f:
-            config.write(f, space_around_delimiters=settings["format"].get("format-profile-space-around-delimiters", True))
-
-
-def extract_file_paths(paths: List[Path]) -> List[Path]:
-    """ Takes list of files and directories, returns the files as well as all files within directories as a List """
-    file_paths = []
-    for path in paths:
-        if path.is_dir():
-            file_paths.extend(path.rglob("**/*"))
-        else:
-            file_paths.append(path)
-
-    return file_paths
 
 
 def main() -> None:
@@ -98,7 +22,7 @@ def main() -> None:
     parser.add_argument("Files", metavar="F", type=Path, nargs="+", help="Files or directories to format")
 
     args = parser.parse_args()
-    files = extract_file_paths(args.Files)
+    files = extractFilePaths(args.Files)
     setting_path = args.setting
     to_format = args.format
     to_fix = args.fix
@@ -119,9 +43,11 @@ def main() -> None:
 
     if to_fix or to_diagnose:
         for file in files:
-            examineFile(file, settings, full_body_check)
+            diagnostics = diagnoseIssuesWithFile(file, settings)
+            full_body_check["Diagnostics"].extend([d.toDict() for d in diagnostics])
 
             results = yaml.dump(full_body_check, default_flow_style=False, indent=4, width=240)
+
             if report:
                 report.write_text(results)
             else:
@@ -130,11 +56,62 @@ def main() -> None:
     if to_fix:
         for file in files:
             if f"{file.as_posix()}" in full_body_check:
-                fixFile(file, settings, full_body_check)
+                applyFixesToFile(file, settings, full_body_check)
 
     if to_format:
         for file in files:
-            formatFile(file, settings)
+            applyFormattingToFile(file, settings)
+
+
+def diagnoseIssuesWithFile(file: Path, settings: dict) -> List[Diagnostic]:
+    """ For file, runs all diagnostic checks in settings and returns a list of diagnostics """
+    # Find correct diagnostic generator for file
+    diagnostic_generator = factory.create(file, settings)
+
+    if not diagnostic_generator:
+        return []
+
+    return list(filter(lambda d: d, diagnostic_generator.check()))
+
+
+def applyFixesToFile(file, settings, full_body_check) -> None:
+    if not file.exists():
+        return
+    ext = ".".join(file.name.split(".")[-2:])
+
+    if ext == "def.json":
+        issues = full_body_check[f"{file.as_posix()}"]
+        for issue in issues:
+            if issue["diagnostic"] == "diagnostic-definition-redundant-override" and settings["fixes"].get(
+                    "diagnostic-definition-redundant-override", True):
+                pass
+
+
+def applyFormattingToFile(file: Path, settings) -> None:
+    if not file.exists():
+        return
+
+    ext = ".".join(file.name.split(".")[-2:])
+
+    if ext == "def.json":
+        formatter = DefJsonFormatter(settings)
+        formatter.format(file)
+
+    if ext == "inst.cfg":
+        formatter = InstCfgFormatter(settings)
+        formatter.format(file)
+
+
+def extractFilePaths(paths: List[Path]) -> List[Path]:
+    """ Takes list of files and directories, returns the files as well as all files within directories as a List """
+    file_paths = []
+    for path in paths:
+        if path.is_dir():
+            file_paths.extend(path.rglob("**/*"))
+        else:
+            file_paths.append(path)
+
+    return file_paths
 
 
 if __name__ == "__main__":