Deprecated ArrayMeta (#48)

f3ath · web-flow · commit 8b98f7d47f0a · 2017-08-30T17:24:13.000-07:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Implementation of [JSON API](http://jsonapi.org) in PHP 7
 This library is an attempt to express business rules of JSON API specification in a set of PHP 7 classes.
 
-A simple example to illustrate the general idea. This (slightly modified) JSON representation from
+A simple example to illustrate the general idea. This JSON representation from
 [the documentation](http://jsonapi.org/format/#document-resource-objects)
 
 ```json
@@ -19,8 +19,8 @@ A simple example to illustrate the general idea. This (slightly modified) JSON r
                     "id": "9"
                 },
                 "links": {
-                    "self": "\/articles\/1\/relationships\/author",
-                    "related": "\/articles\/1\/author"
+                    "self": "/articles/1/relationships/author",
+                    "related": "/articles/1/author"
                 }
             }
         }
@@ -29,6 +29,7 @@ A simple example to illustrate the general idea. This (slightly modified) JSON r
 ```
 can be built with the following php code:
 ```php
+<?php
 $articles = new ResourceObject('articles', '1');
 $author = Relationship::fromLinkage(
     Linkage::fromSingleIdentifier(
@@ -40,7 +41,7 @@ $author->setLink('related', '/articles/1/author');
 $articles->setRelationship('author', $author);
 $articles->setAttribute('title', 'Rails is Omakase');
 $doc = Document::fromResource($articles);
-echo json_encode($doc, JSON_PRETTY_PRINT);
+echo json_encode($doc, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
 ```
 
 Please refer to [the tests](./test) for the full API documentation:
diff --git a/src/Document/ArrayMeta.php b/src/Document/ArrayMeta.php
@@ -11,6 +11,9 @@
 
 namespace JsonApiPhp\JsonApi\Document;
 
+/**
+ * @deprecated to be removed in 1.0, use Meta::fromArray()
+ */
 class ArrayMeta extends Meta
 {
     public function __construct(array $array)
diff --git a/src/Document/Meta.php b/src/Document/Meta.php
@@ -20,6 +20,11 @@ public function __construct(\stdClass $data)
         $this->data = $data;
     }
 
+    public static function fromArray(array $array): self
+    {
+        return new self((object) $array);
+    }
+
     public function jsonSerialize()
     {
         return $this->data;
diff --git a/test/Document/DocumentTest.php b/test/Document/DocumentTest.php
@@ -12,8 +12,8 @@
 namespace JsonApiPhp\JsonApi\Test\Document;
 
 use JsonApiPhp\JsonApi\Document;
-use JsonApiPhp\JsonApi\Document\ArrayMeta;
 use JsonApiPhp\JsonApi\Document\Error;
+use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\Resource\NullResource;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceIdentifier;
 use JsonApiPhp\JsonApi\Test\BaseTestCase;
@@ -24,7 +24,7 @@ public function testCanCreateFromMeta()
     {
         $this->assertEqualsAsJson(
             ['meta' => ['foo' => 'bar']],
-            Document::fromMeta(new ArrayMeta(['foo' => 'bar']))
+            Document::fromMeta(Meta::fromArray(['foo' => 'bar']))
         );
     }
 
diff --git a/test/Document/ErrorTest.php b/test/Document/ErrorTest.php
@@ -31,7 +31,7 @@ public function testErrorWithFullSetOfProperties()
         $e->setDetail('Nothing is found');
         $e->setSourcePointer('/data');
         $e->setSourceParameter('test_param');
-        $e->setMeta(new ArrayMeta(['foo' => 'bar']));
+        $e->setMeta(Meta::fromArray(['foo' => 'bar']));
 
         $this->assertEqualsAsJson(
             [
diff --git a/test/Document/MetaTest.php b/test/Document/MetaTest.php
@@ -11,13 +11,13 @@
 
 namespace JsonApiPhp\JsonApi\Test\Document;
 
-use JsonApiPhp\JsonApi\Document\ArrayMeta;
+use JsonApiPhp\JsonApi\Document\Meta;
 use PHPUnit\Framework\TestCase;
 
 class MetaTest extends TestCase
 {
     public function testPhpArraysAreConvertedToObjects()
     {
-        $this->assertEquals('{"0":"foo"}', json_encode(new ArrayMeta(['foo'])));
+        $this->assertEquals('{"0":"foo"}', json_encode(Meta::fromArray(['foo'])));
     }
 }
diff --git a/test/Document/Resource/Relationship/RelationshipTest.php b/test/Document/Resource/Relationship/RelationshipTest.php
@@ -11,7 +11,6 @@
 
 namespace JsonApiPhp\JsonApi\Test\Document\Resource\Relationship;
 
-use JsonApiPhp\JsonApi\Document\ArrayMeta;
 use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\Resource\Relationship\Linkage;
 use JsonApiPhp\JsonApi\Document\Resource\Relationship\Relationship;
@@ -91,7 +90,7 @@ public function testCanCreateFromMeta()
                     'a' => 'b',
                 ],
             ],
-            Relationship::fromMeta(new ArrayMeta(['a' => 'b']))
+            Relationship::fromMeta(Meta::fromArray(['a' => 'b']))
         );
     }
 }
diff --git a/test/Document/Resource/ResourceFieldsTest.php b/test/Document/Resource/ResourceFieldsTest.php
@@ -11,7 +11,7 @@
 
 namespace JsonApiPhp\JsonApi\Test\Document\Resource;
 
-use JsonApiPhp\JsonApi\Document\ArrayMeta;
+use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\Resource\Relationship\Relationship;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;
 use PHPUnit\Framework\TestCase;
@@ -37,7 +37,7 @@ public function testCanNotSetRelationshipIfAttributeExists()
     {
         $res = new ResourceObject('books', '1');
         $res->setAttribute('foo', 'bar');
-        $res->setRelationship('foo', Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));
+        $res->setRelationship('foo', Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));
     }
 
     /**
@@ -47,7 +47,7 @@ public function testCanNotSetRelationshipIfAttributeExists()
     public function testCanNotSetAttributeIfRelationshipExists()
     {
         $res = new ResourceObject('books', '1');
-        $res->setRelationship('foo', Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));
+        $res->setRelationship('foo', Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));
         $res->setAttribute('foo', 'bar');
     }
 
@@ -72,7 +72,7 @@ public function testAttributeCanNotHaveReservedNames(string $name)
     public function testRelationshipCanNotHaveReservedNames(string $name)
     {
         $res = new ResourceObject('books', 'abc');
-        $res->setRelationship($name, Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));
+        $res->setRelationship($name, Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));
     }
 
     public function invalidAttributeNames(): array
diff --git a/test/Document/Resource/ResourceTest.php b/test/Document/Resource/ResourceTest.php
@@ -11,7 +11,7 @@
 
 namespace JsonApiPhp\JsonApi\Test\Document\Resource;
 
-use JsonApiPhp\JsonApi\Document\ArrayMeta;
+use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\Resource\Relationship\Relationship;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceIdentifier;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;
@@ -58,7 +58,7 @@ public function resourceProvider()
                         'foo' => 'bar',
                     ],
                 ],
-                new ResourceIdentifier('books', '42abc', new ArrayMeta(['foo' => 'bar'])),
+                new ResourceIdentifier('books', '42abc', Meta::fromArray(['foo' => 'bar'])),
             ],
             [
                 [
@@ -83,10 +83,10 @@ public function resourceProvider()
                 ],
                 (function () {
                     $resource = new ResourceObject('books', '42abc');
-                    $resource->setMeta(new ArrayMeta(['foo' => 'bar']));
+                    $resource->setMeta(Meta::fromArray(['foo' => 'bar']));
                     $resource->setAttribute('attr', 'val');
                     $resource->setLink('self', 'http://localhost');
-                    $resource->setRelationship('author', Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));
+                    $resource->setRelationship('author', Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));
                     return $resource;
                 })(),
             ],
diff --git a/test/IntegrationTest.php b/test/IntegrationTest.php
@@ -37,8 +37,8 @@ public function testFromTheReadmeFile()
                     "id": "9"
                 },
                 "links": {
-                    "self": "\/articles\/1\/relationships\/author",
-                    "related": "\/articles\/1\/author"
+                    "self": "/articles/1/relationships/author",
+                    "related": "/articles/1/author"
                 }
             }
         }
@@ -60,7 +60,7 @@ public function testFromTheReadmeFile()
 
         $this->assertEquals(
             $json,
-            json_encode($doc, JSON_PRETTY_PRINT)
+            json_encode($doc, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
         );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@`
`11`	`11`
`12`	`12`	`namespace JsonApiPhp\JsonApi\Document;`
`13`	`13`
	`14`	`+/**`
	`15`	`+ * @deprecated to be removed in 1.0, use Meta::fromArray()`
	`16`	`+ */`
`14`	`17`	`class ArrayMeta extends Meta`
`15`	`18`	`{`
`16`	`19`	`public function __construct(array $array)`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,11 @@ public function __construct(\stdClass $data)`
`20`	`20`	`$this->data = $data;`
`21`	`21`	`}`
`22`	`22`
	`23`	`+ public static function fromArray(array $array): self`
	`24`	`+ {`
	`25`	`+ return new self((object) $array);`
	`26`	`+ }`
	`27`	`+`
`23`	`28`	`public function jsonSerialize()`
`24`	`29`	`{`
`25`	`30`	`return $this->data;`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function testErrorWithFullSetOfProperties()`
`31`	`31`	`$e->setDetail('Nothing is found');`
`32`	`32`	`$e->setSourcePointer('/data');`
`33`	`33`	`$e->setSourceParameter('test_param');`
`34`		`- $e->setMeta(new ArrayMeta(['foo' => 'bar']));`
	`34`	`+ $e->setMeta(Meta::fromArray(['foo' => 'bar']));`
`35`	`35`
`36`	`36`	`$this->assertEqualsAsJson(`
`37`	`37`	`[`
Original file line number	Diff line number	Diff line change
`@@ -11,13 +11,13 @@`
`11`	`11`
`12`	`12`	`namespace JsonApiPhp\JsonApi\Test\Document;`
`13`	`13`
`14`		`-use JsonApiPhp\JsonApi\Document\ArrayMeta;`
	`14`	`+use JsonApiPhp\JsonApi\Document\Meta;`
`15`	`15`	`use PHPUnit\Framework\TestCase;`
`16`	`16`
`17`	`17`	`class MetaTest extends TestCase`
`18`	`18`	`{`
`19`	`19`	`public function testPhpArraysAreConvertedToObjects()`
`20`	`20`	`{`
`21`		`- $this->assertEquals('{"0":"foo"}', json_encode(new ArrayMeta(['foo'])));`
	`21`	`+ $this->assertEquals('{"0":"foo"}', json_encode(Meta::fromArray(['foo'])));`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`
`12`	`12`	`namespace JsonApiPhp\JsonApi\Test\Document\Resource\Relationship;`
`13`	`13`
`14`		`-use JsonApiPhp\JsonApi\Document\ArrayMeta;`
`15`	`14`	`use JsonApiPhp\JsonApi\Document\Meta;`
`16`	`15`	`use JsonApiPhp\JsonApi\Document\Resource\Relationship\Linkage;`
`17`	`16`	`use JsonApiPhp\JsonApi\Document\Resource\Relationship\Relationship;`
`@@ -91,7 +90,7 @@ public function testCanCreateFromMeta()`
`91`	`90`	`'a' => 'b',`
`92`	`91`	`],`
`93`	`92`	`],`
`94`		`- Relationship::fromMeta(new ArrayMeta(['a' => 'b']))`
	`93`	`+ Relationship::fromMeta(Meta::fromArray(['a' => 'b']))`
`95`	`94`	`);`
`96`	`95`	`}`
`97`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace JsonApiPhp\JsonApi\Test\Document\Resource;`
`13`	`13`
`14`		`-use JsonApiPhp\JsonApi\Document\ArrayMeta;`
	`14`	`+use JsonApiPhp\JsonApi\Document\Meta;`
`15`	`15`	`use JsonApiPhp\JsonApi\Document\Resource\Relationship\Relationship;`
`16`	`16`	`use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;`
`17`	`17`	`use PHPUnit\Framework\TestCase;`
`@@ -37,7 +37,7 @@ public function testCanNotSetRelationshipIfAttributeExists()`
`37`	`37`	`{`
`38`	`38`	`$res = new ResourceObject('books', '1');`
`39`	`39`	`$res->setAttribute('foo', 'bar');`
`40`		`- $res->setRelationship('foo', Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));`
	`40`	`+ $res->setRelationship('foo', Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`@@ -47,7 +47,7 @@ public function testCanNotSetRelationshipIfAttributeExists()`
`47`	`47`	`public function testCanNotSetAttributeIfRelationshipExists()`
`48`	`48`	`{`
`49`	`49`	`$res = new ResourceObject('books', '1');`
`50`		`- $res->setRelationship('foo', Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));`
	`50`	`+ $res->setRelationship('foo', Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));`
`51`	`51`	`$res->setAttribute('foo', 'bar');`
`52`	`52`	`}`
`53`	`53`
`@@ -72,7 +72,7 @@ public function testAttributeCanNotHaveReservedNames(string $name)`
`72`	`72`	`public function testRelationshipCanNotHaveReservedNames(string $name)`
`73`	`73`	`{`
`74`	`74`	`$res = new ResourceObject('books', 'abc');`
`75`		`- $res->setRelationship($name, Relationship::fromMeta(new ArrayMeta(['a' => 'b'])));`
	`75`	`+ $res->setRelationship($name, Relationship::fromMeta(Meta::fromArray(['a' => 'b'])));`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`public function invalidAttributeNames(): array`
Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,8 @@ public function testFromTheReadmeFile()`
`37`	`37`	`"id": "9"`
`38`	`38`	`},`
`39`	`39`	`"links": {`
`40`		`- "self": "\/articles\/1\/relationships\/author",`
`41`		`- "related": "\/articles\/1\/author"`
	`40`	`+ "self": "/articles/1/relationships/author",`
	`41`	`+ "related": "/articles/1/author"`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`	`}`
`@@ -60,7 +60,7 @@ public function testFromTheReadmeFile()`
`60`	`60`
`61`	`61`	`$this->assertEquals(`
`62`	`62`	`$json,`
`63`		`- json_encode($doc, JSON_PRETTY_PRINT)`
	`63`	`+ json_encode($doc, JSON_PRETTY_PRINT \| JSON_UNESCAPED_SLASHES)`
`64`	`64`	`);`
`65`	`65`	`}`
`66`	`66`	`}`