com.sksamuel.scapegoat.inspections.controlflow.RepeatedIfElseBody.scala Maven / Gradle / Ivy

Go to download
package com.sksamuel.scapegoat.inspections.controlflow

import com.sksamuel.scapegoat.{Inspection, InspectionContext, Inspector, Levels}

class RepeatedIfElseBody
    extends Inspection(
      text = "Repeated body of if main and else branch",
      defaultLevel = Levels.Warning,
      description = "Checks for the main branch and the else branch of an if being the same.",
      explanation =
        "The if statement could be refactored if both branches are the same or start with the same."
    ) {

  def inspector(context: InspectionContext): Inspector =
    new Inspector(context) {
      override def postTyperTraverser =
        new context.Traverser {

          import context.global._

          private def isRepeated(mainBranch: Tree, elseBranch: Tree): Boolean =
            mainBranch.toString() == elseBranch.toString()

          private def twoBlocksStartWithTheSame(oneBlock: Block, another: Block): Boolean = {
            (oneBlock.children.headOption, another.children.headOption) match {
              case (Some(statement1), Some(statement2)) if statement1.toString == statement2.toString => true
              case _                                                                                  => false
            }
          }

          override def inspect(tree: Tree): Unit = {
            tree match {
              case If(_, mainBranch, elseBranch) if isRepeated(mainBranch, elseBranch) =>
                context
                  .warn(tree.pos, self, tree.toString.take(500), "Main and else branches of if are repeated.")
              case If(_, mainBranch @ Block(_, _), elseBranch @ Block(_, _))
                  if twoBlocksStartWithTheSame(mainBranch, elseBranch) =>
                context.warn(
                  tree.pos,
                  self,
                  tree.toString.take(500),
                  "Main and else branches start with the same command."
                )
              case _ => continue(tree)
            }
          }
        }
    }
}