Merge pull request #291 from jrfnl/feature/cs-update

CS update after upstream changes

Author: jaapio

phpcs.xml.dist

@@ -1,22 +1,29 @@
 <?xml version="1.0"?>
-<ruleset name="phpDocumentor">
- <description>The coding standard for phpDocumentor.</description>
+<ruleset name="ReflectionDocBlock">
+ <description>The coding standard for this library.</description>
 
     <file>src</file>
     <file>tests/unit</file>
-    <exclude-pattern>*/tests/unit/Types/ContextFactoryTest.php</exclude-pattern>
+    <exclude-pattern>*/tests/unit/Types/ContextFactoryTest\.php</exclude-pattern>
     <exclude-pattern>*/tests/unit/Assets/*</exclude-pattern>
     <arg value="p"/>
 
+    <!-- Set the minimum PHP version for PHPCompatibility.
+         This should be kept in sync with the requirements in the composer.json file. -->
+    <config name="testVersion" value="7.2-"/>
+
     <rule ref="phpDocumentor">
         <exclude name="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly.ReferencedGeneralException" />
+
+        <!-- Property type declarations are a PHP 7.4 feature. -->
+        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint"/>
     </rule>
 
     <rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix">
-        <exclude-pattern>*/src/*/Abstract*.php</exclude-pattern>
+        <exclude-pattern>*/src/*/Abstract*\.php</exclude-pattern>
     </rule>
 
     <rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements.UnusedMethod">
-        <exclude-pattern>*/src/DocBlock/Tags/InvalidTag.php</exclude-pattern>
+        <exclude-pattern>*/src/DocBlock/Tags/InvalidTag\.php</exclude-pattern>
     </rule>
 </ruleset>

src/DocBlock.php

@@ -69,28 +69,28 @@ public function __construct(
         $this->isTemplateStart = $isTemplateStart;
     }
 
-    public function getSummary() : string
+    public function getSummary(): string
     {
         return $this->summary;
     }
 
-    public function getDescription() : DocBlock\Description
+    public function getDescription(): DocBlock\Description
     {
         return $this->description;
     }
 
     /**
      * Returns the current context.
      */
-    public function getContext() : ?Types\Context
+    public function getContext(): ?Types\Context
     {
         return $this->context;
     }
 
     /**
      * Returns the current location.
      */
-    public function getLocation() : ?Location
+    public function getLocation(): ?Location
     {
         return $this->location;
     }
@@ -114,7 +114,7 @@ public function getLocation() : ?Location
      *
      * @see self::isTemplateEnd() for the check whether a closing marker was provided.
      */
-    public function isTemplateStart() : bool
+    public function isTemplateStart(): bool
     {
         return $this->isTemplateStart;
     }
@@ -124,7 +124,7 @@ public function isTemplateStart() : bool
      *
      * @see self::isTemplateStart() for a more complete description of the Docblock Template functionality.
      */
-    public function isTemplateEnd() : bool
+    public function isTemplateEnd(): bool
     {
         return $this->isTemplateEnd;
     }
@@ -134,7 +134,7 @@ public function isTemplateEnd() : bool
      *
      * @return Tag[]
      */
-    public function getTags() : array
+    public function getTags(): array
     {
         return $this->tags;
     }
@@ -147,7 +147,7 @@ public function getTags() : array
      *
      * @return Tag[]
      */
-    public function getTagsByName(string $name) : array
+    public function getTagsByName(string $name): array
     {
         $result = [];
 
@@ -170,7 +170,7 @@ public function getTagsByName(string $name) : array
      *
      * @return TagWithType[]
      */
-    public function getTagsWithTypeByName(string $name) : array
+    public function getTagsWithTypeByName(string $name): array
     {
         $result = [];
 
@@ -190,7 +190,7 @@ public function getTagsWithTypeByName(string $name) : array
      *
      * @param string $name Tag name to check for.
      */
-    public function hasTag(string $name) : bool
+    public function hasTag(string $name): bool
     {
         foreach ($this->getTags() as $tag) {
             if ($tag->getName() === $name) {
@@ -206,7 +206,7 @@ public function hasTag(string $name) : bool
      *
      * @param Tag $tagToRemove The tag to remove.
      */
-    public function removeTag(Tag $tagToRemove) : void
+    public function removeTag(Tag $tagToRemove): void
     {
         foreach ($this->tags as $key => $tag) {
             if ($tag === $tagToRemove) {
@@ -221,7 +221,7 @@ public function removeTag(Tag $tagToRemove) : void
      *
      * @param Tag $tag The tag to add.
      */
-    private function addTag(Tag $tag) : void
+    private function addTag(Tag $tag): void
     {
         $this->tags[] = $tag;
     }

src/DocBlock/Description.php

@@ -15,6 +15,7 @@
 
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter;
+
 use function vsprintf;
 
 /**
@@ -71,7 +72,7 @@ public function __construct(string $bodyTemplate, array $tags = [])
     /**
      * Returns the body template.
      */
-    public function getBodyTemplate() : string
+    public function getBodyTemplate(): string
     {
         return $this->bodyTemplate;
     }
@@ -81,7 +82,7 @@ public function getBodyTemplate() : string
      *
      * @return Tag[]
      */
-    public function getTags() : array
+    public function getTags(): array
     {
         return $this->tags;
     }
@@ -90,7 +91,7 @@ public function getTags() : array
      * Renders this description as a string where the provided formatter will format the tags in the expected string
      * format.
      */
-    public function render(?Formatter $formatter = null) : string
+    public function render(?Formatter $formatter = null): string
     {
         if ($formatter === null) {
             $formatter = new PassthroughFormatter();
@@ -107,7 +108,7 @@ public function render(?Formatter $formatter = null) : string
     /**
      * Returns a plain string representation of this description.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return $this->render();
     }

src/DocBlock/DescriptionFactory.php

@@ -15,6 +15,7 @@
 
 use phpDocumentor\Reflection\Types\Context as TypeContext;
 use phpDocumentor\Reflection\Utils;
+
 use function count;
 use function explode;
 use function implode;
@@ -25,6 +26,7 @@
 use function strpos;
 use function substr;
 use function trim;
+
 use const PREG_SPLIT_DELIM_CAPTURE;
 
 /**
@@ -60,7 +62,7 @@ public function __construct(TagFactory $tagFactory)
     /**
      * Returns the parsed text of this description.
      */
-    public function create(string $contents, ?TypeContext $context = null) : Description
+    public function create(string $contents, ?TypeContext $context = null): Description
     {
         $tokens   = $this->lex($contents);
         $count    = count($tokens);
@@ -88,7 +90,7 @@ public function create(string $contents, ?TypeContext $context = null) : Descrip
      *
      * @return string[] A series of tokens of which the description text is composed.
      */
-    private function lex(string $contents) : array
+    private function lex(string $contents): array
     {
         $contents = $this->removeSuperfluousStartingWhitespace($contents);
 
@@ -142,7 +144,7 @@ private function lex(string $contents) : array
      * 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.
      */
-    private function removeSuperfluousStartingWhitespace(string $contents) : string
+    private function removeSuperfluousStartingWhitespace(string $contents): string
     {
         $lines = explode("\n", $contents);
 

src/DocBlock/ExampleFinder.php

@@ -14,6 +14,7 @@
 namespace phpDocumentor\Reflection\DocBlock;
 
 use phpDocumentor\Reflection\DocBlock\Tags\Example;
+
 use function array_slice;
 use function file;
 use function getcwd;
@@ -22,6 +23,7 @@
 use function rtrim;
 use function sprintf;
 use function trim;
+
 use const DIRECTORY_SEPARATOR;
 
 /**
@@ -38,7 +40,7 @@ class ExampleFinder
     /**
      * Attempts to find the example contents for the given descriptor.
      */
-    public function find(Example $example) : string
+    public function find(Example $example): string
     {
         $filename = $example->getFilePath();
 
@@ -53,15 +55,15 @@ public function find(Example $example) : string
     /**
      * Registers the project's root directory where an 'examples' folder can be expected.
      */
-    public function setSourceDirectory(string $directory = '') : void
+    public function setSourceDirectory(string $directory = ''): void
     {
         $this->sourceDirectory = $directory;
     }
 
     /**
      * Returns the project's root directory where an 'examples' folder can be expected.
      */
-    public function getSourceDirectory() : string
+    public function getSourceDirectory(): string
     {
         return $this->sourceDirectory;
     }
@@ -71,7 +73,7 @@ public function getSourceDirectory() : string
      *
      * @param string[] $directories
      */
-    public function setExampleDirectories(array $directories) : void
+    public function setExampleDirectories(array $directories): void
     {
         $this->exampleDirectories = $directories;
     }
@@ -81,7 +83,7 @@ public function setExampleDirectories(array $directories) : void
      *
      * @return string[]
      */
-    public function getExampleDirectories() : array
+    public function getExampleDirectories(): array
     {
         return $this->exampleDirectories;
     }
@@ -99,7 +101,7 @@ public function getExampleDirectories() : array
      *
      * @return string[] all lines of the example file
      */
-    private function getExampleFileContents(string $filename) : ?array
+    private function getExampleFileContents(string $filename): ?array
     {
         $normalizedPath = null;
 
@@ -129,23 +131,23 @@ private function getExampleFileContents(string $filename) : ?array
     /**
      * Get example filepath based on the example directory inside your project.
      */
-    private function getExamplePathFromExampleDirectory(string $file) : string
+    private function getExamplePathFromExampleDirectory(string $file): string
     {
         return getcwd() . DIRECTORY_SEPARATOR . 'examples' . DIRECTORY_SEPARATOR . $file;
     }
 
     /**
      * Returns a path to the example file in the given directory..
      */
-    private function constructExamplePath(string $directory, string $file) : string
+    private function constructExamplePath(string $directory, string $file): string
     {
         return rtrim($directory, '\\/') . DIRECTORY_SEPARATOR . $file;
     }
 
     /**
      * Get example filepath based on sourcecode.
      */
-    private function getExamplePathFromSource(string $file) : string
+    private function getExamplePathFromSource(string $file): string
     {
         return sprintf(
             '%s%s%s',

src/DocBlock/Serializer.php

@@ -16,6 +16,7 @@
 use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter;
+
 use function sprintf;
 use function str_repeat;
 use function str_replace;
@@ -72,7 +73,7 @@ public function __construct(
      *
      * @return string The serialized doc block.
      */
-    public function getDocComment(DocBlock $docblock) : string
+    public function getDocComment(DocBlock $docblock): string
     {
         $indent      = str_repeat($this->indentString, $this->indent);
         $firstIndent = $this->isFirstLineIndented ? $indent : '';
@@ -98,7 +99,7 @@ public function getDocComment(DocBlock $docblock) : string
         return $comment . $indent . ' */';
     }
 
-    private function removeTrailingSpaces(string $indent, string $text) : string
+    private function removeTrailingSpaces(string $indent, string $text): string
     {
         return str_replace(
             sprintf("\n%s * \n", $indent),
@@ -107,7 +108,7 @@ private function removeTrailingSpaces(string $indent, string $text) : string
         );
     }
 
-    private function addAsterisksForEachLine(string $indent, string $text) : string
+    private function addAsterisksForEachLine(string $indent, string $text): string
     {
         return str_replace(
             "\n",
@@ -116,7 +117,7 @@ private function addAsterisksForEachLine(string $indent, string $text) : string
         );
     }
 
-    private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, ?int $wrapLength) : string
+    private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, ?int $wrapLength): string
     {
         $text = $docblock->getSummary() . ((string) $docblock->getDescription() ? "\n\n" . $docblock->getDescription()
                 : '');
@@ -129,7 +130,7 @@ private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, ?int $wra
         return $text;
     }
 
-    private function addTagBlock(DocBlock $docblock, ?int $wrapLength, string $indent, string $comment) : string
+    private function addTagBlock(DocBlock $docblock, ?int $wrapLength, string $indent, string $comment): string
     {
         foreach ($docblock->getTags() as $tag) {
             $tagText = $this->tagFormatter->format($tag);