[Refactor] Initial work on upgrading neomerx dependency

Author: lindyhopchris

composer.json

@@ -24,7 +24,7 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-json": "*",
-        "laravel-json-api/neomerx-json-api": "^1.1",
+        "laravel-json-api/neomerx-json-api": "^5.0",
         "laravel/framework": "^8.76|^9.0",
         "nyholm/psr7": "^1.2",
         "ramsey/uuid": "^3.0|^4.0",

src/Adapter/AbstractRelationshipAdapter.php

@@ -18,9 +18,9 @@
 namespace CloudCreativity\LaravelJsonApi\Adapter;
 
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreAwareInterface;
 use CloudCreativity\LaravelJsonApi\Store\StoreAwareTrait;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class AbstractRelationshipAdapter

src/Adapter/AbstractResourceAdapter.php

@@ -21,6 +21,7 @@
 use CloudCreativity\LaravelJsonApi\Codec\ChecksMediaTypes;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\ResourceAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Queue\AsynchronousProcess;
 use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreAwareInterface;
 use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
@@ -29,7 +30,6 @@
 use CloudCreativity\LaravelJsonApi\Utils\InvokesHooks;
 use CloudCreativity\LaravelJsonApi\Utils\Str;
 use Illuminate\Support\Collection;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class AbstractResourceAdaptor

src/Adapter/Concerns/FindsManyResources.php

@@ -19,7 +19,7 @@
 
 use Illuminate\Support\Collection;
 use InvalidArgumentException;
-use Neomerx\JsonApi\Contracts\Document\DocumentInterface;
+use Neomerx\JsonApi\Contracts\Schema\DocumentInterface;
 use function is_array;
 use function is_string;
 

src/Api/Api.php

@@ -27,14 +27,13 @@
 use CloudCreativity\LaravelJsonApi\Contracts\Exceptions\ExceptionParserInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Resolver\ResolverInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreInterface;
+use CloudCreativity\LaravelJsonApi\Encoder\EncoderOptions;
 use CloudCreativity\LaravelJsonApi\Factories\Factory;
 use CloudCreativity\LaravelJsonApi\Http\Responses\Responses;
 use CloudCreativity\LaravelJsonApi\Resolver\AggregateResolver;
 use CloudCreativity\LaravelJsonApi\Resolver\NamespaceResolver;
 use GuzzleHttp\Client;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
-use Neomerx\JsonApi\Contracts\Http\Headers\SupportedExtensionsInterface;
-use Neomerx\JsonApi\Encoder\EncoderOptions;
 
 /**
  * Class Api
@@ -212,18 +211,6 @@ public function getStore()
         return $this->store;
     }
 
-    /**
-     * @return SupportedExtensionsInterface|null
-     */
-    public function getSupportedExtensions()
-    {
-        if ($ext = $this->config->supportedExt()) {
-            return $this->factory->createSupportedExtensions($ext);
-        }
-
-        return null;
-    }
-
     /**
      * @return EncodingList
      */
@@ -333,7 +320,9 @@ public function encoder($options = 0, $depth = 512)
             $options = new EncoderOptions($options, $this->getUrl()->toString(), $depth);
         }
 
-        return $this->factory->createEncoder($this->getContainer(), $options);
+        return $this->factory
+            ->createExtendedEncoder($this->getContainer())
+            ->withEncoderOptions($options);
     }
 
     /**

src/Api/LinkGenerator.php

@@ -19,8 +19,8 @@
 namespace CloudCreativity\LaravelJsonApi\Api;
 
 use Illuminate\Contracts\Routing\UrlGenerator as IlluminateUrlGenerator;
-use Neomerx\JsonApi\Contracts\Document\LinkInterface;
-use Neomerx\JsonApi\Contracts\Schema\SchemaFactoryInterface;
+use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
+use Neomerx\JsonApi\Contracts\Schema\LinkInterface;
 
 /**
  * Class LinkGenerator
@@ -31,28 +31,28 @@ class LinkGenerator
 {
 
     /**
-     * @var SchemaFactoryInterface
+     * @var FactoryInterface
      */
-    private $factory;
+    private FactoryInterface $factory;
 
     /**
      * @var UrlGenerator
      */
-    private $urls;
+    private UrlGenerator $urls;
 
     /**
      * @var IlluminateUrlGenerator
      */
-    private $generator;
+    private IlluminateUrlGenerator $generator;
 
     /**
      * LinkGenerator constructor.
      *
-     * @param SchemaFactoryInterface $factory
+     * @param FactoryInterface $factory
      * @param UrlGenerator $urls
      * @param IlluminateUrlGenerator $generator
      */
-    public function __construct(SchemaFactoryInterface $factory, UrlGenerator $urls, IlluminateUrlGenerator $generator)
+    public function __construct(FactoryInterface $factory, UrlGenerator $urls, IlluminateUrlGenerator $generator)
     {
         $this->factory = $factory;
         $this->urls = $urls;
@@ -74,7 +74,7 @@ public function current($meta = null, array $queryParams = [])
             $url .= '?' . http_build_query($queryParams);
         }
 
-        return $this->factory->createLink($url, $meta, true);
+        return $this->createLink($url, $meta, true);
     }
 
     /**
@@ -87,7 +87,7 @@ public function current($meta = null, array $queryParams = [])
      */
     public function index($resourceType, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->index($resourceType, $queryParams),
             $meta,
             true
@@ -104,7 +104,7 @@ public function index($resourceType, $meta = null, array $queryParams = [])
      */
     public function create($resourceType, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->create($resourceType, $queryParams),
             $meta,
             true
@@ -122,7 +122,7 @@ public function create($resourceType, $meta = null, array $queryParams = [])
      */
     public function read($resourceType, $id, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->read($resourceType, $id, $queryParams),
             $meta,
             true
@@ -140,7 +140,7 @@ public function read($resourceType, $id, $meta = null, array $queryParams = [])
      */
     public function update($resourceType, $id, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->update($resourceType, $id, $queryParams),
             $meta,
             true
@@ -158,7 +158,7 @@ public function update($resourceType, $id, $meta = null, array $queryParams = []
      */
     public function delete($resourceType, $id, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->delete($resourceType, $id, $queryParams),
             $meta,
             true
@@ -177,7 +177,7 @@ public function delete($resourceType, $id, $meta = null, array $queryParams = []
      */
     public function relatedResource($resourceType, $id, $relationshipKey, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->relatedResource($resourceType, $id, $relationshipKey, $queryParams),
             $meta,
             true
@@ -196,7 +196,7 @@ public function relatedResource($resourceType, $id, $relationshipKey, $meta = nu
      */
     public function readRelationship($resourceType, $id, $relationshipKey, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->readRelationship($resourceType, $id, $relationshipKey, $queryParams),
             $meta,
             true
@@ -215,7 +215,7 @@ public function readRelationship($resourceType, $id, $relationshipKey, $meta = n
      */
     public function replaceRelationship($resourceType, $id, $relationshipKey, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->replaceRelationship($resourceType, $id, $relationshipKey, $queryParams),
             $meta,
             true
@@ -234,7 +234,7 @@ public function replaceRelationship($resourceType, $id, $relationshipKey, $meta
      */
     public function addRelationship($resourceType, $id, $relationshipKey, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->addRelationship($resourceType, $id, $relationshipKey, $queryParams),
             $meta,
             true
@@ -249,15 +249,35 @@ public function addRelationship($resourceType, $id, $relationshipKey, $meta = nu
      * @param $relationshipKey
      * @param array|object|null $meta
      * @param array $queryParams
-     * @return string
+     * @return LinkInterface
      */
     public function removeRelationship($resourceType, $id, $relationshipKey, $meta = null, array $queryParams = [])
     {
-        return $this->factory->createLink(
+        return $this->createLink(
             $this->urls->removeRelationship($resourceType, $id, $relationshipKey, $queryParams),
             $meta,
             true
         );
     }
 
+    /**
+     * Create a link.
+     *
+     * This method uses the old method signature for creating a link via the Neomerx factory, and converts
+     * it to a call to the new factory method signature.
+     *
+     * @param string $subHref
+     * @param array|object|null $meta
+     * @param bool $treatAsHref
+     * @return LinkInterface
+     */
+    private function createLink(string $subHref, $meta = null, bool $treatAsHref = false): LinkInterface
+    {
+        return $this->factory->createLink(
+            false === $treatAsHref,
+            $subHref,
+            !is_null($meta),
+            $meta,
+        );
+    }
 }

src/Broadcasting/BroadcastsData.php

@@ -19,7 +19,7 @@
 namespace CloudCreativity\LaravelJsonApi\Broadcasting;
 
 use CloudCreativity\LaravelJsonApi\Contracts\Encoder\SerializerInterface;
-use Neomerx\JsonApi\Encoder\Parameters\EncodingParameters;
+use CloudCreativity\LaravelJsonApi\Encoder\Parameters\EncodingParameters;
 
 /**
  * Trait BroadcastsData

src/Client/AbstractClient.php

@@ -20,8 +20,8 @@
 use CloudCreativity\LaravelJsonApi\Contracts\Client\ClientInterface;
 use CloudCreativity\LaravelJsonApi\Encoder\Parameters\EncodingParameters;
 use CloudCreativity\LaravelJsonApi\Exceptions\ClientException;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
-use Neomerx\JsonApi\Contracts\Schema\ContainerInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
+use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
 use Neomerx\JsonApi\Http\Headers\MediaType;
 use Psr\Http\Message\ResponseInterface;
 
@@ -34,9 +34,9 @@ abstract class AbstractClient implements ClientInterface
 {
 
     /**
-     * @var ContainerInterface
+     * @var SchemaContainerInterface
      */
-    protected $schemas;
+    protected SchemaContainerInterface $schemas;
 
     /**
      * @var ClientSerializer
@@ -79,10 +79,10 @@ abstract protected function request(
     /**
      * AbstractClient constructor.
      *
-     * @param ContainerInterface $schemas
+     * @param SchemaContainerInterface $schemas
      * @param ClientSerializer $serializer
      */
-    public function __construct(ContainerInterface $schemas, ClientSerializer $serializer)
+    public function __construct(SchemaContainerInterface $schemas, ClientSerializer $serializer)
     {
         $this->schemas = $schemas;
         $this->serializer = $serializer;
@@ -406,7 +406,7 @@ protected function resourceIdentifier($record)
     {
         $schema = $this->schemas->getSchema($record);
 
-        return [$schema->getResourceType(), $schema->getId($record)];
+        return [$schema->getType(), $schema->getId($record)];
     }
 
     /**

src/Client/ClientSerializer.php

@@ -17,10 +17,10 @@
 
 namespace CloudCreativity\LaravelJsonApi\Client;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Encoder\SerializerInterface;
+use CloudCreativity\LaravelJsonApi\Factories\Factory;
 use Illuminate\Support\Collection;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
-use Neomerx\JsonApi\Contracts\Http\HttpFactoryInterface;
 
 /**
  * Class ClientSerializer
@@ -36,7 +36,7 @@ class ClientSerializer
     protected $serializer;
 
     /**
-     * @var HttpFactoryInterface
+     * @var Factory;
      */
     protected $factory;
 
@@ -64,9 +64,9 @@ class ClientSerializer
      * ClientSerializer constructor.
      *
      * @param SerializerInterface $serializer
-     * @param HttpFactoryInterface $factory
+     * @param Factory $factory
      */
-    public function __construct(SerializerInterface $serializer, HttpFactoryInterface $factory)
+    public function __construct(SerializerInterface $serializer, Factory $factory)
     {
         $this->serializer = $serializer;
         $this->factory = $factory;

src/Client/GuzzleClient.php

@@ -23,7 +23,7 @@
 use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Exception\TransferException;
 use GuzzleHttp\Psr7\Request;
-use Neomerx\JsonApi\Contracts\Schema\ContainerInterface;
+use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
 
 /**
  * Class GuzzleClient
@@ -42,12 +42,12 @@ class GuzzleClient extends AbstractClient
      * GuzzleClient constructor.
      *
      * @param Client $http
-     * @param ContainerInterface $schemas
+     * @param SchemaContainerInterface $schemas
      * @param ClientSerializer $serializer
      */
     public function __construct(
         Client $http,
-        ContainerInterface $schemas,
+        SchemaContainerInterface $schemas,
         ClientSerializer $serializer
     ) {
         parent::__construct($schemas, $serializer);