Improve randomPastDate & randomFutureDate methods

serpro69 · Mar 9, 2024 · c60787c · c60787c
1 parent 6219997
commit c60787c
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 3 deletions.
diff --git a/core/src/main/kotlin/io/github/serpro69/kfaker/IRandom.kt b/core/src/main/kotlin/io/github/serpro69/kfaker/IRandom.kt
@@ -264,12 +264,24 @@ interface IRandom {
      */
     fun randomPastDate(): OffsetDateTime
 
+    /**
+     * Returns a pseudorandom, uniformly distributed [OffsetDateTime] value
+     * between [min] (inclusive) and now (exclusive) using UTC zone offset
+     */
+    fun randomPastDate(min: Instant): OffsetDateTime
+
     /**
      * Returns a pseudorandom, uniformly distributed [OffsetDateTime] value
      * between now (exclusive) and now + 50 years (inclusive) using UTC zone offset
      */
     fun randomFutureDate(): OffsetDateTime
 
+    /**
+     * Returns a pseudorandom, uniformly distributed [OffsetDateTime] value
+     * between now (exclusive) and [max] (inclusive) using UTC zone offset
+     */
+    fun randomFutureDate(max: Instant): OffsetDateTime
+
     /**
      * Returns a pseudorandom, uniformly distributed [OffsetDateTime] value
      * between [min] (inclusive) and [max] (inclusive) using the defined [zoneOffset]

diff --git a/core/src/main/kotlin/io/github/serpro69/kfaker/RandomService.kt b/core/src/main/kotlin/io/github/serpro69/kfaker/RandomService.kt
@@ -226,13 +226,26 @@ class RandomService internal constructor(override val config: FakerConfig) : IRa
     }
 
     override fun randomPastDate(): OffsetDateTime {
-        return randomDate(Instant.ofEpochSecond(0), Instant.now().minusMillis(1), ZoneOffset.UTC)
+        return randomPastDate(Instant.ofEpochSecond(0))
+    }
+
+    override fun randomPastDate(min: Instant): OffsetDateTime {
+        val now = Instant.now()
+        require(min.isBefore(now))
+
+        return randomDate(min, now.minusMillis(1), ZoneOffset.UTC)
     }
 
     override fun randomFutureDate(): OffsetDateTime {
+        val maxInstant = Instant.now().plus(Duration.ofDays(50 * 365))
+        return randomFutureDate(maxInstant)
+    }
+
+    override fun randomFutureDate(max: Instant): OffsetDateTime {
         val now = Instant.now()
-        val maxInstant = now.plus(Duration.ofDays(50 * 365))
-        return randomDate(now.plusMillis(1), maxInstant, ZoneOffset.UTC)
+        require(max.isAfter(now))
+
+        return randomDate(now.plusMillis(1), max, ZoneOffset.UTC)
     }
 
     override fun randomDate(min: Instant, max: Instant, zoneOffset: ZoneOffset): OffsetDateTime {

diff --git a/core/src/main/kotlin/io/github/serpro69/kfaker/provider/misc/RandomProvider.kt b/core/src/main/kotlin/io/github/serpro69/kfaker/provider/misc/RandomProvider.kt
@@ -199,8 +199,12 @@ class RandomProvider internal constructor(
 
     override fun randomPastDate(): OffsetDateTime = resolveUnique(RANDOM_DATE) { rs.randomPastDate() }
 
+    override fun randomPastDate(min: Instant): OffsetDateTime = resolveUnique(RANDOM_DATE) { rs.randomPastDate(min) }
+
     override fun randomFutureDate(): OffsetDateTime = resolveUnique(RANDOM_DATE) { rs.randomFutureDate() }
 
+    override fun randomFutureDate(max: Instant): OffsetDateTime = resolveUnique(RANDOM_DATE) { rs.randomFutureDate(max) }
+
     override fun randomDate(min: Instant, max: Instant, zoneOffset: ZoneOffset): OffsetDateTime =
         resolveUnique(RANDOM_SUBSET) { rs.randomDate(min, max, zoneOffset) }
 

diff --git a/docs/src/orchid/resources/pages/data-provider/core/random.adoc b/docs/src/orchid/resources/pages/data-provider/core/random.adoc
@@ -44,8 +44,12 @@ Faker().random.randomSublist(listOf(1, 2, 3, 4, 5, 6))
 
 Faker().random.randomPastDate()
 
+Faker().random.randomPastDate(min = Instant.ofEpochSecond(0))
+
 Faker().random.randomFutureDate()
 
+Faker().random.randomFutureDate(max = Instant.now().plus(Duration.ofDays(7)))
+
 Faker().random.randomDate(min = Instant.ofEpochSecond(0), max = Instant.now(), zoneOffset = ZoneOffset.UTC)
 
 // and more