com.sksamuel.scapegoat.inspections.NoOpOverride.scala Maven / Gradle / Ivy

Go to download
package com.sksamuel.scapegoat.inspections

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

/**
 * @author Stephen Samuel
 */
class NoOpOverride
    extends Inspection(
      text = "Noop override",
      defaultLevel = Levels.Info,
      description = "Checks for code that overrides parent method but simply calls super.",
      explanation = "This method is overridden yet only calls super."
    ) {

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

          import context.global._

          private def argumentsMatch(signatureArgs: List[ValDef], actualArgs: List[Tree]): Boolean = {
            signatureArgs.size == actualArgs.size &&
            signatureArgs.zip(actualArgs).forall {
              case (sig, act: Ident) => sig.name == act.name
              case _                 => false
            }
          }

          override def inspect(tree: Tree): Unit = {
            tree match {
              case DefDef(_, name, _, vparamss, _, Apply(Select(Super(This(_), _), name2), args))
                  if name == name2 && vparamss.size == 1 && argumentsMatch(
                    vparamss.headOption.getOrElse(List.empty),
                    args
                  ) =>
                context.warn(tree.pos, self, tree.toString.take(200))
              case _ => continue(tree)
            }
          }
        }
    }
}