Apply new code standards to projects

Author: jaapio

Makefile

@@ -0,0 +1,35 @@
+.PHONY: install-phive
+install-phive:
+	mkdir tools; \
+	wget -O tools/phive.phar https://github.com/phar-io/phive/releases/download/0.13.2/phive-0.13.2.phar; \
+	wget -O tools/phive.phar.asc https://github.com/phar-io/phive/releases/download/0.13.2/phive-0.13.2.phar.asc; \
+	gpg --keyserver pool.sks-keyservers.net --recv-keys 0x9D8A98B29B2D5D79; \
+	gpg --verify tools/phive.phar.asc tools/phive.phar; \
+	chmod +x tools/phive.phar
+
+.PHONY: setup
+setup: install-phive
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phar-ga:latest php tools/phive.phar install --force-accept-unsigned
+
+.PHONY: phpcs
+phpcs:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest -s
+
+.PHONY: phpcbf
+phpcbf:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest phpcbf
+
+.PHONY: phpstan
+phpstan:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpstan-ga:latest analyse src --no-progress --configuration phpstan.neon
+
+.PHONY: psalm
+psalm:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.2 tools/psalm --show-info=true
+.PHONY: test
+test:
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.2 tools/phpunit
+
+.PHONY: pre-commit-test
+pre-commit-test: test phpcs phpstan psalm
+

phive.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpunit" version="^6.5.5" installed="6.5.5" location="./tools/phpunit"/>
-  <phar name="phpstan" version="^0.9.1" installed="0.9.1" location="./tools/phpstan"/>
+  <phar name="phpunit" version="^8.4" installed="8.4.3" location="./tools/phpunit" copy="true"/>
+  <phar name="psalm" version="^3.7.2" installed="3.11.2" location="./tools/psalm" copy="true"/>
 </phive>

phpcs.xml.dist

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="phpDocumentor">
+ <description>The coding standard for phpDocumentor.</description>
+
+    <file>src</file>
+    <file>tests/unit</file>
+    <arg value="p"/>
+
+    <rule ref="phpDocumentor">
+    </rule>
+</ruleset>

phpstan.neon

@@ -0,0 +1,2 @@
+parameters:
+    level: max

phpunit.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 
-<phpunit bootstrap="tests/common/bootstrap.php" colors="true">
+<phpunit bootstrap="vendor/autoload.php" colors="true">
     <testsuites>
         <testsuite name="unit">
             <directory>./tests/unit/</directory>

psalm.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<psalm
+    totallyTyped="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config file:///composer/vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Element.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -7,8 +8,6 @@
  * 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 / Naenius (http://www.naenius.com)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
@@ -22,10 +21,10 @@ interface Element
     /**
      * Returns the Fqsen of the element.
      */
-    public function getFqsen(): Fqsen;
+    public function getFqsen() : Fqsen;
 
     /**
      * Returns the name of the element.
      */
-    public function getName(): string;
+    public function getName() : string;
 }

src/File.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -7,8 +8,6 @@
  * 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<mike@phpdoc.org>
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
@@ -22,15 +21,15 @@ interface File
     /**
      * Returns the content of the file as a string.
      */
-    public function getContents(): string;
+    public function getContents() : string;
 
     /**
      * Returns md5 hash of the file.
      */
-    public function md5(): string;
+    public function md5() : string;
 
     /**
      * Returns an relative path to the file.
      */
-    public function path(): string;
+    public function path() : string;
 }

src/Fqsen.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -7,30 +8,33 @@
  * 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 / Naenius (http://www.naenius.com)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
 namespace phpDocumentor\Reflection;
 
 use InvalidArgumentException;
+use function assert;
+use function end;
+use function explode;
+use function is_string;
+use function preg_match;
+use function sprintf;
+use function trim;
 
 /**
  * Value Object for Fqsen.
  *
  * @link https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc-meta.md
+ *
+ * @psalm-immutable
  */
 final class Fqsen
 {
-    /**
-     * @var string full quallified class name
-     */
+    /** @var string full quallified class name */
     private $fqsen;
 
-    /**
-     * @var string name of the element without path.
-     */
+    /** @var string name of the element without path. */
     private $name;
 
     /**
@@ -41,7 +45,9 @@ final class Fqsen
     public function __construct(string $fqsen)
     {
         $matches = [];
+
         $result = preg_match(
+            //phpcs:ignore Generic.Files.LineLength.TooLong
             '/^\\\\([a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff\\\\]*)?(?:[:]{2}\\$?([a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*))?(?:\\(\\))?$/',
             $fqsen,
             $matches
@@ -59,22 +65,24 @@ public function __construct(string $fqsen)
             $this->name = $matches[2];
         } else {
             $matches = explode('\\', $fqsen);
-            $this->name = trim(end($matches), '()');
+            $name = end($matches);
+            assert(is_string($name));
+            $this->name = trim($name, '()');
         }
     }
 
     /**
      * converts this class to string.
      */
-    public function __toString(): string
+    public function __toString() : string
     {
         return $this->fqsen;
     }
 
     /**
      * Returns the name of the element without path.
      */
-    public function getName(): string
+    public function getName() : string
     {
         return $this->name;
     }

src/Location.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -7,15 +8,15 @@
  * 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<mike@phpdoc.org>
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
 namespace phpDocumentor\Reflection;
 
 /**
  * The location where an element occurs within a file.
+ *
+ * @psalm-immutable
  */
 final class Location
 {
@@ -37,15 +38,15 @@ public function __construct(int $lineNumber, int $columnNumber = 0)
     /**
      * Returns the line number that is covered by this location.
      */
-    public function getLineNumber(): int
+    public function getLineNumber() : int
     {
         return $this->lineNumber;
     }
 
     /**
      * Returns the column number (character position on a line) for this location object.
      */
-    public function getColumnNumber(): int
+    public function getColumnNumber() : int
     {
         return $this->columnNumber;
     }

src/Project.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -7,8 +8,6 @@
  * 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 / Naenius (http://www.naenius.com)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
@@ -22,5 +21,5 @@ interface Project
     /**
      * Returns the name of the project.
      */
-    public function getName(): string;
+    public function getName() : string;
 }

src/ProjectFactory.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 /**
@@ -7,8 +8,6 @@
  * 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 / Naenius (http://www.naenius.com)
- * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      http://phpdoc.org
  */
 
@@ -23,9 +22,7 @@ interface ProjectFactory
     /**
      * Creates a project from the set of files.
      *
-     * @param string $name
      * @param File[] $files
-     * @return Project
      */
-    public function create($name, array $files): Project;
+    public function create(string $name, array $files) : Project;
 }