composer update

vendor/phpdocumentor/reflection-docblock/src/DocBlock/DescriptionFactory.php

@@ -1,18 +1,32 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * This file is part of phpDocumentor.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @copyright 2010-2015 Mike van Riel<mike@phpdoc.org>
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
 namespace phpDocumentor\Reflection\DocBlock;
 
 use phpDocumentor\Reflection\Types\Context as TypeContext;
+use Webmozart\Assert\Assert;
+use function count;
+use function explode;
+use function implode;
+use function ltrim;
+use function min;
+use function preg_split;
+use function str_replace;
+use function strlen;
+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.
@@ -38,8 +52,6 @@ class DescriptionFactory
 
     /**
      * Initializes this factory with the means to construct (inline) tags.
-     *
-     * @param TagFactory $tagFactory
      */
     public function __construct(TagFactory $tagFactory)
     {
@@ -48,27 +60,36 @@ class DescriptionFactory
 
     /**
      * Returns the parsed text of this description.
-     *
-     * @param string $contents
-     * @param TypeContext $context
-     *
-     * @return Description
      */
-    public function create($contents, TypeContext $context = null)
+    public function create(string $contents, ?TypeContext $context = null) : Description
     {
-        list($text, $tags) = $this->parse($this->lex($contents), $context);
+        $tokens   = $this->lex($contents);
+        $count    = count($tokens);
+        $tagCount = 0;
+        $tags     = [];
 
-        return new Description($text, $tags);
+        for ($i = 1; $i < $count; $i += 2) {
+            $tags[]     = $this->tagFactory->create($tokens[$i], $context);
+            $tokens[$i] = '%' . ++$tagCount . '$s';
+        }
+
+        //In order to allow "literal" inline tags, the otherwise invalid
+        //sequence "{@}" is changed to "@", and "{}" is changed to "}".
+        //"%" is escaped to "%%" because of vsprintf.
+        //See unit tests for examples.
+        for ($i = 0; $i < $count; $i += 2) {
+            $tokens[$i] = str_replace(['{@}', '{}', '%'], ['@', '}', '%%'], $tokens[$i]);
+        }
+
+        return new Description(implode('', $tokens), $tags);
     }
 
     /**
      * Strips the contents from superfluous whitespace and splits the description into a series of tokens.
      *
-     * @param string $contents
-     *
      * @return string[] A series of tokens of which the description text is composed.
      */
-    private function lex($contents)
+    private function lex(string $contents) : array
     {
         $contents = $this->removeSuperfluousStartingWhitespace($contents);
 
@@ -77,7 +98,7 @@ class DescriptionFactory
             return [$contents];
         }
 
-        return preg_split(
+        $parts =  preg_split(
             '/\{
                 # "{@}" is not a valid inline tag. This ensures that we do not treat it as one, but treat it literally.
                 (?!@\})
@@ -103,39 +124,12 @@ class DescriptionFactory
                 )
             \}/Sux',
             $contents,
-            null,
+            0,
             PREG_SPLIT_DELIM_CAPTURE
         );
-    }
+        Assert::isArray($parts);
 
-    /**
-     * Parses the stream of tokens in to a new set of tokens containing Tags.
-     *
-     * @param string[] $tokens
-     * @param TypeContext $context
-     *
-     * @return string[]|Tag[]
-     */
-    private function parse($tokens, TypeContext $context)
-    {
-        $count = count($tokens);
-        $tagCount = 0;
-        $tags  = [];
-
-        for ($i = 1; $i < $count; $i += 2) {
-            $tags[] = $this->tagFactory->create($tokens[$i], $context);
-            $tokens[$i] = '%' . ++$tagCount . '$s';
-        }
-
-        //In order to allow "literal" inline tags, the otherwise invalid
-        //sequence "{@}" is changed to "@", and "{}" is changed to "}".
-        //"%" is escaped to "%%" because of vsprintf.
-        //See unit tests for examples.
-        for ($i = 0; $i < $count; $i += 2) {
-            $tokens[$i] = str_replace(['{@}', '{}', '%'], ['@', '}', '%%'], $tokens[$i]);
-        }
-
-        return [implode('', $tokens), $tags];
+        return $parts;
     }
 
     /**
@@ -151,12 +145,8 @@ class DescriptionFactory
      *
      * If we do not normalize the indentation then we have superfluous whitespace on the second and subsequent
      * lines and this may cause rendering issues when, for example, using a Markdown converter.
-     *
-     * @param string $contents
-     *
-     * @return string
      */
-    private function removeSuperfluousStartingWhitespace($contents)
+    private function removeSuperfluousStartingWhitespace(string $contents) : string
     {
         $lines = explode("\n", $contents);
 
@@ -168,9 +158,9 @@ class DescriptionFactory
 
         // 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) {
+            if (trim($lines[$i]) === '') {
                 continue;
             }
 
@@ -181,7 +171,7 @@ class DescriptionFactory
 
         // 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);
             }
         }