From 8869408bd6adffc4eb37774447206548246df55a Mon Sep 17 00:00:00 2001
From: Asis Pattisahusiwa <79239132+asispts@users.noreply.github.com>
Date: Fri, 3 Nov 2023 16:27:57 +0700
Subject: [PATCH] Detect useless property annotation

---
 ptscs/ruleset.xml                             |  3 ++
 .../TypeHints/PropertyTypeHintTest.php        | 25 +++++++++
 .../TypeHints/UselessDocblockTest.php         | 20 ++++++++
 .../_data/PropertyTypeHint.php.fixed          | 48 +++++++++++++++++
 .../TypeHints/_data/PropertyTypeHint.php.inc  | 51 +++++++++++++++++++
 .../TypeHints/_data/UselessDocblock.php.fixed | 28 ++++++++++
 .../TypeHints/_data/UselessDocblock.php.inc   | 28 ++++++++++
 7 files changed, 203 insertions(+)
 create mode 100644 tests/Sniffs/Slevomat/TypeHints/PropertyTypeHintTest.php
 create mode 100644 tests/Sniffs/Slevomat/TypeHints/UselessDocblockTest.php
 create mode 100644 tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.fixed
 create mode 100644 tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.inc
 create mode 100644 tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
 create mode 100644 tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.inc

diff --git a/ptscs/ruleset.xml b/ptscs/ruleset.xml
index 5c226fc..e83a519 100644
--- a/ptscs/ruleset.xml
+++ b/ptscs/ruleset.xml
@@ -194,6 +194,9 @@
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
     <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment" />
 
+    <!-- Useless typehint -->
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.UselessAnnotation" />
+
 
     <!--++++++++++++++++++++++++++++++++++++
     Code analysis
diff --git a/tests/Sniffs/Slevomat/TypeHints/PropertyTypeHintTest.php b/tests/Sniffs/Slevomat/TypeHints/PropertyTypeHintTest.php
new file mode 100644
index 0000000..1f21698
--- /dev/null
+++ 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/UselessDocblockTest.php b/tests/Sniffs/Slevomat/TypeHints/UselessDocblockTest.php
new file mode 100644
index 0000000..0665c5e
--- /dev/null
+++ b/tests/Sniffs/Slevomat/TypeHints/UselessDocblockTest.php
@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat\TypeHints;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+
+final class UselessDocblockTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield [];
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/PropertyTypeHint.php.fixed
new file mode 100644
index 0000000..9ab0caa
--- /dev/null
+++ 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
new file mode 100644
index 0000000..83ef829
--- /dev/null
+++ 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/UselessDocblock.php.fixed b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
new file mode 100644
index 0000000..78a3ab6
--- /dev/null
+++ b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.fixed
@@ -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;
+    }
+}
diff --git a/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.inc b/tests/Sniffs/Slevomat/TypeHints/_data/UselessDocblock.php.inc
new file mode 100644
index 0000000..78a3ab6
--- /dev/null
+++ 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;
+    }
+}