Implemented first version of JoinAssertThatStatements inspection that will try to merge assertThat() statements with the same actual object together, preserving comments.

2019-04-28 20:43:42 +02:00
parent 666e373405
commit 941ddfdb5e
15 changed files with 347 additions and 35 deletions
@@ -0,0 +1,87 @@
+package de.platon42.intellij.plugins.cajon.inspections
+
+import com.intellij.codeInspection.ProblemHighlightType
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.*
+import com.intellij.psi.util.PsiTreeUtil
+import de.platon42.intellij.plugins.cajon.*
+import de.platon42.intellij.plugins.cajon.quickfixes.JoinStatementsQuickFix
+
+class JoinAssertThatStatementsInspection : AbstractAssertJInspection() {
+
+    companion object {
+        private const val DISPLAY_NAME = "Joining multiple assertThat() statements with same actual expression"
+        private const val CAN_BE_JOINED_DESCRIPTION = "Multiple assertThat() statements can be joined together"
+    }
+
+    override fun getDisplayName() = DISPLAY_NAME
+
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+        return object : JavaElementVisitor() {
+            override fun visitCodeBlock(block: PsiCodeBlock?) {
+                super.visitCodeBlock(block)
+                val statements = block?.statements ?: return
+                var lastActualExpression: PsiExpression? = null
+                var sameCount = 0
+                var firstStatement: PsiStatement? = null
+                var lastStatement: PsiStatement? = null
+                for (statement in statements) {
+                    val assertThatCall = isLegitAssertThatCall(statement)
+                    var reset = true
+                    var actualExpression: PsiExpression? = null
+                    if (assertThatCall != null) {
+                        reset = (lastActualExpression == null)
+                        actualExpression = assertThatCall.firstArg
+                        if (!reset) {
+                            val isSame = when (actualExpression) {
+                                is PsiReferenceExpression -> (actualExpression.qualifierExpression == (lastActualExpression as? PsiReferenceExpression)?.qualifierExpression)
+                                is PsiMethodCallExpression -> (actualExpression.text == (lastActualExpression as? PsiMethodCallExpression)?.text)
+                                        && !KNOWN_METHODS_WITH_SIDE_EFFECTS.test(actualExpression)
+                                is PsiPolyadicExpression -> (actualExpression.text == (lastActualExpression as? PsiPolyadicExpression)?.text)
+                                else -> false
+                            }
+                            if (isSame) {
+                                sameCount++
+                                lastStatement = statement
+                            } else {
+                                reset = true
+                            }
+                        }
+                    }
+                    if (reset) {
+                        if (sameCount > 1) {
+                            registerProblem(firstStatement, lastStatement)
+                        }
+                        firstStatement = statement
+                        lastStatement = null
+                        lastActualExpression = actualExpression
+                        sameCount = 1
+                    }
+                }
+                if (sameCount > 1) {
+                    registerProblem(firstStatement, lastStatement)
+                }
+            }
+
+            private fun registerProblem(firstStatement: PsiStatement?, lastStatement: PsiStatement?) {
+                val problemDescriptor = holder.manager.createProblemDescriptor(
+                    firstStatement!!,
+                    lastStatement!!,
+                    CAN_BE_JOINED_DESCRIPTION,
+                    ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
+                    isOnTheFly,
+                    JoinStatementsQuickFix()
+                )
+                holder.registerProblem(problemDescriptor)
+            }
+
+            private fun isLegitAssertThatCall(statement: PsiStatement?): PsiMethodCallExpression? {
+                if ((statement is PsiExpressionStatement) && (statement.expression is PsiMethodCallExpression)) {
+                    val assertThatCall = PsiTreeUtil.findChildrenOfType(statement, PsiMethodCallExpression::class.java).find { ALL_ASSERT_THAT_MATCHERS.test(it) }
+                    return assertThatCall?.takeIf { it.findFluentCallTo(EXTRACTING_CALL_MATCHERS) == null }
+                }
+                return null
+            }
+        }
+    }
+}