Improve member names validation (#70)

Author: f3ath

.travis.yml

@@ -1,6 +1,5 @@
 language: php
 php:
-  - '7.0'
   - '7.1'
   - '7.2'
 

composer.json

@@ -11,7 +11,7 @@
     }
   ],
   "require": {
-    "php": ">=7.0"
+    "php": ">=7.1"
   },
   "require-dev": {
     "phpunit/phpunit": "^6.0",
@@ -21,7 +21,10 @@
   "autoload": {
     "psr-4": {
       "JsonApiPhp\\JsonApi\\": "src/"
-    }
+    },
+    "files": [
+      "src/functions.php"
+    ]
   },
   "autoload-dev": {
     "psr-4": {

src/Document.php

@@ -3,9 +3,9 @@
 
 namespace JsonApiPhp\JsonApi;
 
+use JsonApiPhp\JsonApi\Document\Container;
 use JsonApiPhp\JsonApi\Document\Error;
 use JsonApiPhp\JsonApi\Document\LinksTrait;
-use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\MetaTrait;
 use JsonApiPhp\JsonApi\Document\PrimaryData\MultiIdentifierData;
 use JsonApiPhp\JsonApi\Document\PrimaryData\MultiResourceData;
@@ -16,7 +16,7 @@
 use JsonApiPhp\JsonApi\Document\Resource\ResourceIdentifier;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;
 
-class Document implements \JsonSerializable
+final class Document implements \JsonSerializable
 {
     const MEDIA_TYPE = 'application/vnd.api+json';
     const DEFAULT_API_VERSION = '1.0';
@@ -46,7 +46,7 @@ private function __construct()
     {
     }
 
-    public static function fromMeta(Meta $meta): self
+    public static function fromMeta(iterable $meta): self
     {
         $doc = new self;
         $doc->setMeta($meta);
@@ -100,12 +100,12 @@ public function setApiVersion(string $version = self::DEFAULT_API_VERSION)
         $this->api['version'] = $version;
     }
 
-    public function setApiMeta(Meta $meta)
+    public function setApiMeta(iterable $meta): void
     {
-        $this->api['meta'] = $meta;
+        $this->api['meta'] = new Container($meta);
     }
 
-    public function setIncluded(ResourceObject ...$resources)
+    public function setIncluded(ResourceObject ...$resources): void
     {
         if (null === $this->data) {
             throw new \LogicException('Document with no data cannot contain included resources');
@@ -118,30 +118,25 @@ public function setIncluded(ResourceObject ...$resources)
         }
     }
 
-    public function markSparse()
+    public function markSparse(): void
     {
         $this->sparse = true;
     }
 
     public function jsonSerialize()
     {
         $this->enforceFullLinkage();
-        return array_filter(
-            [
-                'data' => $this->data,
-                'errors' => $this->errors,
-                'meta' => $this->meta,
-                'jsonapi' => $this->api,
-                'links' => $this->links,
-                'included' => $this->included ? array_values($this->included) : null,
-            ],
-            function ($v) {
-                return null !== $v;
-            }
-        );
+        return filterNulls([
+            'data' => $this->data,
+            'errors' => $this->errors,
+            'meta' => $this->meta,
+            'jsonapi' => $this->api,
+            'links' => $this->links,
+            'included' => $this->included ? array_values($this->included) : null,
+        ]);
     }
 
-    private function enforceFullLinkage()
+    private function enforceFullLinkage(): void
     {
         if ($this->sparse || empty($this->included)) {
             return;

src/Document/Container.php

@@ -3,25 +3,31 @@
 
 namespace JsonApiPhp\JsonApi\Document;
 
-class Container implements \JsonSerializable, \IteratorAggregate
+use function JsonApiPhp\JsonApi\isValidMemberName;
+
+final class Container implements \JsonSerializable
 {
     private $data;
 
-    public function set(MemberName $name, $value)
+    public function __construct(iterable $data = null)
     {
-        if (! $this->data) {
-            $this->data = (object) [];
+        if ($data) {
+            foreach ($data as $k => $v) {
+                $this->set((string) $k, $v);
+            }
         }
-        $this->data->$name = $value;
     }
 
-    public function getIterator(): \Traversable
+    public function set(string $name, $value)
     {
-        return $this->data;
+        if (! isValidMemberName($name)) {
+            throw new \OutOfBoundsException("Invalid member name '$name'");
+        }
+        $this->data[$name] = $value;
     }
 
     public function jsonSerialize()
     {
-        return $this->data;
+        return (object) $this->data;
     }
 }

src/Document/Error.php

@@ -3,6 +3,8 @@
 
 namespace JsonApiPhp\JsonApi\Document;
 
+use function JsonApiPhp\JsonApi\filterNulls;
+
 final class Error implements \JsonSerializable
 {
     use MetaTrait;
@@ -65,20 +67,15 @@ public function setSourceParameter(string $parameter)
 
     public function jsonSerialize()
     {
-        return array_filter(
-            [
-                'id' => $this->id,
-                'links' => $this->links,
-                'status' => $this->status,
-                'code' => $this->code,
-                'title' => $this->title,
-                'detail' => $this->detail,
-                'source' => $this->source,
-                'meta' => $this->meta,
-            ],
-            function ($v) {
-                return null !== $v;
-            }
-        ) ?: (object) [];
+        return filterNulls([
+            'id' => $this->id,
+            'links' => $this->links,
+            'status' => $this->status,
+            'code' => $this->code,
+            'title' => $this->title,
+            'detail' => $this->detail,
+            'source' => $this->source,
+            'meta' => $this->meta,
+        ]) ?: (object) [];
     }
 }

src/Document/Link/Link.php

@@ -3,32 +3,16 @@
 
 namespace JsonApiPhp\JsonApi\Document;
 
-use JsonApiPhp\JsonApi\Document\Link\Link;
-use JsonApiPhp\JsonApi\Document\Link\LinkInterface;
-
 trait LinksTrait
 {
     /**
-     * @var Container|null
+     * @var Container
      */
     protected $links;
 
-    public function setLink(string $name, string $url)
-    {
-        $this->init();
-        $this->links->set(new MemberName($name), new Link($url));
-    }
-
-    public function setLinkObject(string $name, LinkInterface $link)
-    {
-        $this->init();
-        $this->links->set(new MemberName($name), $link);
-    }
-
-    private function init()
+    public function setLink(string $name, string $url, iterable $meta = null)
     {
-        if (! $this->links) {
-            $this->links = new Container();
-        }
+        $this->links = $this->links ?: new Container();
+        $this->links->set($name, $meta ? ['meta' => new Container($meta), 'href' => $url] : $url);
     }
 }