- Added payload builders

- Added unit tests for engine explain and profile methods
- Covered artisan commands with unit tests
- Made refactoring

Author: babenkoivan

src/Console/ElasticIndexCommand.php

@@ -2,43 +2,32 @@
 
 namespace ScoutElastic\Console;
 
+use Illuminate\Console\Command;
+use ScoutElastic\Console\Features\requiresIndexConfiguratorArgument;
 use ScoutElastic\Facades\ElasticClient;
+use ScoutElastic\Payloads\IndexPayload;
 
-class ElasticIndexCreateCommand extends ElasticIndexCommand
+class ElasticIndexCreateCommand extends Command
 {
+    use requiresIndexConfiguratorArgument;
+
     protected $name = 'elastic:create-index';
 
     protected $description = 'Create an Elasticsearch index';
 
-    protected function buildPayload()
+    public function fire()
     {
-        $configurator = $this->getConfigurator();
-
-        $body = [];
-
-        if ($settings = $configurator->getSettings()) {
-            $body['settings'] = $settings;
+        if (!$configurator = $this->getIndexConfigurator()) {
+            return;
         }
 
-        if ($defaultMappings = $configurator->getDefaultMapping()) {
-            $body['mappings'] = ['_default_' => $defaultMappings];
-        }
-
-        $payload = $this->buildBasePayload();
-
-        if ($body) {
-            $payload['body'] = $body;
-        }
-
-        return $payload;
-    }
-
-    public function fire()
-    {
-        $configurator = $this->getConfigurator();
+        $payload = (new IndexPayload($configurator))
+            ->setIfNotEmpty('body.settings', $configurator->getSettings())
+            ->setIfNotEmpty('body.mappings._default_', $configurator->getDefaultMapping())
+            ->get();
 
         ElasticClient::indices()
-            ->create($this->buildPayload());
+            ->create($payload);
 
         $this->info(sprintf(
             'The index %s was created!',

src/Console/ElasticIndexCreateCommand.php

@@ -2,20 +2,30 @@
 
 namespace ScoutElastic\Console;
 
+use Illuminate\Console\Command;
+use ScoutElastic\Console\Features\requiresIndexConfiguratorArgument;
 use ScoutElastic\Facades\ElasticClient;
+use ScoutElastic\Payloads\IndexPayload;
 
-class ElasticIndexDropCommand extends ElasticIndexCommand
+class ElasticIndexDropCommand extends Command
 {
+    use requiresIndexConfiguratorArgument;
+
     protected $name = 'elastic:drop-index';
 
     protected $description = 'Drop an Elasticsearch index';
 
     public function fire()
     {
-        $configurator = $this->getConfigurator();
+        if (!$configurator = $this->getIndexConfigurator()) {
+            return;
+        }
+
+        $payload = (new IndexPayload($configurator))
+            ->get();
 
         ElasticClient::indices()
-            ->delete($this->buildBasePayload());
+            ->delete($payload);
 
         $this->info(sprintf(
             'The index %s was deleted!',

src/Console/ElasticIndexDropCommand.php

@@ -2,95 +2,69 @@
 
 namespace ScoutElastic\Console;
 
+use Illuminate\Console\Command;
+use ScoutElastic\Console\Features\requiresIndexConfiguratorArgument;
 use ScoutElastic\Facades\ElasticClient;
 use Exception;
+use ScoutElastic\Payloads\IndexPayload;
 
-class ElasticIndexUpdateCommand extends ElasticIndexCommand
+class ElasticIndexUpdateCommand extends Command
 {
+    use requiresIndexConfiguratorArgument;
+
     protected $name = 'elastic:update-index';
 
     protected $description = 'Update settings and mappings of an Elasticsearch index';
 
-    protected function buildMappingPayload()
-    {
-        $configurator = $this->getConfigurator();
-
-        $defaultMapping = $configurator->getDefaultMapping();
-
-        if (!$defaultMapping) {
-            return null;
-        }
-
-        return array_merge(
-            $this->buildBasePayload(),
-            [
-                'type' => '_default_',
-                'body' => [
-                    '_default_' => $defaultMapping
-                ]
-            ]
-        );
-    }
-
-    protected function buildSettingsPayload()
-    {
-        $configurator = $this->getConfigurator();
-
-        $settings = $configurator->getSettings();
-
-        if (!$settings) {
-            return null;
-        }
-
-        return array_merge(
-            $this->buildBasePayload(),
-            [
-                'body' => [
-                    'settings' => $settings
-                ]
-            ]
-        );
-    }
-
     public function fire()
     {
-        $configurator = $this->getConfigurator();
+        if (!$configurator = $this->getIndexConfigurator()) {
+            return;
+        }
 
-        $indexName = $configurator->getName();
-        $basePayload = $this->buildBasePayload();
+        $indexPayload = (new IndexPayload($configurator))->get();
 
         $indices = ElasticClient::indices();
 
-        if (!$indices->exists($basePayload)) {
+        if (!$indices->exists($indexPayload)) {
             $this->error(sprintf(
                 'Index %s doesn\'t exist',
-                $indexName
+                $configurator->getName()
             ));
 
             return;
         }
 
         try {
-            $indices->close($basePayload);
+            $indices->close($indexPayload);
 
-            if ($settingsPayload = $this->buildSettingsPayload()) {
-                $indices->putSettings($settingsPayload);
+            if ($settings = $configurator->getSettings()) {
+                $indexSettingsPayload = (new IndexPayload($configurator))
+                    ->set('body.settings', $settings)
+                    ->get();
+
+                $indices->putSettings($indexSettingsPayload);
             }
 
-            if ($mappingPayload = $this->buildMappingPayload()) {
-                $indices->putMapping($mappingPayload);
+            if ($defaultMapping = $configurator->getDefaultMapping()) {
+                $indexMappingPayload = (new IndexPayload($configurator))
+                    ->set('type', '_default_')
+                    ->set('body._default_', $defaultMapping)
+                    ->get();
+
+                $indices->putMapping($indexMappingPayload);
             }
 
-            $indices->open($basePayload);
+            $indices->open($indexPayload);
         } catch (Exception $exception) {
-            $indices->open($basePayload);
+            $indices->open($indexPayload);
 
             throw $exception;
         }
 
         $this->info(sprintf(
             'The index %s was updated!',
-            $indexName
+            $configurator->getName()
         ));
     }
 }

src/Console/ElasticIndexUpdateCommand.php

@@ -3,69 +3,41 @@
 namespace ScoutElastic\Console;
 
 use Illuminate\Console\Command;
+use ScoutElastic\Console\Features\requiresModelArgument;
 use ScoutElastic\Facades\ElasticClient;
-use ScoutElastic\SearchableModel;
-use Symfony\Component\Console\Input\InputArgument;
+use ScoutElastic\Payloads\TypePayload;
 
 class ElasticUpdateMappingCommand extends Command
 {
+    use requiresModelArgument;
+
     protected $name = 'elastic:update-mapping';
 
     protected $description = 'Update a model mapping';
 
-    /**
-     * @return SearchableModel
-     */
-    protected function getModel()
-    {
-        $model = trim($this->argument('model'));
-        return (new $model);
-    }
-
-    protected function buildPayload()
-    {
+    public function fire() {
         $model = $this->getModel();
+
         $configurator = $model->getIndexConfigurator();
 
-        $mapping = [];
+        $mapping = array_merge_recursive($configurator->getDefaultMapping(), $model->getMapping());
 
-        if ($defaultMapping = $configurator->getDefaultMapping()) {
-            $mapping = array_merge($mapping, $defaultMapping);
-        }
+        if (empty($mapping)) {
+            $this->error('Nothing to update: the mapping is not specified.');
 
-        if ($modelMapping = $model->getMapping()) {
-            $mapping = array_merge($mapping, $modelMapping);
+            return;
         }
 
-        if (!$mapping) {
-            return null;
-        }
+        $payload = (new TypePayload($model))
+            ->set('body.'.$model->searchableAs(), $mapping)
+            ->get();
 
-        return [
-            'index' => $configurator->getName(),
-            'type' => $model->searchableAs(),
-            'body' => [$model->searchableAs() => $mapping]
-        ];
-    }
-
-    public function fire() {
-        $model = $this->getModel();
-
-        if ($payload = $this->buildPayload()) {
-            ElasticClient::indices()
-                ->putMapping($payload);
-        }
+        ElasticClient::indices()
+            ->putMapping($payload);
 
         $this->info(sprintf(
             'The %s mapping was updated!',
             $model->searchableAs()
         ));
     }
-
-    protected function getArguments()
-    {
-        return [
-            ['model', InputArgument::REQUIRED, 'The model class'],
-        ];
-    }
 }

src/Console/ElasticUpdateMappingCommand.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace ScoutElastic\Console\Features;
+
+use ScoutElastic\IndexConfigurator;
+use Symfony\Component\Console\Input\InputArgument;
+
+trait requiresIndexConfiguratorArgument
+{
+    /**
+     * @return IndexConfigurator
+     */
+    protected function getIndexConfigurator()
+    {
+        $configuratorClass = trim($this->argument('index-configurator'));
+
+        $configuratorInstance = new $configuratorClass;
+
+        if (!($configuratorInstance instanceof IndexConfigurator)) {
+            $this->error(sprintf(
+                'The class %s must extend %s.',
+                $configuratorClass,
+                IndexConfigurator::class
+            ));
+
+            return null;
+        }
+
+        return (new $configuratorClass);
+    }
+
+    protected function getArguments()
+    {
+        return [
+            ['index-configurator', InputArgument::REQUIRED, 'The index configurator class'],
+        ];
+    }
+}