Disallow empty function unless adding a comment (#18)

asispts · Nov 3, 2023 · c7f260e · c7f260e
1 parent 9f0c019
commit c7f260e
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 1 deletion.
diff --git a/ptscs/ruleset.xml b/ptscs/ruleset.xml
@@ -192,6 +192,7 @@
     <rule ref="SlevomatCodingStandard.Variables.UselessVariable" />
     <rule ref="SlevomatCodingStandard.Variables.UnusedVariable" />
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
+    <rule ref="SlevomatCodingStandard.Functions.DisallowEmptyFunction" />
     <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment" />
     <rule ref="SlevomatCodingStandard.Commenting.EmptyComment" />
 

diff --git a/tests/Sniffs/CodeAnalysis/UnnecessaryFinalModifierTest.php b/tests/Sniffs/CodeAnalysis/UnnecessaryFinalModifierTest.php
@@ -15,6 +15,7 @@ protected function setUp(): void
           'Squiz.Classes.ClassFileName.NoMatch',
           'PSR1.Classes.ClassDeclaration.MultipleClasses',
           'SlevomatCodingStandard.Classes.RequireAbstractOrFinal',
+          'SlevomatCodingStandard.Functions.DisallowEmptyFunction',
         ]);
     }
 

diff --git a/tests/Sniffs/Slevomat/Functions/DisallowEmptyFunctionTest.php b/tests/Sniffs/Slevomat/Functions/DisallowEmptyFunctionTest.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\Functions;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class DisallowEmptyFunctionTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield[
+          [new ErrorData(3, 'SlevomatCodingStandard.Functions.DisallowEmptyFunction.EmptyFunction')],
+        ];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/Functions/_data/DisallowEmptyFunction.php.fixed b/tests/Sniffs/Slevomat/Functions/_data/DisallowEmptyFunction.php.fixed
@@ -0,0 +1,10 @@
+<?php
+
+function emptyFunction()
+{
+}
+
+function allowed()
+{
+    // allowed
+}
diff --git a/tests/Sniffs/Slevomat/Functions/_data/DisallowEmptyFunction.php.inc b/tests/Sniffs/Slevomat/Functions/_data/DisallowEmptyFunction.php.inc
@@ -0,0 +1,10 @@
+<?php
+
+function emptyFunction()
+{
+}
+
+function allowed()
+{
+    // allowed
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed
@@ -6,5 +6,6 @@ final class Foobar
 {
     public function check(string $useless, array $list, $missing): void
     {
+        // empty
     }
 }
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.inc b/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.inc
@@ -9,5 +9,6 @@ final class Foobar
      */
     public function check(string $useless, array $list, $missing): void
     {
+        // empty
     }
 }
diff --git a/tests/Sniffs/Slevomat/UnusedUseTest.php b/tests/Sniffs/Slevomat/UnusedUseTest.php
@@ -11,7 +11,10 @@ final class UnusedUseTest extends SniffTestCase
     protected function setUp(): void
     {
         parent::setUp();
-        $this->setExclude(['Squiz.Classes.ClassFileName.NoMatch']);
+        $this->setExclude([
+          'Squiz.Classes.ClassFileName.NoMatch',
+          'SlevomatCodingStandard.Functions.DisallowEmptyFunction',
+        ]);
     }
 
     public static function provideTestData(): Iterator

diff --git a/tests/Sniffs/Squiz/ClassMethodTest.php b/tests/Sniffs/Squiz/ClassMethodTest.php
@@ -14,6 +14,7 @@ protected function setUp(): void
         $this->appendExclude('Squiz.Classes.ClassFileName');
         $this->appendExclude('Generic.PHP.RequireStrictTypes.MissingDeclaration');
         $this->appendExclude('SlevomatCodingStandard.Classes.RequireAbstractOrFinal');
+        $this->appendExclude('SlevomatCodingStandard.Functions.DisallowEmptyFunction');
     }
 
     public static function provideTestData(): Iterator

diff --git a/tests/Sniffs/Squiz/FunctionsTest.php b/tests/Sniffs/Squiz/FunctionsTest.php
@@ -11,6 +11,7 @@ final class FunctionsTest extends SniffTestCase
     protected function setUp(): void
     {
         $this->appendExclude('PSR1.Files.SideEffects.FoundWithSymbols');
+        $this->appendExclude('SlevomatCodingStandard.Functions.DisallowEmptyFunction');
     }
 
     public static function provideTestData(): Iterator