Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

False-positive - empty methods no so empty #329

Merged
merged 2 commits into from
Mar 28, 2020
Merged

False-positive - empty methods no so empty #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d07b1e9
UT for empty methods in inheritance
mccartney Mar 28, 2020
c62e603
EmptyMethod only for private methods
mccartney Mar 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/scala/com/sksamuel/scapegoat/inspections/empty/EmptyMethod.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class EmptyMethod
case DefDef(mods, _, _, _, _, _) if mods.isOverride =>
case ClassDef(mods, _, _, _) if mods.isTrait => continue(tree)
case DefDef(_, _, _, _, _, _) if tree.symbol != null && tree.symbol.enclClass.isTrait =>
case DefDef(_, _, _, _, _, Literal(Constant(()))) =>
case d @ DefDef(_, _, _, _, _, Literal(Constant(()))) if d.symbol != null && d.symbol.isPrivate =>
context.warn(tree.pos, self, tree.toString.take(500))
case _ => continue(tree)
}
Expand Down
28 changes: 24 additions & 4 deletions src/test/scala/com/sksamuel/scapegoat/inspections/empty/EmptyMethodTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ class EmptyMethodTest extends AnyFreeSpec with Matchers with PluginRunner with O
"empty method" - {
"should report warning" in {
val code = """object Test {
def foo = { }
def foo2 = true
def foo3 = {
private def foo = { }
private def foo2 = true
private def foo3 = {
()
}
def foo4 = {
private def foo4 = {
println("sammy")
()
}
Expand All @@ -33,6 +33,26 @@ class EmptyMethodTest extends AnyFreeSpec with Matchers with PluginRunner with O
compileCodeSnippet(code)
compiler.scapegoat.feedback.warnings.size shouldBe 0
}

"for empty methods in public classes" in {
val code =
"""
|class Animal {
| def makeSound(): Unit = {}
|}
|
|class Dog extends Animal {
| override def makeSound(): Unit = {
| println("Bark")
| }
|}
|
|class Fish extends Animal {}
|""".stripMargin

compileCodeSnippet(code)
compiler.scapegoat.feedback.warnings.size shouldBe 0
}
}
}
}