org.llorllale.cactoos.matchers.HasValuesMatching Maven / Gradle / Ivy

Go to download
/*
 * 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.cactoos.Func;
import org.cactoos.scalar.Or;
import org.cactoos.text.FormattedText;
import org.cactoos.text.TextOf;

/**
 * Matcher to check that {@link Iterable} has elements matched by particular
 *  function.
 *
 * Here is an example how {@link HasValuesMatching} can be used:
 * {@code
 *  new Assertion<>(
 *     "must match",
 *     new ListOf<>(1, 2, 3),
 *     new HasValuesMatching<>(value -> value > 2 || value == 3)
 *  ).affirm();
 * }
 *
 * @param  Type of item.
 * @since 1.0.0
 */
public final class HasValuesMatching extends MatcherEnvelope> {
    /**
     * Ctor.
     * @param fnc The function to match at least one element within the
     *  {@link Iterable}.
     */
    public HasValuesMatching(final Func fnc) {
        super(
            new MatcherOf<>(
                actual -> new Or(fnc, actual).value(),
                desc -> desc.appendText("The function matches at least 1 element."),
                (actual, desc) -> desc.appendText(
                    new FormattedText(
                        "No any elements from [%s] matches by the function",
                        new TextOf(actual)
                    ).asString()
                )
            )
        );
    }
}