move SpecBaseObject and implement map type

cebe · cebe · commit 2cbe0405132a · 2018-10-23T16:46:01.000+02:00
diff --git a/src/Reader.php b/src/Reader.php
@@ -3,7 +3,6 @@
 namespace cebe\openapi;
 
 use cebe\openapi\spec\OpenApi;
-use cebe\openapi\spec\SpecBaseObject;
 use Symfony\Component\Yaml\Yaml;
 
 /**
diff --git a/src/SpecBaseObject.php b/src/SpecBaseObject.php
@@ -1,12 +1,14 @@
 <?php
 
-namespace cebe\openapi\spec;
+namespace cebe\openapi;
 
 use cebe\openapi\exceptions\ReadonlyPropertyException;
 use cebe\openapi\exceptions\UnknownPropertyException;
 
 /**
+ * Base class for all spec objects.
  *
+ * Implements property management and validation basics.
  *
  * @author Carsten Brandt <mail@cebe.cc>
  */
@@ -45,9 +47,38 @@ public function __construct(array $data)
                     $this->_errors[] = "property '$property' must be array, but " . gettype($data[$property]) . " given.";
                     continue;
                 }
-                $this->_properties[$property] = [];
-                foreach($data[$property] as $item) {
-                    $this->_properties[$property][] = new $type[0]($item);
+                switch (count($type)) {
+                    case 1:
+                        // array
+                        $this->_properties[$property] = [];
+                        foreach($data[$property] as $item) {
+                            if ($type[0] === 'string') {
+                                if (!is_string($item)) {
+                                    $this->_errors[] = "property '$property' must be array of strings, but array has " . gettype($item) . " element.";
+                                }
+                                $this->_properties[$property][] = $item;
+                            } else {
+                                $this->_properties[$property][] = new $type[0]($item);
+                            }
+                        }
+                        break;
+                    case 2:
+                        // map
+                        if ($type[0] !== 'string') {
+                            throw new \Exception('Invalid map key type: ' . $type[0]);
+                        }
+                        $this->_properties[$property] = [];
+                        foreach($data[$property] as $key => $item) {
+                            if ($type[1] === 'string') {
+                                if (!is_string($item)) {
+                                    $this->_errors[] = "property '$property' must be map<string, string>, but entry '$key' is of type " . gettype($item) . ".";
+                                }
+                                $this->_properties[$property][$key] = $item;
+                            } else {
+                                $this->_properties[$property][$key] = new $type[1]($item);
+                            }
+                        }
+                        break;
                 }
             } else {
                 $this->_properties[$property] = new $type($data[$property]);
@@ -66,7 +97,6 @@ public function __construct(array $data)
      */
     public function validate(): bool
     {
-        $this->_errors = [];
         foreach($this->_properties as $k => $v) {
             if ($v instanceof self) {
                 $v->performValidation();
diff --git a/src/spec/Components.php b/src/spec/Components.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * Holds a set of reusable objects for different aspects of the OAS.
  *
diff --git a/src/spec/Contact.php b/src/spec/Contact.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * Contact information for the exposed API.
  *
diff --git a/src/spec/ExternalDocumentation.php b/src/spec/ExternalDocumentation.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * Allows referencing an external resource for extended documentation.
  *
diff --git a/src/spec/Info.php b/src/spec/Info.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * The object provides metadata about the API.
  *
diff --git a/src/spec/License.php b/src/spec/License.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * License information for the exposed API.
  *
diff --git a/src/spec/OpenApi.php b/src/spec/OpenApi.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * This is the root document object of the OpenAPI document.
  *
diff --git a/src/spec/Paths.php b/src/spec/Paths.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * Holds the relative paths to the individual endpoints and their operations.
  *
diff --git a/src/spec/SecurityRequirement.php b/src/spec/SecurityRequirement.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * Lists the required security schemes to execute this operation.
  *
diff --git a/src/spec/Server.php b/src/spec/Server.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * An object representing a Server.
  *
diff --git a/src/spec/ServerVariable.php b/src/spec/ServerVariable.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * An object representing a Server Variable for server URL template substitution.
  *
diff --git a/src/spec/Tag.php b/src/spec/Tag.php
@@ -2,6 +2,8 @@
 
 namespace cebe\openapi\spec;
 
+use cebe\openapi\SpecBaseObject;
+
 /**
  * Adds metadata to a single tag that is used by the Operation Object.
  *
diff --git a/tests/spec/ServerTest.php b/tests/spec/ServerTest.php
@@ -0,0 +1,51 @@
+<?php
+
+use Symfony\Component\Yaml\Yaml;
+
+/**
+ *
+ *
+ * @author Carsten Brandt <mail@cebe.cc>
+ */
+class ServerTest extends \PHPUnit\Framework\TestCase
+{
+    public function testRead()
+    {
+        /** @var $server \cebe\openapi\spec\Server */
+        $server = \cebe\openapi\Reader::readFromJson(<<<JSON
+{
+  "url": "https://{username}.gigantic-server.com:{port}/{basePath}",
+  "description": "The production API server",
+  "variables": {
+    "username": {
+      "default": "demo",
+      "description": "this value is assigned by the service provider, in this example `gigantic-server.com`"
+    },
+    "port": {
+      "enum": [
+        "8443",
+        "443"
+      ],
+      "default": "8443"
+    },
+    "basePath": {
+      "default": "v2"
+    }
+  }
+}
+JSON
+        , \cebe\openapi\spec\Server::class);
+
+        $result = $server->validate();
+        $this->assertEquals([], $server->getErrors());
+        $this->assertTrue($result);
+
+        $this->assertEquals("https://{username}.gigantic-server.com:{port}/{basePath}", $server->url);
+        $this->assertEquals("The production API server", $server->description);
+        $this->assertCount(3, $server->variables);
+        $this->assertEquals("demo", $server->variables['username']->default);
+        $this->assertEquals("this value is assigned by the service provider, in this example `gigantic-server.com`", $server->variables['username']->description);
+        $this->assertEquals("8443", $server->variables['port']->default);
+    }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace cebe\openapi\spec;`
`4`	`4`
	`5`	`+use cebe\openapi\SpecBaseObject;`
	`6`	`+`
`5`	`7`	`/**`
`6`	`8`	`* Holds a set of reusable objects for different aspects of the OAS.`
`7`	`9`	`*`