deprecate ChronoZonedDateTime.toBeLessThan etc.

[robstoll]

Platform (all, jvm, js): jvm
Extension (none, kotlin 1.3): none

Code related feature

val now = ZonedDateTime.now()
now.compareTo(now.withZoneSameInstant(ZoneOffset.UTC)) // 1
now.isEqual(now.withZoneSameInstant(ZoneOffset.UTC)) // true

We should deprecated the Comparable assertion functions in the context of ZonedDateTime and point to toBeBefore, toBeAfter etc.

See robstoll/atrium-roadmap#50 for further details

Your first contribution?

• Write a comment I'll work on this if you would like to take this issue over.
  This way we get the chance to revise the description in case things have changed in the meantime, we might give you additional hints and we can assign the task to you, so that others do not start as well.
• See Your first code contribution for guidelines.
• Do not hesitate to ask questions here or to contact us via Atrium's slack channel if you need help
  (Invite yourself in case you do not have an account yet).

[JordanllHarper]

Hi I would like to take this on!

[JordanllHarper]

@robstoll I'm just wanting to double check, are you wanting the methods in ' /logic/atrium-logic/src/generated/jvmMain/ch/tutteli/atrium/logic/chronoZonedDateTime.kt ' deprecated? If not, could you point me to the path where I'm needing to deprecate?

[robstoll]

@JordanllHarper no, you don't deprecate existing functions, you add new overloads for the existing functions in https://github.com/robstoll/atrium/blob/main/apis/fluent-en_GB/atrium-api-fluent-en_GB/src/commonMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/comparableExpectations.kt
for the type ChronoZonedDateTime to the corresponding file in jvmMainn (i.e. to /apis/fluent-en_GB/atrium-api-fluent-en_GB/src/jvmMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/chronoZonedDateTimeExpectations.k).
Once you added the overloads, you immediately deprecated them again. We don't intend to remove them again (otherwise there would not be a need to add them in the first place), we will have them as hint for the user as their usage is most likely wrong. See https://github.com/robstoll/atrium/blob/main/apis/fluent-en_GB/atrium-api-fluent-en_GB/src/jvmMain/kotlin/ch/tutteli/atrium/api/fluent/en_GB/bigDecimalExpectations.kt => toEqual. Your deprecated functions should be similar. Also throw a PleaseUseReplacementException and point out that one can use a feature extractor if one desperately want to use toBeGreaterThan and co. on ChronoZonedDateTime. I hope you see a bit what you need to do. Otherwise let me know, I can also create to-dos for this issue which will be more or less a step by step instruction

Same same for the api-infix

[JordanllHarper]

@robstoll I think I understand what you are asking me to do and I'm still working on this!
However, I'm having some issues importing java standard libraries into the comparableExpectations.kt file for both API's. I can't access the java stdlib from the file and am needing some help with this. Apologies for this!

[robstoll]

@JordanllHarper no worries, can you please push your changes and create a WIP PR (a draft). It's way easier to help with setting your code