3.0 rc

.github/workflows/test.yml → .github/workflows/test-coverage.yml

@@ -1,7 +1,9 @@
-name: Test
+name: Tests w/ coverage
 
 on:
   pull_request:
+    branches:
+      - '**'
   push:
     branches:
       - master
@@ -38,29 +40,9 @@ jobs:
           export $ENV
           vendor/bin/phpunit --coverage-clover=coverage.xml
 
-      - name: Upload coverage file
-        uses: actions/upload-artifact@v3
-        with:
-          name: phpunit-${{ matrix.deps }}-${{ matrix.php-version }}.coverage
-          path: coverage.xml
-  upload_coverage:
-    name: Upload coverage to Codecov
-    runs-on: ubuntu-20.04
-    needs:
-      - phpunit
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 2
-
-      - name: Download coverage files
-        uses: actions/download-artifact@v3
-        with:
-          path: reports
-
       - name: Upload to Codecov
         uses: codecov/codecov-action@v3
         with:
-          directory: reports
+          files: coverage.xml
+          flags: phpunit-${{ matrix.php-version }}
+          name: phpunit-${{ matrix.php-version }}

composer.json

@@ -1,10 +1,10 @@
 {
-  "name":              "shmax/graphql-php-validation-toolkit",
-  "description":       "Do validation on fields and args for graphql queries and mutations, and dynamically generate user error types",
-  "type":              "library",
-  "license":           "MIT",
-  "homepage":          "https://github.com/shmax/graphql-php-validation-toolkit",
-  "keywords":          [
+  "name": "shmax/graphql-php-validation-toolkit",
+  "description": "Do validation on fields and args for graphql queries and mutations, and dynamically generate user error types",
+  "type": "library",
+  "license": "MIT",
+  "homepage": "https://github.com/shmax/graphql-php-validation-toolkit",
+  "keywords": [
     "graphql",
     "PHP",
     "mutation",
@@ -23,7 +23,7 @@
     "phpstan/phpstan-phpunit": "1.3.10",
     "mll-lab/php-cs-fixer-config": "^5.0",
     "phpstan/phpstan-strict-rules": "1.5.0",
-    "phpunit/phpunit": "^9.5",
+    "phpunit/phpunit": "^10",
     "webonyx/graphql-php": "^v15.3.0"
   },
   "config": {
@@ -35,14 +35,12 @@
   },
   "autoload": {
     "psr-4": {
-      "GraphQL\\": "src/"
+      "GraphQlPhpValidationToolkit\\": "src/"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "GraphQL\\Tests\\": "tests/",
-      "GraphQL\\Benchmarks\\": "benchmarks/",
-      "GraphQL\\Examples\\Blog\\": "examples/01-blog/Blog/"
+      "GraphQlPhpValidationToolkit\\Tests\\": "tests/"
     }
   },
   "scripts": {

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

@@ -1,37 +1,41 @@
 # 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.
+
+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
+    _valid
+    _result
   }
 }
 ```
 
 ### Try mutation with invalid input
+
 ```
 mutation {
   deleteAuthor(id: 3) {
-    valid
-    result
-    suberrors {
-      id {
-        code
-        msg
-      }
+    _valid
+    _result
+    id {
+      _code
+      _msg
     }
   }
 }

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

@@ -5,8 +5,8 @@
 use GraphQL\GraphQL;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type;
-use GraphQL\Type\Definition\ValidatedFieldDefinition;
 use GraphQL\Type\Schema;
+use GraphQlPhpValidationToolkit\Type\ErrorType\ValidatedFieldDefinition;
 
 $authors = [
     1 => [

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

@@ -1,43 +1,45 @@
 # 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.
+
+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
-      }
+    _valid
+    _result
+    id {
+      _code
+      _msg
     }
   }
 }
 ```
 
 ### Try mutation with invalid input
+
 ```
 mutation {
   deleteAuthor(id: 3) {
-    valid
-    result
-    suberrors {
-      id {
-        code
-        msg
-      }
+    _valid
+    _result
+    id {
+      _code
+      _msg
     }
   }
 }

examples/02-custom-error-codes/index.php

@@ -6,12 +6,12 @@
 use GraphQL\Type\Definition\Description;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type;
-use GraphQL\Type\Definition\ValidatedFieldDefinition;
 use GraphQL\Type\Schema;
+use GraphQlPhpValidationToolkit\Type\ErrorType\ValidatedFieldDefinition;
 
-enum AuthorValidation {
+enum AuthorValidation
+{
     #[Description(description: 'Author not found.')]
-
     case UnknownAuthor;
     case AuthorAlreadyDeleted;
 }
@@ -61,7 +61,7 @@ public function __construct()
             'deleteAuthor' => new ValidatedFieldDefinition([
                 'name' => 'deleteAuthor',
                 'typeSetter' => function (Type $type) use ($types) {
-                    if(!isset($types[$type->name])) {
+                    if (!isset($types[$type->name])) {
                         $types[$type->name] = $type;
                     }
                     return $types[$type->name];

examples/03-input-object-validation/README.md

@@ -1,19 +1,23 @@
-# Validation of InputObjects (or Objects) 
-
-You can add `validate` properties to the fields of nested Objects or InputObjects (and those fields can themselves be of complex types with their own fields, and so on). This library will sniff them out and recursively build up a result type with a similarly nested structure.
+# Validation of InputObjects (or Objects)
 
+You can add `validate` properties to the fields of nested Objects or InputObjects (and those fields can themselves be of
+complex types with their own fields, and so on). This library will sniff them out and recursively build up a result type
+with a similarly nested structure.
 
 ### 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(
@@ -23,31 +27,28 @@ mutation {
       age: 47
     }
   ) {
-		result {
+	_result {
       id
       name
     }
-    suberrors {
-      attributes {
-        code
-        msg
-        suberrors {
-          age {
-            code
-            msg
-          }
-          name {
-            code
-            msg
-          }
+    attributes {
+      _code
+      _msg
+        age {
+          _code
+          _msg
+        }
+        name {
+          _code
+          _msg
         }
-      }
     }
   }
 }
 ```
 
 ### Try mutation with invalid input
+
 ```
 mutation {
 	updateAuthor(
@@ -57,24 +58,20 @@ mutation {
       age: -3
     }
   ) {
-		result {
+    _result {
       id
       name
     }
-    suberrors {
-      attributes {
-        code
-        msg
-        suberrors {
-          age {
-            code
-            msg
-          }
-          name {
-            code
-            msg
-          }
-        }
+    attributes {
+      _code
+      _msg
+      age {
+        _code
+        _msg
+      }
+      name {
+        _code
+        _msg
       }
     }
   }

examples/03-input-object-validation/index.php

@@ -6,19 +6,22 @@
 use GraphQL\Type\Definition\InputObjectType;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type;
-use GraphQL\Type\Definition\ValidatedFieldDefinition;
 use GraphQL\Type\Schema;
+use GraphQlPhpValidationToolkit\Type\ErrorType\ValidatedFieldDefinition;
 
-enum NameErrors {
+enum NameErrors
+{
     case NameTooLong;
     case NameNotUnique;
 }
 
-enum AgeErrors {
+enum AgeErrors
+{
     case Negative;
 }
 
-enum AuthorErrors {
+enum AuthorErrors
+{
     case UnknownAuthor;
     case DeceasedAuthor;
 }
@@ -115,7 +118,7 @@ public function __construct()
                         'type' => Type::id(),
                         'errorCodes' => AuthorErrors::class,
                         'validate' => function (string $authorId) use ($authors) {
-                            if (! isset($authors[$authorId])) {
+                            if (!isset($authors[$authorId])) {
                                 return [AuthorValidation::UnknownAuthor, 'We have no record of that author'];
                             }