Merge pull request #346 from tighten/drift/request-validation-must-ex…

…tend-controller Require request validation formatter to extend controller
tighten · Nov 17, 2023 · 8637bc3 · 8637bc3
2 parents a51d151 + 568b467
commit 8637bc3
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 2 deletions.
diff --git a/src/Commands/FormatCommand.php b/src/Commands/FormatCommand.php
@@ -93,7 +93,7 @@ private function formatFile(InputInterface $input, OutputInterface $output, $fil
         if (! empty($only = $input->getOption('only'))) {
             $formatters = array_filter($this->getAllFormatters($file), function ($formatter) use ($only) {
                 foreach ($only as $filter) {
-                    if (false !== strpos($formatter, $filter)) {
+                    if (strpos($formatter, $filter) !== false) {
                         return true;
                     }
                 }

diff --git a/src/Commands/LintCommand.php b/src/Commands/LintCommand.php
@@ -117,7 +117,7 @@ private function lintFile(InputInterface $input, OutputInterface $output, $file)
         if (! empty($only = $input->getOption('only'))) {
             $linters = array_filter($this->getAllLinters($file), function ($linter) use ($only) {
                 foreach ($only as $filter) {
-                    if (false !== strpos($linter, $filter)) {
+                    if (strpos($linter, $filter) !== false) {
                         return true;
                     }
                 }

diff --git a/src/Formatters/RequestValidation.php b/src/Formatters/RequestValidation.php
@@ -43,8 +43,28 @@ private function visitor(): NodeVisitorAbstract
     {
         return new class extends NodeVisitorAbstract
         {
+            private bool $extendsController = false;
+
+            public function beforeTraverse(array $nodes)
+            {
+                $this->extendsController = false;
+
+                return null;
+            }
+
             public function enterNode(Node $node): Node|int|null
             {
+                if ($node instanceof Node\Stmt\Class_
+                    && ! empty($node->extends)
+                    && $node->extends->toString() === 'Controller'
+                ) {
+                    $this->extendsController = true;
+                }
+
+                if (! $this->extendsController) {
+                    return null;
+                }
+
                 if (! $node instanceof Node\Expr\MethodCall) {
                     return null;
                 }

diff --git a/tests/Formatting/Formatters/RequestValidationTest.php b/tests/Formatting/Formatters/RequestValidationTest.php
@@ -114,4 +114,26 @@ public function store()
 
         $this->assertSame($file, $formatted);
     }
+
+    /** @test */
+    public function it_ignores_classes_that_do_not_extend_controller()
+    {
+        $file = <<<'file'
+<?php
+
+namespace App;
+
+class ControllerA extends NotController
+{
+    public function store()
+    {
+        $this->validate(['name' => 'required'], ['name.required' => 'Name is required']);
+    }
+}
+file;
+
+        $formatted = (new TFormat)->format(new RequestValidation($file));
+
+        $this->assertSame($file, $formatted);
+    }
 }