fix(CustomTypes): update to breaking changes of the API

Jens Schulze · Jens Schulze · commit 5e23104240d9 · 2015-10-05T10:57:20.000+02:00
BREAKING CHANGE: update actions for changing the order of custom fields have been changed
diff --git a/features/request/Type/TypeUpdate.feature b/features/request/Type/TypeUpdate.feature
@@ -249,19 +249,7 @@ Feature: I want to update a type
     """
     {
       "action": "changeFieldDefinitionOrder",
-      "attributes": [
-        {
-          "type": {
-            "name": "String"
-          },
-          "name": "custom-string",
-          "label": {
-            "en": "Custom String"
-          },
-          "isRequired": false,
-          "inputHint": "SingleLine"
-        }
-      ]
+      "fieldNames": ["field1", "field2"]
     }
     """
     Then the path should be "types/id"
@@ -273,19 +261,7 @@ Feature: I want to update a type
       "actions": [
         {
           "action": "changeFieldDefinitionOrder",
-          "attributes": [
-            {
-              "type": {
-                "name": "String"
-              },
-              "name": "custom-string",
-              "label": {
-                "en": "Custom String"
-              },
-              "isRequired": false,
-              "inputHint": "SingleLine"
-            }
-          ]
+          "fieldNames": ["field1", "field2"]
         }
       ]
     }
@@ -299,10 +275,7 @@ Feature: I want to update a type
     {
       "action": "changeEnumValueOrder",
       "fieldName": "<field-name>",
-      "values": [{
-        "key": "enumkey",
-        "label": "Enum Label"
-      }]
+      "keys": [ "enumkey1", "enumkey2"]
     }
     """
     Then the path should be "types/id"
@@ -315,10 +288,7 @@ Feature: I want to update a type
         {
           "action": "changeEnumValueOrder",
           "fieldName": "<field-name>",
-          "values": [{
-            "key": "enumkey",
-            "label": "Enum Label"
-          }]
+          "keys": [ "enumkey1", "enumkey2"]
         }
       ]
     }
@@ -332,12 +302,7 @@ Feature: I want to update a type
     {
       "action": "changeLocalizedEnumValueOrder",
       "fieldName": "<field-name>",
-      "values": [{
-        "key": "enumkey",
-        "label": {
-          "en": "Enum Label"
-        }
-      }]
+      "keys": [ "enumkey1", "enumkey2"]
     }
     """
     Then the path should be "types/id"
@@ -350,12 +315,7 @@ Feature: I want to update a type
         {
           "action": "changeLocalizedEnumValueOrder",
           "fieldName": "<field-name>",
-          "values": [{
-            "key": "enumkey",
-            "label": {
-              "en": "Enum Label"
-            }
-          }]
+          "keys": [ "enumkey1", "enumkey2"]
         }
       ]
     }
diff --git a/src/Request/Types/Command/TypeChangeEnumValueOrderAction.php b/src/Request/Types/Command/TypeChangeEnumValueOrderAction.php
@@ -16,8 +16,8 @@
  * @method TypeChangeEnumValueOrderAction setAction(string $action = null)
  * @method string getFieldName()
  * @method TypeChangeEnumValueOrderAction setFieldName(string $fieldName = null)
- * @method EnumCollection getValues()
- * @method TypeChangeEnumValueOrderAction setValues(EnumCollection $values = null)
+ * @method array getKeys()
+ * @method TypeChangeEnumValueOrderAction setKeys(array $keys = null)
  */
 class TypeChangeEnumValueOrderAction extends AbstractAction
 {
@@ -26,7 +26,7 @@ public function fieldDefinitions()
         return [
             'action' => [static::TYPE => 'string'],
             'fieldName' => [static::TYPE => 'string'],
-            'values' => [static::TYPE => '\Commercetools\Core\Model\Common\EnumCollection']
+            'keys' => [static::TYPE => 'array']
         ];
     }
 
@@ -41,12 +41,12 @@ public function __construct(array $data = [], $context = null)
     }
 
     /**
-     * @param EnumCollection $enums
+     * @param array $keys
      * @param Context|callable $context
      * @return TypeChangeEnumValueOrderAction
      */
-    public static function ofEnums(EnumCollection $enums, $context = null)
+    public static function ofEnums(array $keys, $context = null)
     {
-        return static::of($context)->setValues($enums);
+        return static::of($context)->setKeys($keys);
     }
 }
diff --git a/src/Request/Types/Command/TypeChangeFieldDefinitionOrderAction.php b/src/Request/Types/Command/TypeChangeFieldDefinitionOrderAction.php
@@ -14,16 +14,16 @@
  *
  * @method string getAction()
  * @method TypeChangeFieldDefinitionOrderAction setAction(string $action = null)
- * @method FieldDefinitionCollection getFieldDefinitions()
- * @method TypeChangeFieldDefinitionOrderAction setFieldDefinitions(FieldDefinitionCollection $fieldDefinitions = null)
+ * @method array getFieldNames()
+ * @method TypeChangeFieldDefinitionOrderAction setFieldNames(array $fieldNames = null)
  */
 class TypeChangeFieldDefinitionOrderAction extends AbstractAction
 {
     public function fieldDefinitions()
     {
         return [
             'action' => [static::TYPE => 'string'],
-            'fieldDefinitions' => [static::TYPE => '\Commercetools\Core\Model\Type\FieldDefinitionCollection'],
+            'fieldNames' => [static::TYPE => 'array'],
         ];
     }
 
@@ -42,8 +42,8 @@ public function __construct(array $data = [], $context = null)
      * @param Context|callable $context
      * @return TypeChangeFieldDefinitionOrderAction
      */
-    public static function ofFieldDefinitions(FieldDefinitionCollection $fieldDefinitions, $context = null)
+    public static function ofFieldDefinitions(array $fieldNames, $context = null)
     {
-        return static::of($context)->setFieldDefinitions($fieldDefinitions);
+        return static::of($context)->setFieldNames($fieldNames);
     }
 }
diff --git a/src/Request/Types/Command/TypeChangeLocalizedEnumValueOrderAction.php b/src/Request/Types/Command/TypeChangeLocalizedEnumValueOrderAction.php
@@ -17,8 +17,8 @@
  * @method TypeChangeLocalizedEnumValueOrderAction setAction(string $action = null)
  * @method string getFieldName()
  * @method TypeChangeLocalizedEnumValueOrderAction setFieldName(string $fieldName = null)
- * @method LocalizedEnumCollection getValues()
- * @method TypeChangeLocalizedEnumValueOrderAction setValues(LocalizedEnumCollection $values = null)
+ * @method array getKeys()
+ * @method TypeChangeLocalizedEnumValueOrderAction setKeys(array $keys = null)
  */
 class TypeChangeLocalizedEnumValueOrderAction extends AbstractAction
 {
@@ -27,7 +27,7 @@ public function fieldDefinitions()
         return [
             'action' => [static::TYPE => 'string'],
             'fieldName' => [static::TYPE => 'string'],
-            'values' => [static::TYPE => '\Commercetools\Core\Model\Common\LocalizedEnumCollection']
+            'keys' => [static::TYPE => 'array']
         ];
     }
 
@@ -42,12 +42,12 @@ public function __construct(array $data = [], $context = null)
     }
 
     /**
-     * @param LocalizedEnumCollection $enums
+     * @param array $keys
      * @param Context|callable $context
      * @return TypeChangeLocalizedEnumValueOrderAction
      */
-    public static function ofEnums(LocalizedEnumCollection $enums, $context = null)
+    public static function ofEnums(array $keys, $context = null)
     {
-        return static::of($context)->setValues($enums);
+        return static::of($context)->setKeys($keys);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -249,19 +249,7 @@ Feature: I want to update a type`
`249`	`249`	`"""`
`250`	`250`	`{`
`251`	`251`	`"action": "changeFieldDefinitionOrder",`
`252`		`- "attributes": [`
`253`		`- {`
`254`		`- "type": {`
`255`		`- "name": "String"`
`256`		`- },`
`257`		`- "name": "custom-string",`
`258`		`- "label": {`
`259`		`- "en": "Custom String"`
`260`		`- },`
`261`		`- "isRequired": false,`
`262`		`- "inputHint": "SingleLine"`
`263`		`- }`
`264`		`- ]`
	`252`	`+ "fieldNames": ["field1", "field2"]`
`265`	`253`	`}`
`266`	`254`	`"""`
`267`	`255`	`Then the path should be "types/id"`
`@@ -273,19 +261,7 @@ Feature: I want to update a type`
`273`	`261`	`"actions": [`
`274`	`262`	`{`
`275`	`263`	`"action": "changeFieldDefinitionOrder",`
`276`		`- "attributes": [`
`277`		`- {`
`278`		`- "type": {`
`279`		`- "name": "String"`
`280`		`- },`
`281`		`- "name": "custom-string",`
`282`		`- "label": {`
`283`		`- "en": "Custom String"`
`284`		`- },`
`285`		`- "isRequired": false,`
`286`		`- "inputHint": "SingleLine"`
`287`		`- }`
`288`		`- ]`
	`264`	`+ "fieldNames": ["field1", "field2"]`
`289`	`265`	`}`
`290`	`266`	`]`
`291`	`267`	`}`
`@@ -299,10 +275,7 @@ Feature: I want to update a type`
`299`	`275`	`{`
`300`	`276`	`"action": "changeEnumValueOrder",`
`301`	`277`	`"fieldName": "<field-name>",`
`302`		`- "values": [{`
`303`		`- "key": "enumkey",`
`304`		`- "label": "Enum Label"`
`305`		`- }]`
	`278`	`+ "keys": [ "enumkey1", "enumkey2"]`
`306`	`279`	`}`
`307`	`280`	`"""`
`308`	`281`	`Then the path should be "types/id"`
`@@ -315,10 +288,7 @@ Feature: I want to update a type`
`315`	`288`	`{`
`316`	`289`	`"action": "changeEnumValueOrder",`
`317`	`290`	`"fieldName": "<field-name>",`
`318`		`- "values": [{`
`319`		`- "key": "enumkey",`
`320`		`- "label": "Enum Label"`
`321`		`- }]`
	`291`	`+ "keys": [ "enumkey1", "enumkey2"]`
`322`	`292`	`}`
`323`	`293`	`]`
`324`	`294`	`}`
`@@ -332,12 +302,7 @@ Feature: I want to update a type`
`332`	`302`	`{`
`333`	`303`	`"action": "changeLocalizedEnumValueOrder",`
`334`	`304`	`"fieldName": "<field-name>",`
`335`		`- "values": [{`
`336`		`- "key": "enumkey",`
`337`		`- "label": {`
`338`		`- "en": "Enum Label"`
`339`		`- }`
`340`		`- }]`
	`305`	`+ "keys": [ "enumkey1", "enumkey2"]`
`341`	`306`	`}`
`342`	`307`	`"""`
`343`	`308`	`Then the path should be "types/id"`
`@@ -350,12 +315,7 @@ Feature: I want to update a type`
`350`	`315`	`{`
`351`	`316`	`"action": "changeLocalizedEnumValueOrder",`
`352`	`317`	`"fieldName": "<field-name>",`
`353`		`- "values": [{`
`354`		`- "key": "enumkey",`
`355`		`- "label": {`
`356`		`- "en": "Enum Label"`
`357`		`- }`
`358`		`- }]`
	`318`	`+ "keys": [ "enumkey1", "enumkey2"]`
`359`	`319`	`}`
`360`	`320`	`]`
`361`	`321`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@`
`16`	`16`	`* @method TypeChangeEnumValueOrderAction setAction(string $action = null)`
`17`	`17`	`* @method string getFieldName()`
`18`	`18`	`* @method TypeChangeEnumValueOrderAction setFieldName(string $fieldName = null)`
`19`		`- * @method EnumCollection getValues()`
`20`		`- * @method TypeChangeEnumValueOrderAction setValues(EnumCollection $values = null)`
	`19`	`+ * @method array getKeys()`
	`20`	`+ * @method TypeChangeEnumValueOrderAction setKeys(array $keys = null)`
`21`	`21`	`*/`
`22`	`22`	`class TypeChangeEnumValueOrderAction extends AbstractAction`
`23`	`23`	`{`
`@@ -26,7 +26,7 @@ public function fieldDefinitions()`
`26`	`26`	`return [`
`27`	`27`	`'action' => [static::TYPE => 'string'],`
`28`	`28`	`'fieldName' => [static::TYPE => 'string'],`
`29`		`- 'values' => [static::TYPE => '\Commercetools\Core\Model\Common\EnumCollection']`
	`29`	`+ 'keys' => [static::TYPE => 'array']`
`30`	`30`	`];`
`31`	`31`	`}`
`32`	`32`
`@@ -41,12 +41,12 @@ public function __construct(array $data = [], $context = null)`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * @param EnumCollection $enums`
	`44`	`+ * @param array $keys`
`45`	`45`	`* @param Context\|callable $context`
`46`	`46`	`* @return TypeChangeEnumValueOrderAction`
`47`	`47`	`*/`
`48`		`- public static function ofEnums(EnumCollection $enums, $context = null)`
	`48`	`+ public static function ofEnums(array $keys, $context = null)`
`49`	`49`	`{`
`50`		`- return static::of($context)->setValues($enums);`
	`50`	`+ return static::of($context)->setKeys($keys);`
`51`	`51`	`}`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,16 +14,16 @@`
`14`	`14`	`*`
`15`	`15`	`* @method string getAction()`
`16`	`16`	`* @method TypeChangeFieldDefinitionOrderAction setAction(string $action = null)`
`17`		`- * @method FieldDefinitionCollection getFieldDefinitions()`
`18`		`- * @method TypeChangeFieldDefinitionOrderAction setFieldDefinitions(FieldDefinitionCollection $fieldDefinitions = null)`
	`17`	`+ * @method array getFieldNames()`
	`18`	`+ * @method TypeChangeFieldDefinitionOrderAction setFieldNames(array $fieldNames = null)`
`19`	`19`	`*/`
`20`	`20`	`class TypeChangeFieldDefinitionOrderAction extends AbstractAction`
`21`	`21`	`{`
`22`	`22`	`public function fieldDefinitions()`
`23`	`23`	`{`
`24`	`24`	`return [`
`25`	`25`	`'action' => [static::TYPE => 'string'],`
`26`		`- 'fieldDefinitions' => [static::TYPE => '\Commercetools\Core\Model\Type\FieldDefinitionCollection'],`
	`26`	`+ 'fieldNames' => [static::TYPE => 'array'],`
`27`	`27`	`];`
`28`	`28`	`}`
`29`	`29`
`@@ -42,8 +42,8 @@ public function __construct(array $data = [], $context = null)`
`42`	`42`	`* @param Context\|callable $context`
`43`	`43`	`* @return TypeChangeFieldDefinitionOrderAction`
`44`	`44`	`*/`
`45`		`- public static function ofFieldDefinitions(FieldDefinitionCollection $fieldDefinitions, $context = null)`
	`45`	`+ public static function ofFieldDefinitions(array $fieldNames, $context = null)`
`46`	`46`	`{`
`47`		`- return static::of($context)->setFieldDefinitions($fieldDefinitions);`
	`47`	`+ return static::of($context)->setFieldNames($fieldNames);`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@`
`17`	`17`	`* @method TypeChangeLocalizedEnumValueOrderAction setAction(string $action = null)`
`18`	`18`	`* @method string getFieldName()`
`19`	`19`	`* @method TypeChangeLocalizedEnumValueOrderAction setFieldName(string $fieldName = null)`
`20`		`- * @method LocalizedEnumCollection getValues()`
`21`		`- * @method TypeChangeLocalizedEnumValueOrderAction setValues(LocalizedEnumCollection $values = null)`
	`20`	`+ * @method array getKeys()`
	`21`	`+ * @method TypeChangeLocalizedEnumValueOrderAction setKeys(array $keys = null)`
`22`	`22`	`*/`
`23`	`23`	`class TypeChangeLocalizedEnumValueOrderAction extends AbstractAction`
`24`	`24`	`{`
`@@ -27,7 +27,7 @@ public function fieldDefinitions()`
`27`	`27`	`return [`
`28`	`28`	`'action' => [static::TYPE => 'string'],`
`29`	`29`	`'fieldName' => [static::TYPE => 'string'],`
`30`		`- 'values' => [static::TYPE => '\Commercetools\Core\Model\Common\LocalizedEnumCollection']`
	`30`	`+ 'keys' => [static::TYPE => 'array']`
`31`	`31`	`];`
`32`	`32`	`}`
`33`	`33`
`@@ -42,12 +42,12 @@ public function __construct(array $data = [], $context = null)`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * @param LocalizedEnumCollection $enums`
	`45`	`+ * @param array $keys`
`46`	`46`	`* @param Context\|callable $context`
`47`	`47`	`* @return TypeChangeLocalizedEnumValueOrderAction`
`48`	`48`	`*/`
`49`		`- public static function ofEnums(LocalizedEnumCollection $enums, $context = null)`
	`49`	`+ public static function ofEnums(array $keys, $context = null)`
`50`	`50`	`{`
`51`		`- return static::of($context)->setValues($enums);`
	`51`	`+ return static::of($context)->setKeys($keys);`
`52`	`52`	`}`
`53`	`53`	`}`