feat: dependencies: allow more importers closes #3 (#16)

"dependencies" template:
Allow multiple importers separated by a ","

Tests
--------

* 2 importers
* package name with _

version 0.5.0

Author: reka

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2023-01-29
+
+* Dependencies rules: Allow multiple importer packages
+
+### Added
+
 ## [0.4.0] - 2023-01-05
 
 ### Added

README.md

@@ -59,8 +59,15 @@ You'll be prompted to provide:
 * a package name
 * the packages that are allowed to import the package above
 
+The 1st parameter is the fully qualified name of a package or module.  
+It can be a package within your project or an external dependency.
+
 The 2nd parameter is optional.  
-E.g. it makes sense to say that no other package should import the `api` or `cli` package of your project.
+You have the following possibilities:
+
+* 0 allowed importer (e.g. for packages like `api`, `cli`). Leave this parameter empty.
+* 1 allowed importer. Provide the importer package's fully qualified name.
+* Multiple allowed importers. Provide multiple fully qualified package names separated by a comma `,`
 
 =>
 
@@ -69,6 +76,11 @@ E.g. it makes sense to say that no other package should import the `api` or `cli
 * 1 for `import` statements
 * 1 for `from ... import` statements
 
+Every generated rule allows imports:
+
+* within the package itself
+* in tests
+
 ## Dependencies Use Cases
 
 ### Internal Dependencies Between the Packages of a Project

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sourcery-rules-generator"
-version = "0.4.0"
+version = "0.5.0"
 description = "Generate architecture rules for Python projects."
 license = "MIT"
 authors = ["reka <reka@sourcery.ai>"]

sourcery_rules_generator/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.0"
+__version__ = "0.5.0"

sourcery_rules_generator/cli/dependencies_cli.py

@@ -26,7 +26,7 @@
 ## Parameters for the "Dependencies" Template
 
 1. The package that gets imported. Required.
-2. The package(s) that are allowed to import the package above. This parameter can be empty.
+2. The package(s) that are allowed to import the package above. This parameter can be empty. You can provide multiple fully qualified package names separated by comma `,`.
 """
 
 
@@ -35,12 +35,12 @@ def create(
     package_option: str = typer.Option(
         None,
         "--package",
-        help="The fully qualified name of the package",
+        help="The fully qualified name of the package. Always exactly 1 package.",
     ),
     caller_option: str = typer.Option(
         None,
         "--importer",
-        help="The fully qualified name of the allowed importer",
+        help="The fully qualified names of the allowed importers separated by comma. This can be 0, 1 or more importers.",
     ),
     interactive_flag: bool = typer.Option(
         True,

sourcery_rules_generator/dependencies.py

@@ -12,19 +12,30 @@ def create_yaml_rules(package: str, allowed_importer: Optional[str]) -> str:
     return yaml_converter.dumps(rules_dict)
 
 
-def create_sourcery_custom_rules(package: str, allowed_importer: Optional[str]) -> str:
+def create_sourcery_custom_rules(
+    package: str, allowed_importer_text: Optional[str]
+) -> str:
     # Dots aren't allowed in the rule ID.
     package_slug = package.replace(".", "-")
 
+    # The dot in the package's fully qualified name
+    # needs to be escaped in the regex used for the condition.
     package_in_regex = package.replace(".", "\.")
-    package_path = package.replace(".", "/")
 
-    exclude_paths = [f"{package_path}/", "tests/"]
-    description = f"Do not import `{package}` in other packages"
-    if allowed_importer:
-        description = f"Only `{allowed_importer}` should import `{package}`"
-        allowed_importer_path = allowed_importer.replace(".", "/")
-        exclude_paths.append(f"{allowed_importer_path}/")
+    exclude_paths = [_path_for_package(package), "tests/"]
+
+    if allowed_importer_text:
+        if "," in allowed_importer_text:
+            allowed_importers = allowed_importer_text.split(",")
+            description = _description_for_multiple_importers(
+                package, allowed_importers
+            )
+            exclude_paths.extend(_path_for_package(impo) for impo in allowed_importers)
+        else:
+            description = _description_for_1_importer(package, allowed_importer_text)
+            exclude_paths.append(_path_for_package(allowed_importer_text))
+    else:
+        description = _description_for_0_importer(package)
 
     import_rule = SourceryCustomRule(
         id=f"dependency-rules-{package_slug}-import",
@@ -45,3 +56,20 @@ def create_sourcery_custom_rules(package: str, allowed_importer: Optional[str])
     )
 
     return (import_rule, from_rule)
+
+
+def _description_for_0_importer(package: str):
+    return f"Do not import `{package}` in other packages"
+
+
+def _description_for_1_importer(package: str, allowed_importer: str):
+    return f"Only `{allowed_importer}` should import `{package}`"
+
+
+def _description_for_multiple_importers(package: str, allowed_importers: list[str]):
+    quoted = [f"`{impo}`" for impo in allowed_importers]
+    return f"Only {', '.join(quoted)} should import `{package}`"
+
+
+def _path_for_package(package: str) -> str:
+    return package.replace(".", "/") + "/"

tests/conftest.py

@@ -9,3 +9,11 @@ def yaml_rules_only_api_imports_core():
         os.path.dirname(__file__),
         "fixtures/dependency-rules/core-imported-only-by-api.yaml",
     ).read_text()
+
+
+@pytest.fixture
+def yaml_rules_only_db_and_db_util_import_sqlalchemy():
+    return Path(
+        os.path.dirname(__file__),
+        "fixtures/dependency-rules/sqlalchemy-imported-only-by-2.yaml",
+    ).read_text()

tests/end-to-end/test_cli.py

@@ -14,3 +14,24 @@ def test_create_dependency_rule_with_1_importer(yaml_rules_only_api_imports_core
     assert result.exit_code == 0
     assert "Generated YAML Rules" in result.stderr
     assert result.stdout == yaml_rules_only_api_imports_core
+
+
+def test_create_dependency_rule_with_2_importers(
+    yaml_rules_only_db_and_db_util_import_sqlalchemy,
+):
+    result = runner.invoke(
+        app,
+        [
+            "dependencies",
+            "create",
+            "--package",
+            "sqlalchemy",
+            "--importer",
+            "app.db,app.db_util",
+            "--plain",
+        ],
+    )
+
+    assert result.exit_code == 0
+    assert "Generated YAML Rules" in result.stderr
+    assert result.stdout == yaml_rules_only_db_and_db_util_import_sqlalchemy

tests/fixtures/dependency-rules/sqlalchemy-imported-only-by-2.yaml

@@ -0,0 +1,28 @@
+rules:
+- id: dependency-rules-sqlalchemy-import
+  description: Only `app.db`, `app.db_util` should import `sqlalchemy`
+  pattern: import ..., ${module}, ...
+  condition: module.matches_regex(r"^sqlalchemy\b")
+  paths:
+    exclude:
+    - sqlalchemy/
+    - tests/
+    - app/db/
+    - app/db_util/
+  tags:
+  - architecture
+  - dependencies
+- id: dependency-rules-sqlalchemy-from
+  description: Only `app.db`, `app.db_util` should import `sqlalchemy`
+  pattern: from ${module} import ...
+  condition: module.matches_regex(r"^sqlalchemy\b")
+  paths:
+    exclude:
+    - sqlalchemy/
+    - tests/
+    - app/db/
+    - app/db_util/
+  tags:
+  - architecture
+  - dependencies
+

tests/test_version.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "0.4.0"
+    assert __version__ == "0.5.0"