Merge pull request #19 from luftfartsverket/13-various-refactoring

BREAKING CHANGE: Refactors reqstool decorators build hook

Author: lfvjimisola

.github/workflows/build.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Install dependencies
         run: pip install hatch
       - name: Run unit and integrations tests
-        run: hatch run test:pytest --cov=reqstool-python-decorators --cov-report=xml --cov-report=html 
+        run: hatch run dev:pytest --cov=reqstool-python-decorators --cov-report=xml --cov-report=html 
       - name: Build project
         run: hatch build
       # Upload artifacts for later use

.github/workflows/lint.yml

@@ -16,6 +16,6 @@ jobs:
       - name: Install pip package(s)
         run: pip install hatch
       - name: Run black formatter check
-        run: hatch run lint:black --check --verbose src tests
+        run: hatch run dev:black --check --verbose src tests
       - name: Run flake8 linter
-        run: hatch run lint:flake8
+        run: hatch run dev:flake8

README.md

@@ -34,7 +34,7 @@ When you declare this in the pyproject.toml file, you are specifying the require
 The plugin can be configured through the `pyproject.toml` file. Configure plugin in `pyproject.toml`as follows;
 
 ```
-[tool.hatch.build.targets.wheel.hooks.decorators]
+[tool.hatch.build.hooks.reqstool_decorators]
 dependencies = ["reqstool-python-hatch-plugin == <version>"]
 path = ["src","tests"]
 

docs/modules/ROOT/pages/usage.adoc

@@ -5,8 +5,8 @@
 
 The plugin can be configured through the `pyproject.toml` file. Configure plugin in `pyproject.toml`as follows;
 
-```
-[tool.hatch.build.targets.wheel.hooks.decorators]
+```toml
+[tool.hatch.build.hooks.reqstool_decorators]
 dependencies = ["reqstool-python-hatch-plugin == <version>"]
 path = ["src","tests"]
 

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling", "hatch-vcs", "build", "twine"]
 build-backend = "hatchling.build"
 
 [tool.pytest.ini_options]
-addopts = ["-s", "--import-mode=importlib"]
+addopts = ["-s", "--import-mode=importlib", "--log-cli-level=DEBUG"]
 pythonpath = [".", "src", "tests"]
 testpaths = ["tests/unit"]
 
@@ -38,8 +38,6 @@ dependencies = [
 
 packages = [{ include = "reqstool_python_hatch_plugin", from = "src" }]
 
-[project.scripts]
-
 [project.entry-points.hatch]
 decorators = "reqstool_python_hatch_plugin.hooks"
 
@@ -49,12 +47,15 @@ source = "vcs"
 [tool.hatch.version.raw-options]
 local_scheme = "no-local-version"
 
-[tool.hatch.envs.test]
-dependencies = ["pytest==8.3.3", "pytest-sugar==1.0.0", "pytest-cov==5.0.0"]
-
-[tool.hatch.envs.lint]
-detached = true
-dependencies = ["black==24.10.0", "flake8==7.1.1", "flake8-pyproject==1.2.3"]
+[tool.hatch.envs.dev]
+dependencies = [
+    "black==24.10.0",
+    "flake8-pyproject==1.2.3",
+    "flake8==7.1.1",
+    "pytest-cov==5.0.0",
+    "pytest-sugar==1.0.0",
+    "pytest==8.3.3",
+]
 
 [tool.black]
 line-length = 120

src/reqstool_python_hatch_plugin/build_hook/hook.py

@@ -0,0 +1,28 @@
+# Copyright © LFV
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+from reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor
+
+
+class ReqstoolDecorators(BuildHookInterface):
+    """
+    Build hook that creates reqstool annotations files based on reqstool decorators.
+    Attributes:
+        PLUGIN_NAME (str): The name of the plugin, set to "reqstool_decorators".
+
+    Methods:
+        initialize(version, build_data):
+            Executes custom actions during the build process, such as processing decorated Python files.
+    """
+
+    PLUGIN_NAME = "reqstool_decorators"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.__config_path = None
+
+    def initialize(self, version, build_data):
+        path = self.config.get("path", [])
+
+        decorator_processor = DecoratorProcessor()
+        decorator_processor.process_decorated_data(path_to_python_files=path)

src/reqstool_python_hatch_plugin/build_hooks/reqstool_decorators.py

@@ -1,9 +1,10 @@
 # Copyright © LFV
 
 from hatchling.plugin import hookimpl
-from reqstool_python_hatch_plugin.build_hook.hook import Decorator
+
+from reqstool_python_hatch_plugin.build_hooks.reqstool_decorators import ReqstoolDecorators
 
 
 @hookimpl
 def hatch_register_build_hook():
-    return Decorator
+    return ReqstoolDecorators