From 9f0c01973abd11a16c7a93698db8ad6ab29680bf Mon Sep 17 00:00:00 2001
From: Asis Pattisahusiwa <79239132+asispts@users.noreply.github.com>
Date: Fri, 3 Nov 2023 17:26:46 +0700
Subject: [PATCH] Detect and remove empty comment (#17)

---
 ptscs/ruleset.xml                             |  1 +
 .../Slevomat/Commenting/EmptyCommentTest.php  | 27 +++++++++++++++++++
 .../Commenting/_data/EmptyComment.php.fixed   | 12 +++++++++
 .../Commenting/_data/EmptyComment.php.inc     | 16 +++++++++++
 .../_data/ParameterTypeHint.php.fixed         |  2 --
 .../TypeHints/_data/ReturnTypeHint.php.fixed  |  2 --
 .../TypeHints/_data/UselessDocblock.php.fixed |  2 --
 7 files changed, 56 insertions(+), 6 deletions(-)
 create mode 100644 tests/Sniffs/Slevomat/Commenting/EmptyCommentTest.php
 create mode 100644 tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.fixed
 create mode 100644 tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.inc

diff --git a/ptscs/ruleset.xml b/ptscs/ruleset.xml
index 84f0e62..f28979d 100644
--- a/ptscs/ruleset.xml
+++ b/ptscs/ruleset.xml
@@ -193,6 +193,7 @@
     <rule ref="SlevomatCodingStandard.Variables.UnusedVariable" />
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
     <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment" />
+    <rule ref="SlevomatCodingStandard.Commenting.EmptyComment" />
 
     <!-- Useless typehint -->
     <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.UselessAnnotation" />
diff --git a/tests/Sniffs/Slevomat/Commenting/EmptyCommentTest.php b/tests/Sniffs/Slevomat/Commenting/EmptyCommentTest.php
new file mode 100644
index 0000000..9bf3655
--- /dev/null
+++ b/tests/Sniffs/Slevomat/Commenting/EmptyCommentTest.php
@@ -0,0 +1,27 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\Commenting;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class EmptyCommentTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield[
+          [
+            new ErrorData(7, 'SlevomatCodingStandard.Commenting.EmptyComment.EmptyComment'),
+            new ErrorData(11, 'SlevomatCodingStandard.Commenting.EmptyComment.EmptyComment'),
+            new ErrorData(14, 'SlevomatCodingStandard.Commenting.EmptyComment.EmptyComment'),
+          ],
+        ];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.fixed b/tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.fixed
new file mode 100644
index 0000000..2fdebed
--- /dev/null
+++ b/tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.fixed
@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    private $var1;
+
+    private $var2;
+
+    private $var3;
+}
diff --git a/tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.inc b/tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.inc
new file mode 100644
index 0000000..eb8de6d
--- /dev/null
+++ b/tests/Sniffs/Slevomat/Commenting/_data/EmptyComment.php.inc
@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     */
+    private $var1;
+
+    /***/
+    private $var2;
+
+    //
+    private $var3;
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed
index 1474af8..a1d1356 100644
--- a/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed
+++ b/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed
@@ -4,8 +4,6 @@ namespace App;
 
 final class Foobar
 {
-    /**
-     */
     public function check(string $useless, array $list, $missing): void
     {
     }
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.fixed
index 2e5c6cb..6921f99 100644
--- a/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.fixed
+++ b/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.fixed
@@ -4,8 +4,6 @@ namespace App;
 
 final class Foobar
 {
-    /**
-     */
     public function useless(): string
     {
         return $this->value;
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
index 431312a..21e09b6 100644
--- a/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
+++ b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
@@ -17,8 +17,6 @@ final class Foobar
         $this->value = $value;
     }
 
-    /**
-     */
     public function getValue(): string
     {
         return $this->value;