archunitpython 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

archunitpython/__init__.py

@@ -1,6 +1,6 @@
 """ArchUnitPython - Architecture testing library for Python projects."""
 
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 
 # Files API
 # Common
@@ -12,6 +12,7 @@ from archunitpython.common import (
     Violation,
 )
 from archunitpython.common.extraction import clear_graph_cache, extract_graph
+from archunitpython.config import ConfiguredRule, rules_from_config
 from archunitpython.files import files, project_files
 from archunitpython.graph import dependency_graph, project_graph
 from archunitpython.layers import layers, project_layers
@@ -35,6 +36,9 @@ __all__ = [
     # Layers
     "project_layers",
     "layers",
+    # Config
+    "rules_from_config",
+    "ConfiguredRule",
     # Slices
     "project_slices",
     # Metrics

archunitpython/config/__init__.py

@@ -0,0 +1,5 @@
+"""Configuration-file support for common architecture rules."""
+
+from archunitpython.config.loader import ConfiguredRule, rules_from_config
+
+__all__ = ["ConfiguredRule", "rules_from_config"]

archunitpython/config/loader.py

@@ -0,0 +1,119 @@
+"""Load common architecture rules from a JSON configuration file."""
+
+from __future__ import annotations
+
+import json
+import os
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+from archunitpython.common.assertion.violation import Violation
+from archunitpython.common.error.errors import UserError
+from archunitpython.common.fluentapi.checkable import Checkable, CheckOptions
+from archunitpython.files.fluentapi.files import project_files
+
+
+@dataclass(frozen=True)
+class ConfiguredRule:
+    """A named rule loaded from a configuration file."""
+
+    name: str
+    rule: Checkable
+
+    def check(self, options: CheckOptions | None = None) -> list[Violation]:
+        """Run the configured rule."""
+        return self.rule.check(options)
+
+
+def rules_from_config(config_path: str) -> list[ConfiguredRule]:
+    """Load common architecture rules from a JSON config file.
+
+    The fluent Python API remains the primary interface. Config files provide a
+    lightweight way to share straightforward rules across projects or teams.
+    """
+    path = Path(config_path)
+    try:
+        raw_config = json.loads(path.read_text(encoding="utf-8"))
+    except OSError as exc:
+        raise UserError(f"Could not read config file: {config_path}") from exc
+    except json.JSONDecodeError as exc:
+        raise UserError(f"Invalid JSON config file: {config_path}") from exc
+
+    if not isinstance(raw_config, dict):
+        raise UserError("Architecture config must be a JSON object.")
+
+    project_path = _optional_string(raw_config, "project_path") or os.getcwd()
+    rules = raw_config.get("rules")
+    if not isinstance(rules, list):
+        raise UserError("Architecture config must define a 'rules' list.")
+
+    base_dir = str(path.parent if path.parent != Path("") else Path.cwd())
+    resolved_project_path = _resolve_project_path(base_dir, project_path)
+
+    return [_build_rule(resolved_project_path, item, index) for index, item in enumerate(rules, 1)]
+
+
+def _build_rule(project_path: str, item: Any, index: int) -> ConfiguredRule:
+    if not isinstance(item, dict):
+        raise UserError(f"Rule #{index} must be a JSON object.")
+
+    rule_type = _required_string(item, "type", index)
+    name = _optional_string(item, "name") or f"{rule_type} rule #{index}"
+    rule: Checkable
+    if rule_type == "no_cycles":
+        subject = _optional_string(item, "subject")
+        builder = project_files(project_path)
+        if subject is not None:
+            rule = builder.in_path(subject).should().have_no_cycles()
+        else:
+            rule = builder.should().have_no_cycles()
+    elif rule_type == "forbidden_dependency":
+        source = _required_string(item, "source", index)
+        target = _required_string(item, "target", index)
+        rule = (
+            project_files(project_path)
+            .in_path(source)
+            .should_not()
+            .depend_on_files()
+            .in_path(target)
+        )
+    elif rule_type == "forbidden_external_dependency":
+        source = _required_string(item, "source", index)
+        module = _required_string(item, "module", index)
+        rule = (
+            project_files(project_path)
+            .in_path(source)
+            .should_not()
+            .depend_on_external_modules()
+            .matching(module)
+        )
+    else:
+        raise UserError(
+            f"Unsupported rule type '{rule_type}'. Supported types: "
+            "no_cycles, forbidden_dependency, forbidden_external_dependency."
+        )
+
+    return ConfiguredRule(name=name, rule=rule)
+
+
+def _resolve_project_path(base_dir: str, project_path: str) -> str:
+    if os.path.isabs(project_path):
+        return project_path
+    return os.path.abspath(os.path.join(base_dir, project_path))
+
+
+def _required_string(rule: dict[str, Any], key: str, index: int) -> str:
+    value = rule.get(key)
+    if not isinstance(value, str) or not value.strip():
+        raise UserError(f"Rule #{index} must define a non-empty string '{key}'.")
+    return value
+
+
+def _optional_string(rule: dict[str, Any], key: str) -> str | None:
+    value = rule.get(key)
+    if value is None:
+        return None
+    if not isinstance(value, str) or not value.strip():
+        raise UserError(f"Config value '{key}' must be a non-empty string.")
+    return value

{archunitpython-1.4.0.dist-info → archunitpython-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archunitpython
-Version: 1.4.0
+Version: 1.5.0
 Summary: Architecture testing library for Python projects. Enforce dependency rules, detect cycles, validate metrics.
 Project-URL: Homepage, https://github.com/LukasNiessen/ArchUnitPython
 Project-URL: Repository, https://github.com/LukasNiessen/ArchUnitPython.git
@@ -206,6 +206,42 @@ migrations/*.py
 
 Patterns support comments, blank lines, glob syntax, root-relative paths, path
 patterns, and directory patterns with a trailing `/`.
+
+### Loading Common Rules From Config
+
+For straightforward shared rules, you can load a JSON config file and still run
+the resulting rules in your normal test suite:
+
+```json
+{
+  "project_path": "src",
+  "rules": [
+    {
+      "name": "controllers must not use services directly",
+      "type": "forbidden_dependency",
+      "source": "**/controllers/**",
+      "target": "**/services/**"
+    },
+    {
+      "name": "source files have no cycles",
+      "type": "no_cycles"
+    }
+  ]
+}
+```
+
+```python
+from archunitpython import assert_passes, rules_from_config
+
+def test_configured_architecture_rules():
+    for rule in rules_from_config("archunitpython.json"):
+        assert_passes(rule)
+```
+
+Supported rule types are `no_cycles`, `forbidden_dependency`, and
+`forbidden_external_dependency`. The fluent Python API remains the primary and
+most flexible interface.
+
 ### Explaining Rules With `.because(...)`
 
 Attach a rationale to a rule so failing assertions explain why the rule exists:

{archunitpython-1.4.0.dist-info → archunitpython-1.5.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-archunitpython/__init__.py,sha256=8MQMKFXjGNHJdCtifcWJcAgXLkjqJhDiXYxqp2fmxlQ,1154
+archunitpython/__init__.py,sha256=nXfB-DvtQN-2XR6XM87aM1E71BpqDbTBe-wJLLCgWEs,1282
 archunitpython/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 archunitpython/common/__init__.py,sha256=TKL39Z0kBpWqMH99jU4LsDSUZ5lQ_rcAJfLnmUTDTOI,656
 archunitpython/common/pattern_matching.py,sha256=HMAfo8GsooHvA4d2IxCi3btrYTdwfOQXw4bDNr117P0,2669
@@ -30,6 +30,8 @@ archunitpython/common/projection/cycles/tarjan_scc.py,sha256=pIj1ub8XgcqVLj8skdZ
 archunitpython/common/util/__init__.py,sha256=g-W8kWiVqwdohxm74J3yUonPkb_yDUJrp73S5s4jpgI,117
 archunitpython/common/util/declaration_detector.py,sha256=XgrpgaUIQa9MNFlnhVQz2X_uW7zCO9nrMbGa3tVFyPM,3407
 archunitpython/common/util/logger.py,sha256=2did2mRAlkrElH9SYgv9xYiSzr4A-jXHg3cp6TodhoA,3326
+archunitpython/config/__init__.py,sha256=jl8qQ040ej2h7KOxzNx4Xtct89YKCDZA2kcdJ-RiNK0,191
+archunitpython/config/loader.py,sha256=sXsq8X3rijBT2C_t5EEn1GC-22ZVxxLYcFU4Fuinkcc,4301
 archunitpython/files/__init__.py,sha256=wgl8IOqTeQGpNISu-Q8b_j6rTn8aEgoz6t1S5j8z13g,108
 archunitpython/files/assertion/__init__.py,sha256=K2qiEFfmo6SCgxfOKNrPzYgT5ScKUaw2W2CrDa3jBTw,1068
 archunitpython/files/assertion/custom_file_logic.py,sha256=1v5D80QX_NnAKBwKwyhetY4rA8rrXyxN2BsHlvnLgq8,2956
@@ -77,7 +79,7 @@ archunitpython/testing/common/__init__.py,sha256=Wc4bC-N4t6giChKjj6wuTGKkb39thcY
 archunitpython/testing/common/color_utils.py,sha256=2I8Z1SZfWhhgudMgmXY6PPydGxGl35cK_To-GXnSyJg,1226
 archunitpython/testing/common/violation_factory.py,sha256=yWlvv2U7u-7KoTMfp1QCeJXxTLpPEagKqDHZmPSyrlk,4677
 archunitpython/testing/pytest_plugin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-archunitpython-1.4.0.dist-info/METADATA,sha256=z6zirY281brtJcOrmADYb_Mrll-MNzEC6GKuTPQRkA4,30762
-archunitpython-1.4.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-archunitpython-1.4.0.dist-info/licenses/LICENSE,sha256=kaQWfzfHk45CNIx4sIW7Uf1sNW5rmo6BpZ-R8GruuK0,1102
-archunitpython-1.4.0.dist-info/RECORD,,
+archunitpython-1.5.0.dist-info/METADATA,sha256=ek9DQj2hd0a0h-tvws_nnelozR1PzhZNBLWouBBH0aM,31627
+archunitpython-1.5.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+archunitpython-1.5.0.dist-info/licenses/LICENSE,sha256=kaQWfzfHk45CNIx4sIW7Uf1sNW5rmo6BpZ-R8GruuK0,1102
+archunitpython-1.5.0.dist-info/RECORD,,