Enhancement: Extract Analyzer

ergebnis · Jan 7, 2025 · a8bf864 · a8bf864
1 parent c633936
commit a8bf864
Show file tree

Hide file tree

Showing 20 changed files with 172 additions and 189 deletions.
diff --git a/rules.neon b/rules.neon
@@ -141,6 +141,9 @@ parametersSchema:
 	])
 
 services:
+	-
+		class: Ergebnis\PHPStan\Rules\Analyzer
+
 	-
 		class: Ergebnis\PHPStan\Rules\Classes\FinalRule
 		arguments:

diff --git a/src/Analyzer.php b/src/Analyzer.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2018-2025 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpstan-rules
+ */
+
+namespace Ergebnis\PHPStan\Rules;
+
+use PhpParser\Node;
+
+/**
+ * @internal
+ */
+final class Analyzer
+{
+    /**
+     * @param null|Node\ComplexType|Node\Identifier|Node\Name $typeDeclaration
+     */
+    public function isNullableTypeDeclaration($typeDeclaration): bool
+    {
+        if ($typeDeclaration instanceof Node\NullableType) {
+            return true;
+        }
+
+        if ($typeDeclaration instanceof Node\UnionType) {
+            foreach ($typeDeclaration->types as $type) {
+                if (!$type instanceof Node\Identifier) {
+                    continue;
+                }
+
+                if ('null' === $type->toLowerString()) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    public function hasNullDefaultValue(Node\Param $parameter): bool
+    {
+        if (!$parameter->default instanceof Node\Expr\ConstFetch) {
+            return false;
+        }
+
+        return 'null' === $parameter->default->name->toLowerString();
+    }
+}
diff --git a/src/Closures/NoNullableReturnTypeDeclarationRule.php b/src/Closures/NoNullableReturnTypeDeclarationRule.php
@@ -13,6 +13,7 @@
 
 namespace Ergebnis\PHPStan\Rules\Closures;
 
+use Ergebnis\PHPStan\Rules\Analyzer;
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
@@ -23,6 +24,13 @@
  */
 final class NoNullableReturnTypeDeclarationRule implements Rules\Rule
 {
+    private Analyzer $analyzer;
+
+    public function __construct(Analyzer $analyzer)
+    {
+        $this->analyzer = $analyzer;
+    }
+
     public function getNodeType(): string
     {
         return Node\Expr\Closure::class;
@@ -32,7 +40,7 @@ public function processNode(
         Node $node,
         Analyser\Scope $scope
     ): array {
-        if (!self::hasNullableReturnTypeDeclaration($node)) {
+        if (!$this->analyzer->isNullableTypeDeclaration($node->getReturnType())) {
             return [];
         }
 
@@ -42,27 +50,4 @@ public function processNode(
                 ->build(),
         ];
     }
-
-    private static function hasNullableReturnTypeDeclaration(Node\Expr\Closure $closure): bool
-    {
-        $returnType = $closure->getReturnType();
-
-        if ($returnType instanceof Node\NullableType) {
-            return true;
-        }
-
-        if ($returnType instanceof Node\UnionType) {
-            foreach ($returnType->types as $type) {
-                if (!$type instanceof Node\Identifier) {
-                    continue;
-                }
-
-                if ('null' === $type->toString()) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
 }
diff --git a/src/Closures/NoParameterWithNullDefaultValueRule.php b/src/Closures/NoParameterWithNullDefaultValueRule.php
@@ -13,6 +13,7 @@
 
 namespace Ergebnis\PHPStan\Rules\Closures;
 
+use Ergebnis\PHPStan\Rules\Analyzer;
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
@@ -23,6 +24,13 @@
  */
 final class NoParameterWithNullDefaultValueRule implements Rules\Rule
 {
+    private Analyzer $analyzer;
+
+    public function __construct(Analyzer $analyzer)
+    {
+        $this->analyzer = $analyzer;
+    }
+
     public function getNodeType(): string
     {
         return Node\Expr\Closure::class;
@@ -36,8 +44,8 @@ public function processNode(
             return [];
         }
 
-        $parametersWithNullDefaultValue = \array_values(\array_filter($node->params, static function (Node\Param $parameter): bool {
-            return self::hasNullDefaultValue($parameter);
+        $parametersWithNullDefaultValue = \array_values(\array_filter($node->params, function (Node\Param $parameter): bool {
+            return $this->analyzer->hasNullDefaultValue($parameter);
         }));
 
         if (0 === \count($parametersWithNullDefaultValue)) {
@@ -61,13 +69,4 @@ public function processNode(
                 ->build();
         }, $parametersWithNullDefaultValue);
     }
-
-    private static function hasNullDefaultValue(Node\Param $parameter): bool
-    {
-        if (!$parameter->default instanceof Node\Expr\ConstFetch) {
-            return false;
-        }
-
-        return 'null' === $parameter->default->name->toLowerString();
-    }
 }
diff --git a/src/Closures/NoParameterWithNullableTypeDeclarationRule.php b/src/Closures/NoParameterWithNullableTypeDeclarationRule.php
@@ -13,6 +13,7 @@
 
 namespace Ergebnis\PHPStan\Rules\Closures;
 
+use Ergebnis\PHPStan\Rules\Analyzer;
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
@@ -23,6 +24,13 @@
  */
 final class NoParameterWithNullableTypeDeclarationRule implements Rules\Rule
 {
+    private Analyzer $analyzer;
+
+    public function __construct(Analyzer $analyzer)
+    {
+        $this->analyzer = $analyzer;
+    }
+
     public function getNodeType(): string
     {
         return Node\Expr\Closure::class;
@@ -36,8 +44,8 @@ public function processNode(
             return [];
         }
 
-        $parametersWithNullableTypeDeclaration = \array_values(\array_filter($node->params, static function (Node\Param $parameter): bool {
-            return self::hasNullableTypeDeclaration($parameter);
+        $parametersWithNullableTypeDeclaration = \array_values(\array_filter($node->params, function (Node\Param $parameter): bool {
+            return $this->analyzer->isNullableTypeDeclaration($parameter->type);
         }));
 
         if (0 === \count($parametersWithNullableTypeDeclaration)) {
@@ -61,27 +69,4 @@ public function processNode(
                 ->build();
         }, $parametersWithNullableTypeDeclaration);
     }
-
-    private static function hasNullableTypeDeclaration(Node\Param $parameter): bool
-    {
-        if ($parameter->type instanceof Node\NullableType) {
-            return true;
-        }
-
-        if ($parameter->type instanceof Node\UnionType) {
-            foreach ($parameter->type->types as $type) {
-                if (!$type instanceof Node\Identifier) {
-                    continue;
-                }
-
-                if ('null' !== $type->toString()) {
-                    continue;
-                }
-
-                return true;
-            }
-        }
-
-        return false;
-    }
 }
diff --git a/src/Functions/NoNullableReturnTypeDeclarationRule.php b/src/Functions/NoNullableReturnTypeDeclarationRule.php
@@ -13,6 +13,7 @@
 
 namespace Ergebnis\PHPStan\Rules\Functions;
 
+use Ergebnis\PHPStan\Rules\Analyzer;
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
@@ -23,6 +24,13 @@
  */
 final class NoNullableReturnTypeDeclarationRule implements Rules\Rule
 {
+    private Analyzer $analyzer;
+
+    public function __construct(Analyzer $analyzer)
+    {
+        $this->analyzer = $analyzer;
+    }
+
     public function getNodeType(): string
     {
         return Node\Stmt\Function_::class;
@@ -36,7 +44,7 @@ public function processNode(
             return [];
         }
 
-        if (!self::hasNullableReturnTypeDeclaration($node)) {
+        if (!$this->analyzer->isNullableTypeDeclaration($node->getReturnType())) {
             return [];
         }
 
@@ -51,27 +59,4 @@ public function processNode(
                 ->build(),
         ];
     }
-
-    private static function hasNullableReturnTypeDeclaration(Node\Stmt\Function_ $function): bool
-    {
-        $returnType = $function->getReturnType();
-
-        if ($returnType instanceof Node\NullableType) {
-            return true;
-        }
-
-        if ($returnType instanceof Node\UnionType) {
-            foreach ($returnType->types as $type) {
-                if (!$type instanceof Node\Identifier) {
-                    continue;
-                }
-
-                if ('null' === $type->toString()) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
 }
diff --git a/src/Functions/NoParameterWithNullDefaultValueRule.php b/src/Functions/NoParameterWithNullDefaultValueRule.php
@@ -13,6 +13,7 @@
 
 namespace Ergebnis\PHPStan\Rules\Functions;
 
+use Ergebnis\PHPStan\Rules\Analyzer;
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
@@ -23,6 +24,13 @@
  */
 final class NoParameterWithNullDefaultValueRule implements Rules\Rule
 {
+    private Analyzer $analyzer;
+
+    public function __construct(Analyzer $analyzer)
+    {
+        $this->analyzer = $analyzer;
+    }
+
     public function getNodeType(): string
     {
         return Node\Stmt\Function_::class;
@@ -36,8 +44,8 @@ public function processNode(
             return [];
         }
 
-        $parametersWithNullDefaultValue = \array_values(\array_filter($node->params, static function (Node\Param $parameter): bool {
-            return self::hasNullDefaultValue($parameter);
+        $parametersWithNullDefaultValue = \array_values(\array_filter($node->params, function (Node\Param $parameter): bool {
+            return $this->analyzer->hasNullDefaultValue($parameter);
         }));
 
         if (0 === \count($parametersWithNullDefaultValue)) {
@@ -64,13 +72,4 @@ public function processNode(
                 ->build();
         }, $parametersWithNullDefaultValue);
     }
-
-    private static function hasNullDefaultValue(Node\Param $parameter): bool
-    {
-        if (!$parameter->default instanceof Node\Expr\ConstFetch) {
-            return false;
-        }
-
-        return 'null' === $parameter->default->name->toLowerString();
-    }
 }
diff --git a/src/Functions/NoParameterWithNullableTypeDeclarationRule.php b/src/Functions/NoParameterWithNullableTypeDeclarationRule.php
@@ -13,6 +13,7 @@
 
 namespace Ergebnis\PHPStan\Rules\Functions;
 
+use Ergebnis\PHPStan\Rules\Analyzer;
 use Ergebnis\PHPStan\Rules\ErrorIdentifier;
 use PhpParser\Node;
 use PHPStan\Analyser;
@@ -23,6 +24,13 @@
  */
 final class NoParameterWithNullableTypeDeclarationRule implements Rules\Rule
 {
+    private Analyzer $analyzer;
+
+    public function __construct(Analyzer $analyzer)
+    {
+        $this->analyzer = $analyzer;
+    }
+
     public function getNodeType(): string
     {
         return Node\Stmt\Function_::class;
@@ -36,8 +44,8 @@ public function processNode(
             return [];
         }
 
-        $parametersWithNullableTypeDeclaration = \array_values(\array_filter($node->params, static function (Node\Param $parameter): bool {
-            return self::hasNullableTypeDeclaration($parameter);
+        $parametersWithNullableTypeDeclaration = \array_values(\array_filter($node->params, function (Node\Param $parameter): bool {
+            return $this->analyzer->isNullableTypeDeclaration($parameter->type);
         }));
 
         if (0 === \count($parametersWithNullableTypeDeclaration)) {
@@ -64,27 +72,4 @@ public function processNode(
                 ->build();
         }, $parametersWithNullableTypeDeclaration);
     }
-
-    private static function hasNullableTypeDeclaration(Node\Param $parameter): bool
-    {
-        if ($parameter->type instanceof Node\NullableType) {
-            return true;
-        }
-
-        if ($parameter->type instanceof Node\UnionType) {
-            foreach ($parameter->type->types as $type) {
-                if (!$type instanceof Node\Identifier) {
-                    continue;
-                }
-
-                if ('null' !== $type->toString()) {
-                    continue;
-                }
-
-                return true;
-            }
-        }
-
-        return false;
-    }
 }