Replace dashes with underscores in image style ids. (#683)

Author: fubhy

modules/graphql_core/src/Plugin/Deriver/Enums/DisplayModeIdDeriver.php

@@ -66,7 +66,7 @@ protected function getDisplayModes() {
       $target = $current->getTargetType();
       list(, $id) = explode('.', $current->id());
 
-      $carry[$target][strtoupper($id)] = [
+      $carry[$target][StringHelper::upperCase($id)] = [
         'value' => $id,
         'description' => $this->t("The '@label' display mode for '@type' entities.", [
           '@label' => $current->label(),

modules/graphql_core/src/Plugin/GraphQL/Enums/Images/ImageStyleId.php

@@ -5,6 +5,7 @@
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\graphql\Plugin\GraphQL\Enums\EnumPluginBase;
+use Drupal\graphql\Utility\StringHelper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -60,13 +61,7 @@ public function buildEnumValues($definition) {
 
     $storage = $this->entityTypeManager->getStorage('image_style');
     foreach ($storage->loadMultiple() as $imageStyle) {
-      $id = $imageStyle->id();
-      // Add underscore prefix to numeric image styles.
-      if (is_numeric($id[0])) {
-        $id = "_$id";
-      }
-
-      $items[strtoupper($id)] = [
+      $items[StringHelper::upperCase($imageStyle->id())] = [
         'value' => $imageStyle->id(),
         'description' => $imageStyle->label(),
       ];

src/Utility/StringHelper.php

@@ -15,16 +15,30 @@ class StringHelper {
    *   string representation for field or type names.
    */
   public static function camelCase() {
-    $components = func_get_args();
-    $string = is_array($components) ? implode('_', $components) : $components;
-    $filtered = preg_replace('/^[^_a-zA-Z]+/', '', $string);
-    $components = array_filter(preg_split('/[^a-zA-Z0-9]/', $filtered));
+    $args = func_get_args();
+    $components = array_map(function ($component) {
+      return preg_replace('/[^a-zA-Z0-9_]/', '_', $component);
+    }, $args);
 
+    $components = array_filter(explode('_', implode('_', $components)));
     if (!count($components)) {
-      throw new \InvalidArgumentException(sprintf("Failed to create a specification compliant string representation for '%s'.", $string));
+      throw new \InvalidArgumentException(sprintf("Failed to create a specification compliant string representation for '%s'.", implode('', $args)));
     }
 
-    return implode('', array_map('ucfirst', $components));
+    $string = implode('', array_map('ucfirst', $components));
+    $string = $string && is_numeric($string[0]) ? "_$string" : $string;
+    return $string;
+  }
+
+  /**
+   * Turn a list of machine names into a upper-cased string.
+   *
+   * @return string
+   *   A upper-cased concatenation of the input components.
+   */
+  public static function upperCase() {
+    $result = call_user_func_array([static::class, 'camelCase'], func_get_args());
+    return strtoupper($result);
   }
 
   /**

tests/src/Unit/StringFormattingTest.php

@@ -17,7 +17,7 @@ class StringFormattingTest extends UnitTestCase {
    * @expectedExceptionMessageRegExp /Failed to create a specification compliant string representation for '.+'\./
    */
   public function testFailureOnInvalidInput() {
-    StringHelper::camelCase('123456', '^%!@#&');
+    StringHelper::camelCase('^%!@#&');
   }
 
   /**
@@ -43,9 +43,9 @@ public function testPropCaseFormatting($input, $expected) {
   public function providerTestStringFormatting() {
     return [
       [['simple-name'], 'SimpleName'],
-      [['123-name-with*^&!@some-SPECIAL-chars'], 'NameWithSomeSPECIALChars'],
+      [['123-name-with*^&!@some-SPECIAL-chars'], '_123NameWithSomeSPECIALChars'],
       [['simple', 'name-of-string', 'components'], 'SimpleNameOfStringComponents'],
-      [['123', 'array', '%^!@&#*', 'of', 'STRING', '(*&', 'components', 'with', 'SPEcial', 'chars'], 'ArrayOfSTRINGComponentsWithSPEcialChars']
+      [['123', 'array', '%^!@&#*', 'of', 'STRING', '(*&', 'components', 'with', 'SPEcial', 'chars'], '_123ArrayOfSTRINGComponentsWithSPEcialChars']
     ];
   }