[Feature] Add sort-field generator command

Author: lindyhopchris

CHANGELOG.md

@@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file. This projec
   schemas. Previously only sortable attributes were supported. These new classes are added to schemas in the
   `sortables()` method.
 - Eloquent schemas now support a default sort order via the `$defaultSort` property.
+- New generator command `jsonapi:sort-field` to create a custom sort field class.
 - [#74](https://github.com/laravel-json-api/laravel/issues/74) Developers can now add default include paths to the query
   request classes (e.g. `PostQuery` and `PostCollectionQuery`) via the `$defaultIncludePaths` property. These include
   paths are used if the client does not provide any include paths.

src/Console/MakeSortField.php

@@ -0,0 +1,75 @@
+<?php
+/*
+ * Copyright 2021 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 LaravelJsonApi\Laravel\Console;
+
+use Illuminate\Console\GeneratorCommand as BaseGeneratorCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+class MakeSortField extends BaseGeneratorCommand
+{
+
+    use Concerns\ResolvesStub;
+
+    /**
+     * @var string
+     */
+    protected $name = 'jsonapi:sort-field';
+
+    /**
+     * @var string
+     */
+    protected $description = 'Create a new JSON:API sort field.';
+
+    /**
+     * @var string
+     */
+    protected $type = 'JSON:API sort field';
+
+    /**
+     * @inheritDoc
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('sort-field.stub');
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        $jsonApi = trim(config('jsonapi.namespace') ?: 'JsonApi', '\\');
+
+        return $rootNamespace . '\\' . $jsonApi . '\\' . 'Sorting';
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['force', null, InputOption::VALUE_NONE, 'Create the class even if the sort field already exists'],
+        ];
+    }
+
+}

src/ServiceProvider.php

@@ -55,6 +55,7 @@ public function boot(Router $router): void
                 Console\MakeResource::class,
                 Console\MakeSchema::class,
                 Console\MakeServer::class,
+                Console\MakeSortField::class,
                 Console\StubPublish::class,
             ]);
         }

stubs/sort-field.stub

@@ -0,0 +1,59 @@
+<?php
+
+namespace {{ namespace }};
+
+use LaravelJsonApi\Eloquent\Contracts\SortField;
+
+class {{ class }} implements SortField
+{
+
+    /**
+     * @var string
+     */
+    private string $name;
+
+    /**
+     * Create a new sort field.
+     *
+     * @param string $name
+     * @param string|null $column
+     * @return {{ class }}
+     */
+    public static function make(string $name): self
+    {
+        return new static($name);
+    }
+
+    /**
+     * {{ class }} constructor.
+     *
+     * @param string $name
+     */
+    public function __construct(string $name)
+    {
+        $this->name = $name;
+    }
+
+    /**
+     * Get the name of the sort field.
+     *
+     * @return string
+     */
+    public function sortField(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * Apply the sort order to the query.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param string $direction
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function sort($query, string $direction = 'asc')
+    {
+        // @TODO
+    }
+
+}

tests/lib/Integration/Console/MakeFilterTest.php

@@ -88,9 +88,10 @@ private function assertFilterCreated(string $namespace): void
 
         $tests = [
             "namespace App\\{$namespace}\\Filters;",
+            'use LaravelJsonApi\Eloquent\Contracts\Filter;',
             'class CustomFilter implements Filter',
-            "* @return CustomFilter",
-            "* CustomFilter constructor.",
+            '* @return CustomFilter',
+            '* CustomFilter constructor.',
         ];
 
         foreach ($tests as $expected) {

tests/lib/Integration/Console/MakeSortFieldTest.php

@@ -0,0 +1,102 @@
+<?php
+/*
+ * Copyright 2021 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 LaravelJsonApi\Laravel\Tests\Integration\Console;
+
+use Illuminate\Filesystem\Filesystem;
+use LaravelJsonApi\Laravel\Tests\Integration\TestCase;
+
+class MakeSortFieldTest extends TestCase
+{
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->withoutMockingConsoleOutput();
+
+        $files = new Filesystem();
+        $files->deleteDirectory(app_path('JsonApi'));
+        $files->deleteDirectory(app_path('Foo'));
+    }
+
+    /**
+     * @return void
+     */
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        $files = new Filesystem();
+        $files->deleteDirectory(app_path('JsonApi'));
+        $files->deleteDirectory(app_path('Foo'));
+    }
+
+    public function test(): void
+    {
+        config()->set('jsonapi', [
+            'namespace' => 'JsonApi',
+        ]);
+
+        $result = $this->artisan('jsonapi:sort-field CustomSort');
+
+        $this->assertSame(0, $result);
+        $this->assertSortFieldCreated('JsonApi');
+    }
+
+    public function testCustomNamespace(): void
+    {
+        config()->set('jsonapi', [
+            'namespace' => 'Foo\Bar',
+        ]);
+
+        $result = $this->artisan('jsonapi:sort-field', [
+            'name' => 'CustomSort'
+        ]);
+
+        $this->assertSame(0, $result);
+        $this->assertSortFieldCreated('Foo\Bar');
+    }
+
+    /**
+     * @param string $namespace
+     * @return void
+     */
+    private function assertSortFieldCreated(string $namespace): void
+    {
+        $path = str_replace('\\', '/', $namespace);
+
+        $this->assertFileExists($path = app_path("{$path}/Sorting/CustomSort.php"));
+        $content = file_get_contents($path);
+
+        $tests = [
+            "namespace App\\{$namespace}\\Sorting;",
+            'use LaravelJsonApi\Eloquent\Contracts\SortField;',
+            'class CustomSort implements SortField',
+            '* @return CustomSort',
+            '* CustomSort constructor.',
+        ];
+
+        foreach ($tests as $expected) {
+            $this->assertStringContainsString($expected, $content);
+        }
+    }
+
+}