Merge pull request #201 from orklah/master

bump phpstan to master

Author: jaapio

.github/workflows/push.yml

@@ -127,7 +127,7 @@ jobs:
             all-build-${{ hashFiles('**/composer.lock') }}
             all-build-
       - name: Code style check
-        uses: phpDocumentor/coding-standard@v1.0.0
+        uses: phpDocumentor/coding-standard@master
         with:
           args: -s
 
@@ -149,7 +149,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          args: analyse src --level max --configuration phpstan.neon
+          args: analyse src --configuration phpstan.neon
 
   psalm:
     runs-on: ubuntu-latest

Makefile

@@ -21,7 +21,7 @@ phpcbf:
 
 .PHONY: phpstan
 phpstan:
-	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpstan-ga:latest analyse src --no-progress --level max --configuration phpstan.neon
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpstan-ga:latest analyse src --no-progress --configuration phpstan.neon
 
 .PHONY: psaml
 psalm:

phpstan.neon

@@ -3,6 +3,6 @@ includes:
     - /composer/vendor/phpstan/phpstan-webmozart-assert/extension.neon
 
 parameters:
+    level: max
     ignoreErrors:
-        # false positive
-        - '#Method phpDocumentor\Reflection\DocBlock\Tags\Method::filterArguments() should return array<array> but returns array<array|string>#'
+        - '#Call to static method Webmozart\\Assert\\Assert::implementsInterface\(\) with class-string#'

psalm.xml

@@ -14,5 +14,12 @@
 
     <issueHandlers>
         <LessSpecificReturnType errorLevel="info" />
+        
+        <RedundantConditionGivenDocblockType>
+            <errorLevel type="info">
+                <!-- Psalm is very strict and believe that because we documented a type, it is redundant to assert it -->
+                <file name="src/DocBlock/StandardTagFactory.php"/>
+            </errorLevel>
+        </RedundantConditionGivenDocblockType>
     </issueHandlers>
 </psalm>

src/DocBlock.php

@@ -150,7 +150,6 @@ public function getTagsByName(string $name) : array
     {
         $result = [];
 
-        /** @var Tag $tag */
         foreach ($this->getTags() as $tag) {
             if ($tag->getName() !== $name) {
                 continue;
@@ -169,7 +168,6 @@ public function getTagsByName(string $name) : array
      */
     public function hasTag(string $name) : bool
     {
-        /** @var Tag $tag */
         foreach ($this->getTags() as $tag) {
             if ($tag->getName() === $name) {
                 return true;

src/DocBlock/DescriptionFactory.php

@@ -15,7 +15,6 @@
 
 use phpDocumentor\Reflection\Types\Context as TypeContext;
 use Webmozart\Assert\Assert;
-use const PREG_SPLIT_DELIM_CAPTURE;
 use function count;
 use function explode;
 use function implode;
@@ -27,6 +26,7 @@
 use function strpos;
 use function substr;
 use function trim;
+use const PREG_SPLIT_DELIM_CAPTURE;
 
 /**
  * Creates a new Description object given a body of text.
@@ -128,6 +128,7 @@ private function lex(string $contents) : array
             PREG_SPLIT_DELIM_CAPTURE
         );
         Assert::isArray($parts);
+
         return $parts;
     }
 

src/DocBlock/ExampleFinder.php

@@ -14,7 +14,6 @@
 namespace phpDocumentor\Reflection\DocBlock;
 
 use phpDocumentor\Reflection\DocBlock\Tags\Example;
-use const DIRECTORY_SEPARATOR;
 use function array_slice;
 use function file;
 use function getcwd;
@@ -23,6 +22,7 @@
 use function rtrim;
 use function sprintf;
 use function trim;
+use const DIRECTORY_SEPARATOR;
 
 /**
  * Class used to find an example file's location based on a given ExampleDescriptor.
@@ -122,6 +122,7 @@ private function getExampleFileContents(string $filename) : ?array
         }
 
         $lines = $normalizedPath && is_readable($normalizedPath) ? file($normalizedPath) : false;
+
         return $lines !== false ? $lines : null;
     }
 

src/DocBlock/Serializer.php

@@ -94,6 +94,7 @@ public function getDocComment(DocBlock $docblock) : string
         }
 
         $comment = $this->addTagBlock($docblock, $wrapLength, $indent, $comment);
+
         return $comment . $indent . ' */';
     }
 
@@ -127,6 +128,7 @@ private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, ?int $wra
                 : '');
         if ($wrapLength !== null) {
             $text = wordwrap($text, $wrapLength);
+
             return $text;
         }
 

src/DocBlock/StandardTagFactory.php

@@ -71,8 +71,8 @@ final class StandardTagFactory implements TagFactory
     public const REGEX_TAGNAME = '[\w\-\_\\\\:]+';
 
     /**
-     * @var string[] An array with a tag as a key, and an
-     *      FQCN to a class that handles it as an array value.
+     * @var array<class-string<StaticMethod>> An array with a tag as a key, and an
+     *                                        FQCN to a class that handles it as an array value.
      */
     private $tagHandlerMappings = [
         'author' => Author::class,
@@ -97,7 +97,7 @@ final class StandardTagFactory implements TagFactory
     ];
 
     /**
-     * @var string[] An array with a anotation s a key, and an
+     * @var array<class-string<StaticMethod>> An array with a anotation s a key, and an
      *      FQCN to a class that handles it as an array value.
      */
     private $annotationMappings = [];
@@ -125,7 +125,7 @@ final class StandardTagFactory implements TagFactory
      *
      * @see self::registerTagHandler() to add a new tag handler to the existing default list.
      *
-     * @param string[] $tagHandlers
+     * @param array<class-string<StaticMethod>> $tagHandlers
      */
     public function __construct(FqsenResolver $fqsenResolver, ?array $tagHandlers = null)
     {
@@ -137,9 +137,6 @@ public function __construct(FqsenResolver $fqsenResolver, ?array $tagHandlers =
         $this->addService($fqsenResolver, FqsenResolver::class);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function create(string $tagLine, ?TypeContext $context = null) : Tag
     {
         if (!$context) {
@@ -152,29 +149,22 @@ public function create(string $tagLine, ?TypeContext $context = null) : Tag
     }
 
     /**
-     * {@inheritDoc}
+     * @param mixed $value
      */
     public function addParameter(string $name, $value) : void
     {
         $this->serviceLocator[$name] = $value;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function addService(object $service, ?string $alias = null) : void
     {
         $this->serviceLocator[$alias ?: get_class($service)] = $service;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function registerTagHandler(string $tagName, string $handler) : void
     {
         Assert::stringNotEmpty($tagName);
         Assert::classExists($handler);
-        /** @var object $handler stupid hack to make phpstan happy.  */
         Assert::implementsInterface($handler, StaticMethod::class);
 
         if (strpos($tagName, '\\') && $tagName[0] !== '\\') {
@@ -220,9 +210,10 @@ private function createTag(string $body, string $name, TypeContext $context) : T
         );
 
         try {
-            /** @var callable $callable */
             $callable = [$handlerClassName, 'create'];
-            $tag      = call_user_func_array($callable, $arguments);
+            Assert::isCallable($callable);
+            $tag = call_user_func_array($callable, $arguments);
+
             return $tag ?? InvalidTag::create($body, $name);
         } catch (InvalidArgumentException $e) {
             return InvalidTag::create($body, $name)->withError($e);

src/DocBlock/TagFactory.php

@@ -14,6 +14,7 @@
 namespace phpDocumentor\Reflection\DocBlock;
 
 use InvalidArgumentException;
+use phpDocumentor\Reflection\DocBlock\Tags\Factory\StaticMethod;
 use phpDocumentor\Reflection\Types\Context as TypeContext;
 
 interface TagFactory
@@ -69,9 +70,9 @@ public function addService(object $service) : void;
      * to register the name of a tag with the FQCN of a 'Tag Handler'. The Tag handler should implement
      * the {@see Tag} interface (and thus the create method).
      *
-     * @param string $tagName Name of tag to register a handler for. When registering a namespaced tag,
-     *                        the full name, along with a prefixing slash MUST be provided.
-     * @param string $handler FQCN of handler.
+     * @param string                     $tagName Name of tag to register a handler for. When registering a namespaced
+     *                                   tag, the full name, along with a prefixing slash MUST be provided.
+     * @param class-string<StaticMethod> $handler FQCN of handler.
      *
      * @throws InvalidArgumentException If the tag name is not a string.
      * @throws InvalidArgumentException If the tag name is namespaced (contains backslashes) but