Make static anlisys pass

Author: jaapio

Makefile

@@ -0,0 +1,32 @@
+.PHONY: install-phive
+install-phive:
+	mkdir tools; \
+	wget -O tools/phive.phar https://phar.io/releases/phive.phar; \
+	wget -O tools/phive.phar.asc https://phar.io/releases/phive.phar.asc; \
+	gpg --keyserver pool.sks-keyservers.net --recv-keys 0x9D8A98B29B2D5D79; \
+	gpg --verify tools/phive.phar.asc tools/phive.phar; \
+	chmod +x tools/phive.phar
+
+.PHONY: setup
+setup: install-phive
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phar-ga:latest php tools/phive.phar install --force-accept-unsigned
+
+.PHONY: phpcs
+phpcs:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest -d memory_limit=1024M
+
+.PHONY: phpstan
+phpstan:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpstan-ga:latest analyse src --debug --no-progress --level max --configuration phpstan.neon
+
+.PHONY: psaml
+psalm:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project mickaelandrieu/psalm-ga
+
+.PHONY: test
+test:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.2 tools/phpunit
+
+.PHONY: pre-commit-test
+pre-commit-test: test phpcs phpstan psalm
+

composer.lock

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phive xmlns="https://phar.io/phive">
+  <phar name="phpunit" version="^8.4.3" installed="8.4.3" location="./tools/phpunit" copy="true"/>
+  <phar name="phpstan" version="^0.9.1" installed="0.10.2" location="./tools/phpstan" copy="true"/>
+</phive>

phive.xml

@@ -6,5 +6,3 @@ parameters:
     ignoreErrors:
         # false positive
         - '#Method phpDocumentor\Reflection\DocBlock\Tags\Method::filterArguments() should return array<array> but returns array<array|string>#'
-        - "~Parameter #1 $function of function call_user_func_array expects callable(): mixed, array(string, 'create') given.~"
-        - '#Cannot call method render\(\) on phpDocumentor\\Reflection\\DocBlock\\Description\|string#'

phpstan.neon

@@ -1,8 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.0/phpunit.xsd"
         colors="true"
-        checkForUnintentionallyCoveredCode="true"
         beStrictAboutOutputDuringTests="true"
         forceCoversAnnotation="true"
         verbose="true"
@@ -20,17 +21,10 @@
     <whitelist>
         <directory suffix=".php">./src/</directory>
     </whitelist>
-    <blacklist>
-      <directory>./vendor/</directory>
-    </blacklist>
   </filter>
   <logging>
     <log type="coverage-html"
-         title="phpDocumentor Reflection DocBlock"
          target="build/coverage"
-         charset="UTF-8"
-         yui="true"
-         highlight="false"
          lowUpperBound="35"
          highLowerBound="70"/>
   </logging>

phpunit.xml.dist

@@ -177,8 +177,8 @@ public function addService(object $service, ?string $alias = null) : void
     public function registerTagHandler(string $tagName, string $handler) : void
     {
         Assert::stringNotEmpty($tagName);
-        Assert::stringNotEmpty($handler);
         Assert::classExists($handler);
+        /** @var object $handler stupid hack to make phpstan happy.  */
         Assert::implementsInterface($handler, StaticMethod::class);
 
         if (strpos($tagName, '\\') && $tagName[0] !== '\\') {
@@ -224,7 +224,9 @@ private function createTag(string $body, string $name, TypeContext $context) : ?
         );
 
         try {
-            return call_user_func_array([$handlerClassName, 'create'], $arguments);
+            /** @var callable $callable */
+            $callable = [$handlerClassName, 'create'];
+            return call_user_func_array($callable, $arguments);
         } catch (InvalidArgumentException $e) {
             return null;
         }

src/DocBlock/StandardTagFactory.php

@@ -24,7 +24,7 @@ abstract class BaseTag implements DocBlock\Tag
     /** @var string Name of the tag */
     protected $name = '';
 
-    /** @var Description|string|null Description of the tag. */
+    /** @var Description|null Description of the tag. */
     protected $description;
 
     /**
@@ -37,10 +37,7 @@ public function getName() : string
         return $this->name;
     }
 
-    /**
-     * @return Description|string|null
-     */
-    public function getDescription()
+    public function getDescription() : ?Description
     {
         return $this->description;
     }

src/DocBlock/Tags/BaseTag.php

@@ -94,6 +94,6 @@ public function getVersion() : ?string
      */
     public function __toString() : string
     {
-        return $this->version . ($this->description ? ' ' . $this->description->render() : '');
+        return ($this->version ?? '') . ($this->description ? ' ' . $this->description->render() : '');
     }
 }

src/DocBlock/Tags/Deprecated.php

@@ -13,7 +13,6 @@
 
 namespace phpDocumentor\Reflection\DocBlock\Tags;
 
-use phpDocumentor\Reflection\DocBlock\Description;
 use phpDocumentor\Reflection\DocBlock\Tag;
 use Webmozart\Assert\Assert;
 use function array_key_exists;
@@ -26,7 +25,7 @@
 /**
  * Reflection class for a {@}example tag in a Docblock.
  */
-final class Example extends BaseTag
+final class Example implements Tag
 {
     /** @var string Path to a file to use as an example. May also be an absolute URI. */
     private $filePath;
@@ -43,10 +42,10 @@ final class Example extends BaseTag
     /** @var int */
     private $lineCount;
 
-    /**
-     * @param string|Description|null $description
-     */
-    public function __construct(string $filePath, bool $isURI, int $startingLine, int $lineCount, $description)
+    /** @var string|null */
+    private $content;
+
+    public function __construct(string $filePath, bool $isURI, int $startingLine, int $lineCount, ?string $content)
     {
         Assert::notEmpty($filePath);
         Assert::greaterThanEq($startingLine, 0);
@@ -55,31 +54,32 @@ public function __construct(string $filePath, bool $isURI, int $startingLine, in
         $this->filePath     = $filePath;
         $this->startingLine = $startingLine;
         $this->lineCount    = $lineCount;
-        $this->name         = 'example';
-        if ($description !== null) {
-            $this->description = trim((string) $description);
+        if ($content !== null) {
+            $this->content = trim((string) $content);
         }
 
         $this->isURI = $isURI;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getContent()
+    public function getContent() : string
     {
-        if ($this->description === null) {
+        if ($this->content === null) {
             $filePath = '"' . $this->filePath . '"';
             if ($this->isURI) {
                 $filePath = $this->isUriRelative($this->filePath)
                     ? str_replace('%2F', '/', rawurlencode($this->filePath))
                     : $this->filePath;
             }
 
-            return trim($filePath . ' ' . parent::getDescription());
+            return trim($filePath);
         }
 
-        return $this->description;
+        return $this->content;
+    }
+
+    public function getDescription() : ?string
+    {
+        return $this->content;
     }
 
     /**
@@ -121,7 +121,7 @@ public static function create(string $body) : ?Tag
         }
 
         return new static(
-            $filePath ?? $fileUri,
+            $filePath ?? ($fileUri ?? ''),
             $fileUri !== null,
             $startingLine,
             $lineCount,
@@ -145,7 +145,7 @@ public function getFilePath() : string
      */
     public function __toString() : string
     {
-        return $this->filePath . ($this->description ? ' ' . $this->description : '');
+        return $this->filePath . ($this->content ? ' ' . $this->content : '');
     }
 
     /**
@@ -165,4 +165,18 @@ public function getLineCount() : int
     {
         return $this->lineCount;
     }
+
+    public function getName() : string
+    {
+        return 'example';
+    }
+
+    public function render(?Formatter $formatter = null) : string
+    {
+        if ($formatter === null) {
+            $formatter = new Formatter\PassthroughFormatter();
+        }
+
+        return $formatter->format($this);
+    }
 }

src/DocBlock/Tags/Example.php

@@ -24,7 +24,7 @@
 /**
  * Parses a tag definition for a DocBlock.
  */
-class Generic extends BaseTag implements Factory\StaticMethod
+final class Generic extends BaseTag implements Factory\StaticMethod
 {
     /**
      * Parses a tag and populates the member variables.