[Refactor] Initial work upgrading schemas

Author: lindyhopchris

src/Codec/Decoding.php

@@ -20,6 +20,7 @@
 use CloudCreativity\LaravelJsonApi\Contracts\Decoder\DecoderInterface;
 use CloudCreativity\LaravelJsonApi\Decoder\JsonApiDecoder;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
+use CloudCreativity\LaravelJsonApi\Http\Headers\MediaTypeParser;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
 use Neomerx\JsonApi\Http\Headers\MediaType;
 
@@ -51,7 +52,7 @@ class Decoding
     public static function create($mediaType, $decoder): self
     {
         if (is_string($mediaType)) {
-            $mediaType = MediaType::parse(0, $mediaType);
+            $mediaType = MediaTypeParser::getInstance()->parse($mediaType);
         }
 
         if (!$mediaType instanceof MediaTypeInterface) {

src/Codec/DecodingList.php

@@ -17,9 +17,9 @@
 
 namespace CloudCreativity\LaravelJsonApi\Codec;
 
-use Neomerx\JsonApi\Contracts\Http\Headers\HeaderInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\HeaderInterface;
+use CloudCreativity\LaravelJsonApi\Http\Headers\MediaTypeParser;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
-use Neomerx\JsonApi\Http\Headers\MediaType;
 
 /**
  * Class DecodingList
@@ -142,7 +142,7 @@ public function unless(bool $test, $decodings): self
      */
     public function find(string $mediaType): ?Decoding
     {
-        return $this->equalsTo(MediaType::parse(0, $mediaType));
+        return $this->equalsTo(MediaTypeParser::getInstance()->parse($mediaType));
     }
 
     /**

src/Codec/Encoding.php

@@ -18,9 +18,9 @@
 namespace CloudCreativity\LaravelJsonApi\Codec;
 
 use CloudCreativity\LaravelJsonApi\Encoder\EncoderOptions;
+use CloudCreativity\LaravelJsonApi\Http\Headers\MediaTypeParser;
 use Neomerx\JsonApi\Contracts\Http\Headers\AcceptMediaTypeInterface;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
-use Neomerx\JsonApi\Http\Headers\MediaType;
 
 /**
  * Class Encoding
@@ -29,16 +29,15 @@
  */
 class Encoding
 {
-
     /**
      * @var MediaTypeInterface
      */
-    private $mediaType;
+    private MediaTypeInterface $mediaType;
 
     /**
      * @var EncoderOptions|null
      */
-    private $options;
+    private ?EncoderOptions $options;
 
     /**
      * Create an encoding that will encode JSON API content.
@@ -57,7 +56,7 @@ public static function create(
     ): self
     {
         if (!$mediaType instanceof MediaTypeInterface) {
-            $mediaType = MediaType::parse(0, $mediaType);
+            $mediaType = MediaTypeParser::getInstance()->parse($mediaType);
         }
 
         return new self($mediaType, new EncoderOptions($options, $urlPrefix, $depth));
@@ -90,7 +89,7 @@ public static function jsonApi(int $options = 0, string $urlPrefix = null, int $
     public static function custom($mediaType): self
     {
         if (!$mediaType instanceof MediaTypeInterface) {
-            $mediaType = MediaType::parse(0, $mediaType);
+            $mediaType = MediaTypeParser::getInstance()->parse($mediaType);
         }
 
         return new self($mediaType, null);
@@ -161,8 +160,8 @@ public function hasOptions(): bool
      */
     public function is(string ...$mediaTypes): bool
     {
-        $mediaTypes = collect($mediaTypes)->map(function ($mediaType, $index) {
-            return MediaType::parse($index, $mediaType);
+        $mediaTypes = collect($mediaTypes)->map(function ($mediaType) {
+            return MediaTypeParser::getInstance()->parse($mediaType);
         });
 
         return $this->any(...$mediaTypes);

src/Codec/EncodingList.php

@@ -18,8 +18,8 @@
 namespace CloudCreativity\LaravelJsonApi\Codec;
 
 use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\AcceptHeaderInterface;
+use CloudCreativity\LaravelJsonApi\Http\Headers\MediaTypeParser;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
-use Neomerx\JsonApi\Http\Headers\MediaType;
 
 /**
  * Class EncodingList
@@ -190,7 +190,7 @@ public function optional($encoding): self
      */
     public function find(string $mediaType): ?Encoding
     {
-        return $this->matchesTo(MediaType::parse(0, $mediaType));
+        return $this->matchesTo(MediaTypeParser::getInstance()->parse($mediaType));
     }
 
     /**

src/Container.php

@@ -22,9 +22,12 @@
 use CloudCreativity\LaravelJsonApi\Contracts\ContainerInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Http\ContentNegotiatorInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Resolver\ResolverInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Schema\SchemaProviderInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Validation\ValidatorFactoryInterface;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
+use CloudCreativity\LaravelJsonApi\Schema\Schema;
 use Illuminate\Contracts\Container\Container as IlluminateContainer;
+use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
 use Neomerx\JsonApi\Contracts\Schema\SchemaInterface;
 
 /**
@@ -344,10 +347,17 @@ protected function setCreatedSchema($resourceType, SchemaInterface $schema): voi
      * @param string $className
      * @return SchemaInterface
      */
-    protected function createSchemaFromClassName($className): SchemaInterface
+    protected function createSchemaFromClassName(string $className): SchemaInterface
     {
         $schema = $this->create($className);
 
+        if ($schema instanceof SchemaProviderInterface) {
+            return new Schema(
+                $this->container->make(FactoryInterface::class),
+                $schema,
+            );
+        }
+
         if (!$schema instanceof SchemaInterface) {
             throw new RuntimeException("Class [$className] is not a schema provider.");
         }

src/Contracts/Schema/SchemaProviderInterface.php

@@ -0,0 +1,81 @@
+<?php
+/*
+ * Copyright 2022 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Contracts\Schema;
+
+use Neomerx\JsonApi\Contracts\Schema\ContextInterface;
+
+interface SchemaProviderInterface
+{
+    public const SHOW_SELF = 'showSelf';
+    public const SHOW_RELATED = 'related';
+    public const SHOW_DATA = 'showData';
+    public const DATA = 'data';
+    public const META = 'meta';
+    public const LINKS = 'links';
+
+    /**
+     * Set the current context.
+     *
+     * @param ContextInterface|null $context
+     * @return void
+     */
+    public function setContext(?ContextInterface $context): void;
+
+    /**
+     * Get the resource type.
+     *
+     * @return string
+     */
+    public function getResourceType(): string;
+
+    /**
+     * Get the resource id.
+     *
+     * @param object $resource
+     * @return string
+     */
+    public function getId(object $resource): string;
+
+    /**
+     * Get the resource attributes.
+     *
+     * @param object $resource
+     * @return array
+     */
+    public function getAttributes(object $resource): array;
+
+    /**
+     * Get the resource relationships.
+     *
+     * @param object $resource
+     * @param bool $isPrimary
+     * @param array $includedRelationships
+     * @return array
+     */
+    public function getRelationships(object $resource, bool $isPrimary, array $includedRelationships): array;
+
+    /**
+     * Get the resource self url.
+     *
+     * @param object|null $resource
+     * @return string
+     */
+    public function getSelfSubUrl(object $resource = null): string;
+}