// ***************************************************************************************************************************
// * 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.assertions;

import static org.apache.juneau.internal.ObjectUtils.*;

import java.time.temporal.*;
import java.util.*;

import org.apache.juneau.internal.*;

/**
 * Used for fluent assertion calls against dates.
 *
 * <h5 class='section'>Example:</h5>
 * <p class='bcode w800'>
 *    <jc>// Validates the response expiration is after the current date.</jc>
 *    <jv>client</jv>
 *       .get(<jsf>URL</jsf>)
 *       .run()
 *       .assertDateHeader(<js>"Expires"</js>).isAfterNow();
 * </p>
 *
 * @param <R> The return type.
 */
@FluentSetters(returns="FluentDateAssertion<R>")
public class FluentDateAssertion<R> extends FluentComparableAssertion<R> {

   private final Date value;

   /**
    * Constructor.
    *
    * @param value The value being tested.
    * @param returns The object to return after the test.
    */
   public FluentDateAssertion(Date value, R returns) {
      this(null, value, returns);
   }

   /**
    * Constructor.
    *
    * @param creator The assertion that created this assertion.
    * @param value The value being tested.
    * @param returns The object to return after the test.
    */
   public FluentDateAssertion(Assertion creator, Date value, R returns) {
      super(creator, value, returns);
      this.value = value;
   }

   /**
    * Asserts that the value equals the specified value at the specified precision.
    *
    * @param value The value to check against.
    * @param precision The precision (e.g. {@link ChronoUnit#SECONDS}.
    * @return The response object (for method chaining).
    * @throws AssertionError If assertion failed.
    */
   public R isEqual(Date value, ChronoUnit precision) throws AssertionError {
      if (ne(this.value, value, (x,y)->x.toInstant().truncatedTo(precision).equals(y.toInstant().truncatedTo(precision))))
         throw error("Unexpected value.\n\tExpected=[{0}]\n\tActual=[{1}]", value, this.value);
      return returns();
   }

   /**
    * Asserts that the value is after the specified value.
    *
    * @param value The values to check against.
    * @return The response object (for method chaining).
    * @throws AssertionError If assertion failed.
    */
   public R isAfter(Date value) throws AssertionError {
      exists();
      assertNotNull("value", value);
      if (! (this.value.after(value)))
         throw error("Value was not after expected.\n\tExpected=[{0}]\n\tActual=[{1}]", value, this.value);
      return returns();
   }

   /**
    * Asserts that the value is after the current date.
    *
    * @return The response object (for method chaining).
    * @throws AssertionError If assertion failed.
    */
   public R isAfterNow() throws AssertionError {
      return isAfter(new Date());
   }

   /**
    * Asserts that the value is before the specified value.
    *
    * @param value The values to check against.
    * @return The response object (for method chaining).
    * @throws AssertionError If assertion failed.
    */
   public R isBefore(Date value) throws AssertionError {
      exists();
      assertNotNull("value", value);
      if (! (this.value.before(value)))
         throw error("Value was not before expected.\n\tExpected=[{0}]\n\tActual=[{1}]", value, this.value);
      return returns();
   }

   /**
    * Asserts that the value is before the current date.
    *
    * @return The response object (for method chaining).
    * @throws AssertionError If assertion failed.
    */
   public R isBeforeNow() throws AssertionError {
      return isBefore(new Date());
   }

   /**
    * Asserts that the value is between (exclusive) the specified upper and lower values.
    *
    * @param lower The lower value to check against.
    * @param upper The upper value to check against.
    * @return The response object (for method chaining).
    * @throws AssertionError If assertion failed.
    */
   public R isBetween(Date lower, Date upper) throws AssertionError {
      exists();
      assertNotNull("lower", lower);
      assertNotNull("upper", upper);
      isBefore(upper);
      isAfter(lower);
      return returns();
   }

   // <FluentSetters>

   @Override /* GENERATED - Assertion */
   public FluentDateAssertion<R> msg(String msg, Object...args) {
      super.msg(msg, args);
      return this;
   }

   @Override /* GENERATED - Assertion */
   public FluentDateAssertion<R> stderr() {
      super.stderr();
      return this;
   }

   @Override /* GENERATED - Assertion */
   public FluentDateAssertion<R> stdout() {
      super.stdout();
      return this;
   }

   // </FluentSetters>
}