Merge branch 'master' into phpunit

mglaman · web-flow · commit 509ac53a6a3b · 2019-02-02T20:53:59.000-06:00
diff --git a/.travis.yml b/.travis.yml
@@ -5,14 +5,26 @@ php:
   - 7.3
 
 before_install:
-  - composer self-update
   - composer global require "hirak/prestissimo:^0.3"
 install:
   - composer install --no-interaction
 script:
+  # Inspections
   - ./vendor/bin/phpcs src
   - ./vendor/bin/phpstan analyze src
   - ./vendor/bin/phpunit
+
+  # Try to add to a Drupal setup.
+  - composer create-project drupal-composer/drupal-project:8.x-dev $TRAVIS_BUILD_DIR/../drupal --no-interaction
+  - cd $TRAVIS_BUILD_DIR/../drupal
+
+  # Install dependency.
+  - composer config repositories.0 path $TRAVIS_BUILD_DIR
+  - cat composer.json
+  - composer require mglaman/phpstan-drupal *@dev
+  - cp $TRAVIS_BUILD_DIR/tests/fixtures/drupal-phpstan.neon phpstan.neon
+  - ./vendor/bin/phpstan analyze web/core/install.php
+
 cache:
   directories:
     - $HOME/.composer/cache
diff --git a/composer.json b/composer.json
@@ -11,7 +11,8 @@
     "require": {
         "php": "^7.1",
         "phpstan/phpstan": "^0.10.6",
-        "symfony/yaml": "^4.2"
+        "symfony/yaml": "~3.4.5|^4.2",
+        "webflo/drupal-finder": "^1.1"
     },
     "require-dev": {
         "phpstan/phpstan-strict-rules": "^0.10.1",
@@ -28,5 +29,10 @@
     },
     "autoload-dev": {
         "classmap": ["tests/"]
+    },
+    "extra": {
+      "branch-alias": {
+        "dev-master": "0.11-dev"
+      }
     }
 }
diff --git a/src/DependencyInjection/DrupalExtension.php b/src/DependencyInjection/DrupalExtension.php
@@ -2,6 +2,7 @@
 
 namespace PHPStan\DependencyInjection;
 
+use DrupalFinder\DrupalFinder;
 use Nette\DI\CompilerExtension;
 use Nette\DI\Config\Helpers;
 use PHPStan\Drupal\ExtensionDiscovery;
@@ -19,11 +20,6 @@ class DrupalExtension extends CompilerExtension
         'themes' => [],
     ];
 
-    /**
-     * @var string
-     */
-    private $autoloaderPath;
-
     /**
      * @var string
      */
@@ -55,24 +51,9 @@ class DrupalExtension extends CompilerExtension
 
     public function loadConfiguration(): void
     {
-
-        $this->autoloaderPath = $GLOBALS['autoloaderInWorkingDirectory'];
-        $realpath = realpath($this->autoloaderPath);
-        if ($realpath === false) {
-            throw new \InvalidArgumentException('Cannot determine the realpath of the autoloader.');
-        }
-        $project_root = dirname($realpath, 2);
-        if (is_dir($project_root . '/core')) {
-            $this->drupalRoot = $project_root;
-        }
-        foreach (['web', 'docroot'] as $possible_docroot) {
-            if (is_dir("$project_root/$possible_docroot/core")) {
-                $this->drupalRoot = "$project_root/$possible_docroot";
-            }
-        }
-        if ($this->drupalRoot === null) {
-            throw new \InvalidArgumentException('Unable to determine the Drupal root');
-        }
+        $finder = new DrupalFinder();
+        $finder->locateRoot(getcwd());
+        $this->drupalRoot = $finder->getDrupalRoot();
 
         $builder = $this->getContainerBuilder();
         $builder->parameters['drupalRoot'] = $this->drupalRoot;
@@ -99,7 +80,7 @@ public function loadConfiguration(): void
         $extensionDiscovery = new ExtensionDiscovery($this->drupalRoot);
         $extensionDiscovery->setProfileDirectories([]);
         $profiles = $extensionDiscovery->scan('profile');
-        $profile_directories = array_map(function ($profile) {
+        $profile_directories = array_map(function (\PHPStan\Drupal\Extension $profile) : string {
             return $profile->getPath();
         }, $profiles);
         $extensionDiscovery->setProfileDirectories($profile_directories);
@@ -139,8 +120,13 @@ public function loadConfiguration(): void
                 // Prevent \Nette\DI\ContainerBuilder::completeStatement from array_walk_recursive into the arguments
                 // and thinking these are real services for PHPStan's container.
                 if (isset($serviceDefinition['arguments']) && is_array($serviceDefinition['arguments'])) {
-                    array_walk($serviceDefinition['arguments'], function (&$argument) {
-                        $argument = str_replace('@', '', $argument);
+                    array_walk($serviceDefinition['arguments'], function (&$argument) : void {
+                        if (is_array($argument)) {
+                            // @todo fix for @http_kernel.controller.argument_metadata_factory
+                            $argument = '';
+                        } else {
+                            $argument = str_replace('@', '', $argument);
+                        }
                     });
                 }
                 unset($serviceDefinition['tags']);
diff --git a/src/Drupal/Bootstrap.php b/src/Drupal/Bootstrap.php
@@ -2,7 +2,7 @@
 
 namespace PHPStan\Drupal;
 
-use Composer\Autoload\ClassLoader;
+use DrupalFinder\DrupalFinder;
 use Nette\Utils\Finder;
 
 class Bootstrap
@@ -15,11 +15,6 @@ class Bootstrap
         'themes' => [],
     ];
 
-    /**
-     * @var string
-     */
-    private $autoloaderPath;
-
     /**
      * @var \Composer\Autoload\ClassLoader
      */
@@ -55,7 +50,7 @@ class Bootstrap
     private $themes = [];
 
     /**
-     * @var \PHPStan\Drupal\ExtensionDiscovery
+     * @var ?\PHPStan\Drupal\ExtensionDiscovery
      */
     private $extensionDiscovery;
 
@@ -66,34 +61,15 @@ class Bootstrap
 
     public function register(): void
     {
-
-        $this->autoloaderPath = $GLOBALS['autoloaderInWorkingDirectory'];
-        /** @noinspection PhpIncludeInspection */
-        $this->autoloader = require $this->autoloaderPath;
-        if (!$this->autoloader instanceof ClassLoader) {
-            throw new \InvalidArgumentException('Unable to determine the Composer class loader for Drupal');
-        }
-        $realpath = realpath($this->autoloaderPath);
-        if ($realpath === false) {
-            throw new \InvalidArgumentException('Cannot determine the realpath of the autoloader.');
-        }
-        $project_root = dirname($realpath, 2);
-        if (is_dir($project_root . '/core')) {
-            $this->drupalRoot = $project_root;
-        }
-        foreach (['web', 'docroot'] as $possible_docroot) {
-            if (is_dir("$project_root/$possible_docroot/core")) {
-                $this->drupalRoot = "$project_root/$possible_docroot";
-            }
-        }
-        if ($this->drupalRoot === null) {
-            throw new \InvalidArgumentException('Unable to determine the Drupal root');
-        }
+        $finder = new DrupalFinder();
+        $finder->locateRoot(getcwd());
+        $this->autoloader = include $finder->getVendorDir() . '/autoload.php';
+        $this->drupalRoot = $finder->getDrupalRoot();
 
         $this->extensionDiscovery = new ExtensionDiscovery($this->drupalRoot);
         $this->extensionDiscovery->setProfileDirectories([]);
         $profiles = $this->extensionDiscovery->scan('profile');
-        $profile_directories = array_map(function ($profile) {
+        $profile_directories = array_map(function (\PHPStan\Drupal\Extension $profile) : string {
             return $profile->getPath();
         }, $profiles);
         $this->extensionDiscovery->setProfileDirectories($profile_directories);
diff --git a/src/Drupal/Extension.php b/src/Drupal/Extension.php
@@ -37,7 +37,7 @@ class Extension
      *
      * Note that SplFileInfo is a PHP resource and resources cannot be serialized.
      *
-     * @var \SplFileInfo
+     * @var ?\SplFileInfo
      */
     protected $splFileInfo;
 
@@ -51,12 +51,12 @@ class Extension
     /**
      * @var string
      */
-    public $subpath;
+    public $subpath = '';
 
     /**
      * @var string
      */
-    public $origin;
+    public $origin = '';
 
     /**
      * Constructs a new Extension object.
@@ -139,6 +139,8 @@ public function getExtensionPathname(): ?string
         if ($this->filename !== null) {
             return $this->getPath() . '/' . $this->filename;
         }
+
+        return null;
     }
 
     /**
diff --git a/src/Drupal/ExtensionDiscovery.php b/src/Drupal/ExtensionDiscovery.php
@@ -197,7 +197,7 @@ protected function filterByProfileDirectories(array $all_files)
             return $all_files;
         }
 
-        $all_files = array_filter($all_files, function ($file) {
+        $all_files = array_filter($all_files, function (\PHPStan\Drupal\Extension $file) : bool {
             if (strpos($file->subpath, 'profiles') !== 0) {
                 // This extension doesn't belong to a profile, ignore it.
                 return true;
@@ -358,6 +358,13 @@ protected function scanDirectory($dir): array
                 continue;
             }
 
+            // This test module has a function declaration that conflicts with another module. Explicitly skip it.
+            // @see https://www.drupal.org/project/drupal/issues/3020142
+            // @todo remove when Drupal core fixed.
+            if ($fileinfo->getBasename('.info.yml') === 'no_transitions_css') {
+                continue;
+            }
+
             // Determine extension type from info file.
             $type = false;
             $file = $fileinfo->openFile('r');
diff --git a/src/Drupal/ServiceMap.php b/src/Drupal/ServiceMap.php
@@ -13,6 +13,8 @@ class ServiceMap
      */
     public function __construct(array $drupalServices)
     {
+        $this->services = [];
+
         foreach ($drupalServices as $serviceId => $serviceDefinition) {
             // @todo support factories
             if (!isset($serviceDefinition['class'])) {
diff --git a/src/Rules/Classes/EnhancedRequireParentConstructCallRule.php b/src/Rules/Classes/EnhancedRequireParentConstructCallRule.php
@@ -31,11 +31,13 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        $scopeClassReflection = $scope->getClassReflection();
+
         // Provides specific handling for Drupal instances where not calling the parent __construct is "okay."
-        if ($scope->getClassReflection() === null) {
+        if ($scopeClassReflection === null) {
             throw new ShouldNotHappenException();
         }
-        $classReflection = $scope->getClassReflection()->getNativeReflection();
+        $classReflection = $scopeClassReflection->getNativeReflection();
         if (!$classReflection->isInterface()
             && !$classReflection->isAnonymous()
             && $classReflection->implementsInterface('Drupal\Component\Plugin\PluginManagerInterface')
diff --git a/src/Rules/Drupal/GlobalDrupalDependencyInjectionRule.php b/src/Rules/Drupal/GlobalDrupalDependencyInjectionRule.php
@@ -26,7 +26,8 @@ public function processNode(Node $node, Scope $scope): array
         if (!$scope->isInClass() && !$scope->isInTrait()) {
             return [];
         }
-        if ($scope->getClassReflection() === null) {
+        $scopeClassReflection = $scope->getClassReflection();
+        if ($scopeClassReflection === null) {
             throw new ShouldNotHappenException();
         }
 
@@ -37,19 +38,27 @@ public function processNode(Node $node, Scope $scope): array
             'Drupal\Core\Render\Element\ElementInterface',
             'Drupal\Core\Render\Element\FormElementInterface',
             'Drupal\config_translation\FormElement\ElementInterface',
+            // Entities don't use services for now
+            // @see https://www.drupal.org/project/drupal/issues/2913224
+            'Drupal\Core\Entity\EntityInterface',
         ];
-        $classReflection = $scope->getClassReflection()->getNativeReflection();
+        $classReflection = $scopeClassReflection->getNativeReflection();
         foreach ($whitelist as $item) {
             if ($classReflection->implementsInterface($item)) {
                 return [];
             }
         }
 
-        if ($scope->getFunctionName() === null || !($scope->getFunction() instanceof MethodReflection)) {
+        if ($scope->getFunctionName() === null) {
+            throw new ShouldNotHappenException();
+        }
+
+        $scopeFunction = $scope->getFunction();
+        if (!($scopeFunction instanceof MethodReflection)) {
             throw new ShouldNotHappenException();
         }
         // Static methods have to invoke \Drupal.
-        if ($scope->getFunction()->isStatic()) {
+        if ($scopeFunction->isStatic()) {
             return [];
         }
 
diff --git a/src/Rules/Drupal/PluginManager/PluginManagerSetsCacheBackendRule.php b/src/Rules/Drupal/PluginManager/PluginManagerSetsCacheBackendRule.php
@@ -36,11 +36,13 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        if ($scope->getClassReflection() === null) {
+        $scopeClassReflection = $scope->getClassReflection();
+
+        if ($scopeClassReflection === null) {
             throw new ShouldNotHappenException();
         }
 
-        $classReflection = $scope->getClassReflection()->getNativeReflection();
+        $classReflection = $scopeClassReflection->getNativeReflection();
 
         if (!$this->isPluginManager($classReflection)) {
             return [];
@@ -71,6 +73,7 @@ public function processNode(Node $node, Scope $scope): array
                     $cacheTags = $setCacheBackendArgs[2]->value;
                     if (count($cacheTags->items) > 0) {
                         $hasCacheTags = true;
+                        /** @var \PhpParser\Node\Expr\ArrayItem $item */
                         foreach ($cacheTags->items as $item) {
                             if (($item->value instanceof Node\Scalar\String_) &&
                                 strpos($item->value->value, $cacheKey->value) === false) {
diff --git a/tests/fixtures/drupal-phpstan.neon b/tests/fixtures/drupal-phpstan.neon
@@ -0,0 +1,7 @@
+parameters:
+	excludes_analyse:
+		- *Test.php
+		- *TestBase.php
+	level: 0
+includes:
+	- vendor/mglaman/phpstan-drupal/extension.neon

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@ class ServiceMap`
`13`	`13`	`*/`
`14`	`14`	`public function __construct(array $drupalServices)`
`15`	`15`	`{`
	`16`	`+ $this->services = [];`
	`17`	`+`
`16`	`18`	`foreach ($drupalServices as $serviceId => $serviceDefinition) {`
`17`	`19`	`// @todo support factories`
`18`	`20`	`if (!isset($serviceDefinition['class'])) {`