Add samples for localDateAssertions of api-infix (robstoll#996)

rhushikesh · Oct 9, 2021 · 5d2d1be · 5d2d1be
1 parent 6854890
commit 5d2d1be
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 0 deletions.
diff --git a/...-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateAssertions.kt b/...-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/localDateAssertions.kt
@@ -29,6 +29,8 @@ val Expect<LocalDate>.year: Expect<Int>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.LocalDateExpectationSamples.year
+ *
  * @since 0.12.0
  */
 infix fun Expect<LocalDate>.year(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDate> =
@@ -52,6 +54,8 @@ val Expect<LocalDate>.month: Expect<Int>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.LocalDateExpectationSamples.month
+ *
  * @since 0.12.0
  */
 infix fun Expect<LocalDate>.month(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDate> =
@@ -75,6 +79,8 @@ val Expect<LocalDate>.dayOfWeek: Expect<DayOfWeek>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.LocalDateExpectationSamples.dayOfWeek
+ *
  * @since 0.12.0
  */
 infix fun Expect<LocalDate>.dayOfWeek(assertionCreator: Expect<DayOfWeek>.() -> Unit): Expect<LocalDate> =
@@ -99,6 +105,8 @@ val Expect<LocalDate>.day: Expect<Int>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.LocalDateExpectationSamples.day
+ *
  * @since 0.12.0
  */
 infix fun Expect<LocalDate>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDate> =

diff --git a/.../src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/LocalDateExpectationSamples.kt b/.../src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/LocalDateExpectationSamples.kt
@@ -0,0 +1,73 @@
+package ch.tutteli.atrium.api.infix.en_GB.samples
+
+import ch.tutteli.atrium.api.infix.en_GB.*
+import ch.tutteli.atrium.api.verbs.internal.expect
+import java.time.DayOfWeek
+import java.time.LocalDate
+import java.time.Month
+import kotlin.test.Test
+
+class LocalDateExpectationSamples {
+
+    @Test
+    fun year() {
+        expect(LocalDate.of(2021, Month.OCTOBER, 9)) year {
+            it toEqual 2021
+            it toBeGreaterThan 2020
+        }
+
+        fails {
+            expect(LocalDate.of(2021, Month.OCTOBER, 9)) year {
+                it notToEqual 2022
+                it toBeGreaterThan 2022
+                it toBeLessThan 2020
+            }
+        }
+    }
+
+    @Test
+    fun month() {
+        expect(LocalDate.of(2021, Month.OCTOBER, 9)) month {
+            it toEqual Month.OCTOBER.value
+            it notToEqual Month.SEPTEMBER.value
+        }
+
+        fails {
+            expect(LocalDate.of(2021, Month.OCTOBER, 9)) month {
+                it toEqual Month.SEPTEMBER.value
+                it notToEqual Month.OCTOBER.value
+            }
+        }
+    }
+
+    @Test
+    fun dayOfWeek() {
+        expect(LocalDate.of(2021, Month.OCTOBER, 9)) dayOfWeek {
+            it toEqual DayOfWeek.SATURDAY
+            it notToEqual DayOfWeek.SUNDAY
+        }
+
+        fails {
+            expect(LocalDate.of(2021, Month.OCTOBER, 9)) dayOfWeek {
+                it toEqual DayOfWeek.MONDAY
+                it notToEqual DayOfWeek.SATURDAY
+            }
+        }
+    }
+
+    @Test
+    fun day() {
+        expect(LocalDate.of(2021, Month.OCTOBER, 9)) day {
+            it toEqual 9
+            it toBeGreaterThan 5
+        }
+
+        fails {
+            expect(LocalDate.of(2021, Month.OCTOBER, 9)) day {
+                it toEqual 5
+                it toBeLessThan 7
+            }
+        }
+    }
+
+}