fix: comprehensive tests and bug fixes for decorators and processor (#60)

* fix: comprehensive tests and bug fixes for decorators and processor

- Create missing src/reqstool_python_decorators/decorators/__init__.py
- Fix broken import paths in test resources and README
  (src.reqstool_decorators → reqstool_python_decorators)
- Fix state accumulation bug: reset req_svc_results at start of
  process_decorated_data() to prevent results doubling on repeated calls
- Fix fragile AST elementKind extraction: replace CPython repr parsing
  str(type(node)).split(".")[-1][:-5] with node.__class__.__name__[:-3]
- Add str | os.PathLike to all path/file parameters
- Add test_decorators.py with 7 tests covering Requirements/SVCs decorators
- Expand test_processors.py from 5 to 32 tests covering all previously
  untested methods; standardise fixtures on tmp_path

* style: apply black formatting to decorator_processor

Author: jimisola

README.md

@@ -45,7 +45,7 @@ reqstool-python-decorators = "<version>"
 Import decorators:
 
 ```
-from reqstool-decorators.decorators.decorators import Requirements, SVCs
+from reqstool_python_decorators.decorators.decorators import Requirements, SVCs
 ```
 
 Example usage of the decorators:
@@ -65,7 +65,7 @@ def test_somefunction():
 Import processor:
 
 ```
-from reqstool.processors.decorator_processor import DecoratorProcessor
+from reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor
 ```
 
 Main function to collect decorators data and generate yaml file:

src/reqstool_python_decorators/decorators/__init__.py

@@ -0,0 +1 @@
+# Copyright © LFV

src/reqstool_python_decorators/processors/decorator_processor.py

@@ -49,12 +49,12 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.req_svc_results = []
 
-    def find_python_files(self, directory):
+    def find_python_files(self, directory: str | os.PathLike) -> list[str]:
         """
         Find Python files in the given directory.
 
         Parameters:
-        - `directory` (str): The directory to search for Python files.
+        - `directory` (str | PathLike): The directory to search for Python files.
 
         Returns:
         - `python_files` (list): List of Python files found in the directory.
@@ -66,17 +66,14 @@ def find_python_files(self, directory):
                     python_files.append(os.path.join(root, file))
         return python_files
 
-    def get_functions_and_classes(self, file_path, decorator_names):
+    def get_functions_and_classes(self, file_path: str | os.PathLike, decorator_names: list[str]) -> None:
         """
         Get information about functions and classes, if annotated with "Requirements" or "SVCs":
         decorator filepath, elementKind, name and decorators is saved to list that is returned.
 
         Parameters:
-        - `file_path` (str): The path to the Python file.
-        - `decorator_names` (list): List of decorator names to search for.
-
-        Returns:
-        - `results` (list): List of dictionaries containing information about functions and classes.
+        - `file_path` (str | PathLike): The path to the Python file.
+        - `decorator_names` (list[str]): List of decorator names to search for.
 
         Each dictionary includes:
             - `fullyQualifiedName` (str): The fully qualified name of the file.
@@ -85,7 +82,7 @@ def get_functions_and_classes(self, file_path, decorator_names):
             - `decorators` (list): List of dictionaries with decorator info including name and arguments e.g. "REQ_001".
         """
         with open(file_path, "r") as file:
-            tree = ast.parse(file.read(), filename=file_path)
+            tree = ast.parse(file.read(), filename=str(file_path))
 
         for node in ast.walk(tree):
             if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef, ast.ClassDef)):
@@ -100,18 +97,18 @@ def get_functions_and_classes(self, file_path, decorator_names):
                     self.req_svc_results.append(
                         {
                             "fullyQualifiedName": str(file_path).replace("/", "."),
-                            "elementKind": str(type(node)).split(".")[-1][:-5].upper(),
+                            "elementKind": node.__class__.__name__[:-3].upper(),
                             "name": node.name,
                             "decorators": decorators_info,
                         }
                     )
 
-    def write_to_yaml(self, output_file, formatted_data):
+    def write_to_yaml(self, output_file: str | os.PathLike, formatted_data) -> None:
         """
         Write formatted data to a YAML file.
 
         Parameters:
-        - `output_file` (str): The path to the output YAML file.
+        - `output_file` (str | PathLike): The path to the output YAML file.
         - `formatted_data` (dict): The formatted data to be written to the YAML file.
 
         Writes the formatted data to the specified YAML file.
@@ -135,7 +132,7 @@ def map_type(self, input_str) -> str:
         mapping = {item.from_value: item.to_value for item in DECORATOR_TYPES}
         return mapping.get(input_str, input_str)
 
-    def format_results(self, results):
+    def format_results(self, results) -> dict:
         """
         Format the collected results into a structured data format for YAML.
 
@@ -174,31 +171,35 @@ def format_results(self, results):
 
         return formatted_data
 
-    def create_dir_from_path(self, filepath: str) -> None:
+    def create_dir_from_path(self, filepath: str | os.PathLike) -> None:
         """
         Creates directory of provided filepath if it does not exists
 
         Parameters:
-        - `filepath` (str): Filepath to check and create directory from.
+        - `filepath` (str | PathLike): Filepath to check and create directory from.
         """
         directory = os.path.dirname(filepath)
         if not os.path.exists(directory):
             os.makedirs(directory)
 
     def process_decorated_data(
-        self, path_to_python_files: str, output_file: str = "build/reqstool/annotations.yml"
+        self,
+        path_to_python_files: list[str | os.PathLike],
+        output_file: str | os.PathLike = "build/reqstool/annotations.yml",
     ) -> None:
         """
         "Main" function, runs all functions resulting in  a yaml file containing decorated data.
 
         Parameters:
         - `path_to_python_files` (list): List of directories containing Python files.
-        - `output_file` (str): Set path for output file, defaults to build/annotations.yml
+        - `output_file` (str | PathLike): Set path for output file, defaults to build/annotations.yml
 
         This method takes a list of directories containing Python files, collects decorated data from these files,
         formats the collected data, and writes the formatted results to YAML file for Requirements and SVCs annotations.
         """
 
+        self.req_svc_results = []
+
         for path in path_to_python_files:
             python_files = self.find_python_files(directory=path)
             for file_path in python_files:

tests/resources/test_decorators/requirements_decorators.py

@@ -1,4 +1,4 @@
-from src.reqstool_decorators.decorators.decorators import Requirements
+from reqstool_python_decorators.decorators.decorators import Requirements
 
 
 @Requirements("REQ_001", "REQ_222")

tests/resources/test_decorators/svc_decorators.py

@@ -1,4 +1,4 @@
-from src.reqstool_decorators.decorators.decorators import SVCs
+from reqstool_python_decorators.decorators.decorators import SVCs
 
 
 @SVCs("SVC_999")