Remove useless class comment combined with other docblock (#41)

symplify · Feb 23, 2024 · 94d3f18 · 94d3f18
1 parent 3f38152
commit 94d3f18
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 21 deletions.
diff --git a/src/DocBlock/UselessDocBlockCleaner.php b/src/DocBlock/UselessDocBlockCleaner.php
@@ -15,7 +15,8 @@ final class UselessDocBlockCleaner
     private const CLEANING_REGEXES = [
         self::TODO_COMMENT_BY_PHPSTORM_REGEX,
         self::TODO_IMPLEMENT_METHOD_COMMENT_BY_PHPSTORM_REGEX,
-        self::COMMENT_CLASS_REGEX,
+        self::STANDALONE_COMMENT_CLASS_REGEX,
+        self::INLINE_COMMENT_CLASS_REGEX,
         self::COMMENT_CONSTRUCTOR_CLASS_REGEX,
     ];
 
@@ -35,23 +36,26 @@ final class UselessDocBlockCleaner
      * @see https://regex101.com/r/RzTdFH/4
      * @var string
      */
-    private const COMMENT_CLASS_REGEX = '#(\/\*{2}\s+?)?(\*|\/\/)\s+[cC]lass\s+[^\s]*(\s+\*\/)?$#';
+    private const STANDALONE_COMMENT_CLASS_REGEX = '#(\/\*{2}\s+?)?(\*|\/\/)\s+[cC]lass\s+[^\s]*(\s+\*\/)?$#';
 
     /**
-     * @see https://regex101.com/r/bzbxXz/2
+     * @see https://regex101.com/r/RzTdFH/4
      * @var string
      */
-    private const COMMENT_CONSTRUCTOR_CLASS_REGEX = '#^\s{0,}(\/\*{2}\s+?)?(\*|\/\/)\s+[^\s]*\s+[Cc]onstructor\.?(\s+\*\/)?$#';
+    private const INLINE_COMMENT_CLASS_REGEX = '#( \*|\/\/)\s+[cC]lass\s+(\w+)\n#';
 
     /**
-     * @param Token[] $tokens
+     * @see https://regex101.com/r/bzbxXz/2
+     * @var string
      */
-    public function clearDocTokenContent(array $tokens, int $position, Token $currentToken): string
+    private const COMMENT_CONSTRUCTOR_CLASS_REGEX = '#^\s{0,}(\/\*{2}\s+?)?(\*|\/\/)\s+[^\s]*\s+[Cc]onstructor\.?(\s+\*\/)?$#';
+
+    public function clearDocTokenContent(Token $currentToken): string
     {
         $docContent = $currentToken->getContent();
 
         foreach (self::CLEANING_REGEXES as $cleaningRegex) {
-            $docContent = Strings::replace($docContent, $cleaningRegex, '');
+            $docContent = Strings::replace($docContent, $cleaningRegex);
         }
 
         return $docContent;

diff --git a/src/Fixer/Commenting/RemoveUselessDefaultCommentFixer.php b/src/Fixer/Commenting/RemoveUselessDefaultCommentFixer.php
@@ -63,15 +63,13 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
                 continue;
             }
 
-            $cleanedDocContent = $this->uselessDocBlockCleaner->clearDocTokenContent(
-                $reversedTokens,
-                $index,
-                $token
-            );
-
+            $cleanedDocContent = $this->uselessDocBlockCleaner->clearDocTokenContent($token);
             if ($cleanedDocContent === '') {
                 // remove token
                 $tokens->clearTokenAndMergeSurroundingWhitespace($index);
+            } else {
+                // update in case of other contents
+                $tokens[$index] = new Token([T_DOC_COMMENT, $cleanedDocContent]);
             }
         }
     }

diff --git a/tests/Fixer/Commenting/RemoveUselessDefaultCommentFixer/Fixture/remove_from_property.php.inc b/tests/Fixer/Commenting/RemoveUselessDefaultCommentFixer/Fixture/remove_from_property.php.inc
@@ -0,0 +1,28 @@
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
+
+/**
+ * Class RemoveFromPropertyTest
+ * @property SomeItem $item
+ */
+#[\AllowDynamicProperties]
+final class RemoveFromPropertyTest
+{
+}
+
+?>
+-----
+<?php
+
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
+
+/**
+ * @property SomeItem $item
+ */
+#[\AllowDynamicProperties]
+final class RemoveFromPropertyTest
+{
+}
+
+?>
diff --git a/...g/RemoveUselessDefaultCommentFixer/Fixture/skip_1_extra_word_class_method_comment.php.inc b/...g/RemoveUselessDefaultCommentFixer/Fixture/skip_1_extra_word_class_method_comment.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessClassCommentFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
 
 class SomeClass
 {

diff --git a/tests/Fixer/Commenting/RemoveUselessDefaultCommentFixer/Fixture/skip_inline_set.php.inc b/tests/Fixer/Commenting/RemoveUselessDefaultCommentFixer/Fixture/skip_inline_set.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessClassCommentFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
 
 class SkipInlineSet
 {

diff --git a/...er/Commenting/RemoveUselessDefaultCommentFixer/Fixture/skip_usefull_class_comment.php.inc b/...er/Commenting/RemoveUselessDefaultCommentFixer/Fixture/skip_usefull_class_comment.php.inc
@@ -1,10 +1,10 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessClassCommentFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
 
 /**
  * class to provide something
  */
 class SomeClass5
 {
-}
+}
diff --git a/...g/RemoveUselessDefaultCommentFixer/Fixture/skip_usefull_class_constructor_comment.php.inc b/...g/RemoveUselessDefaultCommentFixer/Fixture/skip_usefull_class_constructor_comment.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessClassCommentFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
 
 class SomeClass
 {
@@ -11,4 +11,4 @@ class SomeClass
 	{
 
 	}
-}
+}
diff --git a/...enting/RemoveUselessDefaultCommentFixer/Fixture/useless_class_constructor_comment.php.inc b/...enting/RemoveUselessDefaultCommentFixer/Fixture/useless_class_constructor_comment.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessClassCommentFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
 
 class SomeClass
 {
@@ -47,7 +47,7 @@ class SomeClass
 -----
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessClassCommentFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\Fixture;
 
 class SomeClass
 {