#235: Add matchers for Comparable objects

pom.xml

@@ -77,6 +77,17 @@
       <groupId>org.hamcrest</groupId>
       <artifactId>hamcrest</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.code.findbugs</groupId>
+      <artifactId>findbugs-annotations</artifactId>
+      <version>3.0.1</version>
+      <scope>provided</scope>
+    </dependency>
   </dependencies>
   <profiles>
     <profile>
@@ -86,7 +97,6 @@
           <plugin>
             <groupId>com.qulice</groupId>
             <artifactId>qulice-maven-plugin</artifactId>
-            <version>0.18.19</version>
           </plugin>
           <plugin>
             <groupId>de.thetaphi</groupId>

src/main/java/org/llorllale/cactoos/matchers/IsEqualTo.java

@@ -0,0 +1,61 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) for portions of project cactoos-matchers are held by
+ * Yegor Bugayenko, 2017-2018, as part of project cactoos.
+ * All other copyright for project cactoos-matchers are held by
+ * George Aristy, 2018-2020.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.llorllale.cactoos.matchers;
+
+import java.util.Comparator;
+import org.hamcrest.comparator.ComparatorMatcherBuilder;
+
+/**
+ * Is {@link Comparable} equal to.
+ *
+ * @param <T> Underlying type.
+ * @since 1.0.0
+ */
+public final class IsEqualTo<T extends Comparable<? super T>> extends
+    MatcherEnvelope<T> {
+    /**
+     * Ctor.
+     * @param expected The expected value
+     */
+    public IsEqualTo(final T expected) {
+        this(new NaturalOrdering<>(), expected);
+    }
+
+    /**
+     * Ctor.
+     * @param comparator The comparator.
+     * @param expected The expected value
+     */
+    public IsEqualTo(final Comparator<? super T> comparator, final T expected) {
+        super(
+            ComparatorMatcherBuilder
+                .comparedBy(comparator)
+                .comparesEqualTo(expected)
+        );
+    }
+
+}

src/main/java/org/llorllale/cactoos/matchers/IsGreaterThan.java

@@ -0,0 +1,53 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) for portions of project cactoos-matchers are held by
+ * Yegor Bugayenko, 2017-2018, as part of project cactoos.
+ * All other copyright for project cactoos-matchers are held by
+ * George Aristy, 2018-2020.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.llorllale.cactoos.matchers;
+
+import org.hamcrest.comparator.ComparatorMatcherBuilder;
+
+/**
+ * Is {@link Comparable} object greater than.
+ *
+ * @param <T> Underlying type.
+ * @since 1.0.0
+ */
+public final class IsGreaterThan<T extends Comparable<? super T>> extends
+    MatcherEnvelope<T> {
+
+    /**
+     * Ctor.
+     *
+     * @param expected The expected value
+     */
+    public IsGreaterThan(final T expected) {
+        super(
+            ComparatorMatcherBuilder
+                .comparedBy(new NaturalOrdering<T>())
+                .greaterThan(expected)
+        );
+    }
+
+}

src/main/java/org/llorllale/cactoos/matchers/IsGreaterThanOrEqualTo.java

@@ -0,0 +1,51 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) for portions of project cactoos-matchers are held by
+ * Yegor Bugayenko, 2017-2018, as part of project cactoos.
+ * All other copyright for project cactoos-matchers are held by
+ * George Aristy, 2018-2020.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.llorllale.cactoos.matchers;
+
+import org.hamcrest.comparator.ComparatorMatcherBuilder;
+
+/**
+ * Is {@link Number} greater than or equal to.
+ *
+ * @param <T> Underlying type.
+ * @since 1.0.0
+ */
+public final class IsGreaterThanOrEqualTo<T extends Comparable<? super T>> extends
+    MatcherEnvelope<T> {
+    /**
+     * Ctor.
+     * @param expected The expected value
+     */
+    public IsGreaterThanOrEqualTo(final T expected) {
+        super(
+            ComparatorMatcherBuilder
+                .comparedBy(new NaturalOrdering<T>())
+                .greaterThanOrEqualTo(expected)
+        );
+    }
+
+}

src/main/java/org/llorllale/cactoos/matchers/IsLessThan.java

@@ -0,0 +1,51 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) for portions of project cactoos-matchers are held by
+ * Yegor Bugayenko, 2017-2018, as part of project cactoos.
+ * All other copyright for project cactoos-matchers are held by
+ * George Aristy, 2018-2020.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.llorllale.cactoos.matchers;
+
+import org.hamcrest.comparator.ComparatorMatcherBuilder;
+
+/**
+ * Is {@link Comparable} object greater than.
+ *
+ * @param <T> Underlying type.
+ * @since 1.0.0
+ */
+public final class IsLessThan<T extends Comparable<? super T>> extends
+    MatcherEnvelope<T> {
+    /**
+     * Ctor.
+     * @param expected The expected value
+     */
+    public IsLessThan(final T expected) {
+        super(
+            ComparatorMatcherBuilder
+                .comparedBy(new NaturalOrdering<T>())
+                .lessThan(expected)
+        );
+    }
+
+}

src/main/java/org/llorllale/cactoos/matchers/IsLessThanOrEqualTo.java

@@ -0,0 +1,51 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) for portions of project cactoos-matchers are held by
+ * Yegor Bugayenko, 2017-2018, as part of project cactoos.
+ * All other copyright for project cactoos-matchers are held by
+ * George Aristy, 2018-2020.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package org.llorllale.cactoos.matchers;
+
+import org.hamcrest.comparator.ComparatorMatcherBuilder;
+
+/**
+ * Is {@link Comparable} object less than or equal to.
+ *
+ * @param <T> Underlying type.
+ * @since 1.0.0
+ */
+public final class IsLessThanOrEqualTo<T extends Comparable<? super T>> extends
+    MatcherEnvelope<T> {
+    /**
+     * Ctor.
+     * @param expected The expected value
+     */
+    public IsLessThanOrEqualTo(final T expected) {
+        super(
+            ComparatorMatcherBuilder
+                .comparedBy(new NaturalOrdering<T>())
+                .lessThanOrEqualTo(expected)
+        );
+    }
+
+}

src/main/java/org/llorllale/cactoos/matchers/IsNumber.java

@@ -26,44 +26,24 @@
  */
 package org.llorllale.cactoos.matchers;
 
-import java.util.Comparator;
+import org.hamcrest.comparator.ComparatorMatcherBuilder;
 
 /**
- * Matcher for {@link Number}.
+ * Matcher for {@link Number} equality.
  *
  * @since 1.0.0
  */
 public final class IsNumber extends MatcherEnvelope<Number> {
 
-    /**
-     * Comparator of numbers.
-     */
-    private static final Comparator<Number> FNC =
-        Comparator
-            .comparing(Number::doubleValue)
-            .thenComparing(Number::intValue)
-            .thenComparing(Number::longValue)
-            .thenComparing(Number::floatValue);
-
     /**
      * Ctor.
      * @param expected The expected value
-     * @todo #165:30min Introduce a ComparatorMatcher that encapsulates comparison logic here.
-     *  It would only take a {@code Comparator<X>} and an expected X for example.
      */
     public IsNumber(final Number expected) {
         super(
-            new MatcherOf<>(
-                actual -> IsNumber.FNC.compare(actual, expected) == 0,
-                desc -> desc.appendText("equals ").appendValue(expected),
-                (actual, desc) -> desc
-                    .appendText("comparator returns ")
-                    .appendValue(IsNumber.FNC.compare(actual, expected))
-                    .appendText(" when ")
-                    .appendValue(expected)
-                    .appendText(" compared to ")
-                    .appendValue(actual)
-            )
+            ComparatorMatcherBuilder
+                .comparedBy(new NumberComparator())
+                .comparesEqualTo(expected)
         );
     }
 

src/main/java/org/llorllale/cactoos/matchers/MatcherEnvelope.java

@@ -40,13 +40,13 @@ public abstract class MatcherEnvelope<T> extends BaseMatcher<T> {
     /**
      * The matcher to test.
      */
-    private final Matcher<T> origin;
+    private final Matcher<? super T> origin;
 
     /**
      * Ctor.
      * @param origin Encapsulated matcher.
      */
-    protected MatcherEnvelope(final Matcher<T> origin) {
+    protected MatcherEnvelope(final Matcher<? super T> origin) {
         super();
         this.origin = origin;
     }