[Feature] Add non-Eloquent option to schema generator command

Author: lindyhopchris

CHANGELOG.md

@@ -20,6 +20,8 @@ All notable changes to this project will be documented in this file. This projec
   still be used, the new `RelatedResponse` class merges relationship meta into the top-level `meta` member of the
   response document. For *to-many* relationships that are countable, this will mean the top-level `meta` member will
   contain the count of the relationship.
+- The schema generator Artisan command now has a `--non-eloquent` option to generate a schema for a non-Eloquent
+  resource.
 
 ### Changed
 

src/Console/MakeSchema.php

@@ -53,6 +53,10 @@ class MakeSchema extends GeneratorCommand
      */
     protected function getStub()
     {
+        if ($this->option('non-eloquent')) {
+            return $this->resolveStubPath('non-eloquent-schema.stub');
+        }
+
         return $this->resolveStubPath('schema.stub');
     }
 
@@ -108,6 +112,7 @@ protected function getOptions()
         return [
             ['force', null, InputOption::VALUE_NONE, 'Create the class even if the schema already exists'],
             ['model', 'm', InputOption::VALUE_REQUIRED, 'The model that the schema applies to.'],
+            ['non-eloquent', null, InputOption::VALUE_NONE, 'Create a schema for a non-Eloquent resource.'],
             ['proxy', 'p', InputOption::VALUE_NONE, 'Create a schema for an Eloquent model proxy.'],
             ['server', 's', InputOption::VALUE_REQUIRED, 'The JSON:API server the schema exists in.'],
         ];

stubs/non-eloquent-schema.stub

@@ -0,0 +1,46 @@
+<?php
+
+namespace {{ namespace }};
+
+use {{ namespacedModel }};
+use LaravelJsonApi\Core\Schema\Schema;
+use LaravelJsonApi\NonEloquent\Fields\Attribute;
+use LaravelJsonApi\NonEloquent\Fields\ID;
+use LaravelJsonApi\NonEloquent\Filters\Filter;
+
+class {{ class }} extends Schema
+{
+
+    /**
+     * The model the schema corresponds to.
+     *
+     * @var string
+     */
+    public static string $model = {{ model }}::class;
+
+    /**
+     * Get the resource fields.
+     *
+     * @return array
+     */
+    public function fields(): array
+    {
+        return [
+            ID::make(),
+            // Attribute::make('name'),
+        ];
+    }
+
+    /**
+     * Get the resource filters.
+     *
+     * @return array
+     */
+    public function filters(): array
+    {
+        return [
+            // Filter::make('id'),
+        ];
+    }
+
+}

tests/lib/Integration/Console/MakeSchemaTest.php

@@ -116,6 +116,22 @@ public function testProxy(): void
         $this->assertProxySchemaCreated('App\JsonApi\Proxies\UserAccount', 'UserAccount');
     }
 
+    public function testNonEloquent(): void
+    {
+        config()->set('jsonapi.servers', [
+            'v1' => Server::class,
+        ]);
+
+        $result = $this->artisan('jsonapi:schema', [
+            'name' => 'sites',
+            '--model' => '\App\Entities\Site',
+            '--non-eloquent' => true,
+        ]);
+
+        $this->assertSame(0, $result);
+        $this->assertNonEloquentSchemaCreated('App\Entities\Site', 'Site');
+    }
+
     public function testNoServer(): void
     {
         config()->set('jsonapi.servers', [
@@ -167,6 +183,15 @@ private function assertSchemaCreated(string $namespacedModel, string $model): vo
         foreach ($tests as $expected) {
             $this->assertStringContainsString($expected, $content);
         }
+
+        $missing = [
+            'LaravelJsonApi\Eloquent\ProxySchema',
+            'LaravelJsonApi\Core\Schema\Schema',
+        ];
+
+        foreach ($missing as $notExpected) {
+            $this->assertStringNotContainsString($notExpected, $content);
+        }
     }
 
     /**
@@ -190,6 +215,46 @@ private function assertProxySchemaCreated(string $namespacedModel, string $model
         foreach ($tests as $expected) {
             $this->assertStringContainsString($expected, $content);
         }
+
+        $missing = [
+            'LaravelJsonApi\Eloquent\Schema',
+            'LaravelJsonApi\Core\Schema\Schema',
+        ];
+
+        foreach ($missing as $notExpected) {
+            $this->assertStringNotContainsString($notExpected, $content);
+        }
+    }
+
+    /**
+     * @param string $namespacedModel
+     * @param string $model
+     * @return void
+     */
+    private function assertNonEloquentSchemaCreated(string $namespacedModel, string $model): void
+    {
+        $this->assertFileExists($path = app_path('JsonApi/V1/Sites/SiteSchema.php'));
+        $content = file_get_contents($path);
+
+        $tests = [
+            'namespace App\JsonApi\V1\Sites;',
+            'use LaravelJsonApi\Core\Schema\Schema;',
+            'class SiteSchema extends Schema',
+            "use {$namespacedModel};",
+            "public static string \$model = {$model}::class;",
+        ];
+
+        foreach ($tests as $expected) {
+            $this->assertStringContainsString($expected, $content);
+        }
+
+        $missing = [
+            'LaravelJsonApi\Eloquent',
+        ];
+
+        foreach ($missing as $notExpected) {
+            $this->assertStringNotContainsString($notExpected, $content);
+        }
     }
 
     /**