Link model fixes (#58)

f3ath · web-flow · commit 36b0d295117b · 2017-09-10T23:15:40.000-07:00
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -21,7 +21,6 @@ return PhpCsFixer\Config::create()
         'method_separation' => true,
         'native_function_casing' => true,
         'no_blank_lines_after_class_opening' => true,
-        'no_blank_lines_after_phpdoc' => true,
         'no_empty_statement' => true,
         'no_extra_consecutive_blank_lines' => true,
         'no_leading_import_slash' => true,
diff --git a/README.md b/README.md
@@ -27,17 +27,17 @@ A simple example to illustrate the general idea. This JSON representation from
     }
 }
 ```
-can be built with the following php code:
+can be built with the following php code (less imports):
 ```php
 <?php
 $articles = new ResourceObject('articles', '1');
 $author = Relationship::fromLinkage(
-    Linkage::fromSingleIdentifier(
+    new SingleLinkage(
         new ResourceIdentifier('people', '9')
     )
 );
 $author->setLink('self', '/articles/1/relationships/author');
-$author->setLink('related', '/articles/1/author');
+$author->setLink('related','/articles/1/author');
 $articles->setRelationship('author', $author);
 $articles->setAttribute('title', 'Rails is Omakase');
 $doc = Document::fromResource($articles);
diff --git a/src/Document.php b/src/Document.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi;
diff --git a/src/Document/Error.php b/src/Document/Error.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document;
diff --git a/src/Document/Link/Link.php b/src/Document/Link/Link.php
@@ -0,0 +1,28 @@
+<?php
+/**
+ *  This file is part of JSON:API implementation for PHP.
+ *
+ *  (c) Alexey Karapetov <karapetov@gmail.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document\Link;
+
+final class Link implements LinkInterface
+{
+    private $url;
+
+    public function __construct(string $url)
+    {
+        $this->url = $url;
+    }
+
+    public function jsonSerialize()
+    {
+        return $this->url;
+    }
+}
diff --git a/src/Document/Link/LinkInterface.php b/src/Document/Link/LinkInterface.php
@@ -0,0 +1,18 @@
+<?php
+/**
+ *  This file is part of JSON:API implementation for PHP.
+ *
+ *  (c) Alexey Karapetov <karapetov@gmail.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document\Link;
+
+interface LinkInterface extends \JsonSerializable
+{
+    public function jsonSerialize();
+}
diff --git a/src/Document/Link/LinkObject.php b/src/Document/Link/LinkObject.php
@@ -0,0 +1,33 @@
+<?php
+/**
+ *  This file is part of JSON:API implementation for PHP.
+ *
+ *  (c) Alexey Karapetov <karapetov@gmail.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document\Link;
+
+use JsonApiPhp\JsonApi\Document\Meta;
+
+final class LinkObject implements LinkInterface
+{
+    private $link;
+
+    public function __construct(string $href, Meta $meta = null)
+    {
+        $this->link['href'] = $href;
+        if ($meta) {
+            $this->link['meta'] = $meta;
+        }
+    }
+
+    public function jsonSerialize()
+    {
+        return $this->link;
+    }
+}
diff --git a/src/Document/LinksTrait.php b/src/Document/LinksTrait.php
@@ -7,16 +7,28 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document;
 
+use JsonApiPhp\JsonApi\Document\Link\Link;
+use JsonApiPhp\JsonApi\Document\Link\LinkInterface;
+
 trait LinksTrait
 {
+    /**
+     * @var LinkInterface[]
+     */
     protected $links;
 
-    public function setLink(string $name, string $value, array $meta = null)
+    public function setLink(string $name, string $url)
+    {
+        $this->links[$name] = new Link($url);
+    }
+
+    public function setLinkObject(string $name, LinkInterface $link)
     {
-        $this->links[$name] = $meta ? ['href' => $value, 'meta' => $meta] : $value;
+        $this->links[$name] = $link;
     }
 }
diff --git a/src/Document/Meta.php b/src/Document/Meta.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document;
diff --git a/src/Document/MetaTrait.php b/src/Document/MetaTrait.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document;
diff --git a/src/Document/PrimaryData/MultiIdentifierData.php b/src/Document/PrimaryData/MultiIdentifierData.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\PrimaryData;
diff --git a/src/Document/PrimaryData/MultiResourceData.php b/src/Document/PrimaryData/MultiResourceData.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\PrimaryData;
diff --git a/src/Document/PrimaryData/NullData.php b/src/Document/PrimaryData/NullData.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\PrimaryData;
diff --git a/src/Document/PrimaryData/PrimaryDataInterface.php b/src/Document/PrimaryData/PrimaryDataInterface.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\PrimaryData;
diff --git a/src/Document/PrimaryData/SingleIdentifierData.php b/src/Document/PrimaryData/SingleIdentifierData.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\PrimaryData;
diff --git a/src/Document/PrimaryData/SingleResourceData.php b/src/Document/PrimaryData/SingleResourceData.php
@@ -7,6 +7,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\PrimaryData;
diff --git a/src/Document/Resource/Linkage/LinkageInterface.php b/src/Document/Resource/Linkage/LinkageInterface.php
@@ -1,12 +1,14 @@
-<?php declare(strict_types=1);
+<?php
 /**
- *  This file is part of JSON:API implementation for PHP.
- *
- *  (c) Alexey Karapetov <karapetov@gmail.com>
- *
- *  For the full copyright and license information, please view the LICENSE
- *  file that was distributed with this source code.
- */
+*  This file is part of JSON:API implementation for PHP.
+*
+*  (c) Alexey Karapetov <karapetov@gmail.com>
+*
+*  For the full copyright and license information, please view the LICENSE
+*  file that was distributed with this source code.
+*/
+
+declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Linkage;
 
diff --git a/src/Document/Resource/Linkage/MultiLinkage.php b/src/Document/Resource/Linkage/MultiLinkage.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Linkage;
diff --git a/src/Document/Resource/Linkage/NullLinkage.php b/src/Document/Resource/Linkage/NullLinkage.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Linkage;
diff --git a/src/Document/Resource/Linkage/SingleLinkage.php b/src/Document/Resource/Linkage/SingleLinkage.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Linkage;
diff --git a/src/Document/Resource/Relationship/Relationship.php b/src/Document/Resource/Relationship/Relationship.php
@@ -7,10 +7,12 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Relationship;
 
+use JsonApiPhp\JsonApi\Document\Link\LinkInterface;
 use JsonApiPhp\JsonApi\Document\LinksTrait;
 use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\MetaTrait;
@@ -38,17 +40,17 @@ public static function fromMeta(Meta $meta): self
         return $r;
     }
 
-    public static function fromSelfLink(string $link, array $meta = null): self
+    public static function fromSelfLink(LinkInterface $link): self
     {
         $r = new self;
-        $r->setLink('self', $link, $meta);
+        $r->setLinkObject('self', $link);
         return $r;
     }
 
-    public static function fromRelatedLink(string $link, array $meta = null): self
+    public static function fromRelatedLink(LinkInterface $link): self
     {
         $r = new self;
-        $r->setLink('related', $link, $meta);
+        $r->setLinkObject('related', $link);
         return $r;
     }
 
diff --git a/src/Document/Resource/ResourceIdentifier.php b/src/Document/Resource/ResourceIdentifier.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource;
diff --git a/src/Document/Resource/ResourceObject.php b/src/Document/Resource/ResourceObject.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document\Resource;
diff --git a/test/BaseTestCase.php b/test/BaseTestCase.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Test;
diff --git a/test/Document/CompoundDocumentTest.php b/test/Document/CompoundDocumentTest.php
@@ -7,11 +7,13 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Test\Document;
 
 use JsonApiPhp\JsonApi\Document;
+use JsonApiPhp\JsonApi\Document\Link\Link;
 use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\Resource\Linkage\MultiLinkage;
 use JsonApiPhp\JsonApi\Document\Resource\Linkage\SingleLinkage;
diff --git a/test/Document/DocumentTest.php b/test/Document/DocumentTest.php
@@ -7,12 +7,14 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Test\Document;
 
 use JsonApiPhp\JsonApi\Document;
 use JsonApiPhp\JsonApi\Document\Error;
+use JsonApiPhp\JsonApi\Document\Link\LinkObject;
 use JsonApiPhp\JsonApi\Document\Meta;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceIdentifier;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;
@@ -163,7 +165,7 @@ public function testDocumentCanHaveExtraProperties()
         $doc->setApiMeta(Meta::fromArray(['a' => 'b']));
         $doc->setMeta(Meta::fromArray(['test' => 'test']));
         $doc->setLink('self', 'http://example.com/self');
-        $doc->setLink('related', 'http://example.com/rel', ['foo' => 'bar']);
+        $doc->setLinkObject('related', new LinkObject('http://example.com/rel', Meta::fromArray(['foo' => 'bar'])));
         $this->assertEncodesTo(
             '
             {
diff --git a/test/Document/ErrorTest.php b/test/Document/ErrorTest.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Document;
diff --git a/test/Document/MetaTest.php b/test/Document/MetaTest.php
@@ -7,6 +7,7 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Test\Document;
diff --git a/test/Document/Resource/Relationship/LinkageTest.php b/test/Document/Resource/Relationship/LinkageTest.php
@@ -7,14 +7,14 @@
  *  For the full copyright and license information, please view the LICENSE
  *  file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Test\Document\Resource\Relationship;
 
 use JsonApiPhp\JsonApi\Document\Resource\Linkage\MultiLinkage;
 use JsonApiPhp\JsonApi\Document\Resource\Linkage\NullLinkage;
 use JsonApiPhp\JsonApi\Document\Resource\Linkage\SingleLinkage;
-use JsonApiPhp\JsonApi\Document\Resource\Relationship\Linkage;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceIdentifier;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;
 use JsonApiPhp\JsonApi\Test\BaseTestCase;
diff --git a/test/Document/Resource/Relationship/RelationshipTest.php b/test/Document/Resource/Relationship/RelationshipTest.php
diff --git a/test/Document/Resource/ResourceFieldsTest.php b/test/Document/Resource/ResourceFieldsTest.php
diff --git a/test/Document/Resource/ResourceTest.php b/test/Document/Resource/ResourceTest.php
diff --git a/test/IntegrationTest.php b/test/IntegrationTest.php

Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,12 @@`
`7`	`7`	`* For the full copyright and license information, please view the LICENSE`
`8`	`8`	`* file that was distributed with this source code.`
`9`	`9`	`*/`
	`10`	`+`
`10`	`11`	`declare(strict_types=1);`
`11`	`12`
`12`	`13`	`namespace JsonApiPhp\JsonApi\Document\Resource\Relationship;`
`13`	`14`
	`15`	`+use JsonApiPhp\JsonApi\Document\Link\LinkInterface;`
`14`	`16`	`use JsonApiPhp\JsonApi\Document\LinksTrait;`
`15`	`17`	`use JsonApiPhp\JsonApi\Document\Meta;`
`16`	`18`	`use JsonApiPhp\JsonApi\Document\MetaTrait;`
`@@ -38,17 +40,17 @@ public static function fromMeta(Meta $meta): self`
`38`	`40`	`return $r;`
`39`	`41`	`}`
`40`	`42`
`41`		`- public static function fromSelfLink(string $link, array $meta = null): self`
	`43`	`+ public static function fromSelfLink(LinkInterface $link): self`
`42`	`44`	`{`
`43`	`45`	`$r = new self;`
`44`		`- $r->setLink('self', $link, $meta);`
	`46`	`+ $r->setLinkObject('self', $link);`
`45`	`47`	`return $r;`
`46`	`48`	`}`
`47`	`49`
`48`		`- public static function fromRelatedLink(string $link, array $meta = null): self`
	`50`	`+ public static function fromRelatedLink(LinkInterface $link): self`
`49`	`51`	`{`
`50`	`52`	`$r = new self;`
`51`		`- $r->setLink('related', $link, $meta);`
	`53`	`+ $r->setLinkObject('related', $link);`
`52`	`54`	`return $r;`
`53`	`55`	`}`
`54`	`56`