Upgrade to webflo/drupal-finder 1.3 (#790)

* Upgrade to webflo/drupal-finder 1.3

* Fix phpstan error

* Remove realpath

* Fix AccessCheckImpossibleTypeCallRuleTest

* Remove drupal_root from tests

* Remove drupal_root from schema

* Init drupal_root with null

* Add deprecation message for drupal_root

* Fix docs

* Update DrupalAutoloader.php

* Update DrupalAutoloader.php

* drop isset

* remove README.md section about drupal_root

---------

Co-authored-by: Matt Glaman <[email protected]>

Author: webflo

README.md

@@ -104,26 +104,6 @@ parameters:
             classExtendsInternalClassRule: false
 ```
 
-### Specifying your Drupal project's root
-
-By default, the PHPStan Drupal extension will try to determine your Drupal project's root directory based on the working
-directory that PHPStan is checking. If this is not working properly, you can explicitly define the Drupal project's root
-directory using the `drupal.drupal_root` parameter.
-
-```
-parameters:
-	drupal:
-		drupal_root: /path/to/drupal
-```
-
-You can also use container parameters. For instance you can always set it to the current working directory.
-
-```
-parameters:
-	drupal:
-		drupal_root: %currentWorkingDirectory%
-```
-
 ### Entity storage mappings.
 
 The `EntityTypeManagerGetStorageDynamicReturnTypeExtension` service helps map dynamic return types. This inspects the

composer.json

@@ -15,7 +15,7 @@
         "phpstan/phpstan-deprecation-rules": "^1.1.4",
         "symfony/finder": "^4.2 || ^5.0 || ^6.0 || ^7.0",
         "symfony/yaml": "^4.2|| ^5.0 || ^6.0 || ^7.0",
-        "webflo/drupal-finder": "^1.2"
+        "webflo/drupal-finder": "^1.3.1"
     },
     "require-dev": {
         "behat/mink": "^1.8",

extension.neon

@@ -16,7 +16,7 @@ parameters:
 	scanFiles:
 		- stubs/Twig/functions.stub
 	drupal:
-		drupal_root: '%currentWorkingDirectory%'
+		drupal_root: ~
 		bleedingEdge:
 			checkDeprecatedHooksInApiFiles: false
 			checkCoreDeprecatedHooksInApiFiles: false
@@ -241,7 +241,7 @@ parameters:
 
 parametersSchema:
 	drupal: structure([
-		drupal_root: string()
+		drupal_root: schema(string(), nullable())
 		bleedingEdge: structure([
 			checkDeprecatedHooksInApiFiles: boolean()
 			checkCoreDeprecatedHooksInApiFiles: boolean()

src/Drupal/DrupalAutoloader.php

@@ -6,7 +6,7 @@
 use Drupal\Core\DependencyInjection\ContainerNotInitializedException;
 use Drupal\Core\DrupalKernelInterface;
 use Drupal\TestTools\PhpUnitCompatibility\PhpUnit8\ClassWriter;
-use DrupalFinder\DrupalFinder;
+use DrupalFinder\DrupalFinderComposerRuntime;
 use Drush\Drush;
 use PHPStan\DependencyInjection\Container;
 use PHPUnit\Framework\Test;
@@ -26,7 +26,6 @@
 use function is_array;
 use function is_dir;
 use function is_string;
-use function realpath;
 use function str_replace;
 use function strpos;
 use function strtr;
@@ -84,19 +83,21 @@ class DrupalAutoloader
     public function register(Container $container): void
     {
         /**
-         * @var array{drupal_root: string, bleedingEdge: array{checkDeprecatedHooksInApiFiles: bool, checkCoreDeprecatedHooksInApiFiles: bool, checkContribDeprecatedHooksInApiFiles: bool}} $drupalParams
+         * @var array{drupal_root: string|null, bleedingEdge: array{checkDeprecatedHooksInApiFiles: bool, checkCoreDeprecatedHooksInApiFiles: bool, checkContribDeprecatedHooksInApiFiles: bool}} $drupalParams
          */
         $drupalParams = $container->getParameter('drupal');
-        $drupalRoot = realpath($drupalParams['drupal_root']);
-        $finder = new DrupalFinder();
-        $finder->locateRoot($drupalRoot);
 
+        // Trigger deprecation error if drupal_root is used.
+        if (is_string($drupalParams['drupal_root'])) {
+            trigger_error('The drupal_root parameter is deprecated. Remove it from your configuration. Drupal Root is discoverd automatically.', E_USER_DEPRECATED);
+        }
+
+        $finder = new DrupalFinderComposerRuntime();
         $drupalRoot = $finder->getDrupalRoot();
         $drupalVendorRoot = $finder->getVendorDir();
         if (!(is_string($drupalRoot) && is_string($drupalVendorRoot))) {
-            throw new RuntimeException("Unable to detect Drupal at {$drupalParams['drupal_root']}");
+            throw new RuntimeException("Unable to detect Drupal with webflo/drupal-finder.");
         }
-
         $this->drupalRoot = $drupalRoot;
 
         $this->autoloader = include $drupalVendorRoot . '/autoload.php';

tests/fixtures/config/phpunit-drupal-phpstan.neon

@@ -1,6 +1,5 @@
 parameters:
 	drupal:
-		drupal_root: tests/fixtures/drupal
 		entityMapping:
 			content_entity_using_custom_storage:
 				class: Drupal\phpstan_fixtures\Entity\ContentEntityUsingCustomStorage