Allow unit results in if statement if they're captured by a function (#…

…720) Fixes #229
scapegoat-scala · Jan 23, 2023 · 6ac7fb0 · 6ac7fb0
1 parent cdc8606
commit 6ac7fb0
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/src/main/scala/com/sksamuel/scapegoat/inspections/empty/EmptyIfBlock.scala b/src/main/scala/com/sksamuel/scapegoat/inspections/empty/EmptyIfBlock.scala
@@ -23,6 +23,8 @@ class EmptyIfBlock
 
           override def inspect(tree: Tree): Unit = {
             tree match {
+              // Function directly contains if, an empty block would generate Unit (or Any) output type
+              case Function(_, If(_, Literal(Constant(())), _)) => // skip tree
               case If(_, Literal(Constant(())), _) =>
                 context.warn(tree.pos, self, tree.toString.take(500))
               case _ => continue(tree)

diff --git a/src/test/scala/com/sksamuel/scapegoat/inspections/empty/EmptyIfBlockTest.scala b/src/test/scala/com/sksamuel/scapegoat/inspections/empty/EmptyIfBlockTest.scala
@@ -10,7 +10,8 @@ class EmptyIfBlockTest extends InspectionTest {
   "empty if block" - {
     "should report warning" in {
 
-      val code = """object Test {
+      val code =
+        """object Test {
 
                       if (true) {
                       }
@@ -28,5 +29,26 @@ class EmptyIfBlockTest extends InspectionTest {
       compileCodeSnippet(code)
       compiler.scapegoat.feedback.warnings.size shouldBe 2
     }
+
+    "should not report warning" - {
+      "the if-block is the return value" in {
+        val code =
+          """
+            |import scala.concurrent.Future
+            |import scala.concurrent.ExecutionContext.Implicits.global
+            |object Test {
+            |  Future("test").map(value => {
+            |   if (value.contains("foo")) {
+            |     ()
+            |   } else {
+            |     throw new IllegalStateException("Bar!")
+            |   }
+            |  })
+            |}""".stripMargin
+
+        compileCodeSnippet(code)
+        compiler.scapegoat.feedback.warnings.size shouldBe 0
+      }
+    }
   }
 }