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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cactoos-matchers Show documentation
Extension for cactoos providing object-oriented hamcrest matchers.
There is a newer version: 0.25
/*
 * 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.
 *
 * 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.Text;
import org.cactoos.text.UncheckedText;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeDiagnosingMatcher;

/**
 * The Text-based {@link TypeSafeDiagnosingMatcher} envelope.
 *
 * @since 1.0.0
 */
public abstract class TextMatcherEnvelope extends
    TypeSafeDiagnosingMatcher {

    /**
     * The matcher to test.
     */
    private final Matcher matcher;

    /**
     * The description of the matcher's expected text.
     */
    private final String expected;

    /**
     * The description of the matcher's actual text.
     */
    private final String actual;

    /**
     * Ctor.
     * @param mtchr The matcher to test.
     * @param expected The description of the matcher's expected text.
     */
    public TextMatcherEnvelope(
        final Matcher mtchr, final String expected
    ) {
        this(mtchr, expected, "Text is ");
    }

    /**
     * Ctor.
     * @param mtchr The matcher to test.
     * @param expected The description of the matcher's expected text.
     * @param actual The description of the matcher's actual text.
     */
    public TextMatcherEnvelope(
        final Matcher mtchr, final String expected, final String actual
    ) {
        super();
        this.matcher = mtchr;
        this.expected = expected;
        this.actual = actual;
    }

    @Override
    public final void describeTo(final Description desc) {
        desc.appendText(this.expected).appendDescriptionOf(this.matcher);
    }

    @Override
    protected final boolean matchesSafely(final Text text,
        final Description desc) {
        desc.appendText(this.actual).appendValue(
            new UncheckedText(text).asString()
        );
        return this.matcher.matches(text);
    }

}