Remove useless property, parameter, and return annotations (#16)

* Detect useless property annotation * Detect useless return annotation * Detect useless parameter annotation
asispts · Nov 3, 2023 · e9ce7c5 · e9ce7c5
1 parent 7510051
commit e9ce7c5
Show file tree

Hide file tree

Showing 14 changed files with 326 additions and 11 deletions.
diff --git a/ptscs/Sniffs/PSR12/FileHeaderSniff.php b/ptscs/Sniffs/PSR12/FileHeaderSniff.php
@@ -19,9 +19,9 @@ final class FileHeaderSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return int[]
      */
-    public function register()
+    public function register(): array
     {
         return [\T_OPEN_TAG];
     }
@@ -33,9 +33,8 @@ public function register()
      * @param int                         $stackPtr  The position of the current
      *                                               token in the stack.
      *
-     * @return int|null
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): ?int
     {
         $tokens = $phpcsFile->getTokens();
 
@@ -49,7 +48,7 @@ public function process(File $phpcsFile, $stackPtr)
             $headerLines = $this->getHeaderLines($phpcsFile, $openTag);
             if (empty($headerLines) === true && $openTag === $stackPtr) {
                 // No content in the file.
-                return;
+                return null;
             }
 
             $possibleHeaders[$openTag] = $headerLines;
@@ -123,7 +122,7 @@ public function process(File $phpcsFile, $stackPtr)
      *
      * @return array
      */
-    public function getHeaderLines(File $phpcsFile, $stackPtr)
+    public function getHeaderLines(File $phpcsFile, $stackPtr): array
     {
         $tokens = $phpcsFile->getTokens();
 
@@ -276,12 +275,9 @@ public function getHeaderLines(File $phpcsFile, $stackPtr)
      * Check the spacing and grouping of the statements inside each header block.
      *
      * @param File $phpcsFile The file being scanned.
-     * @param array                       $headerLines Header information, as sourced
-     *                                                 from getHeaderLines().
-     *
-     * @return int|null
+     * @param array $headerLines Header information, as sourced from getHeaderLines().
      */
-    public function processHeaderLines(File $phpcsFile, $headerLines)
+    public function processHeaderLines(File $phpcsFile, $headerLines): void
     {
         $tokens = $phpcsFile->getTokens();
 

diff --git a/ptscs/ruleset.xml b/ptscs/ruleset.xml
@@ -194,6 +194,11 @@
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
     <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment" />
 
+    <!-- Useless typehint -->
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.UselessAnnotation" />
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.UselessAnnotation" />
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.UselessAnnotation" />
+
 
     <!--++++++++++++++++++++++++++++++++++++
     Code analysis

diff --git a/tests/Sniffs/Slevomat/TypeHints/ParameterTypeHintTest.php b/tests/Sniffs/Slevomat/TypeHints/ParameterTypeHintTest.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\TypeHints;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class ParameterTypeHintTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield [
+          [
+            new ErrorData(8, 'SlevomatCodingStandard.TypeHints.ParameterTypeHint.UselessAnnotation'),
+          ],
+        ];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/PropertyTypeHintTest.php b/tests/Sniffs/Slevomat/TypeHints/PropertyTypeHintTest.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\TypeHints;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class PropertyTypeHintTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield [
+          [
+            new ErrorData(10, 'SlevomatCodingStandard.TypeHints.PropertyTypeHint.UselessAnnotation'),
+          ],
+        ];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/ReturnTypeHintTest.php b/tests/Sniffs/Slevomat/TypeHints/ReturnTypeHintTest.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\TypeHints;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class ReturnTypeHintTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield [
+          [ new ErrorData(8, 'SlevomatCodingStandard.TypeHints.ReturnTypeHint.UselessAnnotation')],
+        ];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/UselessDocblockTest.php b/tests/Sniffs/Slevomat/TypeHints/UselessDocblockTest.php
@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\TypeHints;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class UselessDocblockTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield [
+          [
+            new ErrorData(14, 'SlevomatCodingStandard.TypeHints.ParameterTypeHint.UselessAnnotation'),
+            new ErrorData(22, 'SlevomatCodingStandard.TypeHints.ReturnTypeHint.UselessAnnotation'),
+          ],
+        ];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.fixed
@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     */
+    public function check(string $useless, array $list, $missing): void
+    {
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.inc b/tests/Sniffs/Slevomat/TypeHints/_data/ParameterTypeHint.php.inc
@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     * @param string $useless
+     */
+    public function check(string $useless, array $list, $missing): void
+    {
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.fixed
@@ -0,0 +1,48 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+final class Foobar
+{
+    private string $useless;
+
+    /**
+     * @Assert\NotBlank
+     */
+    private $missing;
+
+    /**
+     * Description
+     *
+     */
+    private string $value1;
+
+    private ?int $value2 = null;
+
+    private string|int|float $value3;
+
+    /**
+     * @var string[]
+     */
+    private array $value4;
+
+    /**
+     * @var string The hashed password
+     */
+    private string $password;
+
+    private $inferMissing;
+
+    /**
+     * @var int
+     */
+    private $inferUseless;
+
+    public function __construct(string $inferMissing, int $inferUseless)
+    {
+        $this->inferMissing = $inferMissing;
+        $this->inferUseless = $inferUseless;
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.inc b/tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.inc
@@ -0,0 +1,51 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+final class Foobar
+{
+    /**
+     * @var string
+     */
+    private string $useless;
+
+    /**
+     * @Assert\NotBlank
+     */
+    private $missing;
+
+    /**
+     * Description
+     *
+     */
+    private string $value1;
+
+    private ?int $value2 = null;
+
+    private string|int|float $value3;
+
+    /**
+     * @var string[]
+     */
+    private array $value4;
+
+    /**
+     * @var string The hashed password
+     */
+    private string $password;
+
+    private $inferMissing;
+
+    /**
+     * @var int
+     */
+    private $inferUseless;
+
+    public function __construct(string $inferMissing, int $inferUseless)
+    {
+        $this->inferMissing = $inferMissing;
+        $this->inferUseless = $inferUseless;
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.fixed
@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     */
+    public function useless(): string
+    {
+        return $this->value;
+    }
+
+    public function missing()
+    {
+        return 'missing';
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.inc b/tests/Sniffs/Slevomat/TypeHints/_data/ReturnTypeHint.php.inc
@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     * @return string
+     */
+    public function useless(): string
+    {
+        return $this->value;
+    }
+
+    public function missing()
+    {
+        return 'missing';
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     * @var string
+     */
+    private $value;
+
+    /**
+     * Class constructor.
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.inc b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.inc
@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     * @var string
+     */
+    private $value;
+
+    /**
+     * Class constructor.
+     * @param string $value
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @return string
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+}