YearMonthOps.scala

/******************************************************************
 * See the NOTICE file distributed with this work for additional  *
 * information regarding Copyright ownership.  The author/authors *
 * license this file to you under the terms of 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 codes.reactive.scalatime.impl

import java.time.format.DateTimeFormatter
import java.time.{DateTimeException, LocalDate, YearMonth}

import scala.language.implicitConversions

/** Enriches [[YearMonth]] instances with additional methods. */
final case class YearMonthOps(underlying: YearMonth) extends AnyVal {

  /** Obtains a [[java.time.YearMonth]] with the specified number of months added.
    *
    * @throws DateTimeException if the result exceeds the supported range.
    */
  def +(months: Int): YearMonth = underlying.plusMonths(months)

  /** Obtains a [[YearMonth]] with the specified number of months subtracted.
    *
    * @throws DateTimeException if the result exceeds the supported range.
    */
  def -(months: Int): YearMonth = underlying.minusMonths(months)

  /** Returns `true` if this year-month is before the specified one. */
  def <(other: YearMonth): Boolean = underlying.isBefore(other)

  /** Returns `true` if this year-month is equal to or before the specified one. */
  def <=(other: YearMonth): Boolean = underlying.equals(other) || underlying.isBefore(other)

  /** Returns `true` if this year-month is after the specified one. */
  def >(other: YearMonth): Boolean = underlying.isAfter(other)

  /** Returns `true` if this year-month is equal to or after the specified one. */
  def >=(other: YearMonth): Boolean = underlying.equals(other) || underlying.isAfter(other)

  /** Obtains a [[java.time.LocalDate]] by combining this year-month with the specified day.
    *
    * @throws DateTimeException if the day is invalid for the year-month
    */
  def /(day: Int): LocalDate = underlying.atDay(day)

  /** Formats this year-month using the specified formatter.
    *
    * @throws DateTimeException - if an error occurs during printing
    */
  def |>(formatter: DateTimeFormatter): String = underlying.format(formatter)

  def ▹(formatter: DateTimeFormatter): String = underlying.format(formatter)

}

trait ToYearMonthOps extends Any {
  implicit final def toYearMonthOpsFromYearMonth(f: YearMonth): YearMonthOps = new YearMonthOps(f)
}