Adds logic to detect Kotlin classes

jqno · Jan 8, 2025 · e06a7b0 · e06a7b0
1 parent 19e74c9
commit e06a7b0
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 11 deletions.
diff --git a/...sverifier-core/src/main/java/nl/jqno/equalsverifier/internal/checkers/FieldInspector.java b/...sverifier-core/src/main/java/nl/jqno/equalsverifier/internal/checkers/FieldInspector.java
@@ -7,13 +7,16 @@
 public class FieldInspector<T> {
 
     private final Class<T> type;
+    private final boolean isKotlin;
 
-    public FieldInspector(Class<T> type) {
+    public FieldInspector(Class<T> type, boolean isKotlin) {
         this.type = type;
+        this.isKotlin = isKotlin;
     }
 
     public void check(FieldCheck<T> check) {
-        for (FieldProbe fieldProbe : FieldIterable.of(type)) {
+        FieldIterable it = isKotlin ? FieldIterable.ofKotlin(type) : FieldIterable.of(type);
+        for (FieldProbe fieldProbe : it) {
             check.execute(fieldProbe);
         }
     }

diff --git a/...lsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/checkers/FieldsChecker.java b/...lsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/checkers/FieldsChecker.java
@@ -55,7 +55,7 @@ public FieldsChecker(Context<T> context) {
 
     @Override
     public void check() {
-        FieldInspector<T> inspector = new FieldInspector<>(context.getType());
+        FieldInspector<T> inspector = new FieldInspector<>(context.getType(), config.isKotlin());
 
         if (!context.getClassProbe().isEqualsInheritedFromObject()) {
             inspector.check(arrayFieldCheck);

diff --git a/equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/checkers/NullChecker.java b/equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/checkers/NullChecker.java
@@ -18,7 +18,7 @@ public void check() {
             return;
         }
 
-        FieldInspector<T> inspector = new FieldInspector<>(context.getType());
+        FieldInspector<T> inspector = new FieldInspector<>(context.getType(), context.getConfiguration().isKotlin());
         inspector.check(new NullPointerExceptionFieldCheck<>(context));
     }
 }
diff --git a/...verifier-core/src/main/java/nl/jqno/equalsverifier/internal/reflection/FieldIterable.java b/...verifier-core/src/main/java/nl/jqno/equalsverifier/internal/reflection/FieldIterable.java
@@ -12,12 +12,14 @@ public final class FieldIterable implements Iterable<FieldProbe> {
     private final Class<?> type;
     private final boolean includeSuperclasses;
     private final boolean includeStatic;
+    private final boolean isKotlin;
 
     /** Private constructor. Call {@link #of(Class)} or {@link #ofIgnoringSuper(Class)} instead. */
-    private FieldIterable(Class<?> type, boolean includeSuperclasses, boolean includeStatic) {
+    private FieldIterable(Class<?> type, boolean includeSuperclasses, boolean includeStatic, boolean isKotlin) {
         this.type = type;
         this.includeSuperclasses = includeSuperclasses;
         this.includeStatic = includeStatic;
+        this.isKotlin = isKotlin;
     }
 
     /**
@@ -28,7 +30,18 @@ private FieldIterable(Class<?> type, boolean includeSuperclasses, boolean includ
      * @return A FieldIterable.
      */
     public static FieldIterable of(Class<?> type) {
-        return new FieldIterable(type, true, true);
+        return new FieldIterable(type, true, true, false);
+    }
+
+    /**
+     * Factory method for a FieldIterable that iterates over all declared fields of {@code type} and over the declared
+     * fields of all of its superclasses, but that ignores overridden Kotlin backing fields in superclasses.
+     *
+     * @param type The class that contains the fields over which to iterate.
+     * @return A FieldIterable.
+     */
+    public static FieldIterable ofKotlin(Class<?> type) {
+        return new FieldIterable(type, true, true, true);
     }
 
     /**
@@ -39,7 +52,7 @@ public static FieldIterable of(Class<?> type) {
      * @return A FieldIterable.
      */
     public static FieldIterable ofIgnoringSuper(Class<?> type) {
-        return new FieldIterable(type, false, true);
+        return new FieldIterable(type, false, true, false);
     }
 
     /**
@@ -50,7 +63,7 @@ public static FieldIterable ofIgnoringSuper(Class<?> type) {
      * @return A FieldIterable.
      */
     public static FieldIterable ofIgnoringStatic(Class<?> type) {
-        return new FieldIterable(type, true, false);
+        return new FieldIterable(type, true, false, false);
     }
 
     /**
@@ -61,7 +74,7 @@ public static FieldIterable ofIgnoringStatic(Class<?> type) {
      * @return A FieldIterable.
      */
     public static FieldIterable ofIgnoringSuperAndStatic(Class<?> type) {
-        return new FieldIterable(type, false, false);
+        return new FieldIterable(type, false, false, false);
     }
 
     /**
@@ -75,7 +88,12 @@ public Iterator<FieldProbe> iterator() {
     }
 
     private List<FieldProbe> createFieldList() {
-        return createJavaFieldList();
+        if (isKotlin) {
+            return createKotlinFieldList();
+        }
+        else {
+            return createJavaFieldList();
+        }
     }
 
     private List<FieldProbe> createJavaFieldList() {

diff --git a/...ain/java/nl/jqno/equalsverifier/internal/reflection/annotations/SupportedAnnotations.java b/...ain/java/nl/jqno/equalsverifier/internal/reflection/annotations/SupportedAnnotations.java
@@ -194,7 +194,9 @@ public boolean validate(
                 Set<String> ignoredAnnotations) {
             return "LAZY".equals(properties.getEnumValue("fetch"));
         }
-    };
+    },
+
+    KOTLIN(false, "kotlin.Metadata");
 
     private final boolean inherits;
     private final Set<String> partialClassNames;

diff --git a/equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/util/Configuration.java b/equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/util/Configuration.java
@@ -24,6 +24,7 @@ public final class Configuration<T> {
     private final boolean usingGetClass;
     private final EnumSet<Warning> warningsToSuppress;
     private final Function<String, String> fieldnameToGetter;
+    private final boolean isKotlin;
 
     private final TypeTag typeTag;
     private final AnnotationCache annotationCache;
@@ -46,6 +47,7 @@ private Configuration(
             boolean usingGetClass,
             EnumSet<Warning> warningsToSuppress,
             Function<String, String> fieldnameToGetter,
+            boolean isKotlin,
             List<T> equalExamples,
             List<T> unequalExamples) {
         this.type = type;
@@ -60,6 +62,7 @@ private Configuration(
         this.usingGetClass = usingGetClass;
         this.warningsToSuppress = warningsToSuppress;
         this.fieldnameToGetter = fieldnameToGetter;
+        this.isKotlin = isKotlin;
         this.equalExamples = equalExamples;
         this.unequalExamples = unequalExamples;
     }
@@ -91,6 +94,7 @@ public static <T> Configuration<T> build(
             actualFields);
         Function<String, String> converter =
                 fieldnameToGetter != null ? fieldnameToGetter : DEFAULT_FIELDNAME_TO_GETTER_CONVERTER;
+        boolean isKotlin = annotationCache.hasClassAnnotation(type, SupportedAnnotations.KOTLIN);
 
         return new Configuration<>(type,
                 typeTag,
@@ -104,6 +108,7 @@ public static <T> Configuration<T> build(
                 usingGetClass,
                 warningsToSuppress,
                 converter,
+                isKotlin,
                 equalExamples,
                 unequalExamples);
     }
@@ -200,6 +205,10 @@ public Function<String, String> getFieldnameToGetter() {
         return fieldnameToGetter;
     }
 
+    public boolean isKotlin() {
+        return isKotlin;
+    }
+
     public List<T> getEqualExamples() {
         return Collections.unmodifiableList(equalExamples);
     }