change default value handling

do not change schema by adding default values but return these on
__get() call instead.

fixes #19

Author: cebe

src/SpecBaseObject.php

@@ -29,6 +29,14 @@ abstract class SpecBaseObject implements SpecObjectInterface
      */
     abstract protected function attributes(): array;
 
+    /**
+     * @return array array of attributes default values.
+     */
+    protected function attributeDefaults(): array
+    {
+        return [];
+    }
+
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
      *
@@ -241,6 +249,9 @@ public function __get($name)
         if (isset($this->_properties[$name])) {
             return $this->_properties[$name];
         }
+        if (isset(static::attributeDefaults()[$name])) {
+            return static::attributeDefaults()[$name];
+        }
         if (isset(static::attributes()[$name])) {
             if (is_array(static::attributes()[$name])) {
                 return [];
@@ -259,7 +270,7 @@ public function __set($name, $value)
 
     public function __isset($name)
     {
-        if (isset($this->_properties[$name]) || isset(static::attributes()[$name])) {
+        if (isset($this->_properties[$name]) || isset(static::attributeDefaults()[$name]) || isset(static::attributes()[$name])) {
             return $this->__get($name) !== null;
         }
 

src/spec/OpenApi.php

@@ -45,19 +45,28 @@ protected function attributes(): array
     }
 
     /**
-     * Create an object from spec data.
-     * @param array $data spec data read from YAML or JSON
-     * @throws TypeErrorException in case invalid data is supplied.
+     * @return array array of attributes default values.
      */
-    public function __construct(array $data)
+    protected function attributeDefaults(): array
     {
-        if (empty($data['servers'])) {
-            // Spec: If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.
-            $data['servers'] = [
-                ['url' => '/'],
-            ];
+        return [
+            // Spec: If the servers property is not provided, or is an empty array,
+            // the default value would be a Server Object with a url value of /.
+            'servers' => [
+                new Server(['url' => '/'])
+            ],
+        ];
+    }
+
+    public function __get($name)
+    {
+        $ret = parent::__get($name);
+        // Spec: If the servers property is not provided, or is an empty array,
+        // the default value would be a Server Object with a url value of /.
+        if ($name === 'servers' && $ret === []) {
+            return $this->attributeDefaults()['servers'];
         }
-        parent::__construct($data);
+        return $ret;
     }
 
     /**

src/spec/Parameter.php

@@ -57,14 +57,24 @@ protected function attributes(): array
         ];
     }
 
+    private $_attributeDefaults = [];
+
+    /**
+     * @return array array of attributes default values.
+     */
+    protected function attributeDefaults(): array
+    {
+        return $this->_attributeDefaults;
+    }
+
     /**
      * Create an object from spec data.
      * @param array $data spec data read from YAML or JSON
      * @throws TypeErrorException in case invalid data is supplied.
      */
     public function __construct(array $data)
     {
-        if (!isset($data['style']) && isset($data['in'])) {
+        if (isset($data['in'])) {
             // Spec: Default values (based on value of in):
             // for query - form;
             // for path - simple;
@@ -73,17 +83,19 @@ public function __construct(array $data)
             switch ($data['in']) {
                 case 'query':
                 case 'cookie':
-                    $data['style'] = 'form';
+                    $this->_attributeDefaults['style'] = 'form';
+                    $this->_attributeDefaults['explode'] = true;
                     break;
                 case 'path':
                 case 'header':
-                    $data['style'] = 'simple';
+                    $this->_attributeDefaults['style'] = 'simple';
+                    $this->_attributeDefaults['explode'] = false;
                     break;
             }
         }
-        if (!isset($data['explode']) && isset($data['style'])) {
+        if (isset($data['style'])) {
             // Spec: When style is form, the default value is true. For all other styles, the default value is false.
-            $data['explode'] = ($data['style'] === 'form');
+            $this->_attributeDefaults['explode'] = ($data['style'] === 'form');
         }
         parent::__construct($data);
     }

src/spec/Schema.php

@@ -93,6 +93,16 @@ protected function attributes(): array
         ];
     }
 
+    /**
+     * @return array array of attributes default values.
+     */
+    protected function attributeDefaults(): array
+    {
+        return [
+            'additionalProperties' => true,
+        ];
+    }
+
     /**
      * Create an object from spec data.
      * @param array $data spec data read from YAML or JSON
@@ -112,9 +122,6 @@ public function __construct(array $data)
                     );
                 }
             }
-        } else {
-            // additionalProperties defaults to true.
-            $data['additionalProperties'] = true;
         }
         parent::__construct($data);
     }

tests/ReaderTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- *
- *
- * @author Carsten Brandt <[email protected]>
- */
 class ReaderTest extends \PHPUnit\Framework\TestCase
 {
     public function testReadJson()

tests/WriterTest.php

@@ -0,0 +1,57 @@
+<?php
+
+class WriterTest extends \PHPUnit\Framework\TestCase
+{
+    private function createOpenAPI()
+    {
+        return new \cebe\openapi\spec\OpenApi([
+            'openapi' => '3.0.0',
+            'info' => [
+                'title' => 'Test API',
+                'version' => '1.0.0',
+            ],
+            'paths' => [],
+        ]);
+    }
+
+    public function testWriteJson()
+    {
+        $openapi = $this->createOpenAPI();
+
+        $json = \cebe\openapi\Writer::writeToJson($openapi);
+
+        $this->assertEquals(preg_replace('~\R~', "\n", <<<JSON
+{
+    "openapi": "3.0.0",
+    "info": {
+        "title": "Test API",
+        "version": "1.0.0"
+    },
+    "paths": {}
+}
+JSON
+),
+            $json
+        );
+    }
+
+    public function testWriteYaml()
+    {
+        $openapi = $this->createOpenAPI();
+
+        $yaml = \cebe\openapi\Writer::writeToYaml($openapi);
+
+
+        $this->assertEquals(preg_replace('~\R~', "\n", <<<YAML
+openapi: 3.0.0
+info:
+  title: 'Test API'
+  version: 1.0.0
+paths: {  }
+
+YAML
+        ),
+            $yaml
+        );
+    }
+}