Merge pull request #95 from wunderio/feature/72-Re-add-code-complexity

#72 Add tomasvotruba/cognitive-complexity.

Author: hkirsman

.circleci/config.yml

@@ -3,7 +3,7 @@ jobs:
   # Install all dependencies and run check tasks.
   build_and_test:
     docker:
-      - image: cimg/php:8.1
+      - image: cimg/php:8.1.18
     steps:
       # Check out source code.
       - checkout

composer.json

@@ -45,6 +45,8 @@
         "mglaman/phpstan-drupal": "^1.1",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan-deprecation-rules": "^1.0",
+        "nette/finder": "^2.5",
+        "tomasvotruba/cognitive-complexity": "^0.1.1",
         "webflo/drupal-finder": "^1.3"
     },
     "autoload": {

config/phpstan.neon

@@ -7,3 +7,6 @@ parameters:
 		- '#Plugin definitions cannot be altered.#'
 		- '#Missing cache backend declaration for performance.#'
 		- '#Plugin manager has cache backend specified but does not declare cache tags.#'
+	cognitive_complexity:
+		class: 50
+		function: 15

phpstan.neon

@@ -7,3 +7,6 @@ parameters:
 		- '#Plugin definitions cannot be altered.#'
 		- '#Missing cache backend declaration for performance.#'
 		- '#Plugin manager has cache backend specified but does not declare cache tags.#'
+	cognitive_complexity:
+		class: 50
+		function: 15

src/Drupal/DrupalAutoloader.php

@@ -4,7 +4,6 @@
 
 namespace Wunderio\GrumPHP\Drupal;
 
-use Drupal\Core\DependencyInjection\ContainerNotInitializedException;
 use DrupalFinder\DrupalFinderComposerRuntime;
 use Drush\Drush;
 use mglaman\PHPStanDrupal\Drupal\Extension;
@@ -18,70 +17,7 @@
  *
  * Code re-used from https://github.com/mglaman/phpstan-drupal/blob/main/src/Drupal/DrupalAutoloader.php.
  */
-class DrupalAutoloader {
-
-  /**
-   * Drupal autoloader.
-   *
-   * @var \Composer\Autoload\ClassLoader
-   */
-  private $autoloader;
-
-  /**
-   * Path to Drupal root.
-   *
-   * @var string
-   */
-  private $drupalRoot;
-
-  /**
-   * List of available modules.
-   *
-   * @var array
-   */
-  protected $moduleData = [];
-
-  /**
-   * List of available themes.
-   *
-   * @var array
-   */
-  protected $themeData = [];
-
-  /**
-   * Array of Drupal service mapping.
-   *
-   * @var array
-   */
-  private $serviceMap = [];
-
-  /**
-   * Array of Drupal service yml files.
-   *
-   * @var array
-   */
-  private $serviceYamls = [];
-
-  /**
-   * Array of service class providers.
-   *
-   * @var array
-   */
-  private $serviceClassProviders = [];
-
-  /**
-   * ExtensionDiscovery object.
-   *
-   * @var \mglaman\PHPStanDrupal\Drupal\ExtensionDiscovery
-   */
-  private $extensionDiscovery;
-
-  /**
-   * Array of Drupal namespaces.
-   *
-   * @var array
-   */
-  private $namespaces = [];
+class DrupalAutoloader extends DrupalAutoloaderBase {
 
   /**
    * Load in Drupal code from defined path.
@@ -142,6 +78,32 @@ public function register(string $drupalRoot): void {
       }
     }
 
+    $this->registerIncludeModuleFiles();
+    $this->registerIncludeThemeFiles();
+
+    if (class_exists(Drush::class)) {
+      $reflect = new \ReflectionClass(Drush::class);
+      if ($reflect->getFileName() !== FALSE) {
+        $levels = 2;
+        if (Drush::getMajorVersion() < 9) {
+          $levels = 3;
+        }
+        $drushDir = dirname($reflect->getFileName(), $levels);
+        /** @var \SplFileInfo $file */
+        foreach (Finder::findFiles('*.inc')->in($drushDir . '/includes') as $file) {
+          // phpcs:ignore PHPCS_SecurityAudit.Misc.IncludeMismatch.ErrMiscIncludeMismatchNoExt
+          require_once $file->getPathname();
+        }
+      }
+    }
+
+    $this->registerIncludeServicesFromYamls();
+  }
+
+  /**
+   * Helper for register() method to include module files.
+   */
+  private function registerIncludeModuleFiles() {
     foreach ($this->moduleData as $extension) {
       $this->loadExtension($extension);
 
@@ -176,6 +138,12 @@ public function register(string $drupalRoot): void {
         }
       }
     }
+  }
+
+  /**
+   * Helper for register() method to include theme files.
+   */
+  private function registerIncludeThemeFiles() {
     foreach ($this->themeData as $extension) {
       $this->loadExtension($extension);
       $theme_dir = $this->drupalRoot . '/' . $extension->getPath();
@@ -184,23 +152,14 @@ public function register(string $drupalRoot): void {
         $this->loadAndCatchErrors($theme_settings_file);
       }
     }
+  }
 
-    if (class_exists(Drush::class)) {
-      $reflect = new \ReflectionClass(Drush::class);
-      if ($reflect->getFileName() !== FALSE) {
-        $levels = 2;
-        if (Drush::getMajorVersion() < 9) {
-          $levels = 3;
-        }
-        $drushDir = dirname($reflect->getFileName(), $levels);
-        /** @var \SplFileInfo $file */
-        foreach (Finder::findFiles('*.inc')->in($drushDir . '/includes') as $file) {
-          // phpcs:ignore PHPCS_SecurityAudit.Misc.IncludeMismatch.ErrMiscIncludeMismatchNoExt
-          require_once $file->getPathname();
-        }
-      }
-    }
-
+  /**
+   * Helper for register() method to include services.
+   *
+   * @todo Fix this method not being properly used - see https://github.com/wunderio/code-quality/issues/96 for more info.
+   */
+  private function registerIncludeServicesFromYamls() {
     foreach ($this->serviceYamls as $extension => $serviceYaml) {
       $yaml = Yaml::parseFile($serviceYaml);
       // Weed out service files which only provide parameters.
@@ -245,147 +204,4 @@ public function register(string $drupalRoot): void {
     }
   }
 
-  /**
-   * Load legacy includes.
-   */
-  protected function loadLegacyIncludes(): void {
-    /** @var \SplFileInfo $file */
-    foreach (Finder::findFiles('*.inc')->in($this->drupalRoot . '/core/includes') as $file) {
-      // phpcs:ignore PHPCS_SecurityAudit.Misc.IncludeMismatch.ErrMiscIncludeMismatchNoExt
-      require_once $file->getPathname();
-    }
-  }
-
-  /**
-   * Add core test namespaces.
-   */
-  protected function addTestNamespaces(): void {
-    $core_tests_dir = $this->drupalRoot . '/core/tests/Drupal';
-    $this->namespaces['Drupal\\BuildTests'] = $core_tests_dir . '/BuildTests';
-    $this->namespaces['Drupal\\FunctionalJavascriptTests'] = $core_tests_dir . '/FunctionalJavascriptTests';
-    $this->namespaces['Drupal\\FunctionalTests'] = $core_tests_dir . '/FunctionalTests';
-    $this->namespaces['Drupal\\KernelTests'] = $core_tests_dir . '/KernelTests';
-    $this->namespaces['Drupal\\Tests'] = $core_tests_dir . '/Tests';
-    $this->namespaces['Drupal\\TestSite'] = $core_tests_dir . '/TestSite';
-    $this->namespaces['Drupal\\TestTools'] = $core_tests_dir . '/TestTools';
-    $this->namespaces['Drupal\\Tests\\TestSuites'] = $this->drupalRoot . '/core/tests/TestSuites';
-  }
-
-  /**
-   * Add Drupal module namespaces.
-   */
-  protected function addModuleNamespaces(): void {
-    foreach ($this->moduleData as $module) {
-      $module_name = $module->getName();
-      $module_dir = $this->drupalRoot . '/' . $module->getPath();
-      $this->namespaces["Drupal\\$module_name"] = $module_dir . '/src';
-
-      // Extensions can have a \Drupal\Tests\extension namespace for test
-      // cases, traits, and other classes such
-      // as those that extend \Drupal\TestSite\TestSetupInterface.
-      // @see drupal_phpunit_get_extension_namespaces()
-      $module_test_dir = $module_dir . '/tests/src';
-      if (is_dir($module_test_dir)) {
-        $this->namespaces["Drupal\\Tests\\$module_name"] = $module_test_dir;
-      }
-
-      $servicesFileName = $module_dir . '/' . $module_name . '.services.yml';
-      if (file_exists($servicesFileName)) {
-        $this->serviceYamls[$module_name] = $servicesFileName;
-      }
-      $camelized = $this->camelize($module_name);
-      $name = "{$camelized}ServiceProvider";
-      $class = "Drupal\\{$module_name}\\{$name}";
-
-      $this->serviceClassProviders[$module_name] = $class;
-      $serviceId = "service_provider.$module_name.service_provider";
-      $this->serviceMap[$serviceId] = ['class' => $class];
-    }
-  }
-
-  /**
-   * Add Drupal theme namespaces.
-   */
-  protected function addThemeNamespaces(): void {
-    foreach ($this->themeData as $theme_name => $theme) {
-      $theme_dir = $this->drupalRoot . '/' . $theme->getPath();
-      $this->namespaces["Drupal\\$theme_name"] = $theme_dir . '/src';
-    }
-  }
-
-  /**
-   * Register PS4 namespaces.
-   *
-   * @param array $namespaces
-   *   An array of namespaces to load.
-   */
-  protected function registerPs4Namespaces(array $namespaces): void {
-    foreach ($namespaces as $prefix => $paths) {
-      if (is_array($paths)) {
-        foreach ($paths as $key => $value) {
-          $paths[$key] = $value;
-        }
-      }
-      $this->autoloader->addPsr4($prefix . '\\', $paths);
-    }
-  }
-
-  /**
-   * Loads in extensions (modules, themes, etc).
-   *
-   * Wrapper for \mglaman\PHPStanDrupal\Drupal\Extension->load().
-   *
-   * @param \mglaman\PHPStanDrupal\Drupal\Extension $extension
-   *   Extension object.
-   */
-  protected function loadExtension(Extension $extension): void {
-    try {
-      $extension->load();
-    }
-    catch (\Throwable $e) {
-      // Something prevented the extension file from loading.
-      // This can happen when drupal_get_path or drupal_get_filename are used
-      // outside the scope of a function.
-    }
-  }
-
-  /**
-   * Wrapper for require_once() that catches errors.
-   *
-   * @param string $path
-   *   Path to file.
-   */
-  protected function loadAndCatchErrors(string $path): void {
-    try {
-      // phpcs:ignore PHPCS_SecurityAudit.Misc.IncludeMismatch.ErrMiscIncludeMismatchNoExt
-      require_once $path;
-    }
-    catch (ContainerNotInitializedException $e) {
-      $path = str_replace(dirname($this->drupalRoot) . '/', '', $path);
-      // This can happen when drupal_get_path or drupal_get_filename are used
-      // outside the scope of a function.
-      @trigger_error("$path invoked the Drupal container outside of the scope of a function or class method. It was not loaded.", E_USER_WARNING);
-    }
-    catch (\Throwable $e) {
-      $path = str_replace(dirname($this->drupalRoot) . '/', '', $path);
-      // Something prevented the extension file from loading.
-      @trigger_error("$path failed loading due to {$e->getMessage()}", E_USER_WARNING);
-    }
-  }
-
-  /**
-   * Camelizes a string.
-   *
-   * @todo Should we use method from Symfony\Component\DependencyInjection\Container instead?
-   *
-   * @param string $id
-   *   A string to camelize.
-   *
-   * @return string
-   *   The camelized string.
-   */
-  protected function camelize(string $id): string {
-    return strtr(ucwords(strtr($id, ['_' => ' ', '.' => '_ ', '\\' => '_ '])), [' ' => '']);
-  }
-
 }