Rename naming packagesShouldMatch rule to java classesShouldResideInP…

…ackage rule
enofex · Sep 23, 2024 · 4656059 · 4656059
1 parent 4f9db44
commit 4656059
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 16 deletions.
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
@@ -108,6 +108,7 @@ The default mode is `WITHOUT_TESTS`, which excludes test classes from the import
 |----------|--------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
 | General  | `classesShouldImplementHashCodeAndEquals`              | Classes should implement `hashCode` and `equals` together.                                                   |
 | General  | `classesShouldResideInPackage`                         | Classes matching specific naming patterns should reside in a specified package.                              |
+| General  | `classesShouldResideInPackage`                         | Classes should reside in a specified package.  (e.g., `com.company.project..`).                              |
 | General  | `classesAnnotatedWithShouldResideInPackage`            | Classes annotated with a specific annotation should reside in a specified package.                           |
 | General  | `classesShouldResideOutsidePackage`                    | Classes matching specific naming patterns should reside outside a specified package.                         |
 | General  | `classesShouldBeAnnotatedWith`                         | Classes matching specific naming patterns should be annotated with a specified annotation.                   |
@@ -127,7 +128,6 @@ The default mode is `WITHOUT_TESTS`, which excludes test classes from the import
 | General  | `serialVersionUIDShouldBeStaticFinalLong`              | Fields named `serialVersionUID` should be declared as `static final long`.                                   |
 | Imports  | `shouldHaveNoCycles`                                   | No cyclic dependencies in imports.                                                                           |
 | Imports  | `shouldNotImport`                                      | Disallow specific imports (e.g., `..shaded..`).                                                              |
-| Naming   | `packagesShouldMatch`                                  | Packages should match the specified regex pattern (e.g., `com.company.project..`).                           |
 | Naming   | `classesShouldNotMatch`                                | Classes should not match specific naming patterns (e.g., `.*Impl`).                                          |
 | Naming   | `classesAnnotatedWithShouldMatch`                      | Classes annotated with a specific annotation should match specific naming patterns.                          |
 | Naming   | `methodsShouldNotMatch`                                | Methods should not match specific naming patterns.                                                           |
@@ -228,6 +228,17 @@ Taikai.builder()
     .check();
 ```
 
+- **Classes Should Reside in Specified Package**: Ensure that classes reside in the specified package.
+
+```java
+Taikai.builder()
+    .namespace("com.company.project")
+    .java(java -> java
+        .classesShouldResideInPackage("com.company.project.."))
+    .build()
+    .check();
+```
+
 - **Classes Annotated with Specified Annotation Should Reside in Specified Package**: Ensure that classes annotated with a specific annotation reside in the specified package.
 
 ```java
@@ -403,7 +414,6 @@ Taikai.builder()
     .namespace("com.company.project")
     .java(java -> java
         .naming(naming -> naming
-            .packagesShouldMatch("com.company.project..")
             .classesShouldNotMatch(".*Impl")
             .classesAnnotatedWithShouldMatch(Annotation.class, "coolClass")   
             .classesAnnotatedWithShouldMatch("com.company.project.Annotation", "coolClass")            

diff --git a/src/main/java/com/enofex/taikai/java/JavaConfigurer.java b/src/main/java/com/enofex/taikai/java/JavaConfigurer.java
@@ -112,6 +112,18 @@ public JavaConfigurer noUsageOfDeprecatedAPIs(Configuration configuration) {
     return addRule(TaikaiRule.of(classes().should(notUseDeprecatedAPIs()), configuration));
   }
 
+  public JavaConfigurer classesShouldResideInPackage(String packageIdentifier) {
+    return classesShouldResideInPackage(packageIdentifier, defaultConfiguration());
+  }
+
+  public JavaConfigurer classesShouldResideInPackage(String packageIdentifier,
+      Configuration configuration) {
+    return addRule(TaikaiRule.of(classes()
+            .should().resideInAPackage(packageIdentifier)
+            .as("Package names should match %s".formatted(packageIdentifier)),
+        configuration));
+  }
+
   public JavaConfigurer classesShouldResideInPackage(String regex, String packageIdentifier) {
     return classesShouldResideInPackage(regex, packageIdentifier, defaultConfiguration());
   }

diff --git a/src/main/java/com/enofex/taikai/java/NamingConfigurer.java b/src/main/java/com/enofex/taikai/java/NamingConfigurer.java
@@ -26,18 +26,6 @@ public class NamingConfigurer extends AbstractConfigurer {
     super(configurerContext);
   }
 
-  public NamingConfigurer packagesShouldMatch(String packageIdentifier) {
-    return packagesShouldMatch(packageIdentifier, defaultConfiguration());
-  }
-
-  public NamingConfigurer packagesShouldMatch(String packageIdentifier,
-      Configuration configuration) {
-    return addRule(TaikaiRule.of(classes()
-            .should().resideInAPackage(packageIdentifier)
-            .as("Package names should match %s".formatted(packageIdentifier)),
-        configuration));
-  }
-
   public NamingConfigurer classesShouldNotMatch(String regex) {
     return classesShouldNotMatch(regex, defaultConfiguration());
   }

diff --git a/src/test/java/com/enofex/taikai/ArchitectureTest.java b/src/test/java/com/enofex/taikai/ArchitectureTest.java
@@ -23,13 +23,13 @@ void shouldFulfilConstrains() {
             .methodsShouldNotDeclareGenericExceptions()
             .fieldsShouldNotBePublic()
             .serialVersionUIDFieldsShouldBeStaticFinalLong()
+            .classesShouldResideInPackage("com.enofex.taikai..")
             .imports(imports -> imports
                 .shouldHaveNoCycles()
                 .shouldNotImport("..shaded..")
                 .shouldNotImport("..lombok..")
                 .shouldNotImport("org.junit.."))
             .naming(naming -> naming
-                .packagesShouldMatch("com.enofex.taikai..")
                 .classesShouldNotMatch(".*Impl")
                 .interfacesShouldNotHavePrefixI()
                 .constantsShouldFollowConventions()))

diff --git a/src/test/java/com/enofex/taikai/Usage.java b/src/test/java/com/enofex/taikai/Usage.java
@@ -43,14 +43,14 @@ public static void main(String[] args) {
             .finalClassesShouldNotHaveProtectedMembers()
             .utilityClassesShouldBeFinalAndHavePrivateConstructor()
             .serialVersionUIDFieldsShouldBeStaticFinalLong()
+            .classesShouldResideInPackage("com.enofex.taikai..")
             .imports(imports -> imports
                 .shouldHaveNoCycles()
                 .shouldNotImport("..shaded..")
                 .shouldNotImport("..lombok..")
                 .shouldNotImport("org.junit..")
                 .shouldNotImport(".*ImportsConfigurer", "com.enofex.taikai.TaikaiException"))
             .naming(naming -> naming
-                .packagesShouldMatch("com.enofex.taikai..")
                 .classesShouldNotMatch(".*Impl")
                 .methodsShouldNotMatch("foo")
                 .fieldsShouldNotMatch("bar")