feat(ResolveConfig): generate key for fields and layouts, including n…

…ested
flyntwp · Nov 8, 2016 · cc670a6 · cc670a6
1 parent f32ea4c
commit cc670a6
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 8 deletions.
diff --git a/lib/ACFComposer/ResolveConfig.php b/lib/ACFComposer/ResolveConfig.php
@@ -5,26 +5,36 @@
 use Exception;
 
 class ResolveConfig {
-  public static function forField($config) {
-    return self::forEntity($config, ['name', 'label', 'type']);
+  public static function forField($config, $keySuffix = '') {
+    return self::forEntity($config, ['name', 'label', 'type'], $keySuffix);
   }
 
-  public static function forLayout($config) {
-    return self::forEntity($config, ['name', 'label']);
+  public static function forLayout($config, $keySuffix = '') {
+    return self::forEntity($config, ['name', 'label'], $keySuffix);
   }
 
-  protected static function forEntity($config, $requiredAttributes) {
+  protected static function forEntity($config, $requiredAttributes, $parentKeySuffix = '') {
     if(is_string($config)) {
       $config = apply_filters($config, null);
     }
     $output = self::validateConfig($config, $requiredAttributes);
-    $output = self::forNestedEntities($output);
+
+    $keySuffix = empty($parentKeySuffix) ? $output['name'] : "{$parentKeySuffix}_{$output['name']}";
+    $output['key'] = "field_{$keySuffix}";
+    $output = self::forNestedEntities($output, $keySuffix);
     return $output;
   }
 
-  protected static function forNestedEntities($config) {
+  protected static function forNestedEntities($config, $parentKeySuffix) {
     if(array_key_exists('sub_fields', $config)) {
-      $config['sub_fields'] = array_map('self::forField', $config['sub_fields']);
+      $config['sub_fields'] = array_map(function($field) use ($parentKeySuffix){
+        return self::forField($field, $parentKeySuffix);
+      }, $config['sub_fields']);
+    }
+    if(array_key_exists('layouts', $config)) {
+      $config['layouts'] = array_map(function($layout) use ($parentKeySuffix){
+        return self::forLayout($layout, $parentKeySuffix);
+      }, $config['layouts']);
     }
     return $config;
   }

diff --git a/tests/test-resolveConfigForField.php b/tests/test-resolveConfigForField.php
@@ -14,6 +14,7 @@ function testForFieldWithValidConfig() {
       'type' => 'someType'
     ];
     $output = ResolveConfig::forField($config);
+    $config['key'] = 'field_someField';
     $this->assertEquals($config, $output);
   }
 
@@ -66,6 +67,7 @@ function testForFieldGetConfigFromFilter() {
     ->once()
     ->andReturn($someField);
     $output = ResolveConfig::forField($config);
+    $someField['key'] = "field_someField";
     $this->assertEquals($someField, $output);
   }
 
@@ -82,6 +84,7 @@ function testForFieldWithValidSubField() {
       'sub_fields' => [$subFieldConfig]
     ];
     $output = ResolveConfig::forField($config);
+    $subFieldConfig['key'] = 'field_someField_subField';
     $this->assertEquals($subFieldConfig, $output['sub_fields'][0]);
   }
 
@@ -99,4 +102,20 @@ function testForFieldFailWithInvalidSubField() {
     $this->expectException(Exception::class);
     ResolveConfig::forField($config);
   }
+
+  function testForFieldWithValidLayout() {
+    $layoutConfig = [
+      'name' => 'someLayout',
+      'label' => 'Some Layout'
+    ];
+    $config = [
+      'name' => 'someField',
+      'label' => 'Some Field',
+      'type' => 'someType',
+      'layouts' => [$layoutConfig]
+    ];
+    $output = ResolveConfig::forField($config);
+    $layoutConfig['key'] = 'field_someField_someLayout';
+    $this->assertEquals($layoutConfig, $output['layouts'][0]);
+  }
 }
diff --git a/tests/test-resolveConfigForLayout.php b/tests/test-resolveConfigForLayout.php
@@ -13,6 +13,7 @@ function testForLayoutWithValidConfig() {
       'label' => 'Some Layout'
     ];
     $output = ResolveConfig::forLayout($config);
+    $config['key'] = 'field_someLayout';
     $this->assertEquals($config, $output);
   }
 
@@ -52,6 +53,7 @@ function testForLayoutGetConfigFromFilter() {
     ->once()
     ->andReturn($someLayout);
     $output = ResolveConfig::forLayout($config);
+    $someLayout['key'] = 'field_someLayout';
     $this->assertEquals($someLayout, $output);
   }
   function testForLayoutWithValidSubField() {
@@ -66,6 +68,7 @@ function testForLayoutWithValidSubField() {
       'sub_fields' => [$subFieldConfig]
     ];
     $output = ResolveConfig::forLayout($config);
+    $subFieldConfig['key'] = 'field_someLayout_subField';
     $this->assertEquals($subFieldConfig, $output['sub_fields'][0]);
   }