fix PlantUmlArchCondition.Configuration not accessible warning

On the contrary to the Java compiler the Kotlin compiler emits a warning that `PlantUmlArchCondition.Configuration` as the parameter type of `PlantUmlArchCondition.adhereToPlantUmlDiagram()` is not accessible (because it is package private). Since in the end the pattern used here is a little inconsistent to other places anyway we change this now to be a publicly accessible class. The current construct was a little strange, either it needs to be a generic interface, freely extensible, but then there does not seem to be a reason to hide it from the user. Or we want to limit the possibilities, but then we might as well use a concrete class. As an additional benefit (since we will break the API anyway with release 1.0) we can now define the factory methods directly on the parameter type removing one indirection. Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
TNG · Jun 19, 2022 · e1680a5 · e1680a5
1 parent 38ff639
commit e1680a5
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 32 deletions.
diff --git a/...unit4/src/test/java/com/tngtech/archunit/exampletest/junit4/PlantUmlArchitectureTest.java b/...unit4/src/test/java/com/tngtech/archunit/exampletest/junit4/PlantUmlArchitectureTest.java
@@ -17,9 +17,9 @@
 import static com.tngtech.archunit.core.domain.JavaClass.Functions.GET_PACKAGE_NAME;
 import static com.tngtech.archunit.core.domain.JavaClass.Predicates.equivalentTo;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringAllDependencies;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInAnyPackage;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInDiagram;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringAllDependencies;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInAnyPackage;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInDiagram;
 import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.adhereToPlantUmlDiagram;
 
 @Category(Example.class)

diff --git a/...unit5/src/test/java/com/tngtech/archunit/exampletest/junit5/PlantUmlArchitectureTest.java b/...unit5/src/test/java/com/tngtech/archunit/exampletest/junit5/PlantUmlArchitectureTest.java
@@ -15,9 +15,9 @@
 import static com.tngtech.archunit.core.domain.JavaClass.Functions.GET_PACKAGE_NAME;
 import static com.tngtech.archunit.core.domain.JavaClass.Predicates.equivalentTo;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringAllDependencies;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInAnyPackage;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInDiagram;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringAllDependencies;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInAnyPackage;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInDiagram;
 import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.adhereToPlantUmlDiagram;
 
 @ArchTag("example")

diff --git a/...xample-plain/src/test/java/com/tngtech/archunit/exampletest/PlantUmlArchitectureTest.java b/...xample-plain/src/test/java/com/tngtech/archunit/exampletest/PlantUmlArchitectureTest.java
@@ -15,9 +15,9 @@
 import static com.tngtech.archunit.core.domain.JavaClass.Functions.GET_PACKAGE_NAME;
 import static com.tngtech.archunit.core.domain.JavaClass.Predicates.equivalentTo;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringAllDependencies;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInAnyPackage;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInDiagram;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringAllDependencies;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInAnyPackage;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInDiagram;
 import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.adhereToPlantUmlDiagram;
 
 @Category(Example.class)

diff --git a/archunit/src/main/java/com/tngtech/archunit/library/plantuml/PlantUmlArchCondition.java b/archunit/src/main/java/com/tngtech/archunit/library/plantuml/PlantUmlArchCondition.java
@@ -21,6 +21,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.List;
+import java.util.function.Function;
 
 import com.google.common.base.Joiner;
 import com.google.common.collect.FluentIterable;
@@ -71,9 +72,9 @@
  * Which dependencies should be considered by the rule can be configured via {@link Configuration}.
  * Candidates are
  * <ul>
- *     <li>{@link Configurations#consideringAllDependencies()}</li>
- *     <li>{@link Configurations#consideringOnlyDependenciesInDiagram()}</li>
- *     <li>{@link Configurations#consideringOnlyDependenciesInAnyPackage(String, String...)}</li>
+ *     <li>{@link Configuration#consideringAllDependencies()}</li>
+ *     <li>{@link Configuration#consideringOnlyDependenciesInDiagram()}</li>
+ *     <li>{@link Configuration#consideringOnlyDependenciesInAnyPackage(String, String...)}</li>
  * </ul>
  * <br>
  * A PlantUML diagram used with ArchUnit must abide by a certain set of rules:
@@ -210,16 +211,32 @@ private static URL toUrl(Path path) {
         }
     }
 
-    public static final class Configurations {
-        private Configurations() {
+    /**
+     * Used to specify which dependencies should be checked by the condition. Possible options are:
+     * <ul>
+     *     <li>{@link #consideringAllDependencies()}</li>
+     *     <li>{@link #consideringOnlyDependenciesInDiagram()}</li>
+     *     <li>{@link #consideringOnlyDependenciesInAnyPackage(String, String...)}</li>
+     * </ul>
+     */
+    @PublicAPI(usage = ACCESS)
+    public static final class Configuration {
+        private final Function<JavaClassDiagramAssociation, DescribedPredicate<Dependency>> createIgnorePredicate;
+
+        private Configuration(Function<JavaClassDiagramAssociation, DescribedPredicate<Dependency>> createIgnorePredicate) {
+            this.createIgnorePredicate = createIgnorePredicate;
+        }
+
+        DescribedPredicate<Dependency> asIgnorePredicate(JavaClassDiagramAssociation javaClassDiagramAssociation) {
+            return createIgnorePredicate.apply(javaClassDiagramAssociation);
         }
 
         /**
          * Considers all dependencies of every imported class, including basic Java classes like {@link Object}
          */
         @PublicAPI(usage = ACCESS)
         public static Configuration consideringAllDependencies() {
-            return javaClassDiagramAssociation -> DescribedPredicate.<Dependency>alwaysFalse().as("");
+            return new Configuration(javaClassDiagramAssociation -> DescribedPredicate.<Dependency>alwaysFalse().as(""));
         }
 
         /**
@@ -229,7 +246,7 @@ public static Configuration consideringAllDependencies() {
          */
         @PublicAPI(usage = ACCESS)
         public static Configuration consideringOnlyDependenciesInDiagram() {
-            return NotContainedInDiagramPredicate::new;
+            return new Configuration(NotContainedInDiagramPredicate::new);
         }
 
         /**
@@ -243,7 +260,7 @@ public static Configuration consideringOnlyDependenciesInAnyPackage(String packa
                     .append(furtherPackageIdentifiers)
                     .toList();
 
-            return javaClassDiagramAssociation -> new NotContainedInPackagesPredicate(packageIdentifiers);
+            return new Configuration(javaClassDiagramAssociation -> new NotContainedInPackagesPredicate(packageIdentifiers));
         }
 
         private static class NotContainedInDiagramPredicate extends DescribedPredicate<Dependency> {
@@ -274,16 +291,4 @@ public boolean test(Dependency input) {
             }
         }
     }
-
-    /**
-     * Used to specify which dependencies should be checked by the condition. Compare concrete instances:
-     * <ul>
-     *     <li>{@link Configurations#consideringAllDependencies()}</li>
-     *     <li>{@link Configurations#consideringOnlyDependenciesInDiagram()}</li>
-     *     <li>{@link Configurations#consideringOnlyDependenciesInAnyPackage(String, String...)}</li>
-     * </ul>
-     */
-    interface Configuration {
-        DescribedPredicate<Dependency> asIgnorePredicate(JavaClassDiagramAssociation javaClassDiagramAssociation);
-    }
 }
diff --git a/archunit/src/test/java/com/tngtech/archunit/library/plantuml/PlantUmlArchConditionTest.java b/archunit/src/test/java/com/tngtech/archunit/library/plantuml/PlantUmlArchConditionTest.java
@@ -35,9 +35,9 @@
 import static com.tngtech.archunit.core.domain.TestUtils.importClasses;
 import static com.tngtech.archunit.lang.ArchRule.Assertions.assertNoViolation;
 import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringAllDependencies;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInAnyPackage;
-import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configurations.consideringOnlyDependenciesInDiagram;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringAllDependencies;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInAnyPackage;
+import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.Configuration.consideringOnlyDependenciesInDiagram;
 import static com.tngtech.archunit.library.plantuml.PlantUmlArchCondition.adhereToPlantUmlDiagram;
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.assertj.core.api.Assertions.assertThat;