(#165) Rename Verifies to Satisfies and improve API

src/main/java/org/llorllale/cactoos/matchers/Verifies.java → src/main/java/org/llorllale/cactoos/matchers/Satisfies.java

@@ -27,24 +27,61 @@
 package org.llorllale.cactoos.matchers;
 
 import org.cactoos.Func;
+import org.hamcrest.Matcher;
 
 /**
- * Matches if an object verifies the {@link Func}.
+ * Matches if an object satisfies the {@link Func}.
  *
  * @param <T> Type of the matched value
  * @since 1.0.0
  */
-public final class Verifies<T> extends MatcherEnvelope<T> {
+public final class Satisfies<T> extends MatcherEnvelope<T> {
     /**
      * Ctor.
      * @param func Function to verify
      */
-    public Verifies(final Func<? super T, Boolean> func) {
+    public Satisfies(final Func<? super T, Boolean> func) {
+        this(new IsTrue(), "func application", func);
+    }
+
+    /**
+     * Ctor.
+     * @param matcher Matcher for feature
+     * @param extractor Extractor for feature
+     * @param <U> Feature type
+     */
+    public <U> Satisfies(
+        final Matcher<? super U> matcher,
+        final Func<? super T, ? extends U> extractor
+    ) {
+        this(matcher, "feature", extractor);
+    }
+
+    /**
+     * Ctor.
+     * @param matcher Matcher for feature
+     * @param fdesc Description for feature
+     * @param extractor Extractor for feature
+     * @param <U> Feature type
+     */
+    public <U> Satisfies(
+        final Matcher<? super U> matcher, final String fdesc,
+        final Func<? super T, ? extends U> extractor
+    ) {
         super(
             new MatcherOf<>(
-                func,
-                desc -> desc.appendText("verifies"),
-                (obj, desc) -> desc.appendText("was ").appendValue(obj)
+                obj -> matcher.matches(extractor.apply(obj)),
+                desc -> desc
+                    .appendText(fdesc)
+                    .appendText(" satisfies ")
+                    .appendDescriptionOf(matcher),
+                (obj, desc) -> {
+                    desc.appendText(fdesc)
+                        .appendText(" on ")
+                        .appendValue(obj)
+                        .appendText(" ");
+                    matcher.describeMismatch(extractor.apply(obj), desc);
+                }
             )
         );
     }

src/test/java/org/llorllale/cactoos/matchers/MatchesBeforeTest.java

@@ -95,7 +95,7 @@ void propagatesException() {
                     "Must fail",
                     "ignored",
                     new MatchesBefore<>(
-                        10, new Verifies<>(
+                        10, new Satisfies<>(
                             str -> {
                                 throw new IllegalArgumentException();
                             }

src/test/java/org/llorllale/cactoos/matchers/SatisfiesTest.java

@@ -0,0 +1,128 @@
+/*
+ * 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.core.IsEqual;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Test case for {@link Satisfies}.
+ *
+ * @since 1.0.0
+ * @checkstyle MagicNumberCheck (500 lines)
+ */
+final class SatisfiesTest {
+
+    @Test
+    void exampleFunc() {
+        new Assertion<>(
+            "Must satisfies",
+            1,
+            new Satisfies<>(x -> x > 0)
+        ).affirm();
+    }
+
+    @Test
+    void matchesFunc() {
+        new Assertion<>(
+            "Must match",
+            new Satisfies<>(x -> x > 0),
+            new Matches<>(1)
+        ).affirm();
+    }
+
+    @Test
+    void mismatchesFunc() {
+        new Assertion<>(
+            "must mismatch",
+            new Satisfies<>(x -> x > 1),
+            new Mismatches<>(
+                0,
+                "func application satisfies <true>",
+                "func application on <0> was <false>"
+            )
+        ).affirm();
+    }
+
+    @Test
+    void example() {
+        new Assertion<>(
+            "Must satisfies on an extracted feature",
+            "one string",
+            new Satisfies<>(
+                new IsEqual<>(10),
+                String::length
+            )
+        ).affirm();
+    }
+
+    @Test
+    void matches() {
+        new Assertion<>(
+            "Must match an extracted feature",
+            new Satisfies<>(
+                new IsEqual<>(8),
+                String::length
+            ),
+            new Matches<>("1 string")
+        ).affirm();
+    }
+
+    @Test
+    void mismatches() {
+        new Assertion<>(
+            "must mismatch an extracted feature",
+            new Satisfies<>(
+                new IsEqual<>(4),
+                "length",
+                String::length
+            ),
+            new Mismatches<>(
+                "the string",
+                "length satisfies <4>",
+                "length on \"the string\" was <10>"
+            )
+        ).affirm();
+    }
+
+    @Test
+    void mismatchesNoDesc() {
+        new Assertion<>(
+            "must mismatch with default descriptions",
+            new Satisfies<>(
+                new IsEqual<>(5),
+                String::length
+            ),
+            new Mismatches<>(
+                "some string",
+                "feature satisfies <5>",
+                "feature on \"some string\" was <11>"
+            )
+        ).affirm();
+    }
+}