introduce Comparable.isEqualComparingTo

[robstoll]

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

Code related feature

expect(comparable).isEqualComparingTo(otherComparable)

//instead of

expect(comparable.compareTo(otherComparable)).toBe(0)

And in reporting we want to see:

expected that subject: 1
- is equal comparing to: 2

Following the things you need to do:

lib

• implement _isEqualComparingTo in comparableAssertions.kt (see other functions)
  • add DescriptionComparableAssertion.IS_EQUAL("is equal comparing to") for en_GB
  • add DescriptionComparableAssertion.IS_EQUAL("ist gleich wie") for de_CH

domain

• extend ComparableAssertions with a function isEqualComparingTo (see other functions as a guideline)
• modify ComparableAssertionsBuilder, delegate to comparableAssertions (see other functions as a guideline)
• delegate implementation to robstoll-lib in ComparableAssertionsImpl (see other functions as a guideline)

api-fluent

• provide the fun isEqualComparingTo in comparableAssertions.kt delegating to domain (see other functions as a guideline)
• add @since 0.12.0 (adapt to current milestone) to KDOC
• add isEqualComparingTo to ComparableAssertionsSpec in specs-common and adjust ComparableAssertionsSpec in atrium-api-fluent accordingly

api-infix

• same same but different

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).

[jaibhavaya]

I'll work on this

[jaibhavaya]

PR is in, this is my first contribution to anything open source, so I'm not totally sure if I have to do anything to link it to this issue.

#501

[robstoll]

No need to link it, I am going to review your PR tomorrow. I hope your first contribution was fun so far.

[jaibhavaya]

It was great. Thanks so much for outlining this, it made it super approachable and was a blast to do.