Apply new code style

Author: jaapio

phpcs.xml.dist

@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<ruleset name="phpDocumentor">
+ <description>The coding standard for phpDocumentor.</description>
+
+    <file>src</file>
+    <file>tests/unit</file>
+    <exclude-pattern>*/tests/unit/Types/ContextFactoryTest.php</exclude-pattern>
+    <arg value="p"/>
+    <rule ref="PSR2">
+        <include-pattern>*\.php</include-pattern>
+    </rule>
+
+    <rule ref="Doctrine">
+        <exclude name="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint.UselessDocComment" />
+    </rule>
+
+    <rule ref="Squiz.Classes.ValidClassName.NotCamelCaps">
+        <exclude-pattern>*/src/*_.php</exclude-pattern>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix">
+        <exclude-pattern>*/src/*/Abstract*.php</exclude-pattern>
+    </rule>
+
+    <rule ref="Generic.Formatting.SpaceAfterNot">
+        <properties>
+            <property name="spacing" value="0" />
+        </properties>
+    </rule>
+</ruleset>

src/DocBlock.php

@@ -1,13 +1,13 @@
-<?php declare(strict_types=1);
+<?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-2018 Mike van Riel<[email protected]>
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
@@ -41,8 +41,8 @@ final class DocBlock
 
     /**
      * @param DocBlock\Tag[] $tags
-     * @param Types\Context $context The context in which the DocBlock occurs.
-     * @param Location $location The location within the file that this DocBlock occurs in.
+     * @param Types\Context  $context  The context in which the DocBlock occurs.
+     * @param Location       $location The location within the file that this DocBlock occurs in.
      */
     public function __construct(
         string $summary = '',
@@ -55,41 +55,41 @@ public function __construct(
     ) {
         Assert::allIsInstanceOf($tags, Tag::class);
 
-        $this->summary = $summary;
+        $this->summary     = $summary;
         $this->description = $description ?: new DocBlock\Description('');
         foreach ($tags as $tag) {
             $this->addTag($tag);
         }
 
-        $this->context = $context;
+        $this->context  = $context;
         $this->location = $location;
 
-        $this->isTemplateEnd = $isTemplateEnd;
+        $this->isTemplateEnd   = $isTemplateEnd;
         $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;
     }
@@ -113,7 +113,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;
     }
@@ -123,7 +123,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;
     }
@@ -133,7 +133,7 @@ public function isTemplateEnd(): bool
      *
      * @return Tag[]
      */
-    public function getTags(): array
+    public function getTags() : array
     {
         return $this->tags;
     }
@@ -146,7 +146,7 @@ public function getTags(): array
      *
      * @return Tag[]
      */
-    public function getTagsByName(string $name): array
+    public function getTagsByName(string $name) : array
     {
         $result = [];
 
@@ -167,7 +167,7 @@ public function getTagsByName(string $name): array
      *
      * @param string $name Tag name to check for.
      */
-    public function hasTag(string $name): bool
+    public function hasTag(string $name) : bool
     {
         /** @var Tag $tag */
         foreach ($this->getTags() as $tag) {
@@ -184,7 +184,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) {
@@ -199,7 +199,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

@@ -1,20 +1,21 @@
-<?php declare(strict_types=1);
+<?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-2018 Mike van Riel<[email protected]>
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
 namespace phpDocumentor\Reflection\DocBlock;
 
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter\PassthroughFormatter;
+use function vsprintf;
 
 /**
  * Object representing to description for a DocBlock.
@@ -64,15 +65,15 @@ class Description
     public function __construct(string $bodyTemplate, array $tags = [])
     {
         $this->bodyTemplate = $bodyTemplate;
-        $this->tags = $tags;
+        $this->tags         = $tags;
     }
 
     /**
      * Returns the tags for this DocBlock.
      *
      * @return Tag[]
      */
-    public function getTags(): array
+    public function getTags() : array
     {
         return $this->tags;
     }
@@ -81,7 +82,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();
@@ -98,7 +99,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

@@ -1,19 +1,31 @@
-<?php declare(strict_types=1);
+<?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-2018 Mike van Riel<[email protected]>
- * @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 const PREG_SPLIT_DELIM_CAPTURE;
+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;
 
 /**
  * Creates a new Description object given a body of text.
@@ -48,7 +60,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
     {
         [$text, $tags] = $this->parse($this->lex($contents), $context);
 
@@ -58,10 +70,9 @@ public function create(string $contents, ?TypeContext $context = null): Descript
     /**
      * Strips the contents from superfluous whitespace and splits the description into a series of tokens.
      *
-     *
      * @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);
 
@@ -108,14 +119,14 @@ private function lex(string $contents): array
      *
      * @return string[]|Tag[]
      */
-    private function parse($tokens, ?TypeContext $context = null): array
+    private function parse(array $tokens, ?TypeContext $context = null) : array
     {
-        $count = count($tokens);
+        $count    = count($tokens);
         $tagCount = 0;
-        $tags = [];
+        $tags     = [];
 
         for ($i = 1; $i < $count; $i += 2) {
-            $tags[] = $this->tagFactory->create($tokens[$i], $context);
+            $tags[]     = $this->tagFactory->create($tokens[$i], $context);
             $tokens[$i] = '%' . ++$tagCount . '$s';
         }
 
@@ -144,7 +155,7 @@ private function parse($tokens, ?TypeContext $context = null): 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);