Merge pull request #14 from OSInet/12-orphans

Implement taxonomy_index integrity check

Author: fgm

README.md

@@ -62,8 +62,8 @@ typically by piping the output like this:
     <td>OK</td>
     </tr>
   <tr>
-    <td>References</td>
-    <td>References</td>
+    <td rowspan="2">References</td>
+    <td>Integrity</td>
     <td>OK:<ul>
     <li>file</li>
     <li>image</li>
@@ -74,6 +74,12 @@ typically by piping the output like this:
     <td></td>
     <td></td>
     </tr>
+  <tr>
+    <td>Taxonomy Index</td>
+    <td>OK</td>
+    <td></td>
+    <td>OK</td>
+    </tr>
   <tr>
     <td rowspan="3">System</td>
     <td>Dependency (graph)</td>
@@ -94,18 +100,12 @@ typically by piping the output like this:
     <td></td>
     </tr>
   <tr>
-    <td rowspan="2">Taxonomy</td>
+    <td>Taxonomy</td>
     <td>Freetagging</td>
     <td>Planned</td>
     <td></td>
     <td>OK</td>
     </tr>
-  <tr>
-    <td>Orphans</td>
-    <td>Planned</td>
-    <td></td>
-    <td>OK</td>
-    </tr>
   <tr>
     <td>Variables</td>
     <td>Size</td>

composer.json

@@ -18,6 +18,7 @@
     "name": "osinet/qa",
     "require": {
         "php": ">=7.3",
+        "drupal/core": "^8 || ^9",
         "osinet/grafizzi": "^0.0.2"
     },
     "type": "drupal-module"

src/Commands/QaCommands.php

@@ -6,6 +6,7 @@
 
 use Drupal\qa\Controller\WorkflowsReportController;
 use Drupal\qa\Plugin\QaCheck\References\Integrity;
+use Drupal\qa\Plugin\QaCheck\References\TaxonomyIndex;
 use Drupal\qa\Plugin\QaCheck\System\UnusedExtensions;
 use Drupal\qa\Plugin\QaCheckManager;
 use Drupal\qa\Workflows\ContentModerationGraph;
@@ -97,14 +98,15 @@ public function dependencies() {
   }
 
   /**
-   * Show broken entity_reference fields.
+   * Command helper: runs a QaCheck plugin and display its results.
    *
-   * @command qa:references:integrity
+   * @param string $name
+   *   The plugin name.
    *
    * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
-  public function referencesIntegrity() {
-    $check = $this->qam->createInstance(Integrity::NAME);
+  public function runPlugin(string $name): void {
+    $check = $this->qam->createInstance($name);
     $pass = $check->run();
     $res = [
       'age' => $pass->life->age(),
@@ -121,6 +123,28 @@ public function referencesIntegrity() {
     $this->output->writeln(Yaml::dump($res, 5, 2));
   }
 
+  /**
+   * Show broken entity_reference fields.
+   *
+   * @command qa:references:integrity
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
+   */
+  public function referencesIntegrity() {
+    $this->runPlugin(Integrity::NAME);
+  }
+
+  /**
+   * Show broken taxonomy_index data.
+   *
+   * @command qa:references:taxonomy_index
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
+   */
+  public function referencesTaxonomyIndex() {
+    $this->runPlugin(TaxonomyIndex::NAME);
+  }
+
   /**
    * Show projects entirely unused and unused themes.
    *
@@ -129,21 +153,7 @@ public function referencesIntegrity() {
    * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function systemUnused() {
-    $check = $this->qam->createInstance(UnusedExtensions::NAME);
-    $pass = $check->run();
-    $res = [
-      'age' => $pass->life->age(),
-      'ok' => $pass->ok,
-      'result' => [],
-    ];
-    /** @var \Drupal\qa\Result $result */
-    foreach ($pass->result as $key => $result) {
-      $res['result'][$key] = [
-        'ok' => $result->ok,
-        'data' => $result->data,
-      ];
-    }
-    $this->output->writeln(Yaml::dump($res, 4, 2));
+    $this->runPlugin(UnusedExtensions::NAME);
   }
 
   /**

src/Controller/ResultsReportController.php

@@ -1,13 +1,13 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace Drupal\qa\Controller;
 
 use Drupal\Core\Controller\ControllerBase;
 
 /**
  * Class ResultsReportController.
- *
- * @package Drupal\qa\Controller
  */
 class ResultsReportController extends ControllerBase {
 
@@ -24,6 +24,15 @@ public function report() {
     ];
   }
 
+  /**
+   * Placeholder controller for "results".
+   *
+   * @param string $qaVariable
+   *   The variable name.
+   *
+   * @return array
+   *   A render array.
+   */
   public function view($qaVariable) {
     return [
       '#type' => 'markup',

src/Exportable.php

@@ -2,7 +2,10 @@
 
 namespace Drupal\qa;
 
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+
 abstract class Exportable {
+  use StringTranslationTrait;
 
   /**
    * The directory containing the file containing this class.

src/Plugin/Qa/Control/Cache/Package.php

@@ -1,34 +1,22 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace Drupal\qa\Cache;
 
 use Drupal\qa\BasePackage;
 
 /**
- * @file
- * OSInet QA Plugin for cache checks.
- *
- * @copyright Copyright (C) 2014 Frederic G. MARAND for Ouest Systèmes Informatiques (OSInet)
- *
- * @since DRUPAL-7
- *
- * @license Licensed under the disjunction of the CeCILL, version 2 and General Public License version 2 and later
- *
- * License note: QA is distributed by OSInet to its customers under the
- * CeCILL 2.0 license. OSInet support services only apply to the module
- * when distributed by OSInet, not by any third-party further down the
- * distribution chain.
- *
- * If you obtained QA from drupal.org, that site received it under the
- * GPLv2 license and can therefore distribute it under the GPLv2, and
- * so can you and just anyone down the chain as long as the GPLv2 terms
- * are abided by, the module distributor in that case being the
- * drupal.org organization or the downstream distributor, not OSInet.
+ * OSInet QA Plugin for cache check.
  */
-
 class Package extends BasePackage {
+
+  /**
+   * {@inheritdoc}
+   */
   public function init() {
-    $this->title = t('Cache');
-    $this->description = t('Look for suspicious content in database cache. Do NOT use with other cache types.');
+    $this->title = $this->t('Cache');
+    $this->description = $this->t('Look for suspicious content in database cache. Do NOT use with other cache types.');
   }
+
 }

src/Plugin/Qa/Control/I18n/Package.php

@@ -1,33 +1,22 @@
 <?php
-/**
- * @file
- * OSInet QA Plugin for i18n (internationalization) module
- *
- * @copyright Copyright (C) 2011 Frederic G. MARAND for Ouest Systèmes Informatiques (OSInet)
- *
- * @since DRUPAL-6
- *
- * @license Licensed under the disjunction of the CeCILL, version 2 and General Public License version 2 and later
- *
- * License note: QA is distributed by OSInet to its customers under the
- * CeCILL 2.0 license. OSInet support services only apply to the module
- * when distributed by OSInet, not by any third-party further down the
- * distribution chain.
- *
- * If you obtained QA from drupal.org, that site received it under the
- * GPLv2 license and can therefore distribute it under the GPLv2, and
- * so can you and just anyone down the chain as long as the GPLv2 terms
- * are abided by, the module distributor in that case being the
- * drupal.org organization or the downstream distributor, not OSInet.
- */
+
+declare(strict_types = 1);
 
 namespace Drupal\qa\I18n;
 
 use Drupal\qa\BasePackage;
 
+/**
+ * OSInet QA Plugin for i18n (internationalization) module.
+ */
 class Package extends BasePackage {
+
+  /**
+   * {@inheritdoc}
+   */
   public function init() {
-    $this->title = t('i18n');
-    $this->description = t('Inconsistent variables translation');
+    $this->title = $this->t('i18n');
+    $this->description = $this->t('Inconsistent variables translation');
   }
+
 }

src/Plugin/Qa/Control/Taxonomy/Freetagging.php

@@ -2,10 +2,26 @@
 
 namespace Drupal\qa\Taxonomy;
 
+use Drupal\qa\BaseControl;
+
 /**
  * Find views containing PHP code
  */
-class Freetagging extends Taxonomy {
+class Freetagging extends BaseControl {
+
+  /**
+   * {@inheritdoc]
+   */
+  public function __construct() {
+    parent::__construct();
+    $this->package_name = __NAMESPACE__;
+  }
+
+  public static function getDependencies() {
+    $ret = BaseControl::getDependencies();
+    $ret = array_merge($ret, ['taxonomy']);
+    return $ret;
+  }
 
   /**
    * {@inheritdoc]