More phpstan checks for better code

Author: jaapio

composer.json

@@ -29,7 +29,8 @@
         "phpstan/phpstan-mockery": "^1.1",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan-webmozart-assert": "^1.2",
-        "psalm/phar": "^5.26"
+        "psalm/phar": "^5.26",
+        "shipmonk/dead-code-detector": "^0.5.1"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -3,5 +3,12 @@ parameters:
     ignoreErrors:
         - '#Method phpDocumentor\\Reflection\\DocBlock\\StandardTagFactory::createTag\(\) should return phpDocumentor\\Reflection\\DocBlock\\Tag but returns mixed#'
         - '#Offset 2 on array\{string, 28, int\} on left side of \?\? always exists and is not nullable\.#'
+        -
+          path: src/DocBlockFactoryInterface.php
+          identifier: shipmonk.deadMethod
+        -
+          path: src/DocBlock/TagFactory.php
+          identifier: shipmonk.deadMethod
     paths:
         - src
+        - tests/unit

phpstan.neon

@@ -22,6 +22,7 @@
 use phpDocumentor\Reflection\DocBlock\Tags\Factory\Factory;
 use phpDocumentor\Reflection\DocBlock\Tags\Factory\ImplementsFactory;
 use phpDocumentor\Reflection\DocBlock\Tags\Factory\MethodFactory;
+use phpDocumentor\Reflection\DocBlock\Tags\Factory\MixinFactory;
 use phpDocumentor\Reflection\DocBlock\Tags\Factory\ParamFactory;
 use phpDocumentor\Reflection\DocBlock\Tags\Factory\PropertyFactory;
 use phpDocumentor\Reflection\DocBlock\Tags\Factory\PropertyReadFactory;
@@ -151,6 +152,7 @@ public static function createInstance(FqsenResolver $fqsenResolver): self
             new PropertyReadFactory($typeResolver, $descriptionFactory),
             new PropertyWriteFactory($typeResolver, $descriptionFactory),
             new MethodFactory($typeResolver, $descriptionFactory),
+            new MixinFactory($typeResolver, $descriptionFactory),
             new ImplementsFactory($typeResolver, $descriptionFactory),
             new ExtendsFactory($typeResolver, $descriptionFactory),
             new TemplateFactory($typeResolver, $descriptionFactory),

src/DocBlock/StandardTagFactory.php

@@ -34,7 +34,7 @@ public function format($defaultValue): string
     {
         $method = 'format' . ucfirst(gettype($defaultValue));
         if (method_exists($this, $method)) {
-            return ' = ' . $this->{$method}($defaultValue);
+            return $this->{$method}($defaultValue);
         }
 
         return '';

src/DocBlock/Tags/Factory/MethodParameterFactory.php

@@ -84,7 +84,7 @@ public function __toString(): string
             '$' . $this->getName() .
             (
                 $this->defaultValue !== self::NO_DEFAULT_VALUE ?
-                (new MethodParameterFactory())->format($this->defaultValue) :
+                    ' = ' . (new MethodParameterFactory())->format($this->defaultValue) :
                 ''
             );
     }

src/DocBlock/Tags/MethodParameter.php

@@ -13,17 +13,10 @@
 
 namespace phpDocumentor\Reflection\DocBlock\Tags;
 
-use InvalidArgumentException;
 use phpDocumentor\Reflection\DocBlock\Tag;
 use phpDocumentor\Reflection\Exception\CannotCreateTag;
 use phpDocumentor\Reflection\Type;
 
-use function in_array;
-use function sprintf;
-use function strlen;
-use function substr;
-use function trim;
-
 abstract class TagWithType extends BaseTag
 {
     /** @var ?Type */
@@ -42,43 +35,6 @@ final public static function create(string $body): Tag
         throw new CannotCreateTag('Typed tag cannot be created');
     }
 
-    /**
-     * @return string[]
-     */
-    protected static function extractTypeFromBody(string $body): array
-    {
-        $type         = '';
-        $nestingLevel = 0;
-        for ($i = 0, $iMax = strlen($body); $i < $iMax; $i++) {
-            $character = $body[$i];
-
-            if ($nestingLevel === 0 && trim($character) === '') {
-                break;
-            }
-
-            $type .= $character;
-            if (in_array($character, ['<', '(', '[', '{'])) {
-                $nestingLevel++;
-                continue;
-            }
-
-            if (in_array($character, ['>', ')', ']', '}'])) {
-                $nestingLevel--;
-                continue;
-            }
-        }
-
-        if ($nestingLevel < 0 || $nestingLevel > 0) {
-            throw new InvalidArgumentException(
-                sprintf('Could not find type in %s, please check for malformed notations', $body)
-            );
-        }
-
-        $description = trim(substr($body, strlen($type)));
-
-        return [$type, $description];
-    }
-
     public function __toString(): string
     {
         if ($this->description) {

src/DocBlock/Tags/TagWithType.php

@@ -13,9 +13,9 @@
 
 namespace phpDocumentor\Reflection\DocBlock\Tags;
 
-use Doctrine\Deprecations\Deprecation;
 use phpDocumentor\Reflection\DocBlock\Description;
 use phpDocumentor\Reflection\DocBlock\Tag;
+use phpDocumentor\Reflection\Exception\CannotCreateTag;
 use phpDocumentor\Reflection\Type;
 
 /**
@@ -51,14 +51,7 @@ public function __construct(
      */
     public static function create(string $body): ?Tag
     {
-        Deprecation::trigger(
-            'phpdocumentor/reflection-docblock',
-            'https://github.com/phpDocumentor/ReflectionDocBlock/issues/361',
-            'Create using static factory is deprecated, this method should not be called directly
-             by library consumers',
-        );
-
-        return null;
+        throw new CannotCreateTag('Template tag cannot be created');
     }
 
     public function getTemplateName(): string

src/DocBlock/Tags/Template.php

@@ -10,15 +10,18 @@
 
 final class CustomParam implements Tag
 {
+    /** @var string|null */
     public $myParam;
+
+    /** @var FqsenResolver|null */
     public $fqsenResolver;
 
     public function getName() : string
     {
         return 'spy';
     }
 
-    public static function create($body, FqsenResolver $fqsenResolver = null, ?string $myParam = null)
+    public static function create(string $body, FqsenResolver $fqsenResolver = null, ?string $myParam = null)
     {
         $tag = new self();
         $tag->fqsenResolver = $fqsenResolver;

tests/unit/Assets/CustomParam.php

@@ -7,19 +7,18 @@
 use phpDocumentor\Reflection\DocBlock\Tag;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter;
-use phpDocumentor\Reflection\FqsenResolver;
-use phpDocumentor\Reflection\DocBlock\Tags\Factory\StaticMethod;
 
 final class CustomServiceClass implements Tag
 {
+    /** @var Formatter|null */
     public $formatter;
 
     public function getName() : string
     {
         return 'spy';
     }
 
-    public static function create($body, PassthroughFormatter $formatter = null)
+    public static function create(string $body, PassthroughFormatter $formatter = null)
     {
         $tag = new self();
         $tag->formatter = $formatter;