Merge pull request #7 from Kocal/MethodsShouldBePublicOrPrivateRule

Author: Kocal

README.md

@@ -256,7 +256,7 @@ abstract class BaseComponent
 }
 
 #[AsTwigComponent]
-final class Alert extends BaseComponent
+class Alert extends BaseComponent
 {
 }
 ```
@@ -300,6 +300,65 @@ final class Alert
 
 <br>
 
+### MethodsShouldBePublicOrPrivateRule
+
+Enforces that all methods in Twig Components are either public or private, but not protected.
+Since Twig Components must be final classes and inheritance is forbidden (see `ForbiddenInheritanceRule`), protected methods serve no purpose and should be avoided.
+
+```yaml
+rules:
+    - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule
+```
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+    public string $message;
+
+    protected function formatMessage(): string
+    {
+        return strtoupper($this->message);
+    }
+}
+```
+
+:x:
+
+<br>
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+    public string $message;
+
+    public function formatMessage(): string
+    {
+        return strtoupper($this->message);
+    }
+
+    private function helperMethod(): void
+    {
+        // ...
+    }
+}
+```
+
+:+1:
+
+<br>
+
 ### PublicPropertiesShouldBeCamelCaseRule
 
 Enforces that all public properties in Twig Components follow camelCase naming convention.

ecs.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use PhpCsFixer\Fixer\ClassNotation\ProtectedToPrivateFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
 return ECSConfig::configure()
@@ -11,4 +12,9 @@
     ])
     ->withRootFiles()
     ->withPreparedSets(psr12: true, common: true)
+    ->withSkip([
+        ProtectedToPrivateFixer::class => [
+            __DIR__ . '/tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/*',
+        ],
+    ])
 ;

phpstan-baseline.neon

@@ -11,3 +11,15 @@ parameters:
 			identifier: property.unused
 			count: 1
 			path: tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithPrivateNonCamelCaseProperties.php
+
+		-
+			message: '#^Method Kocal\\PHPStanSymfonyUX\\Tests\\Rules\\TwigComponent\\MethodsShouldBePublicOrPrivateRule\\Fixture\\ComponentWithPublicAndPrivateMethods\:\:privateMethod\(\) is unused\.$#'
+			identifier: method.unused
+			count: 1
+			path: tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/ComponentWithPublicAndPrivateMethods.php
+
+		-
+			message: '#^Method Kocal\\PHPStanSymfonyUX\\Tests\\Rules\\TwigComponent\\MethodsShouldBePublicOrPrivateRule\\Fixture\\LiveComponentWithPublicAndPrivateMethods\:\:privateMethod\(\) is unused\.$#'
+			identifier: method.unused
+			count: 1
+			path: tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/LiveComponentWithPublicAndPrivateMethods.php

src/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Rules\TwigComponent;
+
+use Kocal\PHPStanSymfonyUX\NodeAnalyzer\AttributeFinder;
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+/**
+ * @implements Rule<Class_>
+ */
+final class MethodsShouldBePublicOrPrivateRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
+            return [];
+        }
+
+        $errors = [];
+
+        foreach ($node->getMethods() as $method) {
+            if ($method->isProtected()) {
+                $methodName = $method->name->toString();
+
+                $errors[] = RuleErrorBuilder::message(
+                    sprintf('Method "%s()" in a Twig component should not be protected.', $methodName)
+                )
+                    ->identifier('symfonyUX.twigComponent.methodsShouldBePublicOrPrivate')
+                    ->line($method->getLine())
+                    ->tip('Twig component methods should be either public or private, not protected.')
+                    ->build();
+            }
+        }
+
+        return $errors;
+    }
+}

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/ComponentWithProtectedMethod.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithProtectedMethod
+{
+    public string $name = '';
+
+    protected function protectedMethod(): void
+    {
+    }
+}

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/ComponentWithPublicAndPrivateMethods.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithPublicAndPrivateMethods
+{
+    public string $name = '';
+
+    public function publicMethod(): void
+    {
+    }
+
+    private function privateMethod(): void
+    {
+    }
+}

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/LiveComponentWithProtectedMethod.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule\Fixture;
+
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+
+#[AsLiveComponent]
+final class LiveComponentWithProtectedMethod
+{
+    public string $name = '';
+
+    protected function protectedMethod(): void
+    {
+    }
+}

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/LiveComponentWithPublicAndPrivateMethods.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule\Fixture;
+
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+
+#[AsLiveComponent]
+final class LiveComponentWithPublicAndPrivateMethods
+{
+    public string $name = '';
+
+    public function publicMethod(): void
+    {
+    }
+
+    private function privateMethod(): void
+    {
+    }
+}

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/Fixture/NotAComponent.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule\Fixture;
+
+final class NotAComponent
+{
+    public string $name = '';
+
+    protected function protectedMethod(): void
+    {
+    }
+}

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/MethodsShouldBePublicOrPrivateRuleTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule;
+
+use Kocal\PHPStanSymfonyUX\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<MethodsShouldBePublicOrPrivateRule>
+ */
+final class MethodsShouldBePublicOrPrivateRuleTest extends RuleTestCase
+{
+    public function testViolations(): void
+    {
+        $this->analyse(
+            [__DIR__ . '/Fixture/ComponentWithProtectedMethod.php'],
+            [
+                [
+                    'Method "protectedMethod()" in a Twig component should not be protected.',
+                    14,
+                    'Twig component methods should be either public or private, not protected.',
+                ],
+            ]
+        );
+
+        $this->analyse(
+            [__DIR__ . '/Fixture/LiveComponentWithProtectedMethod.php'],
+            [
+                [
+                    'Method "protectedMethod()" in a Twig component should not be protected.',
+                    14,
+                    'Twig component methods should be either public or private, not protected.',
+                ],
+            ]
+        );
+    }
+
+    public function testNoViolations(): void
+    {
+        $this->analyse(
+            [__DIR__ . '/Fixture/NotAComponent.php'],
+            []
+        );
+
+        $this->analyse(
+            [__DIR__ . '/Fixture/ComponentWithPublicAndPrivateMethods.php'],
+            []
+        );
+
+        $this->analyse(
+            [__DIR__ . '/Fixture/LiveComponentWithPublicAndPrivateMethods.php'],
+            []
+        );
+    }
+
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [__DIR__ . '/config/configured_rule.neon'];
+    }
+
+    protected function getRule(): Rule
+    {
+        return self::getContainer()->getByType(MethodsShouldBePublicOrPrivateRule::class);
+    }
+}