zircote · deluxetom · Apr 29, 2024 · Apr 29, 2024 · Apr 29, 2024
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -15,7 +15,7 @@ jobs:
       fail-fast: true
       matrix:
         operating-system: [ ubuntu-latest ]
-        php: [ '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
+        php: [ '7.4', '8.0', '8.1', '8.2', '8.3', '8.4' ]
         dependencies: [ 'lowest', 'highest' ]
         exclude:
           - php: '8.1'

diff --git a/.github/workflows/security-checks.yml b/.github/workflows/security-checks.yml
@@ -15,7 +15,7 @@ jobs:
       fail-fast: true
       matrix:
         operating-system: [ ubuntu-latest ]
-        php: [ '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
+        php: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
         dependencies: [ 'highest' ]
 
     name: PHP ${{ matrix.php }} on ${{ matrix.operating-system }} with ${{ matrix.dependencies }} dependencies

diff --git a/composer.json b/composer.json
@@ -44,7 +44,7 @@
         }
     },
     "require": {
-        "php": ">=7.2",
+        "php": ">=7.4",
         "ext-json": "*",
         "psr/log": "^1.1 || ^2.0 || ^3.0",
         "symfony/deprecation-contracts": "^2 || ^3",
@@ -62,6 +62,7 @@
         "friendsofphp/php-cs-fixer": "^2.17 || ^3.47.1",
         "phpstan/phpstan": "^1.6",
         "phpunit/phpunit": ">=8",
+        "rector/rector": "^1.0",
         "vimeo/psalm": "^4.23"
     },
     "suggest": {
@@ -84,6 +85,7 @@
         "testlegacy": "Run tests using the legacy TokenAnalyser",
         "testall": "Run all tests (test + testlegacy)",
         "analyse": "Run static analysis (phpstan/psalm)",
+        "rector": "Automatic refactoring",
         "spectral-examples": "Run spectral lint over all .yaml files in the Examples folder",
         "spectral-scratch": "Run spectral lint over all .yaml files in the tests/Fixtures/Scratch folder",
         "spectral": "Run all spectral tests",
@@ -107,6 +109,7 @@
             "export XDEBUG_MODE=off && phpstan analyse --memory-limit=2G",
             "export XDEBUG_MODE=off && psalm"
         ],
+        "rector": "rector process src --dry-run",
         "spectral-examples": "for ff in `find Examples -name '*.yaml'`; do spectral lint $ff; done",
         "spectral-scratch": "for ff in `find tests/Fixtures/Scratch -name '*.yaml'`; do spectral lint $ff; done",
         "spectral": [

diff --git a/rector.php b/rector.php
@@ -0,0 +1,17 @@
+<?php
+
+use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector;
+use Rector\ValueObject\PhpVersion;
+
+return RectorConfig::configure()
+    ->withRules([
+        TypedPropertyFromStrictConstructorRector::class
+    ])
+    ->withSkip([
+        ExplicitBoolCompareRector::class,
+    ])
+    ->withPreparedSets(true, true)
+    ->withPhpVersion(PhpVersion::PHP_74)
+;
diff --git a/src/Analysers/AttributeAnnotationFactory.php b/src/Analysers/AttributeAnnotationFactory.php
@@ -74,11 +74,9 @@ public function build(\Reflector $reflector, Context $context): array
                                 }
                                 $instance->nullable = $nullable ?: Generator::UNDEFINED;
 
-                                if ($rp->isPromoted()) {
-                                    // promoted parameter - docblock is available via class/property
-                                    if ($comment = $rp->getDeclaringClass()->getProperty($rp->getName())->getDocComment()) {
-                                        $instance->_context->comment = $comment;
-                                    }
+                                // promoted parameter - docblock is available via class/property
+                                if ($rp->isPromoted() && ($comment = $rp->getDeclaringClass()->getProperty($rp->getName())->getDocComment())) {
+                                    $instance->_context->comment = $comment;
                                 }
                             } else {
                                 if (!$instance->name || Generator::isDefault($instance->name)) {
@@ -118,28 +116,27 @@ public function build(\Reflector $reflector, Context $context): array
 
             $isParentAllowed = false;
             // support Attachable subclasses
-            if ($isAttachable = $annotation instanceof OA\Attachable) {
-                if (!$isParentAllowed = (null === $annotation->allowedParents())) {
-                    // check for allowed parents
-                    foreach ($annotation->allowedParents() as $allowedParent) {
-                        if ($possibleParent instanceof $allowedParent) {
-                            $isParentAllowed = true;
-                            break;
-                        }
+            if (($isAttachable = $annotation instanceof OA\Attachable) && !$isParentAllowed = (null === $annotation->allowedParents())) {
+                // check for allowed parents
+                foreach ($annotation->allowedParents() as $allowedParent) {
+                    if ($possibleParent instanceof $allowedParent) {
+                        $isParentAllowed = true;
+                        break;
                     }
                 }
             }
 
             // Property can be nested...
-            return $annotation->getRoot() != $possibleParent->getRoot()
+            return $annotation->getRoot() !== $possibleParent->getRoot()
                 && ($explicitParent || ($isAttachable && $isParentAllowed));
         };
 
         $annotationsWithoutParent = [];
         foreach ($annotations as $index => $annotation) {
             $mergedIntoParent = false;
+            $counter = count($annotations);
 
-            for ($ii = 0; $ii < count($annotations); ++$ii) {
+            for ($ii = 0; $ii < $counter; ++$ii) {
                 if ($ii === $index) {
                     continue;
                 }

diff --git a/src/Analysers/DocBlockAnnotationFactory.php b/src/Analysers/DocBlockAnnotationFactory.php
@@ -11,11 +11,10 @@
 
 class DocBlockAnnotationFactory implements AnnotationFactoryInterface
 {
-    /** @var DocBlockParser|null */
-    protected $docBlockParser = null;
+    protected DocBlockParser $docBlockParser;
 
     /** @var Generator|null */
-    protected $generator = null;
+    protected $generator;
 
     public function __construct(?DocBlockParser $docBlockParser = null)
     {

diff --git a/src/Analysers/ReflectionAnalyser.php b/src/Analysers/ReflectionAnalyser.php
@@ -22,7 +22,7 @@
 class ReflectionAnalyser implements AnalyserInterface
 {
     /** @var AnnotationFactoryInterface[] */
-    protected $annotationFactories;
+    protected $annotationFactories = [];
 
     /** @var Generator|null */
     protected $generator;
@@ -32,7 +32,6 @@ class ReflectionAnalyser implements AnalyserInterface
      */
     public function __construct(array $annotationFactories = [])
     {
-        $this->annotationFactories = [];
         foreach ($annotationFactories as $annotationFactory) {
             if ($annotationFactory->isSupported()) {
                 $this->annotationFactories[] = $annotationFactory;
@@ -118,7 +117,7 @@ protected function analyzeFqdn(string $fqdn, Analysis $analysis, array $details)
         if ($parentClass = $rc->getParentClass()) {
             $definition['extends'] = $normaliseClass($parentClass->getName());
         }
-        $definition[$contextType == 'class' ? 'implements' : 'extends'] = array_map($normaliseClass, $details['interfaces']);
+        $definition[$contextType === 'class' ? 'implements' : 'extends'] = array_map($normaliseClass, $details['interfaces']);
         $definition['traits'] = array_map($normaliseClass, $details['traits']);
 
         foreach ($this->annotationFactories as $annotationFactory) {

diff --git a/src/Analysers/TokenAnalyser.php b/src/Analysers/TokenAnalyser.php
@@ -30,14 +30,12 @@ public function setGenerator(Generator $generator): void
      */
     public function fromFile(string $filename, Context $context): Analysis
     {
-        if (function_exists('opcache_get_status') && function_exists('opcache_get_configuration')) {
-            if (empty($GLOBALS['openapi_opcache_warning'])) {
-                $GLOBALS['openapi_opcache_warning'] = true;
-                $status = opcache_get_status();
-                $config = opcache_get_configuration();
-                if (is_array($status) && $status['opcache_enabled'] && $config['directives']['opcache.save_comments'] == false) {
-                    $context->logger->error("php.ini \"opcache.save_comments = 0\" interferes with extracting annotations.\n[LINK] https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.save-comments");
-                }
+        if (function_exists('opcache_get_status') && function_exists('opcache_get_configuration') && empty($GLOBALS['openapi_opcache_warning'])) {
+            $GLOBALS['openapi_opcache_warning'] = true;
+            $status = opcache_get_status();
+            $config = opcache_get_configuration();
+            if (is_array($status) && $status['opcache_enabled'] && $config['directives']['opcache.save_comments'] == false) {
+                $context->logger->error("php.ini \"opcache.save_comments = 0\" interferes with extracting annotations.\n[LINK] https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.save-comments");
             }
         }
         $tokens = token_get_all(file_get_contents($filename));
@@ -166,7 +164,9 @@ protected function fromTokens(array $tokens, Context $parseContext): Analysis
 
                 if ($token[0] === T_IMPLEMENTS) {
                     $schemaContext->implements = $this->parseNamespaceList($tokens, $token, $parseContext);
-                    $classDefinition['implements'] = array_map([$schemaContext, 'fullyQualifiedName'], $schemaContext->implements);
+                    $classDefinition['implements'] = array_map(function (?string $source) use ($schemaContext): string {
+                        return $schemaContext->fullyQualifiedName($source);
+                    }, $schemaContext->implements);
                 }
 
                 if ($comment) {
@@ -207,7 +207,9 @@ protected function fromTokens(array $tokens, Context $parseContext): Analysis
 
                 if ($token[0] === T_EXTENDS) {
                     $schemaContext->extends = $this->parseNamespaceList($tokens, $token, $parseContext);
-                    $interfaceDefinition['extends'] = array_map([$schemaContext, 'fullyQualifiedName'], $schemaContext->extends);
+                    $interfaceDefinition['extends'] = array_map(function (?string $source) use ($schemaContext): string {
+                        return $schemaContext->fullyQualifiedName($source);
+                    }, $schemaContext->extends);
                 }
 
                 if ($comment) {
@@ -394,13 +396,11 @@ protected function fromTokens(array $tokens, Context $parseContext): Analysis
                 }
             }
 
-            if (in_array($token[0], [T_NAMESPACE, T_USE]) === false) {
-                // Skip "use" & "namespace" to prevent "never imported" warnings)
-                if ($comment) {
-                    // Not a doc-comment for a class, property or method?
-                    $this->analyseComment($analysis, $docBlockParser, $comment, new Context(['line' => $line], $schemaContext));
-                    $comment = false;
-                }
+            // Skip "use" & "namespace" to prevent "never imported" warnings)
+            if (in_array($token[0], [T_NAMESPACE, T_USE]) === false && $comment) {
+                // Not a doc-comment for a class, property or method?
+                $this->analyseComment($analysis, $docBlockParser, $comment, new Context(['line' => $line], $schemaContext));
+                $comment = false;
             }
 
             if ($token[0] === T_NAMESPACE) {
@@ -495,6 +495,8 @@ private function nextToken(array &$tokens, Context $context)
 
             return $token;
         }
+
+        return null;
     }
 
     private function parseAttribute(array &$tokens, &$token, Context $parseContext): void

diff --git a/src/Analysers/TokenScanner.php b/src/Analysers/TokenScanner.php
@@ -66,7 +66,7 @@ protected function scanTokens(array $tokens): array
                         break;
                     case '}':
                         array_pop($stack);
-                        if (count($stack) == $unitLevel) {
+                        if (count($stack) === $unitLevel) {
                             $currentName = null;
                         }
                         break;
@@ -76,7 +76,7 @@ protected function scanTokens(array $tokens): array
 
             switch ($token[0]) {
                 case T_ABSTRACT:
-                    if (count($stack)) {
+                    if ($stack !== []) {
                         $isAbstractFunction = true;
                     }
                     break;
@@ -115,7 +115,7 @@ protected function scanTokens(array $tokens): array
                     // unless ...
                     if (is_string($token) && ($token === '(' || $token === '{')) {
                         // new class[()] { ... }
-                        if ('{' == $token) {
+                        if ('{' === $token) {
                             prev($tokens);
                         }
                         break;
@@ -219,10 +219,8 @@ protected function nextToken(array &$tokens)
         $token = true;
         while ($token) {
             $token = next($tokens);
-            if (is_array($token)) {
-                if (in_array($token[0], [T_WHITESPACE, T_COMMENT])) {
-                    continue;
-                }
+            if (is_array($token) && in_array($token[0], [T_WHITESPACE, T_COMMENT])) {
+                continue;
             }
 
             return $token;
@@ -254,7 +252,7 @@ protected function resolveFQN(array $names, string $namespace, array $uses): arr
     protected function skipTo(array &$tokens, string $char, bool $prev = false): void
     {
         while (false !== ($token = next($tokens))) {
-            if (is_string($token) && $token == $char) {
+            if (is_string($token) && $token === $char) {
                 if ($prev) {
                     prev($tokens);
                 }

diff --git a/src/Analysis.php b/src/Analysis.php
@@ -55,12 +55,12 @@ class Analysis
      *
      * @var OA\OpenApi|null
      */
-    public $openapi = null;
+    public $openapi;
 
     /**
      * @var Context|null
      */
-    public $context = null;
+    public $context;
 
     public function __construct(array $annotations = [], ?Context $context = null)
     {
@@ -347,7 +347,7 @@ public function getAnnotationForSource(string $fqdn, string $class): ?OA\Abstrac
                 if (is_iterable($definition['context']->annotations)) {
                     /** @var OA\AbstractAnnotation $annotation */
                     foreach (array_reverse($definition['context']->annotations) as $annotation) {
-                        if (is_a($annotation, $class) && $annotation->isRoot($class) && !$annotation->_context->is('generated')) {
+                        if ($annotation instanceof $class && $annotation->isRoot($class) && !$annotation->_context->is('generated')) {
                             return $annotation;
                         }
                     }