metripy 0.2.8__tar.gz → 0.3.1__tar.gz

{metripy-0.2.8 → metripy-0.3.1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: metripy
-Version: 0.2.8
+Version: 0.3.1
 Summary: A Python tool to generate multi project, multi language code metric reports
 Author-email: Yannick Zimmermann <yannick.zimmermann@proton.me>
 License: MIT
-Project-URL: Homepage, https://github.com/zimmer-yan/metripy
+Project-URL: Homepage, https://zimmer-yan.github.io/metripy/
 Project-URL: Repository, https://github.com/zimmer-yan/metripy
-Project-URL: Documentation, https://github.com/zimmer-yan/metripy#readme
+Project-URL: Documentation, https://zimmer-yan.github.io/metripy/
 Project-URL: Bug Tracker, https://github.com/zimmer-yan/metripy/issues
 Keywords: code metrics,multi-language,code analysis,git metrics,code visualization,software quality,static analysis,repository insights,developer productivity,codebase health,technical debt,language-agnostic
 Classifier: Development Status :: 3 - Alpha

{metripy-0.2.8 → metripy-0.3.1}/metripy/Application/Analyzer.py

@@ -7,14 +7,15 @@ from metripy.Dependency.Dependency import Dependency
 from metripy.Dependency.Npm.Npm import Npm
 from metripy.Dependency.Pip.Pip import Pip
 from metripy.Git.GitAnalyzer import GitAnalyzer
+from metripy.Import.Json.JsonImporter import JsonImporter
 from metripy.LangAnalyzer.AbstractLangAnalyzer import AbstractLangAnalyzer
 from metripy.LangAnalyzer.Php.PhpAnalyzer import PhpAnalyzer
 from metripy.LangAnalyzer.Python.PythonAnalyzer import PythonAnalyzer
-from metripy.LangAnalyzer.Typescript.TypescriptAnalyzer import \
-    TypescriptAnalyzer
+from metripy.LangAnalyzer.Typescript.TypescriptAnalyzer import TypescriptAnalyzer
 from metripy.Metric.Code.FileMetrics import FileMetrics
 from metripy.Metric.Git.GitMetrics import GitMetrics
 from metripy.Metric.ProjectMetrics import ProjectMetrics
+from metripy.Trend.TrendAnalyzer import TrendAnalyzer
 
 
 class Analyzer:
@@ -85,6 +86,18 @@ class Analyzer:
 
         return dependencies
 
+    def add_trends(self, project_metrics: ProjectMetrics):
+        self.output.writeln("<info>Analyzing trends...</info>")
+        importer = JsonImporter(self.output)
+        historical_project_metrics = importer.import_data(self.config.history_path)
+        TrendAnalyzer().add_historical_file_trends(
+            project_metrics.file_metrics, historical_project_metrics.file_metrics
+        )
+        TrendAnalyzer().add_historical_project_trends(
+            project_metrics, historical_project_metrics
+        )
+        self.output.writeln("<success>Trends analyzed</success>")
+
     def run(self, files: list[str]) -> ProjectMetrics:
         git_stats = None
         if self.config.git:
@@ -103,4 +116,11 @@ class Analyzer:
         elif self.config.npm:
             packages = self.analyze_npm()
 
-        return ProjectMetrics(file_metrics, git_stats, packages)
+        if not self.config.history_path:
+            return ProjectMetrics(file_metrics, git_stats, packages)
+
+        # analyze trends
+        project_metrics = ProjectMetrics(file_metrics, git_stats, packages)
+        self.add_trends(project_metrics)
+
+        return project_metrics

{metripy-0.2.8 → metripy-0.3.1}/metripy/Application/Application.py

@@ -2,6 +2,7 @@ import json
 
 from metripy.Application.Analyzer import Analyzer
 from metripy.Application.Config.Parser import Parser
+from metripy.Application.Info import Info
 from metripy.Component.Debug.Debugger import Debugger
 from metripy.Component.File.Finder import Finder
 from metripy.Component.Output.CliOutput import CliOutput
@@ -14,9 +15,22 @@ class Application:
         output = CliOutput()
 
         # issues and debug
-        debugger = Debugger(output).enable()
+        debugger = Debugger(output)
 
         config = Parser().parse(argv)
+        if config.debug:
+            debugger.enable()
+
+        if config.version:
+            output.writeln(Info().get_version_info())
+            return
+
+        if config.help:
+            output.writeln(Info().get_help())
+            return
+
+        if config.quiet:
+            output.set_quiet(True)
 
         finder = Finder()
         files = finder.fetch(config.project_configs)
@@ -46,7 +60,7 @@ class Application:
             )
             for report_config in project_config.reports:
                 reporter: ReporterInterface = ReporterFactory.create(
-                    report_config, output
+                    report_config, output, project_config.name
                 )
                 reporter.generate(project_metrics)
             output.writeln(

metripy-0.3.1/metripy/Application/Config/Config.py

@@ -0,0 +1,47 @@
+from metripy.Application.Config.ProjectConfig import ProjectConfig
+
+
+class Config:
+    def __init__(self):
+        self.project_configs: list[ProjectConfig] = []
+        self.quiet: bool = False
+        self.version: bool = False
+        self.help: bool = False
+        self.debug: bool = False
+
+    def to_dict(self) -> dict:
+        return {
+            "project_configs": [
+                project_config.to_dict() for project_config in self.project_configs
+            ],
+        }
+
+    def set(self, param: str, value: any) -> None:
+        if param == "quiet":
+            self.quiet = value
+        elif param == "version":
+            self.version = value
+        elif param == "help":
+            self.help = value
+        elif param == "debug":
+            self.debug = value
+        elif param.startswith("configs."):
+            self._set_project_value(param[len("configs.") :], value)
+        else:
+            # ignore unknown parameters
+            return
+
+    def _set_project_value(self, param: str, value: any) -> None:
+        keys = param.split(".")
+        project_name = keys[0]
+        project_config = next(
+            (pc for pc in self.project_configs if pc.name == project_name), None
+        )
+        if not project_config:
+            project_config = ProjectConfig(project_name)
+            self.project_configs.append(project_config)
+        if len(keys) > 1:
+            project_config.set(keys[1:], value)
+        else:
+            # weird but okay
+            return

{metripy-0.2.8 → metripy-0.3.1}/metripy/Application/Config/File/ConfigFileReaderFactory.py

@@ -1,10 +1,11 @@
 import os
 import pathlib
 
-from metripy.Application.Config.File.ConfigFileReaderInterface import \
-    ConfigFileReaderInterface
-from metripy.Application.Config.File.JsonConfigFileReader import \
-    JsonConfigFileReader
+from metripy.Application.Config.File.ConfigFileReaderInterface import (
+    ConfigFileReaderInterface,
+)
+from metripy.Application.Config.File.JsonConfigFileReader import JsonConfigFileReader
+from metripy.Application.Config.File.YamlConfigFileReader import YamlConfigFileReader
 
 
 class ConfigFileReaderFactory:
@@ -17,7 +18,7 @@ class ConfigFileReaderFactory:
         if extension == ".json":
             return JsonConfigFileReader(filename)
         elif extension == ".yaml" or extension == ".yml":
-            raise NotImplementedError("YAML support is not implemented yet")
+            return YamlConfigFileReader(filename)
         elif extension == ".xml":
             raise NotImplementedError("XML support is not implemented yet")
         else:

metripy-0.2.8/metripy/Application/Config/File/JsonConfigFileReader.py → metripy-0.3.1/metripy/Application/Config/File/ConfigFileReaderInterface.py

@@ -1,44 +1,39 @@
-import json
 import os
+from abc import ABC, abstractmethod
 
 from metripy.Application.Config.Config import Config
-from metripy.Application.Config.File.ConfigFileReaderInterface import \
-    ConfigFileReaderInterface
 from metripy.Application.Config.GitConfig import GitConfig
 from metripy.Application.Config.ProjectConfig import ProjectConfig
 from metripy.Application.Config.ReportConfig import ReportConfig
 
 
-class JsonConfigFileReader(ConfigFileReaderInterface):
+class ConfigFileReaderInterface(ABC):
     def __init__(self, filename: str):
         self.filename = filename
 
+    @abstractmethod
     def read(self, config: Config) -> None:
-        with open(self.filename, "r") as file:
-            json_data = json.load(file)
-
-        self.parse_json(json_data, config)
+        pass
 
     def resolve_path(self, path: str) -> str:
         return os.path.join(os.path.dirname(self.filename), path)
 
-    def parse_json(self, json_data: dict, config: Config) -> None:
-
+    def parse_data(self, data: dict, config: Config) -> None:
         # configs
-        if configs := json_data.get("configs"):
+        if configs := data.get("configs"):
             for project_name, project_config in configs.items():
                 project_config = self.parse_config_json(project_name, project_config)
                 config.project_configs.append(project_config)
 
-    def parse_config_json(self, project_name: str, json_data: dict) -> ProjectConfig:
+    def parse_config_json(self, project_name: str, data: dict) -> ProjectConfig:
         project_config = ProjectConfig(project_name)
 
         # extensions
-        if base_path := json_data.get("base_path"):
+        if base_path := data.get("base_path"):
             project_config.base_path = base_path
 
         # includes
-        if includes := json_data.get("includes"):
+        if includes := data.get("includes"):
             files = []
             # with config file, includes are relative to the config file
             for include in includes:
@@ -48,35 +43,39 @@ class JsonConfigFileReader(ConfigFileReaderInterface):
             project_config.includes = files
 
         # extensions
-        if extensions := json_data.get("extensions"):
+        if extensions := data.get("extensions"):
             project_config.extensions = extensions
 
         # excludes
-        if excludes := json_data.get("excludes"):
+        if excludes := data.get("excludes"):
             project_config.excludes = excludes
 
         # reports
-        if reports := json_data.get("reports"):
+        if reports := data.get("reports"):
             for report_type, path in reports.items():
                 path = self.resolve_path(path)
                 project_config.reports.append(ReportConfig(report_type, path))
 
         # git
-        if git := json_data.get("git"):
+        if git := data.get("git"):
             project_config.git = GitConfig()
             project_config.git.repo = project_config.base_path
             project_config.git.branch = git.get("branch", project_config.git.branch)
 
         # composer
-        if composer := json_data.get("composer"):
+        if composer := data.get("composer"):
             project_config.composer = composer
 
         # pip
-        if pip := json_data.get("pip"):
+        if pip := data.get("pip"):
             project_config.pip = pip
 
         # npm
-        if npm := json_data.get("npm"):
+        if npm := data.get("npm"):
             project_config.npm = npm
 
+        # trends
+        if history_path := data.get("trends"):
+            project_config.history_path = self.resolve_path(history_path)
+
         return project_config

metripy-0.3.1/metripy/Application/Config/File/JsonConfigFileReader.py

@@ -0,0 +1,17 @@
+import json
+
+from metripy.Application.Config.Config import Config
+from metripy.Application.Config.File.ConfigFileReaderInterface import (
+    ConfigFileReaderInterface,
+)
+
+
+class JsonConfigFileReader(ConfigFileReaderInterface):
+    def __init__(self, filename: str):
+        super().__init__(filename)
+
+    def read(self, config: Config) -> None:
+        with open(self.filename, "r") as file:
+            json_data = json.load(file)
+
+        self.parse_data(json_data, config)

metripy-0.3.1/metripy/Application/Config/File/YamlConfigFileReader.py

@@ -0,0 +1,17 @@
+import yaml
+
+from metripy.Application.Config.Config import Config
+from metripy.Application.Config.File.ConfigFileReaderInterface import (
+    ConfigFileReaderInterface,
+)
+
+
+class YamlConfigFileReader(ConfigFileReaderInterface):
+    def __init__(self, filename: str):
+        super().__init__(filename)
+
+    def read(self, config: Config) -> None:
+        with open(self.filename, "r") as file:
+            yaml_data = yaml.safe_load(file)
+
+        self.parse_data(yaml_data, config)

metripy-0.3.1/metripy/Application/Config/Parser.py

@@ -0,0 +1,44 @@
+import re
+
+from metripy.Application.Config.Config import Config
+from metripy.Application.Config.File.ConfigFileReaderFactory import (
+    ConfigFileReaderFactory,
+)
+
+
+class Parser:
+    def parse(self, argv: list[str]) -> Config:
+        config = Config()
+
+        if argv[0].endswith("metripy.py") or argv[0].endswith("metripy"):
+            argv.pop(0)
+
+        # check for a config file
+        key = 0
+        while key < len(argv):
+            arg = argv[key]
+            if matches := re.search(r"^--config=(.+)$", arg):
+                fileReader = ConfigFileReaderFactory.createFromFileName(
+                    matches.group(1)
+                )
+                fileReader.read(config)
+                argv.pop(key)
+
+            # arguments with options
+            elif matches := re.search(r"^--([\w]+(?:\.[\w]+)*)=(.*)$", arg):
+                param = matches.group(1)
+                value = matches.group(2)
+                config.set(param, value)
+                argv.pop(key)
+
+            # arguments without options
+            elif matches := re.search(r"^--([\w]+(?:\.[\w]+)*)$", arg):
+                param = matches.group(1)
+                config.set(param, True)
+                argv.pop(key)
+            else:
+                key += 1
+
+        # TODO handle remaining arguments
+
+        return config

metripy-0.3.1/metripy/Application/Config/ProjectConfig.py

@@ -0,0 +1,91 @@
+from metripy.Application.Config.GitConfig import GitConfig
+from metripy.Application.Config.ReportConfig import ReportConfig
+
+
+class ProjectConfig:
+    def __init__(self, name: str):
+        self.name: str = name
+        self.base_path: str = "./"
+        self.includes: list[str] = []
+        self.excludes: list[str] = []
+        self.extensions: list[str] = []
+        self.git: GitConfig | None = None
+        self.composer: bool = False
+        self.pip: bool = False
+        self.npm: bool = False
+        self.reports: list[ReportConfig] = []
+        self.history_path: str | None = None
+
+    def to_dict(self) -> dict:
+        return {
+            "name": self.name,
+            "base_path": self.base_path,
+            "includes": self.includes,
+            "excludes": self.excludes,
+            "extensions": self.extensions,
+            "composer": self.composer,
+            "pip": self.pip,
+            "npm": self.npm,
+            "git": self.git.to_dict() if self.git else None,
+            "reports": [report.to_dict() for report in self.reports],
+            "history_path": self.history_path,
+        }
+
+    @staticmethod
+    def str_to_bool(value):
+        if isinstance(value, bool):
+            return value
+        return str(value).lower() in ("true", "1", "yes")
+
+    def set(self, keys: list[str], value: any) -> None:
+        if len(keys) == 0:
+            return
+        primary_key = keys[0]
+        # single value
+        if primary_key == "base_path":
+            self.base_path = value
+        elif primary_key == "pip":
+            self.pip = self.str_to_bool(value)
+        elif primary_key == "npm":
+            self.npm = self.str_to_bool(value)
+        elif primary_key == "composer":
+            self.composer = self.str_to_bool(value)
+        elif primary_key == "trends":
+            self.history_path = value
+        elif primary_key == "git":
+            self.git = GitConfig()
+            self.git.repo = self.base_path
+            self.git.branch = value
+
+        # list values
+        elif primary_key == "includes":
+            if value == "":
+                self.includes = []
+            else:
+                self.includes.append(value)
+        elif primary_key == "excludes":
+            if value == "":
+                self.excludes = []
+            else:
+                self.excludes.append(value)
+        elif primary_key == "extensions":
+            if value == "":
+                self.extensions = []
+            else:
+                self.extensions.append(value)
+
+        # dict values
+        elif primary_key == "reports":
+            if len(keys) == 1:
+                return
+            report_type = keys[1]
+            report_path = value
+            if value != "":
+                self.reports.append(ReportConfig(report_type, report_path))
+            else:
+                report_config = next(
+                    (rc for rc in self.reports if rc.type == report_type), None
+                )
+                if not report_config:
+                    return
+                self.reports.remove(report_config)

metripy-0.3.1/metripy/Application/Info.py

@@ -0,0 +1,36 @@
+import toml
+
+
+class Info:
+    def __init__(self):
+        data = self._get_data()
+        self.version = data["project"]["version"]
+        self.url = data["project"]["urls"]["Homepage"]
+
+    def _get_data(self) -> dict:
+        with open("pyproject.toml", "r") as file:
+            data = toml.load(file)
+        return data
+
+    def get_version(self) -> str:
+        return self.version
+
+    def get_version_info(self) -> str:
+        return f"""
+Metripy {self.get_version()}
+{self.url}
+"""
+
+    def get_help(self) -> str:
+        return (
+            self.get_version_info()
+            + """
+Usage: metripy [options]
+Options:
+ --config=<file>    Use a custom config file
+ --version            Show the version and exit
+ --help               Show this help message and exit
+ --debug              Enable debug mode
+ --quiet              Disable output
+"""
+        )

{metripy-0.2.8 → metripy-0.3.1}/metripy/Dependency/Dependency.py

@@ -1,7 +1,8 @@
 from typing import Self
 
+
 class Dependency:
-    def __init__(self, name: str, version: str|None):
+    def __init__(self, name: str, version: str | None):
         self.name = name
         self.version = version
         self.latest: str = ""

{metripy-0.2.8 → metripy-0.3.1}/metripy/Dependency/Pip/Pip.py

@@ -1,5 +1,4 @@
 import os
-import re
 
 import toml
 
@@ -39,7 +38,7 @@ class Pip:
                 return self._parse_dependencies(deps)
 
         return []
-    
+
     def _parse_dependencies(self, lines: list[str]) -> list[Dependency]:
         dependencies = []
         for dep in lines:

{metripy-0.2.8 → metripy-0.3.1}/metripy/Dependency/Pip/PyPi.py

@@ -16,6 +16,7 @@ class PyPi:
             print(f"Package '{dependency.name}' has no info section")
             return dependency
 
+        dependency.type = "pip"
         dependency.description = info.get("summary")
         dependency.repository = info.get("project_url") or info.get("home_page")
         if info.get("license"):

{metripy-0.2.8 → metripy-0.3.1}/metripy/Git/GitAnalyzer.py

@@ -9,8 +9,6 @@ from metripy.Metric.Git.GitMetrics import GitMetrics
 
 class GitAnalyzer:
     def __init__(self, git_config: GitConfig):
-        print(git_config.repo)
-        print(git_config.branch)
         self.repo = Repo(git_config.repo)
         self.branch_name = git_config.branch
 
@@ -22,7 +20,6 @@ class GitAnalyzer:
         first_of_month_last_year = datetime(now.year - 1, now.month, 1)
         # first_of_month_last_year = datetime(now.year, now.month, 1)
         after_date = first_of_month_last_year.strftime("%Y-%m-%d")
-        print(f"analyzing from {after_date}")
 
         return self.get_metrics(after_date)
 

metripy-0.3.1/metripy/Import/Json/JsonImporter.py

@@ -0,0 +1,17 @@
+import json
+
+from metripy.Component.Output.CliOutput import CliOutput
+from metripy.Metric.ProjectMetrics import ProjectMetrics
+
+
+class JsonImporter:
+    def __init__(self, output: CliOutput):
+        self.output = output
+
+    def import_data(self, path: str) -> ProjectMetrics:
+        self.output.writeln(f"<info>Importing data from {path}...</info>")
+        with open(path, "r") as file:
+            data = json.load(file)
+            project_metrics = ProjectMetrics.from_dict(data)
+        self.output.writeln("<success>Data imported successfuly</success>")
+        return project_metrics

{metripy-0.2.8 → metripy-0.3.1}/metripy/LangAnalyzer/AbstractLangAnalyzer.py

@@ -40,13 +40,13 @@ class AbstractLangAnalyzer(ABC):
             full_name = module.full_name
 
             if len(module.functions) > 0:
-                avgCcPerFunction = sum(
-                    function.complexity for function in module.functions
-                ) / len(module.functions)
+                totalCc = sum(function.complexity for function in module.functions)
+                avgCcPerFunction = totalCc / len(module.functions)
                 avgLocPerFunction = (
                     module.lloc - module.comments - len(module.functions)
                 ) / len(module.functions)
             else:
+                totalCc = 0
                 avgCcPerFunction = 0
                 avgLocPerFunction = 0
             maintainabilityIndex = module.maintainability_index
@@ -54,6 +54,7 @@ class AbstractLangAnalyzer(ABC):
             file_metric = FileMetrics(
                 full_name=full_name,
                 loc=module.loc,
+                totalCc=totalCc,
                 avgCcPerFunction=avgCcPerFunction,
                 maintainabilityIndex=maintainabilityIndex,
                 avgLocPerFunction=avgLocPerFunction,

{metripy-0.2.8 → metripy-0.3.1}/metripy/LangAnalyzer/Php/PhpAnalyzer.py

@@ -131,7 +131,7 @@ class PhpAnalyzer(AbstractLangAnalyzer):
 
         code_lines = code.split("\n")
         for func_name, function_node in functions.items():
-            lines = code_lines[function_node.lineno:function_node.line_end]
+            lines = code_lines[function_node.lineno : function_node.line_end]
             function_metrics = self.halstead_analyzer.calculate_halstead_metrics(
                 "\n".join(lines)
             )
@@ -147,6 +147,7 @@ class PhpAnalyzer(AbstractLangAnalyzer):
             function_node.calculated_length = function_metrics["calculated_length"]
             function_node.bugs = function_metrics["bugs"]
             function_node.time = function_metrics["time"]
+            function_node.calc_mi()
 
         maintainability_index = self._calculate_maintainability_index(
             functions.values(), module_node