feat(SLB-468): cardinality validator improvement

Extend the cardinality validator to ensure content of children blocks is checked, not just the count

Author: nbaosullivan

packages/@amazeelabs/silverback-gutenberg/drupal/silverback_gutenberg/src/GutenbergValidation/GutenbergCardinalityValidatorTrait.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\silverback_gutenberg\GutenbergValidation;
 
+use Drupal\Component\Utility\Html;
 use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
@@ -73,31 +74,39 @@ public function validateCardinality(array $block, array $expected_children): arr
       return $this->validateEmptyInnerBlocks($expected_children);
     }
 
-    // Count blocks, then check if the quantity for each is correct.
+    // Count blocks and keep references for additional validations.
     $countInnerBlockInstances = [];
+    $innerBlocksByName = [];
     foreach ($block['innerBlocks'] as $innerBlock) {
-      if (!isset($countInnerBlockInstances[$innerBlock['blockName']])) {
-        $countInnerBlockInstances[$innerBlock['blockName']] = 0;
+      $blockName = $innerBlock['blockName'] ?? NULL;
+      if ($blockName === NULL) {
+        continue;
       }
-      $countInnerBlockInstances[$innerBlock['blockName']]++;
+      if (!isset($countInnerBlockInstances[$blockName])) {
+        $countInnerBlockInstances[$blockName] = 0;
+      }
+      $countInnerBlockInstances[$blockName]++;
+      $innerBlocksByName[$blockName][] = $innerBlock;
     }
 
     foreach ($expected_children as $child) {
-      if (!isset($countInnerBlockInstances[$child['blockName']]) && $child['min'] > 0) {
+      $blockName = $child['blockName'];
+      $childBlocks = $innerBlocksByName[$blockName] ?? [];
+
+      if (!isset($countInnerBlockInstances[$blockName]) && $child['min'] > 0) {
         $message = $this->getExpectedQuantityErrorMessage($child);
         return [
           'is_valid' => FALSE,
           'message' => $message,
         ];
       }
       // Minimum is set to 0, so we don't care if the block is not present.
-      if (!isset($countInnerBlockInstances[$child['blockName']]) && $child['min'] === 0) {
-        return [
-          'is_valid' => TRUE,
-          'message' => '',
-        ];
+      if (!isset($countInnerBlockInstances[$blockName]) && $child['min'] === 0) {
+        continue;
       }
-      if ($countInnerBlockInstances[$child['blockName']] < $child['min']) {
+
+      $blockCount = $countInnerBlockInstances[$blockName] ?? 0;
+      if ($blockCount < $child['min']) {
         return [
           'is_valid' => FALSE,
           'message' => \Drupal::translation()->formatPlural($child['min'],
@@ -109,7 +118,7 @@ public function validateCardinality(array $block, array $expected_children): arr
             ]),
         ];
       }
-      if ($child['max'] !== GutenbergCardinalityValidatorInterface::CARDINALITY_UNLIMITED && $countInnerBlockInstances[$child['blockName']] > $child['max']) {
+      if ($child['max'] !== GutenbergCardinalityValidatorInterface::CARDINALITY_UNLIMITED && $blockCount > $child['max']) {
         return [
           'is_valid' => FALSE,
           'message' => \Drupal::translation()->formatPlural($child['max'],
@@ -121,6 +130,13 @@ public function validateCardinality(array $block, array $expected_children): arr
             ]),
         ];
       }
+
+      if (!empty($childBlocks) && !$this->hasPopulatedBlock($childBlocks)) {
+        return [
+          'is_valid' => FALSE,
+          'message' => $this->getMissingContentErrorMessage($child),
+        ];
+      }
     }
 
     return [
@@ -172,7 +188,18 @@ private function validateEmptyInnerBlocks (array $expected_children): array {
   private function validateAnyInnerBlocks(array $inner_blocks, array $expected_children): array {
     $min = $expected_children['min'];
     $max = $expected_children['max'];
-    $count = count($inner_blocks['innerBlocks']);
+    $innerBlockList = $inner_blocks['innerBlocks'] ?? [];
+    $count = count($innerBlockList);
+    if (
+      $count > 0 &&
+      !$this->hasPopulatedBlock($innerBlockList) &&
+      !$this->isBlockPopulated($inner_blocks)
+    ) {
+      return [
+        'is_valid' => FALSE,
+        'message' => $this->getMissingContentErrorMessage(NULL),
+      ];
+    }
     if ($count < $min) {
       return [
         'is_valid' => FALSE,
@@ -218,4 +245,132 @@ private function getExpectedQuantityErrorMessage(array $child_block): string|Tra
     return $result;
   }
 
+  private function blockHasMeaningfulHtml(array $block): bool {
+    $innerHTML = $block['innerHTML'] ?? '';
+    if (is_string($innerHTML) && $this->stringContainsContent($innerHTML)) {
+      return TRUE;
+    }
+
+    if (!empty($block['innerContent']) && is_array($block['innerContent'])) {
+      foreach ($block['innerContent'] as $chunk) {
+        if (is_string($chunk) && $this->stringContainsContent($chunk)) {
+          return TRUE;
+        }
+      }
+    }
+
+    return FALSE;
+  }
+
+  private function stringContainsContent(string $value): bool {
+    $decoded = Html::decodeEntities($value);
+    $stripped = trim(strip_tags($decoded));
+    if ($stripped !== '') {
+      return TRUE;
+    }
+
+    return (bool) preg_match('/<(img|video|audio|iframe|svg|figure|source|embed|object|picture)\b/i', $value);
+  }
+
+  private function blockHasMeaningfulAttributes(array $block): bool {
+    $attrs = $block['attrs'] ?? [];
+    if (empty($attrs)) {
+      return FALSE;
+    }
+
+    foreach ($attrs as $value) {
+      if ($this->isMeaningfulValue($value)) {
+        return TRUE;
+      }
+    }
+
+    return FALSE;
+  }
+
+  private function isMeaningfulValue(mixed $value): bool {
+    if ($value === NULL) {
+      return FALSE;
+    }
+    if (is_string($value)) {
+      return trim($value) !== '';
+    }
+    if (is_bool($value)) {
+      return $value;
+    }
+    if (is_numeric($value)) {
+      return TRUE;
+    }
+    if (is_array($value)) {
+      foreach ($value as $item) {
+        if ($this->isMeaningfulValue($item)) {
+          return TRUE;
+        }
+      }
+      return FALSE;
+    }
+
+    return TRUE;
+  }
+
+  /**
+   * Checks if any block in the supplied list is populated.
+   */
+  private function hasPopulatedBlock(array $blocks): bool {
+    foreach ($blocks as $block) {
+      if (is_array($block) && $this->isBlockPopulated($block)) {
+        return TRUE;
+      }
+    }
+    return FALSE;
+  }
+
+  private function isBlockPopulated(array $block): bool {
+    $evaluated = FALSE;
+
+    if (array_key_exists('innerHTML', $block) || array_key_exists('innerContent', $block)) {
+      $evaluated = TRUE;
+      if ($this->blockHasMeaningfulHtml($block)) {
+        return TRUE;
+      }
+    }
+
+    if (array_key_exists('attrs', $block)) {
+      $evaluated = TRUE;
+      if ($this->blockHasMeaningfulAttributes($block)) {
+        return TRUE;
+      }
+    }
+
+    if (!empty($block['innerBlocks']) && is_array($block['innerBlocks'])) {
+      $evaluated = TRUE;
+      foreach ($block['innerBlocks'] as $innerBlock) {
+        if (is_array($innerBlock) && $this->isBlockPopulated($innerBlock)) {
+          return TRUE;
+        }
+      }
+    }
+
+    if (!$evaluated) {
+      return TRUE;
+    }
+
+    return FALSE;
+  }
+
+  private function getMissingContentErrorMessage(?array $child_block): string|TranslatableMarkup {
+    $messageSuffix = t('content or attributes.');
+
+    if (!empty($child_block)) {
+      $messageParams = [
+        '%label' => $child_block['blockLabel'],
+        '@message_suffix' => $messageSuffix,
+      ];
+      return t('%label: block must contain @message_suffix', $messageParams);
+    }
+
+    return t('Block must contain @message_suffix', [
+      '@message_suffix' => $messageSuffix,
+    ]);
+  }
+
 }