com.fitbur.assertj.error.MessageFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of external-test Show documentation
There is a newer version: 1.0.0
/**
 * 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.
 *
 * Copyright 2012-2016 the original author or authors.
 */
package com.fitbur.assertj.error;

import static com.fitbur.assertj.util.Preconditions.checkNotNull;
import static com.fitbur.assertj.util.Strings.formatIfArgs;

import com.fitbur.assertj.description.Description;
import com.fitbur.assertj.internal.AbstractComparisonStrategy;
import com.fitbur.assertj.presentation.Representation;
import com.fitbur.assertj.util.VisibleForTesting;

/**
 * Formats the messages to be included in assertion errors.
 * 
 * @author Alex Ruiz
 */
public class MessageFormatter {
  private static final MessageFormatter INSTANCE = new MessageFormatter();

  public static MessageFormatter instance() {
    return INSTANCE;
  }

  @VisibleForTesting
  DescriptionFormatter descriptionFormatter = DescriptionFormatter.instance();

  @VisibleForTesting
  MessageFormatter() {
  }

  /**
   * Interprets a printf-style format {@code String} for failed assertion messages. It is similar to
   * {@link String#format(String, Object...)}, except for:
   * 
   * the value of the given {@link Description} is used as the first argument referenced in the format
   * string
   * each of the arguments in the given array is converted to a {@code String} by invoking
   * {@link com.fitbur.assertj.presentation.Representation#toStringOf(Object)}.
   * 
   * 
   * @param d the description of the failed assertion, may be {@code null}.
   * @param format the format string.
   * @param args arguments referenced by the format specifiers in the format string.
   * @throws NullPointerException if the format string is {@code null}.
   * @return A formatted {@code String}.
   */
  public String format(Description d, Representation p, String format, Object... args) {
    checkNotNull(format);
    checkNotNull(args);
    return descriptionFormatter.format(d) + formatIfArgs(format, format(p, args));
  }

  private Object[] format(Representation p, Object[] args) {
    int argCount = args.length;
    String[] formatted = new String[argCount];
    for (int i = 0; i < argCount; i++) {
      formatted[i] = asText(p, args[i]);
    }
    return formatted;
  }

  private String asText(Representation p, Object o) {
    if (o instanceof AbstractComparisonStrategy) {
      return ((AbstractComparisonStrategy) o).asText();
    }
    return p.toStringOf(o);
  }
}