/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.juneau.bct.assertions;

import static org.apache.juneau.commons.utils.Shorts.*;
import static org.apache.juneau.commons.utils.StringUtils.*;

import java.io.*;
import java.util.*;
import java.util.function.*;
import java.util.regex.*;

import org.apache.juneau.commons.function.*;
import org.apache.juneau.commons.utils.*;

/**
 * Used for fluent assertion calls against strings.
 *
 * <h5 class='section'>Example:</h5>
 * <p class='bjava'>
 *    <jc>// Validates the response body of an HTTP call is the text "OK".</jc>
 *    <jv>client</jv>
 *       .get(<jsf>URL</jsf>)
 *       .run()
 *       .assertContent().is(<js>"OK"</js>);
 * </p>
 *
 *
 * <h5 class='section'>Test Methods:</h5>
 * <p>
 * <ul class='javatree'>
 *    <li class='jc'>{@link FluentStringAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentStringAssertion#is(String) is(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isNot(String) isNot(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isLines(String...) isLines(String...)}
 *       <li class='jm'>{@link FluentStringAssertion#isSortedLines(String...) isSortedLines(String...)}
 *       <li class='jm'>{@link FluentStringAssertion#isIc(String) isIc(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isNotIc(String) isNotIc(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isContains(String...) isContains(String...)}
 *       <li class='jm'>{@link FluentStringAssertion#isNotContains(String...) isNotContains(String...)}
 *       <li class='jm'>{@link FluentStringAssertion#isEmpty() isEmpty()}
 *       <li class='jm'>{@link FluentStringAssertion#isNotEmpty() isNotEmpty()}
 *       <li class='jm'>{@link FluentStringAssertion#isString(Object) isString(Object)}
 *       <li class='jm'>{@link FluentStringAssertion#isMatches(String) isMatches(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isPattern(String) isPattern(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isPattern(String,int) isPattern(String,int)}
 *       <li class='jm'>{@link FluentStringAssertion#isPattern(Pattern) isPattern(Pattern)}
 *       <li class='jm'>{@link FluentStringAssertion#isStartsWith(String) isStartsWith(String)}
 *       <li class='jm'>{@link FluentStringAssertion#isEndsWith(String) isEndsWith(String)}
 *    </ul>
 *    <li class='jc'>{@link FluentObjectAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentObjectAssertion#isExists() isExists()}
 *       <li class='jm'>{@link FluentObjectAssertion#is(Object) is(Object)}
 *       <li class='jm'>{@link FluentObjectAssertion#is(Predicate) is(Predicate)}
 *       <li class='jm'>{@link FluentObjectAssertion#isNot(Object) isNot(Object)}
 *       <li class='jm'>{@link FluentObjectAssertion#isAny(Object...) isAny(Object...)}
 *       <li class='jm'>{@link FluentObjectAssertion#isNotAny(Object...) isNotAny(Object...)}
 *       <li class='jm'>{@link FluentObjectAssertion#isNull() isNull()}
 *       <li class='jm'>{@link FluentObjectAssertion#isNotNull() isNotNull()}
 *       <li class='jm'>{@link FluentObjectAssertion#isString(String) isString(String)}
 *       <li class='jm'>{@link FluentObjectAssertion#isSame(Object) isSame(Object)}
 *       <li class='jm'>{@link FluentObjectAssertion#isType(Class) isType(Class)}
 *       <li class='jm'>{@link FluentObjectAssertion#isExactType(Class) isExactType(Class)}
 *    </ul>
 * </ul>
 *
 * <h5 class='section'>Transform Methods:</h5>
 * <p>
 * <ul class='javatree'>
 *    <li class='jc'>{@link FluentStringAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentStringAssertion#asReplaceAll(String,String) asReplaceAll(String,String)}
 *       <li class='jm'>{@link FluentStringAssertion#asReplace(String,String) asReplace(String,String)}
 *       <li class='jm'>{@link FluentStringAssertion#asUrlDecode() asUrlDecode()}
 *       <li class='jm'>{@link FluentStringAssertion#asLc() asLc()}
 *       <li class='jm'>{@link FluentStringAssertion#asUc() asUc()}
 *       <li class='jm'>{@link FluentStringAssertion#asLines() asLines()}
 *       <li class='jm'>{@link FluentStringAssertion#asSplit(String) asSplit(String)}
 *       <li class='jm'>{@link FluentStringAssertion#asLength() asLength()}
 *       <li class='jm'>{@link FluentStringAssertion#asOneLine() asOneLine()}
  *   </ul>
 *    <li class='jc'>{@link FluentObjectAssertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link FluentObjectAssertion#asString() asString()}
 *       <li class='jm'>{@link FluentObjectAssertion#asString(ThrowingFunction) asString(ThrowingFunction)}
 *       <li class='jm'>{@link FluentObjectAssertion#asTransformed(UnaryOperator) asTransformed(UnaryOperator)}
 *       <li class='jm'>{@link FluentObjectAssertion#asAny() asAny()}
 * </ul>
 * </ul>
 *
 * <h5 class='section'>Configuration Methods:</h5>
 * <p>
 * <ul class='javatree'>
 *    <li class='jc'>{@link Assertion}
 *    <ul class='javatreec'>
 *       <li class='jm'>{@link Assertion#setMsg(String, Object...) setMsg(String, Object...)}
 *       <li class='jm'>{@link Assertion#setOut(PrintStream) setOut(PrintStream)}
 *       <li class='jm'>{@link Assertion#setSilent() setSilent()}
 *       <li class='jm'>{@link Assertion#setStdOut() setStdOut()}
 *       <li class='jm'>{@link Assertion#setThrowable(Class) setThrowable(Class)}
 *    </ul>
 * </ul>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauEcosystemOverview">Juneau Ecosystem</a>
 * </ul>
 *
 * @param <R> The return type.
 */
@SuppressWarnings({
   "java:S115", // Constants use UPPER_snakeCase convention
   "java:S1192" // Duplicated literals (argument/property names) read more clearly inline than as constants
})
public class FluentStringAssertion<R> extends FluentObjectAssertion<String,R> {

   private static final String LINE_SEPARATOR_REGEX = "[\\r\\n]+";

   private static final Messages MESSAGES = Messages.of(FluentStringAssertion.class, "Messages");
   private static final String MSG_stringDifferedAtPosition = MESSAGES.getString("stringDifferedAtPosition");
   private static final String MSG_expectedStringHadDifferentNumbersOfLines = MESSAGES.getString("expectedStringHadDifferentNumbersOfLines");
   private static final String MSG_expectedStringHadDifferentValuesAtLine = MESSAGES.getString("expectedStringHadDifferentValuesAtLine");
   private static final String MSG_stringEqualedUnexpected = MESSAGES.getString("stringEqualedUnexpected");
   private static final String MSG_stringDidNotContainExpectedSubstring = MESSAGES.getString("stringDidNotContainExpectedSubstring");
   private static final String MSG_stringContainedUnexpectedSubstring = MESSAGES.getString("stringContainedUnexpectedSubstring");
   private static final String MSG_stringWasNotEmpty = MESSAGES.getString("stringWasNotEmpty");
   private static final String MSG_stringWasNull = MESSAGES.getString("stringWasNull");
   private static final String MSG_stringWasEmpty = MESSAGES.getString("stringWasEmpty");
   private static final String MSG_stringDidNotMatchExpectedPattern = MESSAGES.getString("stringDidNotMatchExpectedPattern");
   private static final String MSG_stringDidNotStartWithExpected = MESSAGES.getString("stringDidNotStartWithExpected");
   private static final String MSG_stringDidNotEndWithExpected = MESSAGES.getString("stringDidNotEndWithExpected");

   private boolean javaStrings;

   /**
    * Chained constructor.
    *
    * <p>
    * Used when transforming one assertion into another so that the assertion config can be used by the new assertion.
    *
    * @param creator
    *    The assertion that created this assertion.
    *    <br>Should be <jk>null</jk> if this is the top-level assertion.
    * @param value
    *    The object being tested.
    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
    * @param returns
    *    The object to return after a test method is called.
    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
    * used on the same assertion.
    */
   public FluentStringAssertion(Assertion creator, String value, R returns) {
      super(creator, value, returns);
   }

   /**
    * Constructor.
    *
    * @param value
    *    The object being tested.
    *    <br>Can be <jk>null</jk> (assertions such as {@code isNull()} then operate on the absence of a value).
    * @param returns
    *    The object to return after a test method is called.
    *    <br>If <jk>null</jk>, the test method returns this object allowing multiple test method calls to be
    * used on the same assertion.
    */
   public FluentStringAssertion(String value, R returns) {
      this(null, value, returns);
   }

   /**
    * When enabled, text in the message is converted to valid Java strings.
    *
    * <p class='bjava'>
    *    <jv>value</jv>.replaceAll(<js>"\\\\"</js>, <js>"\\\\\\\\"</js>).replaceAll(<js>"\n"</js>, <js>"\\\\n"</js>).replaceAll(<js>"\t"</js>, <js>"\\\\t"</js>);
    * </p>
    *
    * @return This object.
    */
   public FluentStringAssertion<R> asJavaStrings() {
      this.javaStrings = true;
      return this;
   }

   /**
    * Converts the text to lowercase.
    *
    * @return This object.
    */
   public FluentStringAssertion<R> asLc() {
      return asTransformed(Shorts::lcr);
   }

   /**
    * Returns the length of this string as an integer assertion.
    *
    * @return This object.
    */
   public FluentIntegerAssertion<R> asLength() {
      return new FluentIntegerAssertion<>(this, valueIsNull() ? null : value().length(), returns());
   }

   /**
    * Splits the string into lines.
    *
    * @return This object.
    */
   public FluentListAssertion<String,R> asLines() {
      return asSplit(LINE_SEPARATOR_REGEX);
   }

   /**
    * Removes any newlines from the string.
    *
    * @return This object.
    */
   public FluentStringAssertion<R> asOneLine() {
      return asTransformed(x -> x == null ? null : x.replaceAll("[\\r\\n]+[ \\t]*", "  "));
   }

   /**
    * Performs the specified substring replacement on the underlying string.
    *
    * @param target The sequence of char values to be replaced.
    * @param replacement The replacement sequence of char values.
    * @return This object.
    */
   public FluentStringAssertion<R> asReplace(String target, String replacement) {
      reqnn("target", target);
      reqnn("replacement", replacement);
      return asTransformed(x -> x == null ? null : x.replace(target, replacement));
   }

   /**
    * Performs the specified regular expression replacement on the underlying string.
    *
    * @param regex The regular expression to which this string is to be matched.
    * @param replacement The string to be substituted for each match.
    * @return This object.
    */
   public FluentStringAssertion<R> asReplaceAll(String regex, String replacement) {
      reqnn("regex", regex);
      reqnn("replacement", replacement);
      return asTransformed(x -> x == null ? null : x.replaceAll(regex, replacement));
   }

   /**
    * Splits the string into lines using the specified regular expression.
    *
    * @param regex The delimiting regular expression
    * @return This object.
    */
   public FluentListAssertion<String,R> asSplit(String regex) {
      reqnn("regex", regex);
      return new FluentListAssertion<>(this, valueIsNull() ? null : l(value().trim().split(regex)), returns());
   }

   @Override /* Overridden from FluentObjectAssertion */
   public FluentStringAssertion<R> asTransformed(UnaryOperator<String> function) {
      return new FluentStringAssertion<>(this, function.apply(orElse(null)), returns());
   }

   /**
    * Removes any leading/trailing whitespace from the string.
    *
    * @return This object.
    */
   public FluentStringAssertion<R> asTrimmed() {
      return new FluentStringAssertion<>(this, valueIsNull() ? null : value().trim(), returns());
   }

   /**
    * Converts the text to uppercase.
    *
    * @return This object.
    */
   public FluentStringAssertion<R> asUc() {
      return asTransformed(Shorts::ucr);
   }

   /**
    * URL-decodes the text in this assertion.
    *
    * @return This object.
    */
   public FluentStringAssertion<R> asUrlDecode() {
      return asTransformed(StringUtils::urlDecode);
   }

   /**
    * Asserts that the text equals the specified value.
    *
    * <p>
    * Similar to {@link #is(String)} except error message states diff position.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bjava'>
    *    <jc>// Validates the response body of an HTTP call is the text "OK".</jc>
    *    <jv>client</jv>
    *       .get(<jsf>URL</jsf>)
    *       .run()
    *       .assertContent().is(<js>"OK"</js>);
    * </p>
    *
    * @param value
    *    The value to check against.
    *    <br>If multiple values are specified, they are concatenated with newlines.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   @Override
   public R is(String value) throws AssertionError {
      var s = orElse(null);
      if (neq(value, s))
         throw error(MSG_stringDifferedAtPosition, diffPosition(value, s), fix(value), fix(s));
      return returns();
   }

   /**
    * Asserts that the text contains all of the specified substrings.
    *
    * @param values The values to check against.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isContains(String...values) throws AssertionError {
      reqnn("values", values);
      var s = orElse(null);
      for (var substring : values)
         if (nn(substring) && ! contains(s, substring))
            throw error(MSG_stringDidNotContainExpectedSubstring, fix(substring), fix(s));
      return returns();
   }

   /**
    * Asserts that the text is empty.
    *
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isEmpty() throws AssertionError {
      var s = orElse(null);
      if (nn(s) && ! s.isEmpty())
         throw error(MSG_stringWasNotEmpty, fix(s));
      return returns();
   }

   /**
    * Asserts that the text ends with the specified string.
    *
    * @param string The string to test for.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isEndsWith(String string) {
      reqnn("string", string);
      var s = value();
      if (! s.endsWith(string))
         throw error(MSG_stringDidNotEndWithExpected, fix(string), fix(s));
      return returns();
   }

   /**
    * Asserts that the text equals the specified value ignoring case.
    *
    * @param value The value to check against.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isIc(String value) throws AssertionError {
      var s = orElse(null);
      if (neqic(value, s))
         throw error(MSG_stringDifferedAtPosition, diffPositionIc(value, s), fix(value), fix(s));
      return returns();
   }

   /**
    * Asserts that the lines of text equals the specified value.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bjava'>
    *    <jc>// Validates the response body of an HTTP call is the text "OK".</jc>
    *    <jv>client</jv>
    *       .get(<jsf>URL</jsf>)
    *       .run()
    *       .assertContent().isLines(
    *          <js>"Line 1"</js>,
    *          <js>"Line 2"</js>,
    *          <js>"Line 3"</js>
    *       );
    * </p>
    *
    * @param lines
    *    The value to check against.
    *    <br>If multiple values are specified, they are concatenated with newlines.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isLines(String...lines) throws AssertionError {
      reqnn("lines", lines);
      var v = join(lines, '\n');
      var s = value();
      if (neq(v, s))
         throw error(MSG_stringDifferedAtPosition, diffPosition(v, s), fix(v), fix(s));
      return returns();
   }

   /**
    * Asserts that the text matches the specified pattern containing <js>"*"</js> meta characters.
    *
    * <p>
    * The <js>"*"</js> meta character can be used to represent zero or more characters..
    *
    * @param searchPattern The search pattern.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isMatches(String searchPattern) throws AssertionError {
      reqnn("searchPattern", searchPattern);
      return isPattern(getMatchPattern(searchPattern));
   }

   /**
    * Asserts that the text equals the specified value.
    *
    * @param value The value to check against.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   @Override
   public R isNot(String value) throws AssertionError {
      var s = orElse(null);
      if (eq(value, s))
         throw error(MSG_stringEqualedUnexpected, fix(s));
      return returns();
   }

   /**
    * Asserts that the text doesn't contain any of the specified substrings.
    *
    * @param values The values to check against.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isNotContains(String...values) throws AssertionError {
      reqnn("values", values);
      var s = orElse(null);
      for (var substring : values)
         if (nn(substring) && contains(s, substring))
            throw error(MSG_stringContainedUnexpectedSubstring, fix(substring), fix(s));
      return returns();
   }

   /**
    * Asserts that the text is not null or empty.
    *
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isNotEmpty() throws AssertionError {
      var s = orElse(null);
      if (s == null)
         throw error(MSG_stringWasNull);
      if (s.isEmpty())
         throw error(MSG_stringWasEmpty);
      return returns();
   }

   /**
    * Asserts that the text does not equal the specified value ignoring case.
    *
    * @param value The value to check against.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isNotIc(String value) throws AssertionError {
      var s = orElse(null);
      if (eqic(value, s))
         throw error(MSG_stringEqualedUnexpected, fix(s));
      return returns();
   }

   /**
    * Asserts that the text matches the specified regular expression pattern.
    *
    * @param pattern The pattern to test for.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isPattern(Pattern pattern) throws AssertionError {
      reqnn("pattern", pattern);
      var s = value();
      if (! pattern.matcher(s).matches())
         throw error(MSG_stringDidNotMatchExpectedPattern, fix(pattern.pattern()), fix(s));
      return returns();
   }

   /**
    * Asserts that the text matches the specified regular expression.
    *
    * @param regex The pattern to test for.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isPattern(String regex) throws AssertionError {
      return isPattern(regex, 0);
   }

   /**
    * Asserts that the text matches the specified regular expression.
    *
    * @param regex The pattern to test for.
    * @param flags Pattern match flags.  See {@link Pattern#compile(String, int)}.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isPattern(String regex, int flags) throws AssertionError {
      reqnn("regex", regex);
      var p = Pattern.compile(regex, flags);
      var s = value();
      if (! p.matcher(s).matches())
         throw error(MSG_stringDidNotMatchExpectedPattern, fix(regex), fix(s));
      return returns();
   }

   /**
    * Asserts that the text equals the specified value after splitting both by newlines and sorting the rows.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bjava'>
    *    <jc>// Validates the response body of an HTTP call is the text "OK".</jc>
    *    <jv>client</jv>
    *       .get(<jsf>URL</jsf>)
    *       .run()
    *       .assertContent().isSortedLines(
    *          <js>"Line 1"</js>,
    *          <js>"Line 2"</js>,
    *          <js>"Line 3"</js>
    *       );
    * </p>
    *
    * @param lines
    *    The value to check against.
    *    <br>If multiple values are specified, they are concatenated with newlines.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isSortedLines(String...lines) {
      reqnn("lines", lines);

      // Must work for windows too.
      var e = join(lines, '\n').trim().split(LINE_SEPARATOR_REGEX);
      var a = value().trim().split(LINE_SEPARATOR_REGEX);

      if (e.length != a.length)
         throw error(MSG_expectedStringHadDifferentNumbersOfLines, e.length, a.length);

      Arrays.sort(e);
      Arrays.sort(a);

      for (var i = 0; i < e.length; i++)
         if (! e[i].equals(a[i]))
            throw error(MSG_expectedStringHadDifferentValuesAtLine, i + 1, e[i], a[i]);

      return returns();
   }

   /**
    * Asserts that the text starts with the specified string.
    *
    * @param string The string to test for.
    * @return The fluent return object.
    * @throws AssertionError If assertion failed.
    */
   public R isStartsWith(String string) {
      reqnn("string", string);
      var s = value();
      if (! s.startsWith(string))
         throw error(MSG_stringDidNotStartWithExpected, fix(string), fix(s));
      return returns();
   }

   /**
    * Asserts that the text equals the specified object after calling {@link #toString()} on the object.
    *
    * @param value The value to check against.
    * @return The fluent return object.
    */
   public R isString(Object value) {
      return is(value == null ? null : toString());
   }

   @Override /* Overridden from Assertion */
   public FluentStringAssertion<R> setMsg(String msg, Object...args) {
      super.setMsg(msg, args);
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentStringAssertion<R> setOut(PrintStream value) {
      super.setOut(value);
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentStringAssertion<R> setSilent() {
      super.setSilent();
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentStringAssertion<R> setStdOut() {
      super.setStdOut();
      return this;
   }

   @Override /* Overridden from Assertion */
   public FluentStringAssertion<R> setThrowable(Class<? extends RuntimeException> value) {
      super.setThrowable(value);
      return this;
   }

   private String fix(String text) {
      if (javaStrings)
         text = text.replace("\\", "\\\\").replace("\n", "\\n").replace("\t", "\\t");
      return text;
   }
}