Merge pull request #207 from orklah/static-analysis

More static analysis fixes

Author: jaapio

phpcs.xml.dist

@@ -8,6 +8,7 @@
     <arg value="p"/>
 
     <rule ref="phpDocumentor">
+        <exclude name="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly.ReferencedGeneralException" />
     </rule>
 
     <rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix">

psalm.xml

@@ -13,13 +13,18 @@
     </projectFiles>
 
     <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>
+
+        <PossiblyNullArrayOffset>
+            <errorLevel type="info">
+                <!-- Psalm forbid accessing an array with a null offset but it's still working code without notice -->
+                <file name="src/DocBlock/StandardTagFactory.php"/>
+            </errorLevel>
+        </PossiblyNullArrayOffset>
     </issueHandlers>
 </psalm>

src/DocBlock.php

@@ -19,7 +19,7 @@
 final class DocBlock
 {
     /** @var string The opening line for this docblock. */
-    private $summary = '';
+    private $summary;
 
     /** @var DocBlock\Description The actual description for this docblock. */
     private $description;
@@ -34,10 +34,10 @@ final class DocBlock
     private $location;
 
     /** @var bool Is this DocBlock (the start of) a template? */
-    private $isTemplateStart = false;
+    private $isTemplateStart;
 
     /** @var bool Does this DocBlock signify the end of a DocBlock template? */
-    private $isTemplateEnd = false;
+    private $isTemplateEnd;
 
     /**
      * @param DocBlock\Tag[] $tags

src/DocBlock/DescriptionFactory.php

@@ -158,7 +158,7 @@ private function removeSuperfluousStartingWhitespace(string $contents) : string
 
         // determine how many whitespace characters need to be stripped
         $startingSpaceCount = 9999999;
-        for ($i = 1; $i < count($lines); ++$i) {
+        for ($i = 1, $iMax = count($lines); $i < $iMax; ++$i) {
             // lines with a no length do not count as they are not indented at all
             if (strlen(trim($lines[$i])) === 0) {
                 continue;
@@ -171,7 +171,7 @@ private function removeSuperfluousStartingWhitespace(string $contents) : string
 
         // strip the number of spaces from each line
         if ($startingSpaceCount > 0) {
-            for ($i = 1; $i < count($lines); ++$i) {
+            for ($i = 1, $iMax = count($lines); $i < $iMax; ++$i) {
                 $lines[$i] = substr($lines[$i], $startingSpaceCount);
             }
         }

src/DocBlock/Serializer.php

@@ -98,10 +98,7 @@ public function getDocComment(DocBlock $docblock) : string
         return $comment . $indent . ' */';
     }
 
-    /**
-     * @return mixed
-     */
-    private function removeTrailingSpaces(string $indent, string $text)
+    private function removeTrailingSpaces(string $indent, string $text) : string
     {
         return str_replace(
             sprintf("\n%s * \n", $indent),
@@ -110,10 +107,7 @@ private function removeTrailingSpaces(string $indent, string $text)
         );
     }
 
-    /**
-     * @return mixed
-     */
-    private function addAsterisksForEachLine(string $indent, string $text)
+    private function addAsterisksForEachLine(string $indent, string $text) : string
     {
         return str_replace(
             "\n",

src/DocBlock/StandardTagFactory.php

@@ -212,6 +212,7 @@ private function createTag(string $body, string $name, TypeContext $context) : T
         try {
             $callable = [$handlerClassName, 'create'];
             Assert::isCallable($callable);
+            /** @phpstan-var callable(string): ?Tag $callable */
             $tag = call_user_func_array($callable, $arguments);
 
             return $tag ?? InvalidTag::create($body, $name);
@@ -222,6 +223,8 @@ private function createTag(string $body, string $name, TypeContext $context) : T
 
     /**
      * Determines the Fully Qualified Class Name of the Factory or Tag (containing a Factory Method `create`).
+     *
+     * @return class-string<StaticMethod>
      */
     private function findHandlerClassName(string $tagName, TypeContext $context) : string
     {

src/DocBlock/Tag.php

@@ -21,6 +21,8 @@ public function getName() : string;
 
     /**
      * @return Tag|mixed Class that implements Tag
+     *
+     * @phpstan-return ?Tag
      */
     public static function create(string $body);
 

src/DocBlock/Tags/Author.php

@@ -29,10 +29,10 @@ final class Author extends BaseTag implements Factory\StaticMethod
     protected $name = 'author';
 
     /** @var string The name of the author */
-    private $authorName = '';
+    private $authorName;
 
     /** @var string The email of the author */
-    private $authorEmail = '';
+    private $authorEmail;
 
     /**
      * Initializes this tag with the author name and e-mail.

src/DocBlock/Tags/Deprecated.php

@@ -44,7 +44,7 @@ final class Deprecated extends BaseTag implements Factory\StaticMethod
     )';
 
     /** @var string|null The version vector. */
-    private $version = '';
+    private $version;
 
     public function __construct(?string $version = null, ?Description $description = null)
     {

src/DocBlock/Tags/Example.php

@@ -34,7 +34,7 @@ final class Example implements Tag, Factory\StaticMethod
      * @var bool Whether the file path component represents an URI. This determines how the file portion
      *     appears at {@link getContent()}.
      */
-    private $isURI = false;
+    private $isURI;
 
     /** @var int */
     private $startingLine;
@@ -55,7 +55,7 @@ public function __construct(string $filePath, bool $isURI, int $startingLine, in
         $this->startingLine = $startingLine;
         $this->lineCount    = $lineCount;
         if ($content !== null) {
-            $this->content = trim((string) $content);
+            $this->content = trim($content);
         }
 
         $this->isURI = $isURI;