atrium-api-fluent/ch.tutteli.atrium.api.fluent.en_GB/day

day

fun Expect<LocalDate>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDate>(source)

Expects that the property LocalDate.dayOfMonth of the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

Return

an Expect for the subject of this expectation.

Since

0.9.0

Samples

expect(LocalDate.of(2021, Month.OCTOBER, 9))
    .day { // subject inside this expectation-group is of type Int (actually 9)
        toEqual(9)
        toBeGreaterThan(5)
    } // subject here is back to type LocalDate

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .day { // subject inside this expectation-group is of type Int (actually 9)
            toEqual(5)       // fails
            toBeLessThan(7)  // still evaluated even though toEqual already fails
            //                  use `.day.` if you want a fail fast behaviour
        }
}

fun Expect<LocalDateTime>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<LocalDateTime>(source)

Expects that the property LocalDateTime.dayOfMonth of the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

Return

an Expect for the subject of this expectation.

Since

0.9.0

Samples

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
    .day { // subject inside this expectation-group is of type Int (actually 9)
        toEqual(9)
        toBeGreaterThan(5)
    } // subject here is back to type LocalDateTime

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
        .day { // subject inside this expectation-group is of type Int (actually 9)
            toEqual(5)       // fails
            toBeLessThan(7)  // still evaluated even though toEqual already fails
            //                  use `.day.` if you want a fail fast behaviour
        }
}

fun Expect<ZonedDateTime>.day(assertionCreator: Expect<Int>.() -> Unit): Expect<ZonedDateTime>(source)

Expects that the property ZonedDateTime.dayOfMonth of the subject of this expectation holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of this expectation.

Return

an Expect for the subject of this expectation.

Since

0.9.0

Samples

val zonedDateTime = ZonedDateTime.of(LocalDateTime.of(2021, 10, 9, 11, 56), ZoneId.systemDefault())

expect(zonedDateTime)
    .day { // subject inside this expectation-group is of type Int (actually 9)
        toEqual(9)
        toBeGreaterThan(5)
    } // subject here is back to type ZonedDateTime

fails {
    expect(zonedDateTime)
        .day { // subject inside this expectation-group is of type Int (actually 9)
            toEqual(5)       // fails
            toBeLessThan(7)  // still evaluated even though toEqual already fails
            //                  use `.day.` if you want a fail fast behaviour
        } // subject here is back to type ZonedDateTime
}

val Expect<LocalDate>.day: Expect<Int>(source)

Creates an Expect for the property LocalDate.dayOfMonth of the subject of this expectation, so that further fluent calls are assertions about it.

Return

The newly created Expect for the extracted feature.

Since

0.9.0

Samples

expect(LocalDate.of(2021, Month.OCTOBER, 9))
    .day // subject is now of type Int (actually 9)
    .toEqual(9)

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .day // subject is now of type Int (actually 9)
        .toEqual(5)          // fails
        .toBeGreaterThan(10) // not evaluated/reported because toEqual already fails
    //                          use `.day { ... }` if you want that all expectations are evaluated
}

val Expect<LocalDateTime>.day: Expect<Int>(source)

Creates an Expect for the property LocalDateTime.dayOfMonth of the subject of this expectation, so that further fluent calls are assertions about it.

Return

The newly created Expect for the extracted feature.

Since

0.9.0

Samples

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
    .day // subject is now of type Int (actually 9)
    .toEqual(9)

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
        .day // subject is now of type Int (actually 9)
        .toEqual(5)          // fails
        .toBeGreaterThan(10) // not evaluated/reported because toEqual already fails
    //                          use `.day { ... }` if you want that all expectations are evaluated
}

val Expect<ZonedDateTime>.day: Expect<Int>(source)

Creates an Expect for the property ZonedDateTime.dayOfMonth of the subject of this expectation, so that further fluent calls are assertions about it.

Return

The newly created Expect for the extracted feature.

Since

0.9.0

Samples

expect(ZonedDateTime.of(LocalDateTime.of(2021, 10, 9, 11, 56), ZoneId.systemDefault()))
    .day // subject is now of type Int (actually 9)
    .toEqual(9)

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, 10, 9, 11, 56), ZoneId.systemDefault()))
        .day // subject is now of type Int (actually 9)
        .toEqual(5)          // fails
        .toBeGreaterThan(10) // not evaluated/reported because toEqual already fails
    //                          use `.day { ... }` if you want that all expectations are evaluated
}