Added tests, enhanced PHPDocs

Author: SilverFire

src/spec/Paths.php

@@ -60,7 +60,7 @@ public function __construct(array $data)
                 if ($givenType === 'object') {
                     $givenType = get_class($object);
                 }
-                throw new \TypeError(sprintf('Path MUST be either array or PathItem object, "%s" given', $givenType));
+                throw new TypeErrorException(sprintf('Path MUST be either array or PathItem object, "%s" given', $givenType));
             }
         }
     }

src/spec/Responses.php

@@ -10,6 +10,7 @@
 use ArrayAccess;
 use ArrayIterator;
 use cebe\openapi\DocumentContextInterface;
+use cebe\openapi\exceptions\TypeErrorException;
 use cebe\openapi\exceptions\UnresolvableReferenceException;
 use cebe\openapi\json\JsonPointer;
 use cebe\openapi\ReferenceContext;
@@ -37,8 +38,8 @@ class Responses implements SpecObjectInterface, DocumentContextInterface, ArrayA
 
     /**
      * Create an object from spec data.
-     * @param array $data spec data read from YAML or JSON
-     * @throws \cebe\openapi\exceptions\TypeErrorException in case invalid data is supplied.
+     * @param array[]|Response[]|Reference[] $data spec data read from YAML or JSON
+     * @throws TypeErrorException in case invalid data is supplied.
      */
     public function __construct(array $data)
     {
@@ -48,10 +49,16 @@ public function __construct(array $data)
             if (preg_match('~^(?:default|[1-5](?:[0-9][0-9]|XX))$~', $statusCode)) {
                 if ($response instanceof Response || $response instanceof Reference) {
                     $this->_responses[$statusCode] = $response;
-                } elseif (isset($response['$ref'])) {
+                } elseif (is_array($response) && isset($response['$ref'])) {
                     $this->_responses[$statusCode] = new Reference($response, Response::class);
-                } else {
+                } elseif (is_array($response)) {
                     $this->_responses[$statusCode] = new Response($response);
+                } else {
+                    $givenType = gettype($response);
+                    if ($givenType === 'object') {
+                        $givenType = get_class($response);
+                    }
+                    throw new TypeErrorException(sprintf('Response MUST be either an array, a Response or a Reference object, "%s" given', $givenType));
                 }
             } else {
                 $this->_errors[] = "Responses: $statusCode is not a valid HTTP status code.";

tests/spec/PathTest.php

@@ -4,6 +4,8 @@
 use cebe\openapi\spec\Operation;
 use cebe\openapi\spec\PathItem;
 use cebe\openapi\spec\Paths;
+use cebe\openapi\spec\Response;
+use cebe\openapi\spec\Responses;
 
 /**
  * @covers \cebe\openapi\spec\Paths
@@ -63,6 +65,48 @@ public function testRead()
         }
     }
 
+    public function testCreateionFromObjects()
+    {
+        $paths = new Paths([
+            '/pets' => new PathItem([
+                'get' => new Operation([
+                    'responses' => new Responses([
+                        200 => new Response(['description' => 'A list of pets.']),
+                        404 => ['description' => 'The pets list is gone 🙀'],
+                    ])
+                ])
+            ])
+        ]);
+
+        $this->assertTrue($paths->hasPath('/pets'));
+        $this->assertInstanceOf(PathItem::class, $paths->getPath('/pets'));
+        $this->assertInstanceOf(PathItem::class, $paths['/pets']);
+        $this->assertInstanceOf(Operation::class, $paths->getPath('/pets')->get);
+
+        $this->assertSame('A list of pets.', $paths->getPath('/pets')->get->responses->getResponse(200)->description);
+        $this->assertSame('The pets list is gone 🙀', $paths->getPath('/pets')->get->responses->getResponse(404)->description);
+    }
+
+    public function badPathsConfigProvider()
+    {
+        yield [['/pets' => 'foo'], 'Path MUST be either array or PathItem object, "string" given'];
+        yield [['/pets' => 42], 'Path MUST be either array or PathItem object, "integer" given'];
+        yield [['/pets' => false], 'Path MUST be either array or PathItem object, "boolean" given'];
+        yield [['/pets' => new stdClass()], 'Path MUST be either array or PathItem object, "stdClass" given'];
+        // The last one can be supported in future, but now SpecBaseObjects::__construct() requires array explicitly
+    }
+
+    /**
+     * @dataProvider badPathsConfigProvider
+     */
+    public function testPathsCanNotBeCreatedFromBullshit($config, $expectedException)
+    {
+        $this->expectException(\cebe\openapi\exceptions\TypeErrorException::class);
+        $this->expectExceptionMessage($expectedException);
+
+        new Paths($config);
+    }
+
     public function testInvalidPath()
     {
         /** @var $paths Paths */
@@ -88,4 +132,5 @@ public function testInvalidPath()
         ], $paths->getErrors());
         $this->assertFalse($result);
     }
+
 }