Merge pull request #1070 from jqno/equalsverifier-4

Prepare for release of EqualsVerifier 4.0

Author: jqno

.github/dependabot.yml

@@ -8,8 +8,6 @@ updates:
       dependencies:
         patterns:
           - "*"
-    ignore:
-      - dependency-name: "com.github.spotbugs:*"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

.github/workflows/ci.yml

@@ -15,18 +15,6 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - title: "Supported JDK 8"
-            experimental: false
-            cache-id: "jdk8"
-            java: 8
-            dist: temurin
-            flags: "-DdisableStaticAnalysis"
-          - title: "Supported JDK 11"
-            experimental: false
-            cache-id: "jdk11"
-            java: 11
-            dist: temurin
-            flags: "-DdisableStaticAnalysis"
           - title: "Supported JDK 17"
             experimental: false
             cache-id: "jdk17"

.github/workflows/pitest-comment.yml

@@ -40,4 +40,4 @@ jobs:
         # The updatePR maven goal is used here with an explicit version. This allows us to upload without checking out
         # the code, but does mean the version here must be maintained. An alternative would be to checkout the code and use
         # the github goal. This will work as long as the artifact is extracted to the maven target directory
-        run: mvn -DrepoToken=${{ secrets.GITHUB_TOKEN }} com.arcmutate:pitest-github-maven-plugin:2.1.0:updatePR
+        run: mvn -DrepoToken=${{ secrets.GITHUB_TOKEN }} pitest-github-maven-plugin:updatePR

.github/workflows/pitest.yml

@@ -23,7 +23,6 @@ jobs:
         with:
           # important to set a fetch depth of 2. By default the checkout action make no history available
           fetch-depth: 2
-
       - name: Cache Maven repository
         uses: actions/cache@v4
         with:

.github/workflows/release.yml

@@ -42,7 +42,7 @@ jobs:
         uses: jreleaser/release-action@v2
         with:
           setup-java: false
-          version: 1.17.0
+          version: 1.18.0
         env:
           JRELEASER_PROJECT_VERSION: ${{ github.event.inputs.version }}
           JRELEASER_GITHUB_TOKEN: ${{ secrets.JRELEASER_GITHUB_TOKEN }}

CHANGELOG.md

@@ -5,14 +5,42 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+-   Jump to [version 4.x](#4.x)
 -   Jump to [version 3.x](#3.x)
 -   Jump to [version 2.x](#2.x)
 -   Jump to [version 1.x](#1.x)
 
-<a name="3.x"/>
+<a name="4.x"/>
 
 ## [Unreleased]
 
+If you're upgrading from EqualsVerifier 3.x, please see the [migration guide](http://jqno.nl/equalsverifier/migration3to4).
+
+### Added
+
+- Mockito integration: if Mockito is on the classpath or modulepath, EqualsVerifier will use it to instantiate values. This reduces the need for providing prefab values. If Mockito is not available, or if `EqualsVerifier.set(Mode.skipMockito())` is used, EqualsVerifier will fall back to its previous behaviour.
+- `forExamples(T red, T blue)` as an alternative to `forClass()` or `forPackage()`. Give it two instances of a type, and it will test that type using the values already present in the fields of the instances. This way, you don't have to use `withPrefabValues` anymore.
+- Prefab value for `java.util.HexFormat`. ([Issue 981](https://github.com/jqno/equalsverifier/issues/981))
+
+### Changed
+
+- EqualsVerifier now requires Java 17.
+- EqualsVerifier is now properly modularized according to the JPMS.
+- When using EqualsVerifier as a module, it's no longer needed to `requires net.bytebuddy` (this is now a proper transitive requirement).
+- Improved error message when ClassCastException is encountered.
+
+### Removed
+
+- Built-in prefab values for Google Guava, Joda-Time and Javafx.
+- `#withResetCaches()`, which was deprecated since version 3.16.2.
+- `Warning.ZERO_FIELDS`, which was deprecated since version 3.17.
+- `forPackage(String packageName, boolean scanRecursively)`, which was deprecated since version 3.19.
+- `forPackage(String packageName, Class<?> mustExtend)`, which was deprecated since version 3.19.
+- `forPackage(...).except(Class<?>... types)`, which was deprecated since version 3.19.
+- `forPackage(...).except(Predicate<Class<?>>... exclusionPredicate)`, which was deprecated since version 3.19.
+
+<a name="3.x"/>
+
 ## [3.19.4] - 2025-04-30
 
 ### Fixed
@@ -42,6 +70,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Bug in `withPrefabValueForField` where in some cases the prefab value is not used.
 
+<a name="ScanOption"/>
 ## [3.19] - 2025-02-06
 
 ### Added
@@ -671,7 +700,7 @@ If you're upgrading from EqualsVerifier 2.x, please see the [migration guide](ht
 ### Added
 
 -   Full support for Java 11. ([Issue 197](https://github.com/jqno/equalsverifier/issues/197))
--   Re-usable EqualsVerifier configurations: see [the manual](http://jqno.nl/equalsverifier/manual/reusing-configurations).
+-   Re-usable EqualsVerifier configurations: see [the manual](http://jqno.nl/equalsverifier/manual/several-classes-at-once).
 -   `#report()` method to ask EqualsVerifier for a report, instead of making it fail a test.
 -   `#withGenericPrefabValues()` method added to supply values for specific generic types: see [here](http://jqno.nl/equalsverifier/errormessages/recursive-datastructure#generics).
 
@@ -1329,7 +1358,7 @@ Please don't use version 1.3; [it's a broken release](https://jqno.nl/post/2013/
 
 ### Added
 
--   `#withRelaxedEqualExamples()` to verify equality rules that are more relaxed than simple field-by-field comparisons. ([Issue 9](https://github.com/jqno/equalsverifier/issues/9))
+-   `#forRelaxedEqualExamples()` to verify equality rules that are more relaxed than simple field-by-field comparisons. ([Issue 9](https://github.com/jqno/equalsverifier/issues/9))
 
 ## [0.3] - 2009-08-01
 

README.md

@@ -75,17 +75,16 @@ To build EqualsVerifier, you need [Maven](https://maven.apache.org/). Just call
 
 There are several Maven profiles that can be enabled or disabled:
 
-| profile                | activation                                                             | purpose                                                                                                                                                        |
-| ---------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `modules-jdk8`         | JDK 8 up to but not including 11                                       | Build only the modules that are compatible with Java 8 and up.                                                                                                 |
-| `modules-jdk11`        | JDK 11 up to but not including 16                                      | Build only the modules that are compatible with Java 11 and up.                                                                                                |
-| `modules-jdk16`        | JDK 16                                                                 | Build only the modules that are compatible with Java 16 and up.                                                                                                |
-| `modules-jdk17`        | JDK 17 and up                                                          | Build all modules and build releaseable artifacts.                                                                                                             |
-| `static-analysis`      | JDK 17 and up, _and_ `disableStaticAnalysis` property must be off      | Run static analysis checks. This only happens on a recent JDK. Can be disabled by running `mvn verify -DdisableStaticAnalysis`                                 |
-| `release-verification` | JDK 17 and up, _and_ `disableReleaseVerification` property must be off | Run release verification checks. This only happens on a recent JDK. Can be disabled by running `mvn verify -DdisableReleaseVerification`                       |
-| `argline-preview`      | `preview` property must be on                                          | Enable Java preview features. Can be activated by running `mvn verify -Dpreview`                                                                               |
-| `argline-experimental` | `experimental` property must be on                                     | Enables ByteBuddy experimental features; useful for testing EqualsVerifier on Early Access JDK builds. Can be activated by running `mvn verify -Dexperimental` |
-| `pitest`               | `pitest` property must be on                                           | Used by PITest integration on GitHub. Can be activated by running `mvn verify -Dpitest`                                                                        |
+| profile                        | activation                                         | purpose                                                                                                                                                        |
+| ------------------------------ | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `modules-jdk17`                | JDK 17 up to 20                                    | Build all modules and build releasable artifacts.                                                                                                             |
+| `modules-jdk21`                | JDK 21 and up                                      | Build all modules and build releasable artifacts.                                                                                                             |
+| `static-analysis`              | `disableStaticAnalysis` property must be off       | Run static analysis checks. This only happens on a recent JDK. Can be disabled by running `mvn verify -DdisableStaticAnalysis`.                                |
+| `static-analysis-checkstyle`   | -                                                  | Run Checkstyle checks, for Checkstyle's regression CI.                                                                                                         |
+| `argline-preview`              | `preview` property must be on                      | Enable Java preview features. Can be activated by running `mvn verify -Dpreview`.                                                                              |
+| `argline-experimental`         | `experimental` property must be on                 | Enables ByteBuddy experimental features; useful for testing EqualsVerifier on Early Access JDK builds. Can be activated by running `mvn verify -Dexperimental` |
+| `pitest`                       | `pitest` property must be on                       | Used by PITest integration on GitHub. Can be activated by running `mvn verify -Dpitest`.                                                                       |
+| `modules-jdk21-without-pitest` | JDK 21 and up, _and_ `pitest` property must be off | Like `modules-jdk21`, but with additional verifications that are incompatible with PITest.                                                                     |
 
 ## Formatting
 
@@ -101,15 +100,16 @@ Here's a description of the modules:
 | ----------------------------- | --------------------------------------------------------------------- |
 | docs                          | project's Jekyll website                                              |
 | equalsverifier-core           | the actual EqualsVerifier code                                        |
-| equalsverifier-11             | logic for modules, tests for Java 11 and up                           |
-| equalsverifier-16             | logic for records, and corresponding tests                            |
-| equalsverifier-17             | logic for sealed classes, and corresponding tests                     |
 | equalsverifier-21             | tests for record pattern matching                                     |
+| equalsverifier-testhelpers    | shared types and helpers for use in tests                             |
+| equalsverifier-test           | integration tests (without access to Mockito)                         |
+| equalsverifier-test-jpms      | tests for the Java module system (with access to Mockito)             |
+| equalsverifier-test-kotlin    | tests for Kotlin classes                                              |
+| equalsverifier-test-mockito   | tests for instantiation using Mockito                                 |
 | equalsverifier-aggregator     | generic release assembly description, and shared jacoco configuration |
 | equalsverifier-release-main   | release assembly for jar with dependencies                            |
 | equalsverifier-release-nodep  | release assembly for fat jar (with dependencies shaded in)            |
 | equalsverifier-release-verify | validation tests for the releases                                     |
-| equalsverifier-test-kotlin    | tests for Kotlin classes                                              |
 
 ## Signed JAR
 
@@ -129,10 +129,10 @@ The signed JAR itself can be found in [this repo](https://github.com/jqno/equals
 
 To generate the website
 
--   Using Docker: start the server by running `docker-compose up` or `docker compose run jekyll serve`.
--   Using Jekyll: install the Ruby 3.x toolchain and run `bundle exec jekyll serve --watch`
+- Using Docker: start the server by running `docker-compose up` or `docker compose run jekyll serve`.
+- Using Jekyll: install the Ruby 3.x toolchain and run `bundle exec jekyll serve --watch`
 
-Note that thepage uses the [TilburgsAns](https://www.tilburgsans.nl/) font but references it from the main site at [jqno.nl](https://jqno.nl). In development, it will fall back to a `sans-serif` font. See the font license [here](assets/tilburgsans/Ans%20Font%20License-AFL.pdf).
+Note that the page uses the [TilburgsAns](https://www.tilburgsans.nl/) font but references it from the main site at [jqno.nl](https://jqno.nl). In development, it will fall back to a `sans-serif` font. See the font license [here](assets/tilburgsans/Ans%20Font%20License-AFL.pdf).
 
 # Disclaimer
 

cdg-pitest-licence.txt renamed to arcmutate-licence.txt

@@ -7,6 +7,10 @@
     <property name="charset" value="UTF-8"/>
     <property name="severity" value="error"/>
 
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$"/>
+    </module>
+
     <module name="FileLength"/>
     <module name="FileTabCharacter"/>
     <module name="NewlineAtEndOfFile">

build/checkstyle-config.xml

@@ -90,7 +90,7 @@
         <setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_enum_constant" value="49"/>
         <setting id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter" value="insert"/>
         <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression" value="do not insert"/>
-        <setting id="org.eclipse.jdt.core.formatter.text_block_indentation" value="0"/>
+        <setting id="org.eclipse.jdt.core.formatter.text_block_indentation" value="1"/>
         <setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns" value="false"/>
         <setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="16"/>
         <setting id="org.eclipse.jdt.core.formatter.alignment_for_module_statements" value="16"/>
@@ -147,7 +147,7 @@
         <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation" value="48"/>
         <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations" value="do not insert"/>
         <setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_package" value="49"/>
-        <setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="false"/>
+        <setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="true"/>
         <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement" value="insert"/>
         <setting id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator" value="insert"/>
         <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_label" value="do not insert"/>

build/eclipse-formatter-config.xml

@@ -2,9 +2,9 @@
 title: "The Java Platform Module System"
 permalink: /manual/jpms/
 ---
-EqualsVerifier is compatible with the Java Platform Module System (JPMS). However, since it does some reflection, you have to open up some packages. Perhaps you have already done so, as test frameworks like JUnit also require this.
+EqualsVerifier supports the Java Platform Module System (JPMS). However, since it does some reflection, you have to open up some packages. Perhaps you have already done so, as test frameworks like JUnit also require this.
 
-The recommended approach is to put a `module-info.java` file in your `src/test/java` folder, that copies the content the `module-info.java` file in `src/main/java`. Let's say this is your `src/main/java/module-info.java`:
+The recommended approach is to put a `module-info.java` file in your `src/test/java` folder, that mirrors the content the `module-info.java` file in `src/main/java`. Let's say this is your `src/main/java/module-info.java`:
 
 {% highlight java %}
 module my.module {
@@ -20,7 +20,6 @@ open module my.module {              // Note: open
 
     requires org.junit.jupiter.api;  // For JUnit
     requires nl.jqno.equalsverifier; // For EqualsVerifier
-    requires net.bytebuddy;          // Dependency of EqualsVerifier
 }
 {% endhighlight %}
 
@@ -33,12 +32,9 @@ module my.module {
 
     requires org.junit.jupiter.api;
     requires nl.jqno.equalsverifier;
-    requires net.bytebuddy;
 }
 {% endhighlight %}
 
-Note that the line `requires net.bytebuddy` is not necessary if you use the uberjar dependency `equalsverifier-nodep`.
-
 Note that if you do this, and you have model classes or dependencies for model classes in other packages, you will have to open these packages as well, or provide prefab values for these dependencies:
 
 {% highlight java %}
@@ -59,3 +55,4 @@ If the class is accessible, but the class for one of its fields isn't, you will
     Field foo of type Bar is not accessible via the Java Module System.
     Consider opening the module that contains it, or add prefab values for type Bar.
 
+In those cases, you need to open up their package in `module-info.java` or provide prefab values, as discussed above.