[Refactor] Add query parameter parsing and fix use statements

lindyhopchris · lindyhopchris · commit 9378a254768f · 2022-05-15T20:19:49.000+01:00
diff --git a/docs/basics/adapters.md b/docs/basics/adapters.md
@@ -582,9 +582,9 @@ For example, this would create the following for a `posts` resource:
 namespace App\JsonApi\Posts;
 
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
 use Illuminate\Support\Collection;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class DummyClass extends AbstractResourceAdapter
 {
diff --git a/docs/features/async.md b/docs/features/async.md
@@ -171,7 +171,6 @@ namespace App\JsonApi\Podcasts;
 
 use App\Jobs\ProcessPodcast;
 use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class Adapter extends AbstractAdapter
 {
diff --git a/docs/features/media-types.md b/docs/features/media-types.md
@@ -370,8 +370,8 @@ data. For example:
 ```php
 namespace App\JsonApi\Posts;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class Adapter extends AbstractAdapter
 {
diff --git a/src/Contracts/Encoder/Parameters/SortParameterInterface.php b/src/Contracts/Encoder/Parameters/SortParameterInterface.php
@@ -19,7 +19,9 @@
 
 namespace CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters;
 
-interface SortParameterInterface
+use Stringable;
+
+interface SortParameterInterface extends Stringable
 {
     /**
      * Get sort field name.
diff --git a/src/Contracts/Http/Query/QueryParametersParserInterface.php b/src/Contracts/Http/Query/QueryParametersParserInterface.php
@@ -0,0 +1,33 @@
+<?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\Http\Query;
+
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
+
+interface QueryParametersParserInterface
+{
+    /**
+     * Parse input parameters from request.
+     *
+     * @param array $parameters
+     * @return EncodingParametersInterface
+     */
+    public function parseQueryParameters(array $parameters): EncodingParametersInterface;
+}
diff --git a/src/Eloquent/AbstractAdapter.php b/src/Eloquent/AbstractAdapter.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  * Copyright 2022 Cloud Creativity Limited
  *
@@ -21,17 +20,17 @@
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\HasManyAdapterInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PageInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PagingStrategyInterface;
 use CloudCreativity\LaravelJsonApi\Document\ResourceObject;
+use CloudCreativity\LaravelJsonApi\Encoder\Parameters\EncodingParameters;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations;
 use Illuminate\Database\Eloquent\Scope;
 use Illuminate\Support\Collection;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
-use Neomerx\JsonApi\Encoder\Parameters\EncodingParameters;
 
 /**
  * Class AbstractAdapter
diff --git a/src/Eloquent/AbstractManyRelation.php b/src/Eloquent/AbstractManyRelation.php
@@ -19,8 +19,8 @@
 
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractRelationshipAdapter;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\HasManyAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Illuminate\Database\Eloquent\Model;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class AbstractManyRelation
diff --git a/src/Eloquent/BelongsTo.php b/src/Eloquent/BelongsTo.php
@@ -18,9 +18,9 @@
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractRelationshipAdapter;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class HasOne
diff --git a/src/Eloquent/Concerns/IncludesModels.php b/src/Eloquent/Concerns/IncludesModels.php
@@ -17,11 +17,11 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent\Concerns;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Utils\Str;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Trait IncludesModels
diff --git a/src/Eloquent/Concerns/QueriesRelations.php b/src/Eloquent/Concerns/QueriesRelations.php
@@ -17,12 +17,12 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent\Concerns;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Trait QueriesRelations
diff --git a/src/Eloquent/HasMany.php b/src/Eloquent/HasMany.php
@@ -17,10 +17,10 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class HasMany
diff --git a/src/Eloquent/HasManyThrough.php b/src/Eloquent/HasManyThrough.php
@@ -17,9 +17,9 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
 use Illuminate\Database\Eloquent\Relations;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class HasManyThrough
diff --git a/src/Eloquent/HasOne.php b/src/Eloquent/HasOne.php
@@ -17,9 +17,9 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class HasOne extends BelongsTo
 {
diff --git a/src/Eloquent/HasOneThrough.php b/src/Eloquent/HasOneThrough.php
@@ -17,9 +17,9 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
 use Illuminate\Database\Eloquent\Relations;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 class HasOneThrough extends BelongsTo
 {
diff --git a/src/Eloquent/MorphHasMany.php b/src/Eloquent/MorphHasMany.php
@@ -18,11 +18,11 @@
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\HasManyAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PageInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreAwareInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Store\StoreInterface;
 use Illuminate\Pagination\AbstractPaginator;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class MorphHasMany
diff --git a/src/Eloquent/QueriesMany.php b/src/Eloquent/QueriesMany.php
@@ -19,10 +19,10 @@
 
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractRelationshipAdapter;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\HasManyAdapterInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Eloquent\Concerns\QueriesRelations;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
 use Illuminate\Database\Eloquent\Builder;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class QueriesMany
diff --git a/src/Eloquent/QueriesOne.php b/src/Eloquent/QueriesOne.php
@@ -18,10 +18,10 @@
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractRelationshipAdapter;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Eloquent\Concerns\QueriesRelations;
 use CloudCreativity\LaravelJsonApi\Exceptions\RuntimeException;
 use Illuminate\Database\Eloquent\Builder;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class QueriesOne
diff --git a/src/Http/Query/QueryParametersParser.php b/src/Http/Query/QueryParametersParser.php
@@ -0,0 +1,147 @@
+<?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\Http\Query;
+
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Query\QueryParametersParserInterface;
+use CloudCreativity\LaravelJsonApi\Encoder\Parameters\EncodingParameters;
+use CloudCreativity\LaravelJsonApi\Encoder\Parameters\SortParameter;
+use Neomerx\JsonApi\Http\Query\BaseQueryParser;
+use Neomerx\JsonApi\Http\Query\BaseQueryParserTrait;
+use RuntimeException;
+use Traversable;
+
+class QueryParametersParser implements QueryParametersParserInterface
+{
+    use BaseQueryParserTrait;
+
+    /**
+     * @inheritDoc
+     */
+    public function parseQueryParameters(array $parameters): EncodingParametersInterface
+    {
+        $message = BaseQueryParser::MSG_ERR_INVALID_PARAMETER;
+
+        return new EncodingParameters(
+            $this->getIncludeParameters($parameters, $message),
+            $this->getFieldParameters($parameters, $message),
+            $this->getSortParameters($parameters, $message),
+            $parameters[BaseQueryParser::PARAM_PAGE] ?? null,
+            $parameters[BaseQueryParser::PARAM_FILTER] ?? null,
+            $this->getUnrecognizedParameters($parameters),
+        );
+    }
+
+    /**
+     * Parse include parameters.
+     *
+     * @param array $parameters
+     * @param string $message
+     * @return array|null
+     */
+    private function getIncludeParameters(array $parameters, string $message): ?array
+    {
+        if (!array_key_exists(BaseQueryParser::PARAM_INCLUDE, $parameters)) {
+            return null;
+        }
+
+        return $this->iteratorToArray($this->getIncludePaths($parameters, $message));
+    }
+
+    /**
+     * Parse sparse field sets
+     *
+     * @param array $parameters
+     * @param string $message
+     * @return array|null
+     */
+    private function getFieldParameters(array $parameters, string $message): ?array
+    {
+        if (!array_key_exists(BaseQueryParser::PARAM_FIELDS, $parameters)) {
+            return null;
+        }
+
+        $fieldSets = [];
+
+        foreach ($this->getFields($parameters, $message) as $type => $fieldList) {
+            $fieldSets[$type] = $this->iteratorToArray($fieldList);
+        }
+
+        return $fieldSets;
+    }
+
+    /**
+     * Parse sort parameters.
+     *
+     * @param array $parameters
+     * @param string $message
+     * @return SortParameter[]|null
+     */
+    private function getSortParameters(array $parameters, string $message): ?array
+    {
+        if (!array_key_exists(BaseQueryParser::PARAM_SORT, $parameters)) {
+            return null;
+        }
+
+        $values = [];
+
+        foreach ($this->getSorts($parameters, $message) as $field => $isAsc) {
+            $values[] = new SortParameter($field, $isAsc);
+        }
+
+        return $values;
+    }
+
+    /**
+     * Parse unrecognized parameters.
+     *
+     * @param array $parameters
+     * @return array|null
+     */
+    private function getUnrecognizedParameters(array $parameters): ?array
+    {
+        unset(
+            $parameters[BaseQueryParser::PARAM_INCLUDE],
+            $parameters[BaseQueryParser::PARAM_FIELDS],
+            $parameters[BaseQueryParser::PARAM_SORT],
+            $parameters[BaseQueryParser::PARAM_PAGE],
+            $parameters[BaseQueryParser::PARAM_FILTER],
+        );
+
+        return empty($parameters) ? null : $parameters;
+    }
+
+    /**
+     * @param iterable $value
+     * @return array
+     */
+    private function iteratorToArray(iterable $value): array
+    {
+        if ($value instanceof Traversable) {
+            return iterator_to_array($value);
+        }
+
+        if (is_array($value)) {
+            return $value;
+        }
+
+        throw new RuntimeException('Unexpected iterable value.');
+    }
+}
diff --git a/src/Http/Requests/ValidatedRequest.php b/src/Http/Requests/ValidatedRequest.php
@@ -19,6 +19,7 @@
 
 use CloudCreativity\LaravelJsonApi\Contracts\Auth\AuthorizerInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\ContainerInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Validation\DocumentValidatorInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Validation\ValidatorFactoryInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Validation\ValidatorInterface;
@@ -32,7 +33,6 @@
 use Illuminate\Http\Request;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Arr;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Neomerx\JsonApi\Exceptions\JsonApiException;
 
 /**
diff --git a/src/Pagination/CreatesPages.php b/src/Pagination/CreatesPages.php
diff --git a/src/Pagination/CursorStrategy.php b/src/Pagination/CursorStrategy.php
diff --git a/src/Pagination/StandardStrategy.php b/src/Pagination/StandardStrategy.php
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
diff --git a/stubs/abstract/adapter.stub b/stubs/abstract/adapter.stub
diff --git a/tests/dummy/app/JsonApi/Avatars/Adapter.php b/tests/dummy/app/JsonApi/Avatars/Adapter.php
diff --git a/tests/dummy/app/JsonApi/Sites/Adapter.php b/tests/dummy/app/JsonApi/Sites/Adapter.php
diff --git a/tests/lib/Unit/Http/Query/QueryParametersParserTest.php b/tests/lib/Unit/Http/Query/QueryParametersParserTest.php

Original file line number	Diff line number	Diff line change
@@ -582,9 +582,9 @@ For example, this would create the following for a `posts` resource:
`582`	`582`	`namespace App\JsonApi\Posts;`
`583`	`583`
`584`	`584`	`use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;`
	`585`	`+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;`
`585`	`586`	`use CloudCreativity\LaravelJsonApi\Document\ResourceObject;`
`586`	`587`	`use Illuminate\Support\Collection;`
`587`		`-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;`
`588`	`588`
`589`	`589`	`class DummyClass extends AbstractResourceAdapter`
`590`	`590`	`{`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,6 @@ namespace App\JsonApi\Podcasts;`
`171`	`171`
`172`	`172`	`use App\Jobs\ProcessPodcast;`
`173`	`173`	`use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;`
`174`		`-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;`
`175`	`174`
`176`	`175`	`class Adapter extends AbstractAdapter`
`177`	`176`	`{`
Original file line number	Diff line number	Diff line change
`@@ -370,8 +370,8 @@ data. For example:`
`370`	`370`	```php
`371`	`371`	`namespace App\JsonApi\Posts;`
`372`	`372`
	`373`	`+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;`
`373`	`374`	`use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;`
`374`		`-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;`
`375`	`375`
`376`	`376`	`class Adapter extends AbstractAdapter`
`377`	`377`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,9 @@`
`19`	`19`
`20`	`20`	`namespace CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters;`
`21`	`21`
`22`		`-interface SortParameterInterface`
	`22`	`+use Stringable;`
	`23`	`+`
	`24`	`+interface SortParameterInterface extends Stringable`
`23`	`25`	`{`
`24`	`26`	`/**`
`25`	`27`	`* Get sort field name.`