Merge pull request #21 from sminnee/phpstan011

NEW: Move to phpstan 0.11.
symbiote · Nov 11, 2019 · 1ab1ca5 · 1ab1ca5
2 parents 8fb6491 + ec0c81e
commit 1ab1ca5
Show file tree

Hide file tree

Showing 27 changed files with 437 additions and 179 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+/vendor/
+/resources/
+/assets/
+/app/
+.DS_Store
+.phpunit.result.cache
+composer.lock
diff --git a/.travis.yml b/.travis.yml
@@ -1,28 +1,19 @@
 language: php
+php:
+  - 7.1
+  - 7.2
+  - 7.3
 
 env:
   global:
     - COMPOSER_ROOT_VERSION=5.0.x-dev
     - SS_BASE_URL="https://localhost/"
+    - DB=MYSQL
+  matrix:
+    - RECIPE_VERSION=4.3.x-dev
+    - RECIPE_VERSION=4.4.x-dev
+
 
-matrix:
-  include:
-    # NOTE(Jake): 2018-05-16
-    #
-    # Running in PHP 7.0 doesn't seem to work.
-    #
-    # - php: 7.0
-    #   env:
-    #     - DB=MYSQL
-    #     - RECIPE_VERSION=1.0.x-dev
-    - php: 7.1
-      env:
-        - DB=MYSQL
-        - RECIPE_VERSION=1.1.x-dev
-    - php: 7.2
-      env:
-        - DB=MYSQL
-        - RECIPE_VERSION=1.2.x-dev
 
 before_script:
   - phpenv rehash

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ composer require --dev symbiote/silverstripe-phpstan:1.0.0 phpstan/phpstan-shim:
 
 SilverStripe 4.X
 ```
-composer require --dev symbiote/silverstripe-phpstan:2.0.0 phpstan/phpstan-shim:0.9.2
+composer require --dev symbiote/silverstripe-phpstan:2.0.0 phpstan/phpstan-shim:~0.11.0
 ```
 
 NOTE: We recommend installing the phpstan-shim as currently in SilverStripe 3.X, the QueuedJobs module's dependence on superclosure forces the PHP-Parser dependency of PHPStan to be at a very outdated version.

diff --git a/composer.json b/composer.json
@@ -12,19 +12,21 @@
     ],
     "license": "BSD-3-Clause",
     "authors": [
-    {
-        "name": "Jake Bentvelzen",
-        "email": "[email protected]"
-    }],
+        {
+            "name": "Jake Bentvelzen",
+            "email": "[email protected]"
+        }
+    ],
     "require": {
-        "php": "~7.0",
-        "silverstripe/framework": "~4.0",
+        "php": "~7.1",
+        "silverstripe/framework": "~4.3",
         "silverstripe/vendor-plugin": "^1.0"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "^3.0",
-        "phpstan/phpstan": "~0.9.0",
-        "phpstan/phpstan-phpunit": "~0.9.0"
+        "phpstan/phpstan": "~0.11.0",
+        "phpstan/phpstan-phpunit": "~0.11.0",
+        "phpunit/phpunit": "^7.5.14 || ^8.0"
     },
     "scripts": {
         "phpcs": "phpcs -n -l src/ src/Reflection/ src/Rule/ src/Type tests/ tests/Reflection/ tests/Rule/ tests/Type/",
@@ -33,7 +35,7 @@
         "phpstan": "bash ../../../vendor/bin/phpstan analyse src/ tests/ -c \"tests/phpstan.neon\" -a \"tests/bootstrap-phpstan.php\" --level 4"
     },
     "suggest": {
-        "phpstan/phpstan-shim": "~0.9.0"
+        "phpstan/phpstan-shim": "~0.11.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpstan.neon b/phpstan.neon
@@ -5,6 +5,9 @@ parameters:
     universalObjectCratesClasses:
         - SilverStripe\View\ArrayData
         - SilverStripe\Core\Config\Config_ForClass
+        - SilverStripe\Forms\GridField\GridState_Data
+        - SilverStripe\ORM\DataObject
+        - SilverStripe\ORM\DataObjectInterface
         - Symbiote\QueuedJobs\Services\AbstractQueuedJob # symbiote/silverstripe-queuedjobs module support
     excludes_analyse:
         - silverstripe-cache
@@ -65,9 +68,21 @@ services:
         class: Symbiote\SilverstripePHPStan\Type\DataObjectReturnTypeExtension
         tags:
             - phpstan.broker.dynamicMethodReturnTypeExtension
+
+    -
+        class: Symbiote\SilverstripePHPStan\Type\FormFieldReturnTypeExtension
+        tags:
+            - phpstan.broker.dynamicMethodReturnTypeExtension
+
     # This makes calls to `DBField::create_field('HTMLText', $value)` return the correct type info
     # ie. The injectored type of the first parameter
     -
         class: Symbiote\SilverstripePHPStan\Type\DBFieldStaticReturnTypeExtension
         tags:
             - phpstan.broker.dynamicStaticMethodReturnTypeExtension
+
+    # Special handling for ->hasMethod() checks
+    -
+        class: Symbiote\SilverstripePHPStan\Type\HasMethodTypeSpecifyingExtension
+        tags:
+            - phpstan.typeSpecifier.methodTypeSpecifyingExtension
diff --git a/src/ConfigHelper.php b/src/ConfigHelper.php
@@ -23,7 +23,7 @@ public static function get($className, $configKey)
      * @param string $className
      * @param string $configKey
      * @param string $configValue
-     * @return array|scalar
+     * @return \SilverStripe\Config\Collections\MutableConfigCollectionInterface
      */
     public static function update($className, $configKey, $configValue)
     {

diff --git a/src/Reflection/CachedMethod.php b/src/Reflection/CachedMethod.php
@@ -4,6 +4,7 @@
 
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ClassMemberReflection;
 use PHPStan\Type\Type;
 use PHPStan\Type\MixedType;
 use PHPStan\Reflection\Php\PhpMethodReflection;
@@ -43,7 +44,7 @@ public function getDeclaringClass(): ClassReflection
         return $this->methodReflection->getDeclaringClass();
     }
 
-    public function getPrototype(): MethodReflection
+    public function getPrototype(): ClassMemberReflection
     {
         return $this->methodReflection->getPrototype();
     }
@@ -53,15 +54,15 @@ public function isStatic(): bool
         return $this->methodReflection->isStatic();
     }
 
-    public function getParameters(): array
-    {
-        return $this->methodReflection->getParameters();
-    }
+    // public function getParameters(): array
+    // {
+    //     return $this->methodReflection->getParameters();
+    // }
 
-    public function isVariadic(): bool
-    {
-        return $this->methodReflection->isVariadic();
-    }
+    // public function isVariadic(): bool
+    // {
+    //     return $this->methodReflection->isVariadic();
+    // }
 
     public function isPrivate(): bool
     {
@@ -78,8 +79,16 @@ public function getName(): string
         return $this->name;
     }
 
-    public function getReturnType(): Type
+    // public function getReturnType(): Type
+    // {
+    //     return $this->methodReflection->getReturnType();
+    // }
+
+    /**
+     * @return \PHPStan\Reflection\ParametersAcceptor[]
+     */
+    public function getVariants(): array
     {
-        return $this->methodReflection->getReturnType();
+            return $this->methodReflection->getVariants();
     }
 }
diff --git a/src/Reflection/ComponentHasManyMethod.php b/src/Reflection/ComponentHasManyMethod.php
@@ -5,34 +5,35 @@
 use Symbiote\SilverstripePHPStan\ClassHelper;
 use Symbiote\SilverstripePHPStan\Type\DataListType;
 use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\ClassMemberReflection;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\FunctionVariant;
 use PHPStan\Type\Type;
 use PHPStan\Type\ObjectType;
 
 class ComponentHasManyMethod implements MethodReflection
 {
 
     /**
-     *
-     *
      * @var string
      */
     private $name;
 
     /**
-     *
-     *
      * @var \PHPStan\Reflection\ClassReflection
      */
     private $declaringClass;
 
     /**
-     *
-     *
      * @var DataListType
      */
     private $returnType;
 
+    /**
+     * @var FunctionVariant[]|null
+     */
+    private $variants;
+
     public function __construct(string $name, ClassReflection $declaringClass, ObjectType $type)
     {
         $this->name = $name;
@@ -45,7 +46,7 @@ public function getDeclaringClass(): ClassReflection
         return $this->declaringClass;
     }
 
-    public function getPrototype(): MethodReflection
+    public function getPrototype(): ClassMemberReflection
     {
         return $this;
     }
@@ -84,4 +85,18 @@ public function getReturnType(): Type
     {
         return $this->returnType;
     }
+
+    public function getVariants(): array
+    {
+        if ($this->variants === null) {
+            $this->variants = [
+                new FunctionVariant(
+                    $this->getParameters(),
+                    $this->isVariadic(),
+                    $this->getReturnType()
+                ),
+            ];
+        }
+        return $this->variants;
+    }
 }
diff --git a/src/Reflection/ComponentHasOneMethod.php b/src/Reflection/ComponentHasOneMethod.php
@@ -4,33 +4,34 @@
 
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ClassMemberReflection;
+use PHPStan\Reflection\FunctionVariant;
 use PHPStan\Type\Type;
 use PHPStan\Type\ObjectType;
 
 class ComponentHasOneMethod implements MethodReflection
 {
 
     /**
-     *
-     *
      * @var string
      */
     private $name;
 
     /**
-     *
-     *
      * @var \PHPStan\Reflection\ClassReflection
      */
     private $declaringClass;
 
     /**
-     *
-     *
      * @var ObjectType
      */
     private $returnType;
 
+    /**
+     * @var FunctionVariant[]|null
+     */
+    private $variants;
+
     public function __construct(string $name, ClassReflection $declaringClass, ObjectType $type)
     {
         $this->name = $name;
@@ -43,7 +44,7 @@ public function getDeclaringClass(): ClassReflection
         return $this->declaringClass;
     }
 
-    public function getPrototype(): MethodReflection
+    public function getPrototype(): ClassMemberReflection
     {
         return $this;
     }
@@ -82,4 +83,18 @@ public function getReturnType(): Type
     {
         return $this->returnType;
     }
+
+    public function getVariants(): array
+    {
+        if ($this->variants === null) {
+            $this->variants = [
+                new FunctionVariant(
+                    $this->getParameters(),
+                    $this->isVariadic(),
+                    $this->getReturnType()
+                ),
+            ];
+        }
+        return $this->variants;
+    }
 }
diff --git a/src/Reflection/ComponentManyManyMethod.php b/src/Reflection/ComponentManyManyMethod.php
@@ -6,6 +6,8 @@
 use Symbiote\SilverstripePHPStan\Type\DataListType;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\FunctionVariant;
+use PHPStan\Reflection\ClassMemberReflection;
 use PHPStan\Type\Type;
 use PHPStan\Type\ObjectType;
 
@@ -33,6 +35,11 @@ class ComponentManyManyMethod implements MethodReflection
      */
     private $returnType;
 
+    /**
+     * @var FunctionVariant[]|null
+     */
+    private $variants;
+
     public function __construct(string $name, ClassReflection $declaringClass, ObjectType $type)
     {
         $this->name = $name;
@@ -45,7 +52,7 @@ public function getDeclaringClass(): ClassReflection
         return $this->declaringClass;
     }
 
-    public function getPrototype(): MethodReflection
+    public function getPrototype(): ClassMemberReflection
     {
         return $this;
     }
@@ -84,4 +91,18 @@ public function getReturnType(): Type
     {
         return $this->returnType;
     }
+
+    public function getVariants(): array
+    {
+        if ($this->variants === null) {
+            $this->variants = [
+                new FunctionVariant(
+                    $this->getParameters(),
+                    $this->isVariadic(),
+                    $this->getReturnType()
+                ),
+            ];
+        }
+        return $this->variants;
+    }
 }
diff --git a/src/Reflection/MethodClassReflectionExtension.php b/src/Reflection/MethodClassReflectionExtension.php
@@ -50,7 +50,7 @@ public function getMethod(ClassReflection $classReflection, string $methodName):
         return $this->methods[$classReflection->getName()][strtolower($methodName)];
     }
 
-    public function setBroker(Broker $broker)
+    public function setBroker(Broker $broker): void
     {
         $this->broker = $broker;
     }