atrium-api-infix/ch.tutteli.atrium.api.infix.en_GB/dayOfWeek

dayOfWeek

infix fun Expect<LocalDate>.dayOfWeek(assertionCreator: Expect<DayOfWeek>.() -> Unit): Expect<LocalDate>(source)

Expects that the property LocalDate.getDayOfWeek 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.12.0

Samples

expect(LocalDate.of(2021, Month.OCTOBER, 9)) dayOfWeek {
    // subject inside this expectation-group is of type DayOfWeek (actually SATURDAY)
    it toEqual DayOfWeek.SATURDAY
    it notToEqual DayOfWeek.SUNDAY
} // subject here is back to type LocalDate

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9)) dayOfWeek {
        // subject inside this expectation-group is of type DayOfWeek (actually SATURDAY)
        it toEqual DayOfWeek.MONDAY       // fails
        it notToEqual DayOfWeek.SATURDAY  // still evaluated even though toEqual already fails
        //                                   use `.dayOfWeek.` if you want a fail fast behaviour
    } // subject here is back to type LocalDate
}

infix fun Expect<LocalDateTime>.dayOfWeek(assertionCreator: Expect<DayOfWeek>.() -> Unit): Expect<LocalDateTime>(source)

Expects that the property LocalDateTime.dayOfWeekof 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.12.0

Samples

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56)) dayOfWeek {
    // subject inside this expectation-group is of type DayOfWeek (actually SATURDAY)
    it toEqual DayOfWeek.SATURDAY
    it notToEqual DayOfWeek.SUNDAY
} // subject here is back to type LocalDateTime

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56)) dayOfWeek {
        // subject inside this expectation-group is of type DayOfWeek (actually SATURDAY)
        it toEqual DayOfWeek.MONDAY       // fails
        it notToEqual DayOfWeek.SATURDAY  // still evaluated even though toEqual already fails
        //                                   use `.dayOfWeek.` if you want a fail fast behaviour
    } // subject here is back to type LocalDateTime
}

infix fun Expect<ZonedDateTime>.dayOfWeek(assertionCreator: Expect<DayOfWeek>.() -> Unit): Expect<ZonedDateTime>(source)

Expects that the property ZonedDatetime.dayOfWeek 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.12.0

Samples

expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault())) dayOfWeek {
    // subject inside this expectation-group is of type DayOfWeek (actually SATURDAY)
    it toEqual DayOfWeek.SATURDAY
    it notToEqual DayOfWeek.SUNDAY
} // subject here is back to type ZonedDateTime

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault())) dayOfWeek {
        // subject inside this expectation-group is of type DayOfWeek (actually SATURDAY)
        it toEqual DayOfWeek.MONDAY       // fails
        it notToEqual DayOfWeek.SATURDAY  // still evaluated even though toEqual already fails
        //                                   use `.dayOfWeek.` if you want a fail fast behaviour
    } // subject here is back to type ZonedDateTime
}

val Expect<LocalDate>.dayOfWeek: Expect<DayOfWeek>(source)

Creates an Expect for the property LocalDate.getDayOfWeek 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.12.0

Samples

expect(LocalDate.of(2021, Month.OCTOBER, 9))
    .dayOfWeek toEqual DayOfWeek.SATURDAY
//    | subject is now of type DayOfWeek (actually SATURDAY)

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .dayOfWeek toEqual DayOfWeek.MONDAY
    //    |          |              | not reported because toEqual already fails
    //    |          |              | use `dayOfWeek { ... }` if you want that all expectations are evaluated
    //    |          | fails
    //    | subject is now of type DayOfWeek (actually SATURDAY)
}

val Expect<LocalDateTime>.dayOfWeek: Expect<DayOfWeek>(source)

Creates an Expect for the property LocalDateTime.dayOfWeek 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.12.0

Samples

expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
    .dayOfWeek toEqual DayOfWeek.SATURDAY
//    | subject is now of type DayOfWeek (actually SATURDAY)

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56))
        .dayOfWeek toEqual DayOfWeek.MONDAY
    //    |          |              | not reported because toEqual already fails
    //    |          |              | use `dayOfWeek { ... }` if you want that all expectations are evaluated
    //    |          | fails
    //    | subject is now of type DayOfWeek (actually SATURDAY)
}

val Expect<ZonedDateTime>.dayOfWeek: Expect<DayOfWeek>(source)

Creates an Expect for the property ZonedDatetime.dayOfWeek 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.12.0

Samples

expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault()))
    .dayOfWeek toEqual DayOfWeek.SATURDAY
//    | subject is now of type DayOfWeek (actually SATURDAY)

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault()))
        .dayOfWeek toEqual DayOfWeek.MONDAY
    //    |          |              | not reported because toEqual already fails
    //    |          |              | use `dayOfWeek { ... }` if you want that all expectations are evaluated
    //    |          | fails
    //    | subject is now of type DayOfWeek (actually SATURDAY)
}