Provide a new Spring Rule checking that repositories do not depend on…

… services CLoses gh-32
enofex · Jun 19, 2024 · 6ffbf8e · 6ffbf8e
1 parent 75d52d7
commit 6ffbf8e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
@@ -61,6 +61,7 @@ Architecture rules are defined using Taikai's fluent API, allowing developers to
 |            | Repositories   | `namesShouldEndWithRepository`                         | Repositories should end with "Repository"                                                                             | Default (WITHOUT_TESTS) |
 |            | Repositories   | `namesShouldMatch`                                     | Repositories should match a regex pattern                                                                             | Default (WITHOUT_TESTS) |
 |            | Repositories   | `shouldBeAnnotatedWithRepository`                      | Repositories should be annotated with `@Repository`                                                                   | Default (WITHOUT_TESTS) |
+|            | Repositories   | `shouldNotDependOnServices`                            | Repositories should not depend on service classes annotated with `@Service.`                                          | Default (WITHOUT_TESTS) |
 |            | Services       | `namesShouldEndWithService`                            | Services should end with "Service"                                                                                    | Default (WITHOUT_TESTS) |
 |            | Services       | `namesShouldMatch`                                     | Services should match a regex pattern                                                                                 | Default (WITHOUT_TESTS) |
 |            | Services       | `shouldBeAnnotatedWithService`                         | Services should be annotated with `@Service`                                                                          | Default (WITHOUT_TESTS) |
@@ -362,13 +363,14 @@ Taikai.builder()
     .check();
 ```
 
-- **Repositories Configuration**: Ensure that repository classes end with "Repository" or match a specific regex pattern and are annotated with `@Repository`.
+- **Repositories Configuration**: Ensure that repository classes end with "Repository" or match a specific regex pattern and are annotated with `@Repository` and not depend on classes annotated with `@Service`.
 
 ```java
 Taikai.builder()
     .namespace("com.company.yourproject")
     .spring(spring -> spring
         .repositories(repositories -> repositories
+            .shouldNotDependOnServices()
             .shouldBeAnnotatedWithRepository()
             .namesShouldMatch("regex")
             .namesShouldEndWithRepository()))

diff --git a/src/main/java/com/enofex/taikai/spring/RepositoriesConfigurer.java b/src/main/java/com/enofex/taikai/spring/RepositoriesConfigurer.java
@@ -2,7 +2,10 @@
 
 import static com.enofex.taikai.spring.SpringPredicates.ANNOTATION_REPOSITORY;
 import static com.enofex.taikai.spring.SpringPredicates.annotatedWithRepository;
+import static com.enofex.taikai.spring.SpringPredicates.annotatedWithService;
 import static com.tngtech.archunit.lang.conditions.ArchConditions.be;
+import static com.tngtech.archunit.lang.conditions.ArchConditions.dependOnClassesThat;
+import static com.tngtech.archunit.lang.conditions.ArchConditions.not;
 import static com.tngtech.archunit.lang.conditions.ArchPredicates.are;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
 
@@ -58,5 +61,17 @@ public RepositoriesConfigurer shouldBeAnnotatedWithRepository(String regex,
             .as("Repositories should be annotated with %s".formatted(ANNOTATION_REPOSITORY)),
         configuration));
   }
+
+  public RepositoriesConfigurer shouldNotDependOnServices() {
+    return shouldNotDependOnServices(null);
+  }
+
+  public RepositoriesConfigurer shouldNotDependOnServices(Configuration configuration) {
+    return addRule(TaikaiRule.of(classes()
+            .that(are(annotatedWithRepository(true)))
+            .should(not(dependOnClassesThat(annotatedWithService(true))))
+            .as("Repositories should not depend on Services"),
+        configuration));
+  }
 }
 
diff --git a/src/test/java/com/enofex/taikai/Usage.java b/src/test/java/com/enofex/taikai/Usage.java
@@ -27,6 +27,7 @@ public static void main(String[] args) {
                 .namesShouldMatch("regex")
                 .namesShouldEndWithService())
             .repositories(repositories -> repositories
+                .shouldNotDependOnServices()
                 .shouldBeAnnotatedWithRepository()
                 .namesShouldMatch("regex")
                 .namesShouldEndWithRepository()))