release v0.2.0

Author: alex-pirogov

README.md

@@ -5,7 +5,7 @@ This repository encapsulates abstract classes and interfaces to simplify the pro
 **Install**
 
 ``` bash
-poetry add git+https://github.com/Universal-code-metrics-analyzer/core.git@v0.1.0
+poetry add git+https://github.com/Universal-code-metrics-analyzer/core.git@v0.2.0
 ```
 
 ## Git processor plugin

core/git_processor.py

@@ -1,7 +1,8 @@
 from abc import ABCMeta, abstractmethod
+from datetime import datetime
 from typing import TYPE_CHECKING, Any
 
-from pydantic import BaseModel
+from pydantic import BaseModel, EmailStr
 
 
 class GitProcessorConfigShape(BaseModel):
@@ -23,6 +24,14 @@ class TreeData(BaseModel):
     type: str = 'tree'
 
 
+class CommitMeta(BaseModel):
+    author_email: EmailStr
+    committer_email: EmailStr
+    authored_date: datetime
+    committed_date: datetime
+    message: str
+
+
 class GitProcessor[ConfigShapeT: GitProcessorConfigShape, TreeT, BlobT](metaclass=ABCMeta):
     if TYPE_CHECKING:
         config_shape: type[ConfigShapeT]
@@ -37,9 +46,9 @@ def __init_subclass__(cls, **kwargs: Any) -> None:
 
             setattr(cls, el, attr)
 
-    def __init__(self, config_dict: dict[str, Any], ref: str) -> None:
+    def __init__(self, config_dict: dict[str, Any], sha: str) -> None:
         self.config = self.validate_config(config_dict)
-        self.ref = ref
+        self.sha = sha
 
     def validate_config(self, config_dict: dict[str, Any]) -> ConfigShapeT:
         return self.config_shape.model_validate(config_dict)
@@ -60,3 +69,6 @@ async def process(self) -> TreeData:
         result = await self.process_tree(await self.get_root_tree(), 0)
         await self.cleanup()
         return result
+
+    async def get_commit_meta(self) -> CommitMeta:
+        raise NotImplementedError

core/metrics_calculator.py

@@ -15,28 +15,22 @@ class MetricResult(BaseModel):
     subject_path: str
     value: float
     description: str | None = None
-
-
-class BlobMetricResult(MetricResult):
     result_scope: Literal['module'] | Literal['class'] | Literal['function']
+    level: str | None = None
 
 
 class BlobMetrics(BaseModel):
     type: Literal['blob']
     name: str
     path: str
-    metric_results: list[BlobMetricResult]
-
-
-class TreeMetricResult(MetricResult):
-    result_scope: Literal['program'] | Literal['package']
+    metric_results: list[MetricResult]
 
 
 class TreeMetrics(BaseModel):
     type: Literal['tree']
     name: str
     path: str
-    metric_results: list[TreeMetricResult]
+    metric_results: list[MetricResult]
     trees: list['TreeMetrics']
     blobs: list[BlobMetrics]
 

core/report_generator.py

@@ -3,6 +3,8 @@
 
 from pydantic import BaseModel
 
+from core.git_processor import CommitMeta
+
 from .metrics_calculator import TreeMetrics
 
 
@@ -24,10 +26,17 @@ def __init_subclass__(cls, **kwargs: Any) -> None:
 
             setattr(cls, el, attr)
 
-    def __init__(self, config_dict: dict[str, Any], tree_metrics: TreeMetrics, ref: str) -> None:
+    def __init__(
+        self,
+        config_dict: dict[str, Any],
+        sha: str,
+        commit_meta: CommitMeta,
+        tree_metrics: TreeMetrics,
+    ) -> None:
         self.config = self.validate_config(config_dict)
+        self.sha = sha
+        self.commit_meta = commit_meta
         self.tree_metrics = tree_metrics
-        self.ref = ref
 
     def validate_config(self, config_dict: dict[str, Any]) -> ConfigShapeT:
         return self.config_shape.model_validate(config_dict)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "core"
-version = "0.1.0"
+version = "0.2.0"
 description = ""
 authors = ["Alex Pirogov <pirogovalexandr00@mail.ru>"]
 readme = "README.md"