com.fortysevendeg.scalacheck.datetime.GenDateTime.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalacheck-toolbox-datetime_sjs1_2.12 Show documentation

A library for helping use date and time libraries with ScalaCheck

The newest version!

/*
 * Copyright 2016-2021 47 Degrees Open Source 
 *
 * 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.
 */

package com.fortysevendeg.scalacheck.datetime

import scala.util.Try
import org.scalacheck.Gen
import com.fortysevendeg.scalacheck.datetime.typeclasses._

/**
 * Some generators for working with dates and times.
 */
object GenDateTime {

  /**
   * Generates a DateTime between the given dateTimex and the end of the
   * period
   * @param dateTime
   *   A DateTime to calculate the period offsets from.
   * @param range
   *   An offset from dateTime, serving as an upper bound for generated
   *   DateTimes. Can be negative, denoting an offset before the provided
   *   DateTime.
   * @return
   *   A DateTime generator for DateTimes within the expected range.
   */
  def genDateTimeWithinRange[D, R](
      dateTime: D,
      range: R
  )(implicit scDateTime: ScalaCheckDateTimeInfra[D, R], granularity: Granularity[D]): Gen[D] = {
    for {
      addedRange <- Try(Gen.const(scDateTime.addRange(dateTime, range)))
        .getOrElse(Gen.fail)
      diffMillis = scDateTime.getMillis(addedRange) - scDateTime.getMillis(dateTime)
      millis <- Gen.choose(0L min diffMillis, 0L max diffMillis)
    } yield granularity.normalize(scDateTime.addMillis(dateTime, millis))
  }
}