[Refactor] Get default include paths working

Author: lindyhopchris

src/Api/Api.php

@@ -34,7 +34,6 @@
 use CloudCreativity\LaravelJsonApi\Resolver\NamespaceResolver;
 use GuzzleHttp\Client;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
-use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
 
 /**
  * Class Api
@@ -322,7 +321,7 @@ public function encoder($options = 0, $depth = 512)
         }
 
         return $this->factory
-            ->createExtendedEncoder($this->getSchemaContainer())
+            ->createLaravelEncoder($this->getContainer())
             ->withEncoderOptions($options);
     }
 
@@ -359,7 +358,7 @@ public function client($clientHostOrOptions = [], array $options = [])
 
         $client = ($clientHostOrOptions instanceof Client) ? $clientHostOrOptions : new Client($options);
 
-        return $this->factory->createClient($client, $this->getSchemaContainer(), $this->encoder());
+        return $this->factory->createClient($client, $this->getContainer(), $this->encoder());
     }
 
     /**
@@ -399,14 +398,4 @@ public function register(AbstractProvider $provider)
     {
         $this->resolver->attach($provider->getResolver());
     }
-
-    /**
-     * @return SchemaContainerInterface
-     */
-    private function getSchemaContainer(): SchemaContainerInterface
-    {
-        return $this->factory->createLaravelSchemaContainer(
-            $this->getContainer()
-        );
-    }
 }

src/Codec/Codec.php

@@ -110,8 +110,8 @@ public function getEncoder(): Encoder
             throw new \RuntimeException('Codec does not support encoding JSON API content.');
         }
 
-        $encoder = $this->factory->createExtendedEncoder(
-            $this->factory->createLaravelSchemaContainer($this->container)
+        $encoder = $this->factory->createLaravelEncoder(
+            $this->container,
         );
 
         $options = $this->encoding->getOptions();

src/Container.php

@@ -19,12 +19,14 @@
 
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\ResourceAdapterInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Auth\AuthorizerInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\ContainerAwareInterface;
 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 Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Contracts\Container\Container as IlluminateContainer;
 
 /**
@@ -501,18 +503,37 @@ protected function createContentNegotiatorFromClassName($className)
     }
 
     /**
-     * @inheritDoc
+     * @param string|null $className
+     * @return mixed|nulL
      */
-    protected function create($className)
+    protected function create(?string $className)
     {
-        return $this->exists($className) ? $this->container->make($className) : null;
+        if (false === $this->exists($className)) {
+            return null;
+        }
+
+        try {
+            $value = $this->container->make($className);
+        } catch (BindingResolutionException $ex) {
+            throw new RuntimeException(
+                sprintf('JSON:API container was unable to build %s via the service container.', $className),
+                0,
+                $ex,
+            );
+        }
+
+        if ($value instanceof ContainerAwareInterface) {
+            $value->withContainer($this);
+        }
+
+        return $value;
     }
 
     /**
-     * @param $className
+     * @param string|null $className
      * @return bool
      */
-    protected function exists($className): bool
+    protected function exists(?string $className): bool
     {
         if (null === $className) {
             return false;

src/Contracts/ContainerAwareInterface.php

@@ -0,0 +1,31 @@
+<?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;
+
+interface ContainerAwareInterface
+{
+    /**
+     * Inject the container instance.
+     *
+     * @param ContainerInterface $container
+     * @return void
+     */
+    public function withContainer(ContainerInterface $container): void;
+}

src/Eloquent/AbstractAdapter.php

@@ -20,9 +20,12 @@
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\HasManyAdapterInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\ContainerAwareInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\ContainerInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PageInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PagingStrategyInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Schema\SchemaProviderInterface;
 use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
 use CloudCreativity\LaravelJsonApi\Http\Query\QueryParameters;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
@@ -37,7 +40,7 @@
  *
  * @package CloudCreativity\LaravelJsonApi
  */
-abstract class AbstractAdapter extends AbstractResourceAdapter
+abstract class AbstractAdapter extends AbstractResourceAdapter implements ContainerAwareInterface
 {
 
     use Concerns\DeserializesAttributes,
@@ -92,6 +95,11 @@ abstract class AbstractAdapter extends AbstractResourceAdapter
      */
     private $scopes;
 
+    /**
+     * @var SchemaProviderInterface|null
+     */
+    private ?SchemaProviderInterface $schema = null;
+
     /**
      * Apply the supplied filters to the builder instance.
      *
@@ -114,6 +122,14 @@ public function __construct(Model $model, PagingStrategyInterface $paging = null
         $this->scopes = [];
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function withContainer(ContainerInterface $container): void
+    {
+        $this->schema = $container->getSchema($this->model);
+    }
+
     /**
      * @inheritDoc
      */
@@ -682,7 +698,7 @@ protected function queryOne($query, QueryParametersInterface $parameters)
     }
 
     /**
-     * Get JSON API parameters to use when constructing an Eloquent query.
+     * Get JSON:API parameters to use when constructing an Eloquent query.
      *
      * This method is used to push in any default parameter values that should
      * be used if the client has not provided any.
@@ -693,7 +709,7 @@ protected function queryOne($query, QueryParametersInterface $parameters)
     protected function getQueryParameters(QueryParametersInterface $parameters)
     {
         return new QueryParameters(
-            $parameters->getIncludePaths(),
+            $parameters->getIncludePaths() ?? $this->getSchema()->getIncludePaths(),
             $parameters->getFieldSets(),
             $parameters->getSortParameters() ?: $this->defaultSort(),
             $parameters->getPaginationParameters() ?: $this->defaultPagination(),
@@ -702,6 +718,21 @@ protected function getQueryParameters(QueryParametersInterface $parameters)
         );
     }
 
+    /**
+     * @return SchemaProviderInterface
+     */
+    protected function getSchema(): SchemaProviderInterface
+    {
+        if ($this->schema) {
+            return $this->schema;
+        }
+
+        throw new RuntimeException(sprintf(
+            'Expecting schema to be set in adapters %s.',
+            get_class($this),
+        ));
+    }
+
     /**
      * @return string
      */

src/Encoder/DataAnalyser.php

@@ -0,0 +1,121 @@
+<?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\Encoder;
+
+use ArrayAccess;
+use CloudCreativity\LaravelJsonApi\Contracts\ContainerInterface;
+use Generator;
+use Illuminate\Support\Enumerable;
+use Iterator;
+use RuntimeException;
+
+class DataAnalyser
+{
+    /**
+     * @var ContainerInterface
+     */
+    private ContainerInterface $container;
+
+    /**
+     * DataAnalyser constructor.
+     *
+     * @param ContainerInterface $container
+     */
+    public function __construct(ContainerInterface $container)
+    {
+        $this->container = $container;
+    }
+
+    /**
+     * @param object|iterable|null $data
+     * @return object|null
+     */
+    public function getRootObject($data): ?object
+    {
+        if ($data instanceof Generator) {
+            throw new RuntimeException('Generators are not supported as resource collections.');
+        }
+
+        if (null === $data || $this->isResource($data)) {
+            return $data;
+        }
+
+        $value = $this->getRootObjectFromIterable($data);
+
+        if (null === $value || $this->isResource($value)) {
+            return $value;
+        }
+
+        throw new RuntimeException(
+            sprintf('Unexpected data type: %s.', get_debug_type($value)),
+        );
+    }
+
+    /**
+     * @param object|iterable|null $data
+     * @return array
+     */
+    public function getIncludePaths($data): array
+    {
+        $includePaths = [];
+        $root = $this->getRootObject($data);
+
+        if (null !== $root) {
+            $includePaths = $this->container->getSchema($root)->getIncludePaths();
+        }
+
+        return $includePaths;
+    }
+
+    /**
+     * @param mixed $value
+     * @return bool
+     */
+    private function isResource($value): bool
+    {
+        return is_object($value) && $this->container->hasSchema($value);
+    }
+
+    /**
+     * @param iterable $data
+     * @return object|null
+     */
+    private function getRootObjectFromIterable(iterable $data): ?object
+    {
+        if (is_array($data)) {
+            return $data[0] ?? null;
+        }
+
+        if ($data instanceof Enumerable) {
+            return $data->first();
+        }
+
+        if ($data instanceof Iterator) {
+            $data->rewind();
+            return $data->valid() ? $data->current() : null;
+        }
+
+        foreach ($data as $value) {
+            return $value;
+        }
+
+        return null;
+    }
+}