Allows withOnlyTheseFields if Warning.SURROGATE_OR_BUSINESS_KEY is su…

…ppressed

CHANGELOG.md

@@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- When `Warning.SURROGATE_OR_BUSINESS_KEY` is suppressed, it is now possible to use `#withOnlyTheseFields`, and the fields may include both `@Id` fields and regular fields. ([Issue 934](https://github.com/jqno/equalsverifier/issues/934))
+
 ## [3.15.8] - 2024-03-01
 
 ### Fixed

equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/util/Validations.java

@@ -147,7 +147,7 @@ public static void validateProcessedAnnotations(
         Set<String> excludedFields
     ) {
         validateClassAnnotations(type, cache, warnings, includedFields, excludedFields);
-        validateFieldAnnotations(type, cache, includedFields);
+        validateFieldAnnotations(type, cache, warnings, includedFields);
     }
 
     // CHECKSTYLE OFF: VariableDeclarationUsageDistance
@@ -187,22 +187,25 @@ private static void validateClassAnnotations(
     private static void validateFieldAnnotations(
         Class<?> type,
         AnnotationCache cache,
+        Set<Warning> warnings,
         Set<String> includedFields
     ) {
         FieldIterable
             .of(type)
-            .forEach(f -> validateFieldAnnotation(type, f, cache, includedFields));
+            .forEach(f -> validateFieldAnnotation(type, f, cache, warnings, includedFields));
     }
 
     private static void validateFieldAnnotation(
         Class<?> type,
         Field f,
         AnnotationCache cache,
+        Set<Warning> warnings,
         Set<String> includedFields
     ) {
         validate(
             includedFields.contains(f.getName()) &&
-            cache.hasFieldAnnotation(type, f.getName(), SupportedAnnotations.ID),
+            cache.hasFieldAnnotation(type, f.getName(), SupportedAnnotations.ID) &&
+            !warnings.contains(Warning.SURROGATE_OR_BUSINESS_KEY),
             "you can't use withOnlyTheseFields on a field marked @Id or @EmbeddedId.\n" +
             "Suppress Warning.SURROGATE_KEY and remove withOnlyTheseFields " +
             "if you want to use only the @Id or @EmbeddedId fields in equals."

equalsverifier-core/src/test/java/nl/jqno/equalsverifier/integration/extra_features/JakartaIdTest.java

@@ -399,6 +399,15 @@ public void succeed_whenEqualsIsImplementedInSuperclass_givenWarningSurrogateKey
         EqualsVerifier.forClass(SubclassEntity.class).suppress(Warning.SURROGATE_KEY).verify();
     }
 
+    @Test
+    public void succeed_whenEqualsUsesIdsAndNonIds_givenWarningSurrogateOrBusinessKeyIsSuppressed() {
+        EqualsVerifier
+            .forClass(JakartaIdDirtyTrackingPerson.class)
+            .suppress(Warning.SURROGATE_OR_BUSINESS_KEY)
+            .withOnlyTheseFields("id", "version", "isDirty")
+            .verify();
+    }
+
     static class JakartaIdBusinessKeyPerson {
 
         @jakarta.persistence.Id
@@ -1000,4 +1009,36 @@ public SubclassEntity(UUID id, String name) {
             this.name = name;
         }
     }
+
+    @jakarta.persistence.Entity
+    static class JakartaIdDirtyTrackingPerson {
+
+        @jakarta.persistence.Id
+        private UUID id;
+
+        private int version;
+        private boolean isDirty;
+
+        private String socialSecurity;
+        private String name;
+        private LocalDate birthdate;
+
+        @Override
+        public final boolean equals(Object obj) {
+            if (!(obj instanceof JakartaIdDirtyTrackingPerson)) {
+                return false;
+            }
+            JakartaIdDirtyTrackingPerson other = (JakartaIdDirtyTrackingPerson) obj;
+            return (
+                Objects.equals(id, other.id) &&
+                Objects.equals(version, other.version) &&
+                Objects.equals(isDirty, other.isDirty)
+            );
+        }
+
+        @Override
+        public final int hashCode() {
+            return Objects.hash(id, version, isDirty);
+        }
+    }
 }

equalsverifier-core/src/test/java/nl/jqno/equalsverifier/integration/extra_features/JpaIdTest.java

@@ -415,6 +415,15 @@ public void succeed_whenEqualsIsImplementedInSuperclass_givenWarningSurrogateKey
         EqualsVerifier.forClass(SubclassEntity.class).suppress(Warning.SURROGATE_KEY).verify();
     }
 
+    @Test
+    public void succeed_whenEqualsUsesIdsAndNonIds_givenWarningSurrogateOrBusinessKeyIsSuppressed() {
+        EqualsVerifier
+            .forClass(JpaIdDirtyTrackingPerson.class)
+            .suppress(Warning.SURROGATE_OR_BUSINESS_KEY)
+            .withOnlyTheseFields("id", "version", "isDirty")
+            .verify();
+    }
+
     static class JpaIdBusinessKeyPerson {
 
         @Id
@@ -1092,4 +1101,36 @@ public SubclassEntity(UUID id, String name) {
             this.name = name;
         }
     }
+
+    @Entity
+    static class JpaIdDirtyTrackingPerson {
+
+        @Id
+        private UUID id;
+
+        private int version;
+        private boolean isDirty;
+
+        private String socialSecurity;
+        private String name;
+        private LocalDate birthdate;
+
+        @Override
+        public final boolean equals(Object obj) {
+            if (!(obj instanceof JpaIdDirtyTrackingPerson)) {
+                return false;
+            }
+            JpaIdDirtyTrackingPerson other = (JpaIdDirtyTrackingPerson) obj;
+            return (
+                Objects.equals(id, other.id) &&
+                Objects.equals(version, other.version) &&
+                Objects.equals(isDirty, other.isDirty)
+            );
+        }
+
+        @Override
+        public final int hashCode() {
+            return Objects.hash(id, version, isDirty);
+        }
+    }
 }