Make command

Author: pdphilip

resources/stubs/ElasticModel.php.stub

@@ -0,0 +1,29 @@
+<?php
+
+namespace {{ namespace }};
+
+use Carbon\Carbon;
+use PDPhilip\Elasticsearch\Eloquent\HasMappingDefinition;
+use PDPhilip\Elasticsearch\Eloquent\Model as Eloquent;
+use PDPhilip\Elasticsearch\Schema\Blueprint;
+
+/**
+ * {{ namespace }}\{{ class }}
+ *
+ ******Fields*******
+ * @property string $id
+ * @property Carbon $updated_at
+ * @property Carbon $created_at
+ */
+class {{ class }} extends Eloquent implements HasMappingDefinition
+{
+    protected $connection = 'elasticsearch';
+
+    public $timestamps = true;
+
+    public static function mappingDefinition(Blueprint $index): void
+    {
+        $index->date('updated_at');
+        $index->date('created_at');
+    }
+}

src/Commands/MakeCommand.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PDPhilip\Elasticsearch\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Support\Str;
+use OmniTerm\HasOmniTerm;
+
+class MakeCommand extends GeneratorCommand
+{
+    use HasOmniTerm;
+
+    protected $signature = 'elastic:make {name : The name of the Elasticsearch model}';
+
+    protected $description = 'Create a new Elasticsearch model';
+
+    protected $type = 'Model';
+
+    public function handle(): int
+    {
+        $name = Str::studly($this->argument('name'));
+
+        $namespace = $this->resolveNamespace($name);
+        $class = class_basename(str_replace('/', '\\', $name));
+        $fullClass = $namespace.'\\'.$class;
+        $path = $this->getModelPath($name);
+
+        if (file_exists($path)) {
+            $this->newLine();
+            $this->omni->statusError('Model already exists', $fullClass);
+            $this->newLine();
+
+            return self::FAILURE;
+        }
+
+        $this->makeDirectory($path);
+
+        $stub = $this->buildStub($namespace, $class);
+        $this->files->put($path, $stub);
+
+        $this->newLine();
+        $this->omni->statusSuccess('Model created', $fullClass);
+        $this->omni->tableRow('Path', str_replace(base_path().'/', '', $path));
+        $this->newLine();
+
+        return self::SUCCESS;
+    }
+
+    protected function getStub(): string
+    {
+        return __DIR__.'/../../resources/stubs/ElasticModel.php.stub';
+    }
+
+    private function resolveNamespace(string $name): string
+    {
+        $parts = explode('/', str_replace('\\', '/', $name));
+        array_pop($parts);
+
+        $sub = implode('\\', $parts);
+
+        return $sub
+            ? 'App\\Models\\'.$sub
+            : 'App\\Models';
+    }
+
+    private function getModelPath(string $name): string
+    {
+        $name = str_replace('\\', '/', $name);
+
+        return app_path('Models/'.$name.'.php');
+    }
+
+    private function buildStub(string $namespace, string $class): string
+    {
+        $stub = $this->files->get($this->getStub());
+
+        return str_replace(
+            ['{{ namespace }}', '{{ class }}'],
+            [$namespace, $class],
+            $stub
+        );
+    }
+}

src/Commands/ReIndexCommand.php

@@ -10,6 +10,7 @@
 use Illuminate\Support\Facades\DB;
 use OmniTerm\HasOmniTerm;
 use PDPhilip\Elasticsearch\Connection;
+use PDPhilip\Elasticsearch\Eloquent\HasMappingDefinition;
 use PDPhilip\Elasticsearch\Eloquent\Model;
 use PDPhilip\Elasticsearch\Schema\Blueprint;
 use PDPhilip\Elasticsearch\Schema\Builder as SchemaBuilder;
@@ -170,15 +171,21 @@ private function resolveModel(): ?Model
             return null;
         }
 
-        if (! method_exists($class, 'mappingDefinition')) {
+        if (! is_subclass_of($class, HasMappingDefinition::class)) {
             $this->newLine();
             $this->omni->statusError('Missing mapping definition', $class, [
-                'Add a public mappingDefinition() method to your model:',
+                'Your model must implement HasMappingDefinition:',
                 '',
-                'public function mappingDefinition(Blueprint $index): void',
+                'use PDPhilip\Elasticsearch\Eloquent\HasMappingDefinition;',
+                'use PDPhilip\Elasticsearch\Schema\Blueprint;',
+                '',
+                'class YourModel extends Eloquent implements HasMappingDefinition',
                 '{',
-                '    $index->keyword(\'status\');',
-                '    $index->geoPoint(\'location\');',
+                '    public static function mappingDefinition(Blueprint $index): void',
+                '    {',
+                '        $index->keyword(\'status\');',
+                '        $index->geoPoint(\'location\');',
+                '    }',
                 '}',
             ]);
             $this->newLine();
@@ -244,7 +251,7 @@ private function setupFromModel(Model $model): void
         $connection = DB::connection($this->connectionName);
         $this->schema = $connection->getSchemaBuilder();
 
-        $this->mappingDefinition = fn (Blueprint $index) => $model->mappingDefinition($index);
+        $this->mappingDefinition = fn (Blueprint $index) => $model::mappingDefinition($index);
     }
 
     // ======================================================================

src/ElasticServiceProvider.php

@@ -23,6 +23,7 @@ public function boot(): void
                 Commands\IndicesCommand::class,
                 Commands\ShowCommand::class,
                 Commands\ReIndexCommand::class,
+                Commands\MakeCommand::class,
             ]);
         }
     }

src/Eloquent/ElasticsearchModel.php

@@ -130,10 +130,10 @@ protected function newBaseQueryBuilder()
             Model::OPTION_STORE_IDS => $this->storeIdInDocument,
         ]);
 
-        if (method_exists($this, 'mappingDefinition')) {
+        if ($this instanceof HasMappingDefinition) {
             $connection->registerMappingDefinition(
                 $connection->getTablePrefix().$this->getTable(),
-                fn ($index) => $this->mappingDefinition($index)
+                fn ($index) => static::mappingDefinition($index)
             );
         }
 

src/Eloquent/HasMappingDefinition.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PDPhilip\Elasticsearch\Eloquent;
+
+use PDPhilip\Elasticsearch\Schema\Blueprint;
+
+interface HasMappingDefinition
+{
+    public static function mappingDefinition(Blueprint $index): void;
+}