Refactoring the ControlStructureNestingRule

Author: floriankraemer

.gitignore

@@ -1,3 +1,6 @@
 /bin/
 /vendor/
+/tmp/
+/var/
 .idea
+/.phpunit.cache/

composer.json

@@ -18,5 +18,16 @@
     ],
     "config": {
         "bin-dir": "bin"
+    },
+    "scripts": {
+        "test": [
+            "phpunit"
+        ],
+        "test-coverage": [
+            "phpunit --coverage-text"
+        ],
+        "test-coverage-html": [
+            "phpunit --coverage-html tmp/coverage/"
+        ]
     }
 }

phpunit.xml.dist

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         cacheResult="true"
+         executionOrder="random"
+         resolveDependencies="false"
+         requireCoverageMetadata="false"
+         beStrictAboutChangesToGlobalState="true"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="false"
+         failOnRisky="true"
+         failOnWarning="false">
+
+    <php>
+        <env name="APP_ENV" value="test" />
+    </php>
+
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+
+</phpunit>

src/ControlStructureNestingRule.php

@@ -37,7 +37,7 @@ public function processNode(Node $node, Scope $scope): array
     {
         $this->setParentAttributesToEnableCorrectNestingDetection($node);
 
-        if (!$this->nodeIsAControllerStructure($node)) {
+        if (!$this->nodeIsAControlStructure($node)) {
             return [];
         }
 
@@ -50,7 +50,7 @@ public function processNode(Node $node, Scope $scope): array
         return $errors;
     }
 
-    private function nodeIsAControllerStructure(Node $node): bool
+    private function nodeIsAControlStructure(Node $node): bool
     {
         return $node instanceof If_ ||
             $node instanceof Else_ ||
@@ -62,7 +62,7 @@ private function nodeIsAControllerStructure(Node $node): bool
     private function getNestingLevel(Node $node, int $currentLevel = 1): int
     {
         $parent = $node->getAttribute('parent');
-        if ($this->nodeIsAControllerStructure($parent)) {
+        if ($this->nodeIsAControlStructure($parent)) {
             return $this->getNestingLevel($parent, $currentLevel + 1);
         }
 
@@ -76,26 +76,7 @@ private function getNestingLevel(Node $node, int $currentLevel = 1): int
     public function setParentAttributesToEnableCorrectNestingDetection(Node $node): void
     {
         $traverser = new NodeTraverser();
-        $traverser->addVisitor(
-            new class extends NodeVisitorAbstract {
-                public function enterNode(Node $node)
-                {
-                    foreach ($node->getSubNodeNames() as $subNodeName) {
-                        $subNode = $node->$subNodeName;
-                        if (is_array($subNode)) {
-                            foreach ($subNode as $childNode) {
-                                if ($childNode instanceof Node) {
-                                    $childNode->setAttribute('parent', $node);
-                                }
-                            }
-                        } elseif ($subNode instanceof Node) {
-                            $subNode->setAttribute('parent', $node);
-                        }
-                    }
-                }
-            }
-        );
-
+        $traverser->addVisitor($this->createNodeVisitor());
         $traverser->traverse([$node]);
     }
 
@@ -107,13 +88,38 @@ public function enterNode(Node $node)
      */
     public function addError(int $nestingLevel, Else_|If_|Catch_|ElseIf_|TryCatch $node, array $errors): array
     {
-        $errors[] = RuleErrorBuilder::message(
-            sprintf(
-                'Nesting level of %d exceeded. Maximum allowed is %d.',
-                $nestingLevel,
-                $this->maxNestingLevel
-            )
-        )->line($node->getLine())->build();
+        $errorMessage = sprintf(
+            'Nesting level of %d exceeded. Maximum allowed is %d.',
+            $nestingLevel,
+            $this->maxNestingLevel
+        );
+
+        $errors[] = RuleErrorBuilder::message($errorMessage)->line($node->getLine())->build();
+
         return $errors;
     }
+
+    public function createNodeVisitor(): object
+    {
+        return new class extends NodeVisitorAbstract {
+            public function enterNode(Node $node)
+            {
+                foreach ($node->getSubNodeNames() as $subNodeName) {
+                    $subNode = $node->$subNodeName;
+                    if (is_array($subNode)) {
+                        foreach ($subNode as $childNode) {
+                            if ($childNode instanceof Node) {
+                                $childNode->setAttribute('parent', $node);
+                            }
+                        }
+                        continue;
+                    }
+
+                    if ($subNode instanceof Node) {
+                        $subNode->setAttribute('parent', $node);
+                    }
+                }
+            }
+        };
+    }
 }