restructure

mll-lab · Dec 9, 2024 · 123d8b6 · 123d8b6
1 parent 02f521b
commit 123d8b6
Show file tree

Hide file tree

Showing 10 changed files with 145 additions and 67 deletions.
diff --git a/src/PHPStan/NodeNameExtractor/ClassMethodNameExtractor.php b/src/PHPStan/NodeNameExtractor/ClassMethodNameExtractor.php
@@ -0,0 +1,18 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\PHPStan\NodeNameExtractor;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+
+class ClassMethodNameExtractor implements NodeNameExtractor
+{
+    public function extract(Node $node): ?string
+    {
+        if ($node instanceof ClassMethod) {
+            return $node->name->toString();
+        }
+
+        return null;
+    }
+}
diff --git a/src/PHPStan/NodeNameExtractor/ClassNameExtractor.php b/src/PHPStan/NodeNameExtractor/ClassNameExtractor.php
@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\PHPStan\NodeNameExtractor;
+
+use PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Stmt\Class_;
+
+class ClassNameExtractor implements NodeNameExtractor
+{
+    public function extract(Node $node): ?string
+    {
+        if ($node instanceof Class_ && $node->name instanceof Identifier) {
+            return $node->name->toString();
+        }
+
+        return null;
+    }
+}
diff --git a/src/PHPStan/NodeNameExtractor/NodeNameExtractor.php b/src/PHPStan/NodeNameExtractor/NodeNameExtractor.php
@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\PHPStan\NodeNameExtractor;
+
+use PhpParser\Node;
+
+interface NodeNameExtractor
+{
+    public function extract(Node $node): ?string;
+}
diff --git a/src/PHPStan/NodeNameExtractor/StringNameExtractor.php b/src/PHPStan/NodeNameExtractor/StringNameExtractor.php
@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\PHPStan\NodeNameExtractor;
+
+use PhpParser\Node;
+use PhpParser\Node\Scalar\EncapsedStringPart;
+use PhpParser\Node\Scalar\String_;
+
+class StringNameExtractor implements NodeNameExtractor
+{
+    public function extract(Node $node): ?string
+    {
+        if ($node instanceof String_) {
+            return $node->value;
+        }
+        if ($node instanceof EncapsedStringPart) {
+            return $node->value;
+        }
+
+        return null;
+    }
+}
diff --git a/src/PHPStan/NodeNameExtractor/VariableNameExtractor.php b/src/PHPStan/NodeNameExtractor/VariableNameExtractor.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace MLL\Utils\PHPStan\NodeNameExtractor;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Param;
+
+class VariableNameExtractor implements NodeNameExtractor
+{
+    public function extract(Node $node): ?string
+    {
+        if ($node instanceof Variable && is_string($node->name)) {
+            return $node->name;
+        }
+        if ($node instanceof Param
+            && $node->var instanceof Variable
+            && is_string($node->var->name)
+        ) {
+            return $node->var->name;
+        }
+
+        return null;
+    }
+}
diff --git a/src/PHPStan/Rules/CanonicalCapitalization.php b/src/PHPStan/Rules/CanonicalCapitalization.php
@@ -2,6 +2,10 @@
 
 namespace MLL\Utils\PHPStan\Rules;
 
+use MLL\Utils\PHPStan\NodeNameExtractor\ClassMethodNameExtractor;
+use MLL\Utils\PHPStan\NodeNameExtractor\ClassNameExtractor;
+use MLL\Utils\PHPStan\NodeNameExtractor\StringNameExtractor;
+use MLL\Utils\PHPStan\NodeNameExtractor\VariableNameExtractor;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
@@ -34,13 +38,25 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        $result = NodeIdentifier::extractNodeNameAndType($node)
-            ?? NodeIdentifier::nodeNameForString($node);
-        if ($result === null) {
-            return [];
+        $extractors = [
+            new ClassMethodNameExtractor(),
+            new ClassNameExtractor(),
+            new VariableNameExtractor(),
+            new StringNameExtractor(),
+        ];
+
+        $nodeName = null;
+        foreach ($extractors as $extractor) {
+            $extractedName = $extractor->extract($node);
+            if ($extractedName !== null) {
+                $nodeName = $extractedName;
+                break;
+            }
         }
 
-        [$nodeName, $type] = $result;
+        if ($nodeName === null) {
+            return [];
+        }
 
         $wrongCapitalization = CanonicalCapitalization::findWrongCapitalization($nodeName);
         if ($wrongCapitalization === null) {
@@ -53,7 +69,7 @@ public function processNode(Node $node, Scope $scope): array
 
         return [
             RuleErrorBuilder::message(<<<TXT
-                {$type} "{$nodeName}" should use "{$correct}" instead of "{$incorrect}", rename it to "{$expectedName}".
+                Name of {$node->getType()} "{$nodeName}" should use "{$correct}" instead of "{$incorrect}", rename it to "{$expectedName}".
                 TXT)
                 ->identifier('mll.canonicalCapitalization')
                 ->build(),

diff --git a/src/PHPStan/Rules/CapitalizationOfIDRule.php b/src/PHPStan/Rules/CapitalizationOfIDRule.php
@@ -3,6 +3,9 @@
 namespace MLL\Utils\PHPStan\Rules;
 
 use Illuminate\Support\Str;
+use MLL\Utils\PHPStan\NodeNameExtractor\ClassMethodNameExtractor;
+use MLL\Utils\PHPStan\NodeNameExtractor\ClassNameExtractor;
+use MLL\Utils\PHPStan\NodeNameExtractor\VariableNameExtractor;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
@@ -25,21 +28,33 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        $result = NodeIdentifier::extractNodeNameAndType($node);
-        if ($result === null) {
+        $extractors = [
+            new ClassMethodNameExtractor(),
+            new ClassNameExtractor(),
+            new VariableNameExtractor(),
+        ];
+        $nodeName = null;
+        foreach ($extractors as $extractor) {
+            $extractedName = $extractor->extract($node);
+            if ($extractedName !== null) {
+                $nodeName = $extractedName;
+                break;
+            }
+        }
+
+        if ($nodeName === null) {
             return [];
         }
 
-        [$nodeName, $type] = $result;
-        if (! static::containsWrongIDCapitalization($nodeName)) {
+        if (! self::containsWrongIDCapitalization($nodeName)) {
             return [];
         }
 
-        $expectedName = static::fixIDCapitalization($nodeName);
+        $expectedName = self::fixIDCapitalization($nodeName);
 
         return [
             RuleErrorBuilder::message(<<<TXT
-                {$type} Name "{$nodeName}" should use "ID" instead of "Id", rename it to "{$expectedName}".
+                Name of {$node->getType()} "{$nodeName}" should use "ID" instead of "Id", rename it to "{$expectedName}".
                 TXT)
                 ->identifier('mll.capitalizationOfID')
                 ->build(),

diff --git a/src/PHPStan/Rules/NodeIdentifier.php b/src/PHPStan/Rules/NodeIdentifier.php
diff --git a/...tan/Rules/CanonicalCapitalizationTest.php → ...alization/CanonicalCapitalizationTest.php b/...tan/Rules/CanonicalCapitalizationTest.php → ...alization/CanonicalCapitalizationTest.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace MLL\Utils\Tests\PHPStan\Rules;
+namespace MLL\Utils\Tests\PHPStan\Rules\CanonicalCapitalization;
 
 use MLL\Utils\PHPStan\Rules\CanonicalCapitalization;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -31,16 +31,16 @@ public function testFindWrongCapitalization(string $nodeName, array $data): void
     /** @return iterable<array{string, array{string, string}}> */
     public static function wrongCapitalizationProvider(): iterable
     {
-        yield 'Should correct capitalization for "LabID "' => ['The LabID is incorrect', ['Lab ID', 'LabID ', self::EXPECTED_LAB_ID_IS_INCORRECT]];
-        yield 'Should correct capitalization for "Lab-ID"' => ['The Lab-ID is incorrect', ['Lab ID', 'Lab-ID', self::EXPECTED_LAB_ID_IS_INCORRECT]];
-        yield 'Should correct capitalization for "lab id"' => ['The lab id is incorrect', ['Lab ID', 'lab id', self::EXPECTED_LAB_ID_IS_INCORRECT]];
-        yield 'Should correct capitalization for " labID"' => ['The labID is incorrect', ['Lab ID', ' labID', self::EXPECTED_LAB_ID_IS_INCORRECT]];
-        yield 'Should correct capitalization for "labID "' => ['labID is incorrect', ['Lab ID', 'labID ', 'Lab ID is incorrect']];
         yield 'Should correct capitalization for " LabID"' => ['The LabID', ['Lab ID', ' LabID', 'The Lab ID']];
+        yield 'Should correct capitalization for " labID"' => ['The labID is incorrect', ['Lab ID', ' labID', self::EXPECTED_LAB_ID_IS_INCORRECT]];
         yield 'Should correct capitalization for "LABID"' => ['The LABID is incorrect', ['Lab ID', 'LABID', self::EXPECTED_LAB_ID_IS_INCORRECT]];
+        yield 'Should correct capitalization for "Lab Id"' => ['The Lab Id is incorrect', ['Lab ID', 'Lab Id', self::EXPECTED_LAB_ID_IS_INCORRECT]];
+        yield 'Should correct capitalization for "Lab-ID"' => ['The Lab-ID is incorrect', ['Lab ID', 'Lab-ID', self::EXPECTED_LAB_ID_IS_INCORRECT]];
+        yield 'Should correct capitalization for "LabID "' => ['The LabID is incorrect', ['Lab ID', 'LabID ', self::EXPECTED_LAB_ID_IS_INCORRECT]];
         yield 'Should correct capitalization for "Labid"' => ['The Labid is incorrect', ['Lab ID', 'Labid', self::EXPECTED_LAB_ID_IS_INCORRECT]];
+        yield 'Should correct capitalization for "lab id"' => ['The lab id is incorrect', ['Lab ID', 'lab id', self::EXPECTED_LAB_ID_IS_INCORRECT]];
         yield 'Should correct capitalization for "lab-Id"' => ['The lab-Id is incorrect', ['Lab ID', 'lab-Id', self::EXPECTED_LAB_ID_IS_INCORRECT]];
-        yield 'Should correct capitalization for "Lab Id"' => ['The Lab Id is incorrect', ['Lab ID', 'Lab Id', self::EXPECTED_LAB_ID_IS_INCORRECT]];
+        yield 'Should correct capitalization for "labID "' => ['labID is incorrect', ['Lab ID', 'labID ', 'Lab ID is incorrect']];
     }
 
     /** @dataProvider rightCapitalizationProvider */

diff --git a/...Stan/Rules/CapitalizationOfIDRuleTest.php → ...onOfIDRule/CapitalizationOfIDRuleTest.php b/...Stan/Rules/CapitalizationOfIDRuleTest.php → ...onOfIDRule/CapitalizationOfIDRuleTest.php
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace MLL\Utils\Tests\PHPStan\Rules;
+namespace MLL\Utils\Tests\PHPStan\Rules\CapitalizationOfIDRule;
 
 use MLL\Utils\PHPStan\Rules\CapitalizationOfIDRule;
 use PHPUnit\Framework\Attributes\DataProvider;