Merge pull request #17 from swaggest/symbolized-required

vearutop · web-flow · commit ea7f6415afb9 · 2019-08-21T14:30:32.000+02:00
Symbolize "required" definition
diff --git a/composer.lock b/composer.lock
diff --git a/src/JsonSchema/SchemaBuilder.php b/src/JsonSchema/SchemaBuilder.php
@@ -311,7 +311,7 @@ private function copyTo(SchemaBuilder $schemaBuilder)
 
     private function processOther()
     {
-        static $skip = null, $emptySchema = null;
+        static $skip = null, $emptySchema = null, $names = null;
         if ($skip === null) {
             $emptySchema = new Schema();
             $names = Schema::names();
@@ -332,8 +332,6 @@ private function processOther()
                 $names->if => 1,
                 $names->then => 1,
                 $names->else => 1,
-                $names->fromRef => 1,
-                $names->originPath => 1,
             );
         }
         $schemaData = Schema::export($this->schema);
@@ -345,7 +343,24 @@ private function processOther()
                 continue;
             }
 
-            if (!property_exists($emptySchema, $key) && $key !== 'const' && $key[0] !== '$') {
+            if (!property_exists($emptySchema, $key) && $key !== $names->const && $key[0] !== '$') {
+                continue;
+            }
+
+            if ($names->required == $key && is_array($value)) {
+                $export = "array(\n";
+                foreach ($value as $item) {
+                    if (PhpCode::makePhpName($item) === $item) {
+                        $expItem = 'self::names()->' . $item;
+                    } else {
+                        $expItem = PhpCode::varExport($item);
+                    }
+                    $export .= '    ' . $expItem . ",\n";
+                }
+                $export .= ")";
+                $this->result->addSnippet(
+                    "{$this->varName}->{$key} = " . $export . ";\n"
+                );
                 continue;
             }
 
diff --git a/tests/src/Tmp/Issue5/Sample.php b/tests/src/Tmp/Issue5/Sample.php
@@ -31,7 +31,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->if = IfClass::schema();
         $ownerSchema->then = new Schema();
         $ownerSchema->then->required = array(
-            0 => 'bar',
+            self::names()->bar,
         );
     }
 }
diff --git a/tests/src/Tmp/Swagger/ApiKeySecurity.php b/tests/src/Tmp/Swagger/ApiKeySecurity.php
@@ -61,9 +61,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'name',
-            2 => 'in',
+            self::names()->type,
+            self::names()->name,
+            self::names()->in,
         );
         $ownerSchema->setFromRef('#/definitions/apiKeySecurity');
     }
diff --git a/tests/src/Tmp/Swagger/BasicAuthenticationSecurity.php b/tests/src/Tmp/Swagger/BasicAuthenticationSecurity.php
@@ -45,7 +45,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/basicAuthenticationSecurity');
     }
diff --git a/tests/src/Tmp/Swagger/BodyParameter.php b/tests/src/Tmp/Swagger/BodyParameter.php
@@ -62,9 +62,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'name',
-            1 => 'in',
-            2 => 'schema',
+            self::names()->name,
+            self::names()->in,
+            self::names()->schema,
         );
         $ownerSchema->setFromRef('#/definitions/bodyParameter');
     }
diff --git a/tests/src/Tmp/Swagger/ExternalDocs.php b/tests/src/Tmp/Swagger/ExternalDocs.php
@@ -43,7 +43,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->description = "information about external documentation";
         $ownerSchema->required = array(
-            0 => 'url',
+            self::names()->url,
         );
         $ownerSchema->setFromRef('#/definitions/externalDocs');
     }
diff --git a/tests/src/Tmp/Swagger/FileSchema.php b/tests/src/Tmp/Swagger/FileSchema.php
@@ -81,7 +81,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->description = "A deterministic version of a JSON Schema object.";
         $ownerSchema->required = array(
-            0 => 'type',
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/fileSchema');
     }
diff --git a/tests/src/Tmp/Swagger/Header.php b/tests/src/Tmp/Swagger/Header.php
@@ -126,7 +126,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/header');
     }
diff --git a/tests/src/Tmp/Swagger/Info.php b/tests/src/Tmp/Swagger/Info.php
@@ -62,8 +62,8 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->description = "General information about the API.";
         $ownerSchema->required = array(
-            0 => 'version',
-            1 => 'title',
+            self::names()->version,
+            self::names()->title,
         );
         $ownerSchema->setFromRef('#/definitions/info');
     }
diff --git a/tests/src/Tmp/Swagger/JsonReference.php b/tests/src/Tmp/Swagger/JsonReference.php
@@ -30,7 +30,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->type = 'object';
         $ownerSchema->additionalProperties = false;
         $ownerSchema->required = array(
-            0 => '$ref',
+            '$ref',
         );
         $ownerSchema->setFromRef('#/definitions/jsonReference');
     }
diff --git a/tests/src/Tmp/Swagger/License.php b/tests/src/Tmp/Swagger/License.php
@@ -43,7 +43,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'name',
+            self::names()->name,
         );
         $ownerSchema->setFromRef('#/definitions/license');
     }
diff --git a/tests/src/Tmp/Swagger/NonBodyParameter.php b/tests/src/Tmp/Swagger/NonBodyParameter.php
@@ -30,9 +30,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->oneOf[2] = QueryParameterSubSchema::schema();
         $ownerSchema->oneOf[3] = PathParameterSubSchema::schema();
         $ownerSchema->required = array(
-            0 => 'name',
-            1 => 'in',
-            2 => 'type',
+            self::names()->name,
+            self::names()->in,
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/nonBodyParameter');
     }
diff --git a/tests/src/Tmp/Swagger/Oauth2AccessCodeSecurity.php b/tests/src/Tmp/Swagger/Oauth2AccessCodeSecurity.php
@@ -68,10 +68,10 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'flow',
-            2 => 'authorizationUrl',
-            3 => 'tokenUrl',
+            self::names()->type,
+            self::names()->flow,
+            self::names()->authorizationUrl,
+            self::names()->tokenUrl,
         );
         $ownerSchema->setFromRef('#/definitions/oauth2AccessCodeSecurity');
     }
diff --git a/tests/src/Tmp/Swagger/Oauth2ApplicationSecurity.php b/tests/src/Tmp/Swagger/Oauth2ApplicationSecurity.php
@@ -63,9 +63,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'flow',
-            2 => 'tokenUrl',
+            self::names()->type,
+            self::names()->flow,
+            self::names()->tokenUrl,
         );
         $ownerSchema->setFromRef('#/definitions/oauth2ApplicationSecurity');
     }
diff --git a/tests/src/Tmp/Swagger/Oauth2ImplicitSecurity.php b/tests/src/Tmp/Swagger/Oauth2ImplicitSecurity.php
@@ -63,9 +63,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'flow',
-            2 => 'authorizationUrl',
+            self::names()->type,
+            self::names()->flow,
+            self::names()->authorizationUrl,
         );
         $ownerSchema->setFromRef('#/definitions/oauth2ImplicitSecurity');
     }
diff --git a/tests/src/Tmp/Swagger/Oauth2PasswordSecurity.php b/tests/src/Tmp/Swagger/Oauth2PasswordSecurity.php
@@ -63,9 +63,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'flow',
-            2 => 'tokenUrl',
+            self::names()->type,
+            self::names()->flow,
+            self::names()->tokenUrl,
         );
         $ownerSchema->setFromRef('#/definitions/oauth2PasswordSecurity');
     }
diff --git a/tests/src/Tmp/Swagger/Operation.php b/tests/src/Tmp/Swagger/Operation.php
@@ -90,7 +90,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'responses',
+            self::names()->responses,
         );
         $ownerSchema->setFromRef('#/definitions/operation');
     }
diff --git a/tests/src/Tmp/Swagger/PathParameterSubSchema.php b/tests/src/Tmp/Swagger/PathParameterSubSchema.php
@@ -149,7 +149,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'required',
+            self::names()->required,
         );
         $ownerSchema->setFromRef('#/definitions/pathParameterSubSchema');
     }
diff --git a/tests/src/Tmp/Swagger/Response.php b/tests/src/Tmp/Swagger/Response.php
@@ -50,7 +50,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'description',
+            self::names()->description,
         );
         $ownerSchema->setFromRef('#/definitions/response');
     }
diff --git a/tests/src/Tmp/Swagger/SwaggerSchema.php b/tests/src/Tmp/Swagger/SwaggerSchema.php
@@ -114,9 +114,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->schema = "http://json-schema.org/draft-04/schema#";
         $ownerSchema->title = "A JSON Schema for Swagger 2.0 API.";
         $ownerSchema->required = array(
-            0 => 'swagger',
-            1 => 'info',
-            2 => 'paths',
+            self::names()->swagger,
+            self::names()->info,
+            self::names()->paths,
         );
     }
 
diff --git a/tests/src/Tmp/Swagger/Tag.php b/tests/src/Tmp/Swagger/Tag.php
@@ -44,7 +44,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty = VendorExtension::schema();
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'name',
+            self::names()->name,
         );
         $ownerSchema->setFromRef('#/definitions/tag');
     }
diff --git a/tests/src/Tmp/SwaggerMin/ApiKeySecurity.php b/tests/src/Tmp/SwaggerMin/ApiKeySecurity.php
@@ -65,9 +65,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty->setFromRef('#/definitions/vendorExtension');
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'name',
-            2 => 'in',
+            self::names()->type,
+            self::names()->name,
+            self::names()->in,
         );
         $ownerSchema->setFromRef('#/definitions/apiKeySecurity');
     }
diff --git a/tests/src/Tmp/SwaggerMin/BasicAuthenticationSecurity.php b/tests/src/Tmp/SwaggerMin/BasicAuthenticationSecurity.php
@@ -49,7 +49,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty->setFromRef('#/definitions/vendorExtension');
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/basicAuthenticationSecurity');
     }
diff --git a/tests/src/Tmp/SwaggerMin/BodyParameter.php b/tests/src/Tmp/SwaggerMin/BodyParameter.php
@@ -66,9 +66,9 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty->setFromRef('#/definitions/vendorExtension');
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'name',
-            1 => 'in',
-            2 => 'schema',
+            self::names()->name,
+            self::names()->in,
+            self::names()->schema,
         );
         $ownerSchema->setFromRef('#/definitions/bodyParameter');
     }
diff --git a/tests/src/Tmp/SwaggerMin/ExternalDocs.php b/tests/src/Tmp/SwaggerMin/ExternalDocs.php
@@ -47,7 +47,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->description = "information about external documentation";
         $ownerSchema->required = array(
-            0 => 'url',
+            self::names()->url,
         );
         $ownerSchema->setFromRef('#/definitions/externalDocs');
     }
diff --git a/tests/src/Tmp/SwaggerMin/FileSchema.php b/tests/src/Tmp/SwaggerMin/FileSchema.php
@@ -92,7 +92,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->description = "A deterministic version of a JSON Schema object.";
         $ownerSchema->required = array(
-            0 => 'type',
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/fileSchema');
     }
diff --git a/tests/src/Tmp/SwaggerMin/Header.php b/tests/src/Tmp/SwaggerMin/Header.php
@@ -183,7 +183,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty->setFromRef('#/definitions/vendorExtension');
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
+            self::names()->type,
         );
         $ownerSchema->setFromRef('#/definitions/header');
     }
diff --git a/tests/src/Tmp/SwaggerMin/Info.php b/tests/src/Tmp/SwaggerMin/Info.php
@@ -66,8 +66,8 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->description = "General information about the API.";
         $ownerSchema->required = array(
-            0 => 'version',
-            1 => 'title',
+            self::names()->version,
+            self::names()->title,
         );
         $ownerSchema->setFromRef('#/definitions/info');
     }
diff --git a/tests/src/Tmp/SwaggerMin/JsonReference.php b/tests/src/Tmp/SwaggerMin/JsonReference.php
@@ -30,7 +30,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $ownerSchema->type = 'object';
         $ownerSchema->additionalProperties = false;
         $ownerSchema->required = array(
-            0 => '$ref',
+            '$ref',
         );
         $ownerSchema->setFromRef('#/definitions/jsonReference');
     }
diff --git a/tests/src/Tmp/SwaggerMin/License.php b/tests/src/Tmp/SwaggerMin/License.php
@@ -47,7 +47,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty->setFromRef('#/definitions/vendorExtension');
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'name',
+            self::names()->name,
         );
         $ownerSchema->setFromRef('#/definitions/license');
     }
diff --git a/tests/src/Tmp/SwaggerMin/Oauth2AccessCodeSecurity.php b/tests/src/Tmp/SwaggerMin/Oauth2AccessCodeSecurity.php
@@ -74,10 +74,10 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $patternProperty->setFromRef('#/definitions/vendorExtension');
         $ownerSchema->setPatternProperty('^x-', $patternProperty);
         $ownerSchema->required = array(
-            0 => 'type',
-            1 => 'flow',
-            2 => 'authorizationUrl',
-            3 => 'tokenUrl',
+            self::names()->type,
+            self::names()->flow,
+            self::names()->authorizationUrl,
+            self::names()->tokenUrl,
         );
         $ownerSchema->setFromRef('#/definitions/oauth2AccessCodeSecurity');
     }
diff --git a/tests/src/Tmp/SwaggerMin/Oauth2ApplicationSecurity.php b/tests/src/Tmp/SwaggerMin/Oauth2ApplicationSecurity.php
diff --git a/tests/src/Tmp/SwaggerMin/Oauth2ImplicitSecurity.php b/tests/src/Tmp/SwaggerMin/Oauth2ImplicitSecurity.php
diff --git a/tests/src/Tmp/SwaggerMin/Oauth2PasswordSecurity.php b/tests/src/Tmp/SwaggerMin/Oauth2PasswordSecurity.php
diff --git a/tests/src/Tmp/SwaggerMin/Operation.php b/tests/src/Tmp/SwaggerMin/Operation.php
diff --git a/tests/src/Tmp/SwaggerMin/PathItem.php b/tests/src/Tmp/SwaggerMin/PathItem.php
diff --git a/tests/src/Tmp/SwaggerMin/PathParameterSubSchema.php b/tests/src/Tmp/SwaggerMin/PathParameterSubSchema.php
diff --git a/tests/src/Tmp/SwaggerMin/Response.php b/tests/src/Tmp/SwaggerMin/Response.php
diff --git a/tests/src/Tmp/SwaggerMin/SwaggerSchema.php b/tests/src/Tmp/SwaggerMin/SwaggerSchema.php
diff --git a/tests/src/Tmp/SwaggerMin/Tag.php b/tests/src/Tmp/SwaggerMin/Tag.php

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)`
`31`	`31`	`$ownerSchema->if = IfClass::schema();`
`32`	`32`	`$ownerSchema->then = new Schema();`
`33`	`33`	`$ownerSchema->then->required = array(`
`34`		`- 0 => 'bar',`
	`34`	`+ self::names()->bar,`
`35`	`35`	`);`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)`
`45`	`45`	`$patternProperty = VendorExtension::schema();`
`46`	`46`	`$ownerSchema->setPatternProperty('^x-', $patternProperty);`
`47`	`47`	`$ownerSchema->required = array(`
`48`		`- 0 => 'type',`
	`48`	`+ self::names()->type,`
`49`	`49`	`);`
`50`	`50`	`$ownerSchema->setFromRef('#/definitions/basicAuthenticationSecurity');`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)`
`43`	`43`	`$ownerSchema->setPatternProperty('^x-', $patternProperty);`
`44`	`44`	`$ownerSchema->description = "information about external documentation";`
`45`	`45`	`$ownerSchema->required = array(`
`46`		`- 0 => 'url',`
	`46`	`+ self::names()->url,`
`47`	`47`	`);`
`48`	`48`	`$ownerSchema->setFromRef('#/definitions/externalDocs');`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)`
`81`	`81`	`$ownerSchema->setPatternProperty('^x-', $patternProperty);`
`82`	`82`	`$ownerSchema->description = "A deterministic version of a JSON Schema object.";`
`83`	`83`	`$ownerSchema->required = array(`
`84`		`- 0 => 'type',`
	`84`	`+ self::names()->type,`
`85`	`85`	`);`
`86`	`86`	`$ownerSchema->setFromRef('#/definitions/fileSchema');`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)`
`126`	`126`	`$patternProperty = VendorExtension::schema();`
`127`	`127`	`$ownerSchema->setPatternProperty('^x-', $patternProperty);`
`128`	`128`	`$ownerSchema->required = array(`
`129`		`- 0 => 'type',`
	`129`	`+ self::names()->type,`
`130`	`130`	`);`
`131`	`131`	`$ownerSchema->setFromRef('#/definitions/header');`
`132`	`132`	`}`