Add generic superclasses #503

As a next step to fully support generics within ArchUnit this PR adds support for generic superclasses. In particular

* add `Optional<JavaType> JavaClass.getSuperclass()`, which will return a `JavaParameterizedType` for a parameterized superclass and the raw type otherwise
* add all type arguments of generic superclasses to `JavaClass.directDependencies{From/To}Self`

Example: ArchUnit would now detect `String` as a `Dependency` of `class Foo extends Base<List<? super String>>`

It contains a minor breaking change: Before it was possible to receive a `JavaParameterizedType` without any type arguments. I.e. for `class Foo<T extends String>` the upper bound of `T` would actually be a `JavaParameterizedType` of type `String` without any type arguments. This is inconsistent to the Java Reflection API (and doesn't really make sense), so I have changed this within the PR to return a `JavaClass` instead. If any users of ArchUnit `0.15.0` (where this API was introduced) would use this low-level API and assumed that every `JavaType` within a type signature is either `JavaTypeVariable`, `JavaWildcard` or `JavaParameterizedType`, then this code might break now. I consider the danger slim though, because most users are probably either just interested in the `Dependencies` caused by type parameter bounds (which haven't changed) or handle all possible subclasses of `JavaType`, which would then include `JavaClass` again.

archunit-example/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/SessionBeanRulesTest.java

@@ -66,8 +66,8 @@ private static DescribedPredicate<JavaClass> haveLocalBeanSubclass() {
         return new DescribedPredicate<JavaClass>("have subclass that is a local bean") {
             @Override
             public boolean apply(JavaClass input) {
-                for (JavaClass subClass : input.getAllSubClasses()) {
-                    if (isLocalBeanImplementation(subClass, input)) {
+                for (JavaClass subclass : input.getAllSubclasses()) {
+                    if (isLocalBeanImplementation(subclass, input)) {
                         return true;
                     }
                 }
@@ -93,13 +93,13 @@ private static ArchCondition<JavaClass> haveAUniqueImplementation() {
             @Override
             public void check(JavaClass businessInterface, ConditionEvents events) {
                 events.add(new SimpleConditionEvent(businessInterface,
-                        businessInterface.getAllSubClasses().size() <= 1,
+                        businessInterface.getAllSubclasses().size() <= 1,
                         describe(businessInterface)));
             }
 
             private String describe(JavaClass businessInterface) {
                 return String.format("%s is implemented by %s",
-                        businessInterface.getSimpleName(), joinNamesOf(businessInterface.getAllSubClasses()));
+                        businessInterface.getSimpleName(), joinNamesOf(businessInterface.getAllSubclasses()));
             }
 
             private String joinNamesOf(Set<JavaClass> implementations) {

archunit-example/example-junit4/src/test/java/com/tngtech/archunit/exampletest/junit4/ThirdPartyRulesTest.java

@@ -42,10 +42,10 @@ private static ArchCondition<JavaClass> notCreateProblematicClassesOutsideOfWork
                 target(is(constructor())).and(targetOwner(is(assignableTo(ThirdPartyClassWithProblem.class))));
 
         DescribedPredicate<JavaCall<?>> notFromWithinThirdPartyClass =
-                originOwner(is(not(assignableTo(ThirdPartyClassWithProblem.class)))).forSubType();
+                originOwner(is(not(assignableTo(ThirdPartyClassWithProblem.class)))).forSubtype();
 
         DescribedPredicate<JavaCall<?>> notFromWorkaroundFactory =
-                originOwner(is(not(equivalentTo(ThirdPartyClassWorkaroundFactory.class)))).forSubType();
+                originOwner(is(not(equivalentTo(ThirdPartyClassWorkaroundFactory.class)))).forSubtype();
 
         DescribedPredicate<JavaCall<?>> targetIsIllegalConstructorOfThirdPartyClass =
                 constructorCallOfThirdPartyClass.

archunit-example/example-junit4/src/test/resources/frozen/a81a2b54-5a18-4145-b544-7a580aba0425

@@ -2,8 +2,10 @@ Class <com.tngtech.archunit.example.layers.persistence.layerviolation.DaoCalling
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> has annotation member of type <com.tngtech.archunit.example.layers.service.ServiceType> in (ServiceViolatingLayerRules.java:0)
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> has annotation member of type <com.tngtech.archunit.example.layers.service.SimpleServiceAnnotation> in (ServiceViolatingLayerRules.java:0)
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> is annotated with <com.tngtech.archunit.example.layers.service.ComplexServiceAnnotation> in (ServiceViolatingLayerRules.java:0)
+Class <com.tngtech.archunit.example.layers.service.SpecialServiceHelper> extends class <com.tngtech.archunit.example.layers.service.ServiceHelper> in (SpecialServiceHelper.java:0)
 Class <com.tngtech.archunit.example.layers.service.impl.ServiceImplementation> implements interface <com.tngtech.archunit.example.layers.service.ServiceInterface> in (ServiceImplementation.java:0)
 Constructor <com.tngtech.archunit.example.layers.SomeMediator.<init>(com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules)> has parameter of type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeMediator.java:0)
+Constructor <com.tngtech.archunit.example.layers.service.SpecialServiceHelper.<init>()> calls constructor <com.tngtech.archunit.example.layers.service.ServiceHelper.<init>()> in (SpecialServiceHelper.java:9)
 Field <com.tngtech.archunit.example.layers.SomeMediator.service> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeMediator.java:0)
 Field <com.tngtech.archunit.example.layers.controller.SomeController.otherService> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeController.java:0)
 Field <com.tngtech.archunit.example.layers.controller.SomeController.service> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingDaoRules> in (SomeController.java:0)

archunit-example/example-junit5/src/test/java/com/tngtech/archunit/exampletest/junit5/SessionBeanRulesTest.java

@@ -63,8 +63,8 @@ private static DescribedPredicate<JavaClass> haveLocalBeanSubclass() {
         return new DescribedPredicate<JavaClass>("have subclass that is a local bean") {
             @Override
             public boolean apply(JavaClass input) {
-                for (JavaClass subClass : input.getAllSubClasses()) {
-                    if (isLocalBeanImplementation(subClass, input)) {
+                for (JavaClass subclass : input.getAllSubclasses()) {
+                    if (isLocalBeanImplementation(subclass, input)) {
                         return true;
                     }
                 }
@@ -90,13 +90,13 @@ private static ArchCondition<JavaClass> haveAUniqueImplementation() {
             @Override
             public void check(JavaClass businessInterface, ConditionEvents events) {
                 events.add(new SimpleConditionEvent(businessInterface,
-                        businessInterface.getAllSubClasses().size() <= 1,
+                        businessInterface.getAllSubclasses().size() <= 1,
                         describe(businessInterface)));
             }
 
             private String describe(JavaClass businessInterface) {
                 return String.format("%s is implemented by %s",
-                        businessInterface.getSimpleName(), joinNamesOf(businessInterface.getAllSubClasses()));
+                        businessInterface.getSimpleName(), joinNamesOf(businessInterface.getAllSubclasses()));
             }
 
             private String joinNamesOf(Set<JavaClass> implementations) {

archunit-example/example-junit5/src/test/java/com/tngtech/archunit/exampletest/junit5/ThirdPartyRulesTest.java

@@ -39,10 +39,10 @@ private static ArchCondition<JavaClass> notCreateProblematicClassesOutsideOfWork
                 target(is(constructor())).and(targetOwner(is(assignableTo(ThirdPartyClassWithProblem.class))));
 
         DescribedPredicate<JavaCall<?>> notFromWithinThirdPartyClass =
-                originOwner(is(not(assignableTo(ThirdPartyClassWithProblem.class)))).forSubType();
+                originOwner(is(not(assignableTo(ThirdPartyClassWithProblem.class)))).forSubtype();
 
         DescribedPredicate<JavaCall<?>> notFromWorkaroundFactory =
-                originOwner(is(not(equivalentTo(ThirdPartyClassWorkaroundFactory.class)))).forSubType();
+                originOwner(is(not(equivalentTo(ThirdPartyClassWorkaroundFactory.class)))).forSubtype();
 
         DescribedPredicate<JavaCall<?>> targetIsIllegalConstructorOfThirdPartyClass =
                 constructorCallOfThirdPartyClass.

archunit-example/example-junit5/src/test/resources/frozen/a81a2b54-5a18-4145-b544-7a580aba0425

@@ -2,8 +2,10 @@ Class <com.tngtech.archunit.example.layers.persistence.layerviolation.DaoCalling
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> has annotation member of type <com.tngtech.archunit.example.layers.service.ServiceType> in (ServiceViolatingLayerRules.java:0)
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> has annotation member of type <com.tngtech.archunit.example.layers.service.SimpleServiceAnnotation> in (ServiceViolatingLayerRules.java:0)
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> is annotated with <com.tngtech.archunit.example.layers.service.ComplexServiceAnnotation> in (ServiceViolatingLayerRules.java:0)
+Class <com.tngtech.archunit.example.layers.service.SpecialServiceHelper> extends class <com.tngtech.archunit.example.layers.service.ServiceHelper> in (SpecialServiceHelper.java:0)
 Class <com.tngtech.archunit.example.layers.service.impl.ServiceImplementation> implements interface <com.tngtech.archunit.example.layers.service.ServiceInterface> in (ServiceImplementation.java:0)
 Constructor <com.tngtech.archunit.example.layers.SomeMediator.<init>(com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules)> has parameter of type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeMediator.java:0)
+Constructor <com.tngtech.archunit.example.layers.service.SpecialServiceHelper.<init>()> calls constructor <com.tngtech.archunit.example.layers.service.ServiceHelper.<init>()> in (SpecialServiceHelper.java:9)
 Field <com.tngtech.archunit.example.layers.SomeMediator.service> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeMediator.java:0)
 Field <com.tngtech.archunit.example.layers.controller.SomeController.otherService> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeController.java:0)
 Field <com.tngtech.archunit.example.layers.controller.SomeController.service> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingDaoRules> in (SomeController.java:0)

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/layers/ClassViolatingThirdPartyRules.java

@@ -2,7 +2,7 @@
 
 import com.tngtech.archunit.example.layers.thirdparty.ThirdPartyClassWithProblem;
 import com.tngtech.archunit.example.layers.thirdparty.ThirdPartyClassWorkaroundFactory;
-import com.tngtech.archunit.example.layers.thirdparty.ThirdPartySubClassWithProblem;
+import com.tngtech.archunit.example.layers.thirdparty.ThirdPartySubclassWithProblem;
 
 public class ClassViolatingThirdPartyRules {
     ThirdPartyClassWithProblem illegallyInstantiateThirdPartyClass() {
@@ -13,11 +13,11 @@ ThirdPartyClassWithProblem correctlyInstantiateThirdPartyClass() {
         return new ThirdPartyClassWorkaroundFactory().create();
     }
 
-    ThirdPartySubClassWithProblem illegallyInstantiateThirdPartySubClass() {
-        return new ThirdPartySubClassWithProblem();
+    ThirdPartySubclassWithProblem illegallyInstantiateThirdPartySubclass() {
+        return new ThirdPartySubclassWithProblem();
     }
 
-    ThirdPartySubClassWithProblem correctlyInstantiateThirdPartySubClass() {
-        return new ThirdPartyClassWorkaroundFactory().createSubClass();
+    ThirdPartySubclassWithProblem correctlyInstantiateThirdPartySubclass() {
+        return new ThirdPartyClassWorkaroundFactory().createSubclass();
     }
 }

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/layers/service/SpecialServiceHelper.java

@@ -0,0 +1,10 @@
+package com.tngtech.archunit.example.layers.service;
+
+import java.util.HashMap;
+import java.util.Set;
+
+import com.tngtech.archunit.example.layers.controller.SomeUtility;
+import com.tngtech.archunit.example.layers.controller.one.SomeEnum;
+
+public class SpecialServiceHelper extends ServiceHelper<SomeUtility, HashMap<?, Set<? super SomeEnum>>> {
+}

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/layers/thirdparty/ThirdPartyClassWorkaroundFactory.java

@@ -9,8 +9,8 @@ public ThirdPartyClassWithProblem create() {
         return new ThirdPartyClassWithProblem();
     }
 
-    public ThirdPartySubClassWithProblem createSubClass() {
+    public ThirdPartySubclassWithProblem createSubclass() {
         // some workaround here
-        return new ThirdPartySubClassWithProblem();
+        return new ThirdPartySubclassWithProblem();
     }
 }

archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/layers/thirdparty/ThirdPartySubClassWithProblem.java → archunit-example/example-plain/src/main/java/com/tngtech/archunit/example/layers/thirdparty/ThirdPartySubclassWithProblem.java

@@ -1,4 +1,4 @@
 package com.tngtech.archunit.example.layers.thirdparty;
 
-public class ThirdPartySubClassWithProblem extends ThirdPartyClassWithProblem {
+public class ThirdPartySubclassWithProblem extends ThirdPartyClassWithProblem {
 }

archunit-example/example-plain/src/test/java/com/tngtech/archunit/exampletest/SessionBeanRulesTest.java

@@ -65,8 +65,8 @@ private static DescribedPredicate<JavaAccess<?>> originNeitherConstructorNorPost
             new DescribedPredicate<JavaClass>("have subclass that is a local bean") {
                 @Override
                 public boolean apply(JavaClass input) {
-                    for (JavaClass subClass : input.getAllSubClasses()) {
-                        if (isLocalBeanImplementation(subClass, input)) {
+                    for (JavaClass subclass : input.getAllSubclasses()) {
+                        if (isLocalBeanImplementation(subclass, input)) {
                             return true;
                         }
                     }
@@ -90,13 +90,13 @@ private boolean isLocalBeanImplementation(JavaClass bean, JavaClass businessInte
                 @Override
                 public void check(JavaClass businessInterface, ConditionEvents events) {
                     events.add(new SimpleConditionEvent(businessInterface,
-                            businessInterface.getAllSubClasses().size() <= 1,
+                            businessInterface.getAllSubclasses().size() <= 1,
                             describe(businessInterface)));
                 }
 
                 private String describe(JavaClass businessInterface) {
                     return String.format("%s is implemented by %s",
-                            businessInterface.getSimpleName(), joinNamesOf(businessInterface.getAllSubClasses()));
+                            businessInterface.getSimpleName(), joinNamesOf(businessInterface.getAllSubclasses()));
                 }
 
                 private String joinNamesOf(Set<JavaClass> implementations) {

archunit-example/example-plain/src/test/java/com/tngtech/archunit/exampletest/ThirdPartyRulesTest.java

@@ -43,10 +43,10 @@ private ArchCondition<JavaClass> notCreateProblematicClassesOutsideOfWorkaroundF
                 target(is(constructor())).and(targetOwner(is(assignableTo(ThirdPartyClassWithProblem.class))));
 
         DescribedPredicate<JavaCall<?>> notFromWithinThirdPartyClass =
-                originOwner(is(not(assignableTo(ThirdPartyClassWithProblem.class)))).forSubType();
+                originOwner(is(not(assignableTo(ThirdPartyClassWithProblem.class)))).forSubtype();
 
         DescribedPredicate<JavaCall<?>> notFromWorkaroundFactory =
-                originOwner(is(not(equivalentTo(ThirdPartyClassWorkaroundFactory.class)))).forSubType();
+                originOwner(is(not(equivalentTo(ThirdPartyClassWorkaroundFactory.class)))).forSubtype();
 
         DescribedPredicate<JavaCall<?>> targetIsIllegalConstructorOfThirdPartyClass =
                 constructorCallOfThirdPartyClass.

archunit-example/example-plain/src/test/resources/frozen/a81a2b54-5a18-4145-b544-7a580aba0425

@@ -2,8 +2,10 @@ Class <com.tngtech.archunit.example.layers.persistence.layerviolation.DaoCalling
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> has annotation member of type <com.tngtech.archunit.example.layers.service.ServiceType> in (ServiceViolatingLayerRules.java:0)
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> has annotation member of type <com.tngtech.archunit.example.layers.service.SimpleServiceAnnotation> in (ServiceViolatingLayerRules.java:0)
 Class <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> is annotated with <com.tngtech.archunit.example.layers.service.ComplexServiceAnnotation> in (ServiceViolatingLayerRules.java:0)
+Class <com.tngtech.archunit.example.layers.service.SpecialServiceHelper> extends class <com.tngtech.archunit.example.layers.service.ServiceHelper> in (SpecialServiceHelper.java:0)
 Class <com.tngtech.archunit.example.layers.service.impl.ServiceImplementation> implements interface <com.tngtech.archunit.example.layers.service.ServiceInterface> in (ServiceImplementation.java:0)
 Constructor <com.tngtech.archunit.example.layers.SomeMediator.<init>(com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules)> has parameter of type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeMediator.java:0)
+Constructor <com.tngtech.archunit.example.layers.service.SpecialServiceHelper.<init>()> calls constructor <com.tngtech.archunit.example.layers.service.ServiceHelper.<init>()> in (SpecialServiceHelper.java:9)
 Field <com.tngtech.archunit.example.layers.SomeMediator.service> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeMediator.java:0)
 Field <com.tngtech.archunit.example.layers.controller.SomeController.otherService> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingLayerRules> in (SomeController.java:0)
 Field <com.tngtech.archunit.example.layers.controller.SomeController.service> has type <com.tngtech.archunit.example.layers.service.ServiceViolatingDaoRules> in (SomeController.java:0)

archunit-integration-test/src/test/java/com/tngtech/archunit/ArchUnitArchitectureTest.java

@@ -71,7 +71,7 @@ public class ArchUnitArchitectureTest {
     private static DescribedPredicate<JavaCall<?>> typeIsIllegallyResolvedViaReflection() {
         DescribedPredicate<JavaCall<?>> explicitlyAllowedUsage =
                 origin(is(annotatedWith(MayResolveTypesViaReflection.class)))
-                        .or(contextIsAnnotatedWith(MayResolveTypesViaReflection.class)).forSubType();
+                        .or(contextIsAnnotatedWith(MayResolveTypesViaReflection.class)).forSubtype();
 
         return classIsResolvedViaReflection().and(not(explicitlyAllowedUsage));
     }
@@ -100,7 +100,7 @@ private static DescribedPredicate<JavaCall<?>> classIsResolvedViaReflection() {
                 target(HasOwner.Functions.Get.<JavaClass>owner()
                         .is(equivalentTo(Class.class)))
                         .and(target(has(name("forName"))))
-                        .forSubType();
+                        .forSubtype();
         DescribedPredicate<JavaCall<?>> targetIsMarked =
                 annotatedWith(ResolvesTypesViaReflection.class).onResultOf(Get.target());
 

archunit-integration-test/src/test/java/com/tngtech/archunit/PublicAPIRules.java

@@ -136,13 +136,13 @@ public class PublicAPIRules {
                             .andShould().haveRawReturnType(not(guavaClass()).as("that are no Guava types")));
 
     private static DescribedPredicate<JavaClass> publicAPI() {
-        return annotatedWith(PublicAPI.class).<JavaClass>forSubType()
+        return annotatedWith(PublicAPI.class).<JavaClass>forSubtype()
                 .or(haveMemberThatBelongsToPublicApi())
                 .or(markedAsPublicAPIForInheritance());
     }
 
     private static DescribedPredicate<JavaClass> internal() {
-        return annotatedWith(Internal.class).<JavaClass>forSubType()
+        return annotatedWith(Internal.class).<JavaClass>forSubtype()
                 .or(equivalentTo(Internal.class));
     }
 
@@ -215,8 +215,8 @@ public boolean apply(JavaClass input) {
                     }
                 }
                 return input.getConstructors().isEmpty() &&
-                        input.getSuperClass().isPresent() &&
-                        haveAPublicConstructor().apply(input.getSuperClass().get());
+                        input.getRawSuperclass().isPresent() &&
+                        haveAPublicConstructor().apply(input.getRawSuperclass().get());
             }
         };
     }
@@ -236,8 +236,8 @@ public boolean apply(JavaClass input) {
     }
 
     private static DescribedPredicate<JavaMember> withoutAPIMarking() {
-        return not(annotatedWith(PublicAPI.class)).<JavaMember>forSubType()
-                .and(not(annotatedWith(Internal.class)).forSubType())
+        return not(annotatedWith(PublicAPI.class)).<JavaMember>forSubtype()
+                .and(not(annotatedWith(Internal.class)).forSubtype())
                 .and(declaredIn(modifier(PUBLIC)))
                 .as("without API marking");
     }