Fix PHPStan v0.12, run CS fixer (#295)

* Fix PHPStan v0.12 * Code style autofixes * PHPStan fixes in MethodDocGenerator Co-authored-by: Krzysztof Śmiałek <krzysztof.smialek@amsterdamstandard.com>
beberlei · May 22, 2020 · 10eef03 · 10eef03
1 parent ed28db1
commit 10eef03
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 317 deletions.
diff --git a/bin/MethodDocGenerator.php b/bin/MethodDocGenerator.php
@@ -20,6 +20,9 @@
  */
 class MethodDocGenerator
 {
+    /**
+     * @return void
+     */
     public function generateChainDocs()
     {
         $phpFile = __DIR__.'/../lib/Assert/AssertionChain.php';
@@ -34,10 +37,10 @@ public function generateChainDocs()
     /**
      * @param ReflectionMethod[] $methods
      * @param string $format
-     * @param callable|false $skipParameterTest
+     * @param callable|bool $skipParameterTest
      * @param string $prefix
      *
-     * @return array
+     * @return string[]
      *
      * @throws AssertionFailedException
      */
@@ -47,6 +50,7 @@ private function generateMethodDocs($methods, $format, $skipParameterTest, $pref
         asort($methods);
         foreach ($methods as $method) {
             $doc = $method->getDocComment();
+            assert($doc !== false);
             list(, $descriptionLine) = explode("\n", $doc);
             $shortDescription = trim(substr($descriptionLine, 7), '.');
             $methodName = $prefix.($prefix ? ucfirst($method->getName()) : $method->getName());
@@ -132,11 +136,15 @@ function (ReflectionMethod $reflMethod) {
      * @param string $phpFile
      * @param string[] $lines
      * @param string $fileType
+     *
+     * @return void
      */
     private function generateFile($phpFile, $lines, $fileType)
     {
         $phpFile = realpath($phpFile);
+        assert($phpFile !== false);
         $fileContent = file_get_contents($phpFile);
+        assert($fileContent !== false);
 
         switch ($fileType) {
             case 'class':
@@ -162,6 +170,9 @@ private function generateFile($phpFile, $lines, $fileType)
         }
     }
 
+    /**
+     * @return void
+     */
     public function generateAssertionDocs()
     {
         $phpFile = __DIR__.'/../lib/Assert/Assertion.php';
@@ -177,6 +188,9 @@ public function generateAssertionDocs()
         $this->generateFile($phpFile, $docs, 'class');
     }
 
+    /**
+     * @return void
+     */
     public function generateReadMe()
     {
         $mdFile = __DIR__.'/../README.md';
@@ -189,6 +203,9 @@ public function generateReadMe()
         $this->generateFile($mdFile, $docs, 'readme');
     }
 
+    /**
+     * @return void
+     */
     public function generateLazyAssertionDocs()
     {
         $phpFile = __DIR__.'/../lib/Assert/LazyAssertion.php';

diff --git a/composer.json b/composer.json
@@ -32,7 +32,7 @@
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "*",
-    "phpstan/phpstan-shim": "*",
+    "phpstan/phpstan": "*",
     "phpunit/phpunit": ">=6.0.0 <8"
   },
   "autoload": {

diff --git a/lib/Assert/Assert.php b/lib/Assert/Assert.php
@@ -33,9 +33,6 @@ abstract class Assert
      *
      * @param mixed $value
      * @param string|callable|null $defaultMessage
-     * @param string|null $defaultPropertyPath
-     *
-     * @return AssertionChain
      *
      * @example
      *
@@ -57,9 +54,6 @@ public static function that($value, $defaultMessage = null, string $defaultPrope
      *
      * @param mixed $values
      * @param string|callable|null $defaultMessage
-     * @param string|null $defaultPropertyPath
-     *
-     * @return AssertionChain
      */
     public static function thatAll($values, $defaultMessage = null, string $defaultPropertyPath = null): AssertionChain
     {
@@ -71,9 +65,6 @@ public static function thatAll($values, $defaultMessage = null, string $defaultP
      *
      * @param mixed $value
      * @param string|callable|null $defaultMessage
-     * @param string|null $defaultPropertyPath
-     *
-     * @return AssertionChain
      */
     public static function thatNullOr($value, $defaultMessage = null, string $defaultPropertyPath = null): AssertionChain
     {
@@ -82,8 +73,6 @@ public static function thatNullOr($value, $defaultMessage = null, string $defaul
 
     /**
      * Create a lazy assertion object.
-     *
-     * @return LazyAssertion
      */
     public static function lazy(): LazyAssertion
     {