Merge branch 'develop' into feature/GOVCMSCT2-121

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

@@ -865,6 +865,101 @@ function civictheme_post_update_update_editor_allowed_field(): string {
   return (string) new TranslatableMarkup('Allowed tags setting not set, aborting update.');
 }
 
+/**
+ * Update civictheme_side_navigation to use civictheme_sidebar_navigation.
+ *
+ * @SuppressWarnings(PHPMD.StaticAccess)
+ */
+function civictheme_post_update_update_sidebar_navigation_suggestion(): string {
+  $config_factory = \Drupal::configFactory();
+  $editable = $config_factory->getEditable('block.block.civictheme_side_navigation');
+  if ($editable->isNew()) {
+    return 'Sidebar navigation block config does not exist.';
+  }
+  $settings = $editable->get('settings') ?? [];
+  if (empty($settings['suggestion']) || $settings['suggestion'] !== 'civictheme_sidebar_navigation') {
+    $settings['suggestion'] = 'civictheme_sidebar_navigation';
+    $editable->set('settings', $settings);
+    $editable->save();
+    return 'Updated civictheme_side_navigation block to use civictheme_sidebar_navigation suggestion.';
+  }
+  return 'No update needed for civictheme_side_navigation block.';
+}
+
+/**
+ * Add civictheme_message paragraph type and enable it for civictheme page.
+ *
+ * @SuppressWarnings(PHPMD.StaticAccess)
+ */
+function civictheme_post_update_add_civictheme_message_paragraph(): string {
+  $new_configs = [
+    // Paragraph type definition.
+    'paragraphs.paragraphs_type.civictheme_message' => 'paragraphs_type',
+    'field.storage.paragraph.field_c_p_message_type' => 'field_storage_config',
+    'field.field.paragraph.civictheme_message.field_c_p_background' => 'field_config',
+    'field.field.paragraph.civictheme_message.field_c_p_content' => 'field_config',
+    'field.field.paragraph.civictheme_message.field_c_p_message_type' => 'field_config',
+    'field.field.paragraph.civictheme_message.field_c_p_theme' => 'field_config',
+    'field.field.paragraph.civictheme_message.field_c_p_title' => 'field_config',
+    'field.field.paragraph.civictheme_message.field_c_p_vertical_spacing' => 'field_config',
+    'core.entity_form_display.paragraph.civictheme_message.default' => 'entity_form_display',
+    'core.entity_view_display.paragraph.civictheme_message.default' => 'entity_view_display',
+  ];
+
+  $config_path = \Drupal::service('extension.list.theme')->getPath('civictheme') . '/config/install';
+  \Drupal::classResolver(CivicthemeUpdateHelper::class)->createConfigs($new_configs, $config_path);
+
+  // Enable civictheme_message for civictheme_page.
+  $field_config_name = 'field.field.node.civictheme_page.field_c_n_components';
+  $field_config = \Drupal::configFactory()->getEditable($field_config_name);
+
+  if (!$field_config->isNew()) {
+    $handler_settings = $field_config->get('settings.handler_settings') ?: [];
+    // Ensure target_bundles exists.
+    if (!isset($handler_settings['target_bundles'])) {
+      $handler_settings['target_bundles'] = [];
+    }
+    $handler_settings['target_bundles']['civictheme_message'] = 'civictheme_message';
+
+    // Ensure target_bundles_drag_drop exists.
+    if (!isset($handler_settings['target_bundles_drag_drop'])) {
+      $handler_settings['target_bundles_drag_drop'] = [];
+    }
+    $handler_settings['target_bundles_drag_drop']['civictheme_message'] = [
+      'weight' => -52,
+      'enabled' => TRUE,
+    ];
+
+    $field_config->set('settings.handler_settings', $handler_settings);
+    $field_config->save();
+  }
+
+  return (string) new TranslatableMarkup('Added civictheme_message paragraph type and enabled it for civictheme page.');
+}
+
+/**
+ * Update the field description for field_c_p_background.
+ */
+function civictheme_post_update_update_field_c_p_background_description(): string {
+  $field_configs = [
+    'field.field.paragraph.civictheme_accordion.field_c_p_background',
+    'field.field.paragraph.civictheme_content.field_c_p_background',
+    'field.field.paragraph.civictheme_map.field_c_p_background',
+    'field.field.paragraph.civictheme_promo.field_c_p_background',
+    'field.field.paragraph.civictheme_webform.field_c_p_background',
+  ];
+  foreach ($field_configs as $field_config_name) {
+    $field_config = \Drupal::configFactory()->getEditable($field_config_name);
+
+    if (!$field_config->isNew()) {
+      $field_config->set('description', 'Apply a themed background colour and provide horizontal spacing to the component');
+      $field_config->save();
+    }
+  }
+
+  return (string) new TranslatableMarkup('Updated field description for field_c_p_background.');
+}
+
 /**
  * Add civictheme_fast_fact_card paragraph type and enable it for manual list.
  *

web/themes/contrib/civictheme/civictheme.post_update.php

@@ -45,6 +45,7 @@ require_once __DIR__ . '/includes/primary_navigation.inc';
 require_once __DIR__ . '/includes/promo.inc';
 require_once __DIR__ . '/includes/search.inc';
 require_once __DIR__ . '/includes/secondary_navigation.inc';
+require_once __DIR__ . '/includes/sidebar_navigation.inc';
 require_once __DIR__ . '/includes/system_main_block.inc';
 require_once __DIR__ . '/includes/site_section.inc';
 require_once __DIR__ . '/includes/skip_link.inc';
@@ -214,7 +215,6 @@ function civictheme_preprocess_block(array &$variables): void {
   _civictheme_preprocess_block__system_main_block($variables);
   _civictheme_preprocess_block__civictheme_banner($variables);
   _civictheme_preprocess_block__navigation($variables);
-  _civictheme_preprocess_block__civictheme_footer_menu($variables);
   _civictheme_preprocess_block__content($variables);
   _civictheme_preprocess_block__civictheme_mobile_navigation($variables);
   _civictheme_preprocess_block__civictheme_social_links($variables);

web/themes/contrib/civictheme/civictheme.theme

@@ -76,6 +76,10 @@ settings:
         - '<figure class data-component-id>'
         - '<div class>'
         - '<iframe width height src title allowfullscreen>'
+        - '<video controls class width height>'
+        - '<source src type>'
+        - '<a hreflang target title data-dialog-type data-dialog-options class="ct-content-link ct-content-link--external use-ajax ct-button--button ct-button--prompt ct-button--link ct-promo__button ct-theme-dark">'
+        - '<table class="ct-theme-dark">'
     ckeditor5_style:
       styles:
         -

web/themes/contrib/civictheme/config/install/editor.editor.civictheme_rich_text.yml

@@ -9,7 +9,7 @@ field_name: field_c_p_background
 entity_type: paragraph
 bundle: civictheme_accordion
 label: Background
-description: 'Apply a themed background color and provide horizontal spacing to the component'
+description: 'Apply a themed background colour and provide horizontal spacing to the component'
 required: false
 translatable: true
 default_value:

web/themes/contrib/civictheme/config/install/field.field.paragraph.civictheme_accordion.field_c_p_background.yml

@@ -9,7 +9,7 @@ field_name: field_c_p_background
 entity_type: paragraph
 bundle: civictheme_content
 label: Background
-description: 'Apply a themed background color and provide horizontal spacing to the component'
+description: 'Apply a themed background colour and provide horizontal spacing to the component'
 required: false
 translatable: false
 default_value:

web/themes/contrib/civictheme/config/install/field.field.paragraph.civictheme_content.field_c_p_background.yml

@@ -9,7 +9,7 @@ field_name: field_c_p_background
 entity_type: paragraph
 bundle: civictheme_map
 label: Background
-description: 'Apply a themed background color and provide horizontal spacing to the component'
+description: 'Apply a themed background colour and provide horizontal spacing to the component'
 required: false
 translatable: true
 default_value:

web/themes/contrib/civictheme/config/install/field.field.paragraph.civictheme_map.field_c_p_background.yml

@@ -9,7 +9,7 @@ field_name: field_c_p_background
 entity_type: paragraph
 bundle: civictheme_message
 label: Background
-description: 'Apply a themed background color and provide horizontal spacing to the component'
+description: 'Apply a themed background colour and provide horizontal spacing to the component'
 required: false
 translatable: false
 default_value: