fix: Update schema url add output parameter and rename class (#12)

* fix: Update schema url added output parameter and rename class

* fix: Add inline commet for flake8 to ignore E501 line too long

* fix: Clean up code and update documentation

* fix: Specify E501 in inline comment for flake8 to ignore

* WIP

* WIP

Author: lfvdavid

docs/modules/ROOT/pages/usage.adoc

@@ -42,17 +42,16 @@ def test_somefunction():
 Import processor:
 
 ```
-from reqstool_python_decorators.processors.decorator_processor import ProcessDecorator
+from reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor
 ```
 
 Main function to collect decorators data and generate yaml file:
 
 ```
-process_decorated_data(path_to_python_files)
+process_decorated_data(path_to_python_files, output_file)
 ```
 
-Here `path_to_python_files` is the directories to search through to find decorated code.
+`path_to_python_files` is the directories to search through to find decorated code.
 
-*Note:*
+`output_file` is output file(path) the yaml file is stored to
 
-Yaml file is saved into the `/dist` folder, make sure the folder exists before running the `process_decorated_data` function.

src/reqstool_python_decorators/processors/decorator_processor.py

@@ -18,7 +18,7 @@ def get_from_to(self):
         return f"from: {self.from_value}, to: {self.to_value}"
 
 
-class ProcessDecorator:
+class DecoratorProcessor:
     """
     A class for collecting and processing Requirements and SVCs annotations on functions and classes in a directory.
 
@@ -30,11 +30,8 @@ class ProcessDecorator:
     """
 
     decorators_to_search = ["Requirements", "SVCs"]
-    reqsvc_yaml_path = "dist/all_annotations.yml"
 
-    yaml_language_server = (
-        "# yaml-language-server: $schema=https://schemas.se/requirements-tool/v1/annotations.schema.json\n"
-    )
+    yaml_language_server = "# yaml-language-server: $schema=https://raw.githubusercontent.com/Luftfartsverket/reqstool-client/main/src/reqstool/resources/schemas/v1/annotations.schema.json\n"  # noqa: E501
 
     def __init__(self, *args, **kwargs):
         """
@@ -176,12 +173,24 @@ def format_results(self, results):
 
         return formatted_data
 
-    def process_decorated_data(self, path_to_python_files):
+    def create_dir_from_path(self, filepath: str):
+        """
+        Creates directory of provided filepath if it does not exists
+
+        Parameters:
+        - `filepath` (str): 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, output_file="build/annotations.yml"):
         """
         "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
 
         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.
@@ -191,6 +200,8 @@ def process_decorated_data(self, path_to_python_files):
             python_files = self.find_python_files(directory=path)
             for file_path in python_files:
                 self.get_functions_and_classes(file_path=file_path, decorator_names=self.decorators_to_search)
+
         formatted_reqsvc_data = self.format_results(results=self.req_svc_results)
-        reqsvc_yaml_path = "dist/annotations.yml"
-        self.write_to_yaml(output_file=reqsvc_yaml_path, formatted_data=formatted_reqsvc_data)
+
+        self.create_dir_from_path(output_file)
+        self.write_to_yaml(output_file=output_file, formatted_data=formatted_reqsvc_data)

tests/unit/reqstool_decorators/processors/test_processors.py

@@ -1,20 +1,20 @@
 import pytest
-from src.reqstool_python_decorators.processors.decorator_processor import ProcessDecorator
+from src.reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor
 from ruamel.yaml import YAML
 
 
 @pytest.fixture
 def process_decorator_instance():
-    return ProcessDecorator()
+    return DecoratorProcessor()
 
 
-def test_find_python_files(process_decorator_instance: ProcessDecorator, tmpdir):
+def test_find_python_files(process_decorator_instance: DecoratorProcessor, tmpdir):
     tmpdir.join("pythonfile.py").write("content")
     result = process_decorator_instance.find_python_files(tmpdir)
     assert result == [str(tmpdir.join("pythonfile.py"))]
 
 
-def test_get_functions_and_classes(process_decorator_instance: ProcessDecorator, tmpdir):
+def test_get_functions_and_classes(process_decorator_instance: DecoratorProcessor, tmpdir):
     file_path = str(tmpdir.join("test_file.py"))
     tmpdir.join("test_file.py").write('@SVCs("SVC_001")\nclass Test:\n  pass')
     process_decorator_instance.get_functions_and_classes(file_path, ["SVCs"])
@@ -24,20 +24,18 @@ def test_get_functions_and_classes(process_decorator_instance: ProcessDecorator,
     assert process_decorator_instance.req_svc_results[0]["elementKind"] == "CLASS"
 
 
-def test_map_type_known_type(process_decorator_instance: ProcessDecorator):
+def test_map_type_known_type(process_decorator_instance: DecoratorProcessor):
     result = process_decorator_instance.map_type("FUNCTION")
     assert result == "METHOD"
 
 
-def test_map_type_unknown_type(process_decorator_instance: ProcessDecorator):
+def test_map_type_unknown_type(process_decorator_instance: DecoratorProcessor):
     result = process_decorator_instance.map_type("CLASS")
     assert result == "CLASS"
 
 
-def test_write_to_yaml(process_decorator_instance: ProcessDecorator, tmp_path):
-    yaml_language_server = (
-        "# yaml-language-server: $schema=https://schemas.se/requirements-tool/v1/annotations.schema.json"
-    )
+def test_write_to_yaml(process_decorator_instance: DecoratorProcessor, tmp_path):
+    yaml_language_server = "# yaml-language-server: $schema=https://raw.githubusercontent.com/Luftfartsverket/reqstool-client/main/src/reqstool/resources/schemas/v1/annotations.schema.json\n"  # noqa: E501
 
     test_output_file = tmp_path / "test_output.yml"
     sample_formatted_data = """
@@ -59,7 +57,7 @@ def test_write_to_yaml(process_decorator_instance: ProcessDecorator, tmp_path):
         assert sample_formatted_data == loaded_data
 
 
-@pytest.mark.skip(reason="Test manually and check structure of the annotations.yml file generated in dist folder")
-def test_process_decorated_data(process_decorator_instance: ProcessDecorator):
+@pytest.mark.skip(reason="Test manually and check structure of the annotations.yml file generated in build folder")
+def test_process_decorated_data(process_decorator_instance: DecoratorProcessor):
     paths = ["tests"]
     process_decorator_instance.process_decorated_data(path_to_python_files=paths)