id: scw:assertj:hamcrest-compares-equal-to
version: 10
metadata:
  name: Use AssertJ's isEqualByComparingTo() instead of comparesEqualTo()
  shortDescription: Can be replaced with AssertJ style assertions
  level: warning
  language: java
  enabled: true
  tags: AssertJ; Hamcrest
search:
  methodcall:
    name: assertThat
    anyOf:
    - args:
        2:
          value:
            is:
              methodcall:
                name: comparesEqualTo
                type:
                  reference:
                    matches: org\.hamcrest\.(Matchers|number\.OrderingComparison)
                  checkInheritance: true
      argCount: 2
    - args:
        1:
          type: String
        3:
          value:
            is:
              methodcall:
                name: comparesEqualTo
                type:
                  reference:
                    matches: org\.hamcrest\.(Matchers|number\.OrderingComparison)
                  checkInheritance: true
      argCount: 3
    type: org.hamcrest.MatcherAssert
availableFixes:
- doStaticImports: true
  name: Change to assertThat(actual).isEqualByComparingTo(expected)
  availableIf:
    markedElement:
      is:
        methodcall:
          argCount: 2
  actions:
  - rewrite:
      to: org.assertj.core.api.Assertions.assertThat({{{ arguments.0 }}}).isEqualByComparingTo({{{ arguments.1.arguments.0 }}})
- doStaticImports: true
  name: Change to assertThat(actual).as(reason).isEqualByComparingTo(expected)
  availableIf:
    markedElement:
      is:
        methodcall:
          argCount: 3
  actions:
  - rewrite:
      to: org.assertj.core.api.Assertions.assertThat({{{ arguments.1 }}}).as({{{ arguments.0 }}}).isEqualByComparingTo({{{ arguments.2.arguments.0 }}})