Simplify ListOf (#7)

* fix non-null case

* linting

* linting

* fix validate logic, add new test

* add files

* remove unused code

* fix validation

* exclude tests from analysis

* ws

* remove unused, use constants

* rename fields back to suberrors

Author: shmax

.scrutinizer.yml

@@ -1,6 +1,7 @@
 filter:
   excluded_paths:
     - 'examples/*'
+    - 'tests/'
 build:
   nodes:
     analysis:

README.md

@@ -135,7 +135,8 @@ If you want to return an error message, return an array with the message in the
   ]	  
 ])
 ```
-Note that `ListOf` types are a special case, and support an additional `validateItem` callback for checking each item in their array. Its generated error type will have an array of suberror types, each with their own `path` field that you can query so you can know the exact address in the multidimensional array of each item that failed validation:
+
+Generated `ListOf` error types also have a `path` field that you can query so you can know the exact address in the multidimensional array of each item that failed validation:
 
 ```php
 //...
@@ -144,13 +145,7 @@ Note that `ListOf` types are a special case, and support an additional `validate
   'args' => [
     'phoneNumbers' => [
       'type' => Type::listOf(Type::string()),  
-      'validate' => function(array $phoneNumbers) {
-        if(!count($phoneNumbers)) {
-          return [1, "At least one phone number is required"];
-        }
-        return 0;
-      },
-      'validateItem' => function(string $phoneNumber) {
+      'validate' => function(string $phoneNumber) {
         $res = preg_match('/^[0-9\-]+$/', $phoneNumber) === 1;
         if (!$res) {
           return [1, 'That does not seem to be a valid phone number'];
@@ -182,39 +177,7 @@ If you would like to use custom error codes, add an `errorCodes` property at the
 ]   
 ```
 
-`ListOf` types are again a special case, and support an additional `suberrorCodes` property for validating their items:
 
-```php
-//...
-'setPhoneNumbers' => new ValidatedFieldDefinition([
-  'type' => Types::bool(),
-  'args' => [
-    'phoneNumbers' => [
-      'errorCodes' => [
-        'atLeastOneRequired`
-      ],
-      'suberrorCodes' => [
-        'invalidPhoneNumber'
-      ],
-      'type' => Type::listOf(Type::string()),  
-      'validate' => function(array $phoneNumbers) {
-        if(!count($phoneNumbers)) {
-          return ['atLeastOneRequired', "At least one phone number is required"];
-        }
-        return 0;
-      },
-      'validateItem' => function(string $phoneNumber) {
-        $res = preg_match('/^[0-9\-]+$/', $phoneNumber) === 1;
-        if (!$res) {
-          return ['invalidPhoneNumber', 'That does not seem to be a valid phone number'];
-        }
-        return 0;  
-      }
-    ]
-  ]	  
-])  
-```
- 
 ### Managing Created Types
 This library will create new types as needed. If you are using some kind of type manager to store and retrieve types, you can integrate it by providing a `typeSetter` callback:
 

examples/01-basic-scalar-validation/README.md

@@ -1,50 +1,38 @@
-# Simple scalar validation
-The simplest possible type of user input validation. Mutation expects an `authorId` arg, and will respond with a nicely formatted error code and message if an author by that id doesn't exist.
-
-### Run locally
-```
-php -S localhost:8000 ./index.php
-```
-
-### Install ChromeiQL plug-in for Chrome
-1. Install from [here](https://chrome.google.com/webstore/detail/chromeiql/fkkiamalmpiidkljmicmjfbieiclmeij?hl=en)
-2. Enter "http://localhost:8000" in the text field at the top and press the "Set Endpoint" button
-3. Be sure to inspect the "Docs" flyout to get familiar with the dynamically-generated types
-
-### Try mutation with valid input
-```
-mutation {
-  updateAuthor(authorId:1) {
-    suberrors {
-      authorId {
-        code
-        msg
-      }
-    }
-    result {
-      id
-      name
-    }
-    valid
-  }
-}
-```
-
-### Try mutation with invalid input
-```
-mutation {
-  updateAuthor(authorId:999) {
-    suberrors {
-      authorId {
-        code
-        msg
-      }
-    }
-    result {
-      id
-      name
-    }
-    valid
-  }
-}
+# Simple scalar validation
+The simplest possible type of user input validation. Mutation expects an `authorId` arg, and will respond with a nicely formatted error code and message if an author by that id doesn't exist.
+
+### Run locally
+```
+php -S localhost:8000 ./index.php
+```
+
+### Install ChromeiQL plug-in for Chrome
+1. Install from [here](https://chrome.google.com/webstore/detail/chromeiql/fkkiamalmpiidkljmicmjfbieiclmeij?hl=en)
+2. Enter "http://localhost:8000" in the text field at the top and press the "Set Endpoint" button
+3. Be sure to inspect the "Docs" flyout to get familiar with the dynamically-generated types
+
+### Try mutation with valid input
+```
+mutation {
+  deleteAuthor(id: 1) {
+    valid
+    result
+  }
+}
+```
+
+### Try mutation with invalid input
+```
+mutation {
+  deleteAuthor(id: 3) {
+    valid
+    result
+    suberrors {
+      id {
+        code
+        msg
+      }
+    }
+  }
+}
 ```

examples/01-basic-scalar-validation/index.php

@@ -47,50 +47,49 @@ public function __construct()
     $mutationType = new ObjectType([
         'name' => 'Mutation',
         'fields' => [
-            'updateAuthor' => new ValidatedFieldDefinition([
-                'name' => 'updateAuthor',
-                'type' => $authorType,
+            'deleteAuthor' => new ValidatedFieldDefinition([
+                'name' => 'deleteAuthor',
+                'type' => Type::boolean(),
                 'args' => [
-                    'authorId' => [
+                    'id' => [
                         'type' => Type::id(),
                         'validate' => function(string $authorId) use ($authors) {
                             if (isset($authors[$authorId])) {
                                 return 0;
                             }
 
-                            return [0, "Unknown author"];
+                            return [1, "Unknown author"];
                         }
                     ],
                 ],
                 'resolve' => function ($value, $args) use ($authors) {
                     // do your operation on the author
                     // AuthorProvider::update($authorId);
-                    return $authors[$args['authorId']];
+                    unset($authors[$args['id']]);
+                    return true;
                 },
             ]),
         ],
     ]);
 
-    $queryType = new ObjectType([
-        'name'=>'Query',
-        'fields'=>[
-            'author'=> [
-                'type' => $authorType,
-                "args" => [
-                    'authorId' => [
-                        'type' => Type::id()
-                    ]
-                ],
-                'resolve' => function($value, $args) use ($authors) {
-                    return $authors[$args['authorId']];
-                }
-            ]
-        ]
-    ]);
-
     $schema = new Schema([
         'mutation' => $mutationType,
-        'query' => $queryType
+        'query' => new ObjectType([
+            'name'=>'Query',
+            'fields'=>[
+                'author'=> [
+                    'type' => $authorType,
+                    "args" => [
+                        'authorId' => [
+                            'type' => Type::id()
+                        ]
+                    ],
+                    'resolve' => function($value, $args) use ($authors) {
+                        return $authors[$args['authorId']];
+                    }
+                ]
+            ]
+        ])
     ]);
 
 

examples/02-custom-error-codes/README.md

@@ -1,50 +1,44 @@
-# Simple scalar validation
-If you supply an `errorCodes` property on your `fields` or `args` definitions, then a custom, unique error code type will be created.
-
-### Run locally
-```
-php -S localhost:8000 ./index.php
-```
-
-### Install ChromeiQL plug-in for Chrome
-1. Install from [here](https://chrome.google.com/webstore/detail/chromeiql/fkkiamalmpiidkljmicmjfbieiclmeij?hl=en)
-2. Enter "http://localhost:8000" in the text field at the top and press the "Set Endpoint" button
-3. Be sure to inspect the "Docs" flyout to get familiar with the dynamically-generated types
-
-### Try mutation with valid input
-```
-mutation {
-  updateAuthor(authorId:1) {
-    suberrors {
-      authorId {
-        code
-        msg
-      }
-    }
-    result {
-      id
-      name
-    }
-    valid
-  }
-}
-```
-
-### Try mutation with invalid input
-```
-mutation {
-  updateAuthor(authorId:999) {
-    suberrors {
-      authorId {
-        code
-        msg
-      }
-    }
-    result {
-      id
-      name
-    }
-    valid
-  }
-}
+# Simple scalar validation
+If you supply an `errorCodes` property on your `fields` or `args` definitions, then a custom, unique error code type will be created.
+
+### Run locally
+```
+php -S localhost:8000 ./index.php
+```
+
+### Install ChromeiQL plug-in for Chrome
+1. Install from [here](https://chrome.google.com/webstore/detail/chromeiql/fkkiamalmpiidkljmicmjfbieiclmeij?hl=en)
+2. Enter "http://localhost:8000" in the text field at the top and press the "Set Endpoint" button
+3. Be sure to inspect the "Docs" flyout to get familiar with the dynamically-generated types
+
+### Try mutation with valid input
+```
+mutation {
+  deleteAuthor(id: 1) {
+    valid
+    result
+    suberrors {
+      id {
+        code
+        msg
+      }
+    }
+  }
+}
+```
+
+### Try mutation with invalid input
+```
+mutation {
+  deleteAuthor(id: 3) {
+    valid
+    result
+    suberrors {
+      id {
+        code
+        msg
+      }
+    }
+  }
+}
 ```