Issue #3537532 by richardgaunt, rraney, fionamorrison23, joshua1234511: Added Single Directory Component validation. (#1403)

Co-authored-by: rgaunt <[email protected]>

Author: joshua-salsadigital

package-lock.json

@@ -1,6 +1,6 @@
 {
   "dependencies": {
-    "@civictheme/uikit": "github:civictheme/uikit#fd4cbae4cf41ed780011c7e4f2366a3685561071"
+    "@civictheme/uikit": "github:civictheme/uikit#921eef60baf3dc4bd1aef23beb5c429d199e49b8"
   },
   "scripts": {
     "uikit-change": "node scripts/civictheme-uikit-version-manager/index.mjs"

package.json

@@ -279,4 +279,92 @@ protected static function loadComponentDefinitionFromFs(string $component_name):
     );
   }
 
+  /**
+   * Loads all component definitions from the civictheme components folder.
+   *
+   * @return array<int, array<mixed>>
+   *   An array of component definitions.
+   */
+  public static function loadAllComponentDefinitionsFromCivicTheme(): array {
+    $components_dir = dirname(__DIR__, 6) . '/themes/contrib/civictheme/components';
+    $definitions = [];
+    if (!is_dir($components_dir)) {
+      return $definitions;
+    }
+    foreach (new \DirectoryIterator($components_dir) as $fileinfo) {
+      if ($fileinfo->isDot() || !$fileinfo->isDir()) {
+        continue;
+      }
+      $subdir = $fileinfo->getPathname();
+      foreach (new \DirectoryIterator($subdir) as $subfileinfo) {
+        if ($subfileinfo->isDot() || !$subfileinfo->isDir()) {
+          continue;
+        }
+        $component_file = $subfileinfo->getPathname() . '/' . $subfileinfo->getFilename() . '.component.yml';
+        if (file_exists($component_file)) {
+          try {
+            $definition = Yaml::parseFile($component_file);
+            // Merge with additional required keys.
+            $component_name = $subfileinfo->getFilename();
+            $definition = array_merge(
+              $definition,
+              [
+                'machineName' => $component_name,
+                'extension_type' => 'theme',
+                'id' => 'civictheme:' . $component_name,
+                'library' => ['css' => ['component' => ['foo.css' => []]]],
+                'path' => '',
+                'provider' => 'civictheme',
+                'template' => $component_name . '.twig',
+                'group' => 'civictheme-group',
+                'description' => 'CivicTheme component',
+              ]
+            );
+            $definitions[] = $definition;
+          }
+          catch (\Exception) {
+            // Ignore invalid YAML files for this loader.
+            continue;
+          }
+        }
+      }
+    }
+    return $definitions;
+  }
+
+  /**
+   * Tests that all CivicTheme component definitions don't cause errors.
+   *
+   * @dataProvider dataProviderValidateAllCivicThemeDefinitionsValid
+   *
+   * @throws \Drupal\Core\Render\Component\Exception\InvalidComponentException
+   */
+  public function testValidateAllCivicThemeDefinitionsValid(array $definition): void {
+    $component_validator = new ComponentValidator();
+    $component_validator->setValidator();
+    $this->assertTrue(
+      $component_validator->validateDefinition($definition, TRUE),
+      sprintf(
+        'The CivicTheme component definition "%s" did not pass validation.',
+        $definition['machineName'] ?? '[unknown]'
+      )
+    );
+  }
+
+  /**
+   * Data provider with all CivicTheme component definitions.
+   *
+   * @return array<int, array<int, array<mixed>>>
+   *   The data.
+   */
+  public static function dataProviderValidateAllCivicThemeDefinitionsValid(): array {
+    $definitions = static::loadAllComponentDefinitionsFromCivicTheme();
+    $result = [];
+    foreach ($definitions as $definition) {
+      $key = $definition['machineName'] ?? uniqid('component_', TRUE);
+      $result[$key] = [$definition];
+    }
+    return $result;
+  }
+
 }

web/modules/custom/civictheme_sdc/tests/src/Unit/SingleDirectoryComponentValidatorTest.php

@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "@popperjs/core": "^2.11.8",
-    "@civictheme/uikit": "github:civictheme/uikit#fd4cbae4cf41ed780011c7e4f2366a3685561071"
+    "@civictheme/uikit": "github:civictheme/uikit#921eef60baf3dc4bd1aef23beb5c429d199e49b8"
   },
   "devDependencies": {
     "@alexskrypnyk/scss-variables-extractor": "^0.1.1",