Start of Multimap Assertions (#1)

Setting up the skeleton of the MultimapAssert type

---------

Co-authored-by: Stefano Cordio <stefano.cordio@gmail.com>

Author: mattbertolini

README.md

@@ -0,0 +1,3 @@
+# AssertJ Eclipse Collections [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+
+[![CI](https://github.com/assertj/assertj/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/assertj/assertj/actions/workflows/main.yml?query=branch%3Amain)

pom.xml

@@ -23,6 +23,14 @@
     </license>
   </licenses>
 
+  <developers>
+    <developer>
+      <id>mattbertolini</id>
+      <name>Matt Bertolini</name>
+      <url>https://github.com/mattbertolini</url>
+    </developer>
+  </developers>
+
   <scm>
     <connection>scm:git:https://github.com/assertj/assertj-eclipse-collections.git</connection>
     <developerConnection>scm:git:https://github.com/assertj/assertj-eclipse-collections.git</developerConnection>
@@ -31,9 +39,10 @@
 
   <properties>
     <assertj.version>3.27.3</assertj.version>
+    <java.version>11</java.version>
     <eclipse-collections.version>13.0.0</eclipse-collections.version>
     <!-- Dependency versions overriding -->
-    <junit-jupiter.version>5.11.4</junit-jupiter.version>
+    <junit-jupiter.version>5.12.1</junit-jupiter.version>
   </properties>
 
   <dependencies>
@@ -46,10 +55,16 @@
     <!-- Provided -->
     <dependency>
       <groupId>org.eclipse.collections</groupId>
-      <artifactId>eclipse-collections-api</artifactId>
+      <artifactId>eclipse-collections</artifactId>
       <version>${eclipse-collections.version}</version>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.opentest4j</groupId>
+      <artifactId>opentest4j</artifactId>
+      <scope>provided</scope>
+      <optional>true</optional>
+    </dependency>
     <!-- Test -->
     <dependency>
       <groupId>org.junit.jupiter</groupId>

src/main/java/org/assertj/eclipse/collections/Main.java

@@ -0,0 +1,43 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * Copyright 2025-2025 the original author or authors.
+ */
+package org.assertj.eclipse.collections.api;
+
+import org.assertj.core.util.CheckReturnValue;
+import org.assertj.eclipse.collections.api.multimap.MultimapAssert;
+import org.eclipse.collections.api.multimap.Multimap;
+
+/**
+ * Entry point for assertion methods for the Eclipse Collections library. Each method in this class is a static factory
+ * for a type-specific assertion object.
+ */
+@CheckReturnValue
+public class Assertions {
+  /**
+   * Creates a new {@link Assertions}.
+   */
+  protected Assertions() {
+    // Do nothing
+  }
+
+  /**
+   * Creates a new instance of {@link MultimapAssert}.
+   *
+   * @param actual the actual value.
+   * @return the created assertion object.
+   * @param <KEY> The type of keys in the BagMultimap
+   * @param <VALUE> The type of values in the BagMultimap
+   */
+  public static <KEY, VALUE> MultimapAssert<KEY, VALUE> assertThat(Multimap<KEY, VALUE> actual) {
+    return new MultimapAssert<>(actual);
+  }
+}

src/main/java/org/assertj/eclipse/collections/api/Assertions.java

@@ -0,0 +1,43 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * Copyright 2025-2025 the original author or authors.
+ */
+package org.assertj.eclipse.collections.api;
+
+import org.assertj.core.util.CheckReturnValue;
+import org.assertj.eclipse.collections.api.multimap.MultimapAssert;
+import org.eclipse.collections.api.multimap.Multimap;
+
+/**
+ * Behavior-driven development style entry point for assertion methods for the Eclipse Collections library. Each method
+ * in this class is a static factory for a type-specific assertion object.
+ */
+@CheckReturnValue
+public class BDDAssertions extends Assertions {
+  /**
+   * Creates a new <code>{@link BDDAssertions}</code>.
+   */
+  protected BDDAssertions() {
+    // Do nothing
+  }
+
+  /**
+   * Creates a new instance of {@link MultimapAssert}.
+   *
+   * @param actual the actual value.
+   * @return the created assertion object.
+   * @param <KEY> The type of keys in the BagMultimap
+   * @param <VALUE> The type of values in the BagMultimap
+   */
+  public static <KEY, VALUE> MultimapAssert<KEY, VALUE> then(Multimap<KEY, VALUE> actual) {
+    return assertThat(actual);
+  }
+}

src/main/java/org/assertj/eclipse/collections/api/BDDAssertions.java

@@ -0,0 +1,37 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * Copyright 2025-2025 the original author or authors.
+ */
+package org.assertj.eclipse.collections.api;
+
+import org.assertj.core.api.SoftAssertionsProvider;
+import org.assertj.core.util.CheckReturnValue;
+import org.assertj.eclipse.collections.api.multimap.MultimapAssert;
+import org.eclipse.collections.api.multimap.Multimap;
+
+/**
+ * Soft assertions implementations for Eclipse Collections types.
+ */
+@CheckReturnValue
+public interface EclipseCollectionsSoftAssertionsProvider extends SoftAssertionsProvider {
+  /**
+   * Creates a new, proxied instance of a {@link MultimapAssert}
+   *
+   * @param actual the path
+   * @return the created assertion object
+   * @param <KEY> The type of keys in the actual BagMultimap
+   * @param <VALUE> The type of values in the actual BagMultimap
+   */
+  @SuppressWarnings("unchecked")
+  default <KEY, VALUE> MultimapAssert<KEY, VALUE> assertThat(Multimap<KEY, VALUE> actual) {
+    return this.proxy(MultimapAssert.class, Multimap.class, actual);
+  }
+}

src/main/java/org/assertj/eclipse/collections/api/EclipseCollectionsSoftAssertionsProvider.java

@@ -0,0 +1,44 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * Copyright 2025-2025 the original author or authors.
+ */
+package org.assertj.eclipse.collections.api;
+
+import org.assertj.core.api.AbstractSoftAssertions;
+import org.assertj.core.api.SoftAssertionsProvider;
+import org.opentest4j.MultipleFailuresError;
+
+import java.util.function.Consumer;
+
+/**
+ * A soft assertions provider for Eclipse Collections assertions
+ */
+public class SoftAssertions extends AbstractSoftAssertions implements EclipseCollectionsSoftAssertionsProvider {
+  /**
+   * Creates a new {@link SoftAssertions}.
+   */
+  public SoftAssertions() {
+    // Do nothing
+  }
+
+  /**
+   * Convenience method for calling {@link EclipseCollectionsSoftAssertionsProvider#assertSoftly} for these assertion
+   * types. Equivalent to {@code SoftAssertion.assertSoftly(SoftAssertions.class, softly)}.
+   *
+   * @param softly the Consumer containing the code that will make the soft assertions.
+   *               Takes one parameter (the SoftAssertions instance used to make the assertions).
+   * @throws MultipleFailuresError if possible or SoftAssertionError if any proxied assertion objects threw an {@link
+   *                               AssertionError}
+   */
+  public static void assertSoftly(Consumer<SoftAssertions> softly) {
+    SoftAssertionsProvider.assertSoftly(SoftAssertions.class, softly);
+  }
+}