BaselineMatchers.java

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2020 wcm.io
 * %%
 * 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.
 * #L%
 */
package io.wcm.qa.glnm.hamcrest.baseline;

import java.util.List;
import java.util.Map;

import org.hamcrest.Matcher;

import io.wcm.qa.glnm.differences.base.Difference;
import io.wcm.qa.glnm.differences.base.Differences;
import io.wcm.qa.glnm.differences.difference.EnumDifference;
import io.wcm.qa.glnm.differences.difference.StringDifference;

/**
 * <p>Matchers class.</p>
 *
 * @since 5.0.0
 */
public final class BaselineMatchers {

  private BaselineMatchers() {
    // do not instantiate
  }

  /**
   * Matches map size against baseline.
   *
   * @return baseline based version of {@link org.hamcrest.Matchers#aMapWithSize(int)}
   * @since 5.0.0
   */
  public static Matcher<Map<? extends Object, ? extends Object>> aMapWithSize() {
    return AMapWithSize.aMapWithSize();
  }

  /**
   * Matches array with size.
   *
   * @return baseline based version of {@link org.hamcrest.Matchers#arrayWithSize(int)}
   * @since 5.0.0
   */
  public static Matcher<Object[]> arrayWithSize() {
    return ArrayWithSize.arrayWithSize();
  }

  /**
   * Matcher using persistence.
   *
   * @return boolean matcher working with baseline
   * @since 5.0.0
   */
  public static Matcher<Boolean> baselineBoolean() {
    return BaselineBoolean.baselineBoolean();
  }

  /**
   * Matcher using persistence.
   *
   * @return integer matcher working with baseline
   * @since 5.0.0
   */
  public static Matcher<Integer> baselineInteger() {
    return BaselineInteger.baselineInteger();
  }

  /**
   * Matcher using persistence.
   *
   * @return string matcher working with baseline
   * @since 5.0.0
   */
  public static DifferentiatingMatcher<String> baselineString() {
    return BaselineString.baselineString();
  }

  /**
   * Matcher using persistence.
   *
   * @return string list matcher working with baseline
   * @since 5.0.0
   */
  public static Matcher<List<String>> baselineStringList() {
    return new BaselineStringList();
  }

  /**
   * <p>
   * Adds a difference to following matchers.
   * </p>
   *
   * @param <T> type matcher can handle
   * @param difference a {@link io.wcm.qa.glnm.differences.base.Difference} object.
   * @param matcher a {@link org.hamcrest.Matcher} object.
   * @return a {@link io.wcm.qa.glnm.hamcrest.baseline.DifferentiatingMatcher} object.
   * @since 5.0.0
   */
  public static <T> DifferentiatingMatcher<T> on(String difference, Matcher<T> matcher) {
    return on(new StringDifference(difference), matcher);
  }

  /**
   * <p>
   * Adds a difference to following matchers.
   * </p>
   *
   * @param <T> type matcher can handle
   * @param difference enum value to use as difference
   * @param matcher to differentiate with this difference
   * @return a {@link io.wcm.qa.glnm.hamcrest.baseline.DifferentiatingMatcher} object.
   * @since 5.0.0
   */
  public static <T> DifferentiatingMatcher<T> on(Enum difference, Matcher<T> matcher) {
    return on(new EnumDifference(difference), matcher);
  }

  /**
   * <p>
   * Adds a difference to following matchers.
   * </p>
   *
   * @param <T> type matcher can handle
   * @param difference a {@link io.wcm.qa.glnm.differences.base.Difference} object.
   * @param matcher a {@link org.hamcrest.Matcher} object.
   * @return a {@link io.wcm.qa.glnm.hamcrest.baseline.DifferentiatingMatcher} object.
   * @since 5.0.0
   */
  public static <T> DifferentiatingMatcher<T> on(Difference difference, Matcher<T> matcher) {
    DifferentiatingMatcher<T> differentiatedMatcher = BaselineUtil.differentiate(matcher);
    differentiatedMatcher.prepend(difference);
    return differentiatedMatcher;
  }

  /**
   * <p>
   * Adds a difference to following matchers.
   * </p>
   *
   * @param <T> type matcher can handle
   * @param differences will be used to differentiate the matcher
   * @param matcher a {@link org.hamcrest.Matcher} to be differentiated.
   * @return a {@link io.wcm.qa.glnm.hamcrest.baseline.DifferentiatingMatcher} object.
   * @since 5.0.0
   */
  public static <T> DifferentiatingMatcher<T> on(Differences differences, Matcher<T> matcher) {
    return BaselineUtil.differentiate(matcher, differences);
  }

}