Automatically suppresses Warning.ZERO_FIELDS when using #withPrefabVa…

…luesForField
jqno · Sep 17, 2024 · c621fba · c621fba
1 parent a253cde
commit c621fba
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/...l/jqno/equalsverifier/integration/extended_contract/PrefabValuesForFieldInRecordTest.java b/...l/jqno/equalsverifier/integration/extended_contract/PrefabValuesForFieldInRecordTest.java
@@ -1,7 +1,6 @@
 package nl.jqno.equalsverifier.integration.extended_contract;
 
 import nl.jqno.equalsverifier.EqualsVerifier;
-import nl.jqno.equalsverifier.Warning;
 import nl.jqno.equalsverifier.internal.testhelpers.ExpectedException;
 import org.junit.jupiter.api.Test;
 
@@ -20,7 +19,6 @@ public void succeed_whenRecordHasSinglePrecondition_givenPrefabValuesForField()
         EqualsVerifier
             .forClass(SinglePrecondition.class)
             .withPrefabValuesForField("i", 111, 142)
-            .suppress(Warning.ZERO_FIELDS)
             .verify();
     }
 
@@ -51,7 +49,6 @@ public void succeed_whenRecordHasDualPrecondition_givenPrefabValueForBothFields(
             .forClass(DualPrecondition.class)
             .withPrefabValuesForField("x", 111, 142)
             .withPrefabValuesForField("y", 505, 555)
-            .suppress(Warning.ZERO_FIELDS)
             .verify();
     }
 

diff --git a/...lsverifier-core/src/main/java/nl/jqno/equalsverifier/api/SingleTypeEqualsVerifierApi.java b/...lsverifier-core/src/main/java/nl/jqno/equalsverifier/api/SingleTypeEqualsVerifierApi.java
@@ -113,6 +113,9 @@ public <S> SingleTypeEqualsVerifierApi<T> withPrefabValues(Class<S> otherType, S
      * Adds prefabricated values for instance fields with a given name (and only the fields with
      * the given name) that EqualsVerifier cannot instantiate by itself.
      *
+     * Automatically suppresses {@link Warning.ZERO_FIELDS}, because fields that get a specific
+     * prefabricated value should usually not be assigned to zero.
+     *
      * @param <S> The class of the prefabricated values.
      * @param fieldName The name of the field that the prefabricated values are linked to.
      * @param red An instance of {@code S}.
@@ -129,6 +132,7 @@ public <S> SingleTypeEqualsVerifierApi<T> withPrefabValuesForField(
     ) {
         Validations.validateFieldNameExists(type, fieldName, actualFields);
         PrefabValuesApi.addPrefabValuesForField(fieldCache, type, fieldName, red, blue);
+        suppress(Warning.ZERO_FIELDS);
         return this;
     }