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

month

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

Expects that the property LocalDate.monthValue 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)) month {
    // subject inside this expectation-group is of type Int (actually Month.OCTOBER.value i.e. 10)
    it toEqual Month.OCTOBER.value
    it notToEqual Month.SEPTEMBER.value
} // subject here is back to type LocalDate

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9)) month {
        // subject inside this expectation-group is of type Int (actually Month.OCTOBER.value i.e. 10)
        it toBeLessThan 9      // fails
        it toBeGreaterThan 11  // still evaluated even though toBeLessThan already fails
        //                        use `.month` if you want a fail fast behaviour
    } // subject here is back to type LocalDate
}

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

Expects that the property LocalDateTime.monthValueof 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)) month {
    // subject inside this expectation-group is of type Int (actually Month.OCTOBER.value i.e. 10)
    it toEqual Month.OCTOBER.value
    it notToEqual Month.SEPTEMBER.value
} // subject here is back to type LocalDateTime

fails {
    expect(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56)) month {
        // subject inside this expectation-group is of type Int (actually Month.OCTOBER.value i.e. 10)
        it toBeLessThan 9      // fails
        it toBeGreaterThan 11  // still evaluated even though toBeLessThan already fails
        //                        use `.month` if you want a fail fast behaviour
    } // subject here is back to type LocalDateTime
}

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

Expects that the property ZonedDateTime.monthValue 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())) month {
    // subject inside this expectation-group is of type Int (actually Month.OCTOBER.value i.e. 10)
    it toEqual Month.OCTOBER.value
    it notToEqual Month.SEPTEMBER.value
} // subject here is back to type ZonedDateTime

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault())) month {
        // subject inside this expectation-group is of type Int (actually Month.OCTOBER.value i.e. 10)
        it toBeLessThan 9      // fails
        it toBeGreaterThan 11  // still evaluated even though toBeLessThan already fails
        //                        use `.month` if you want a fail fast behaviour
    } // subject here is back to type ZonedDateTime
}

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

Creates an Expect for the property LocalDate.monthValue 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))
    .month toEqual Month.OCTOBER.value
//    | subject is now of type Int (actually Month.OCTOBER.value i.e. 10)

fails {
    expect(LocalDate.of(2021, Month.OCTOBER, 9))
        .month toBeLessThan 9 toBeGreaterThan 11
    //    |     |              | not reported because toBeLessThan already fails
    //    |     |              | use `month { ... }` if you want that all expectations are evaluated
    //    |     | fails
    //    | subject is now of type Int (actually Month.OCTOBER.value i.e. 10)
}

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

Creates an Expect for the property LocalDateTime.monthValue 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))
    .month toEqual Month.OCTOBER.value
//    | subject is now of type Int (actually Month.OCTOBER.value i.e. 10)

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

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

Creates an Expect for the property ZonedDateTime.monthValue 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()))
    .month toEqual Month.OCTOBER.value
//    | subject is now of type Int (actually Month.OCTOBER.value i.e. 10)

fails {
    expect(ZonedDateTime.of(LocalDateTime.of(2021, Month.OCTOBER, 9, 11, 56), ZoneId.systemDefault()))
        .month toBeLessThan 9 toBeGreaterThan 11
    //    |     |              | not reported because toBeLessThan already fails
    //    |     |              | use `month { ... }` if you want that all expectations are evaluated
    //    |     | fails
    //    | subject is now of type Int (actually Month.OCTOBER.value i.e. 10)
}