Merge pull request #6 from matchish/config

Add feature "Publish config example"
matchish · Apr 11, 2019 · d3ed66f · d3ed66f
2 parents bb9fbf6 + 7622030
commit d3ed66f
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ## [Unreleased]
 
+## [1.1.0] - 2019-04-09
+### Added
+- Default config
+
 ## [1.0.0] - 2019-03-30
 ### Added
 - Import console command
 - Flush console command
-- Implemented all basic scout engine methods
+- Implemented all basic scout engine methods
diff --git a/README.md b/README.md
@@ -74,8 +74,10 @@ For index `products` it will be
 `elasticsearch.indices.settigs.products`  
 
 And for default settings  
-`elasticsearch.indices.settigs.default
-`
+`elasticsearch.indices.settigs.default`
+
+If you need example you can publish default config with artisan command
+`php artisan vendor:publish --tag config`
 ### Zero downtime reimport
 While working in production, to keep your existing search experience available while reimporting your data, you also can use `scout:import` Artisan command:  
 
@@ -115,10 +117,10 @@ $results = Product::search('zonga', function($client, $body) {
 })->raw();
 ```
 
-`$client` is `\ElasticSearch\Client` object from [`elasticsearch/elasticsearch`](https://packagist.org/packages/elasticsearch/elasticsearch) package  
+`$client` is `\ElasticSearch\Client` object from [elasticsearch/elasticsearch](https://packagist.org/packages/elasticsearch/elasticsearch) package  
  And `$body` is `ONGR\ElasticsearchDSL\Search` from [ongr/elasticsearch-dsl](https://packagist.org/packages/ongr/elasticsearch-dsl) package  
 
->Don't forget :star: the package if you like it. :pray:
+>Don't forget to :star: the package if you like it. :pray:
 
 ## :free: License
 Scout ElasticSearch is an open-sourced software licensed under the [MIT license](LICENSE.md).
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "matchish/laravel-scout-elasticsearch",
     "description": "This package extends Laravel Scout adding full power of ElasticSearch",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "keywords": [
         "laravel",
         "scout",

diff --git a/config/elasticsearch.php b/config/elasticsearch.php
@@ -0,0 +1,29 @@
+<?php
+
+return [
+    'indices' => [
+        'mappings' => [
+            'default' => [
+                '_doc' => [
+                    'properties' => [
+                        'created_at' => [
+                            'type' => 'date',
+                        ],
+                        'updated_at' => [
+                            'type' => 'date',
+                        ],
+                        'deleted_at' => [
+                            'type' => 'date',
+                        ],
+                    ],
+                ],
+            ],
+        ],
+        'settings' => [
+            'default' => [
+                'number_of_shards' => 1,
+                'number_of_replicas' => 0,
+            ],
+        ],
+    ],
+];
diff --git a/src/ElasticSearch/Index.php b/src/ElasticSearch/Index.php
@@ -86,8 +86,13 @@ public static function fromSearchable($searchable): Index
         $name = $searchable->searchableAs().'_'.time();
         $settingsConfigKey = "elasticsearch.indices.settings.{$searchable->searchableAs()}";
         $mappingsConfigKey = "elasticsearch.indices.mappings.{$searchable->searchableAs()}";
-        $settings = config($settingsConfigKey, config('elasticsearch.indices.settings.default'));
-        $mappings = config($mappingsConfigKey);
+        $defaultSettings = [
+            'number_of_shards' => 1,
+            'number_of_replicas' => 0,
+
+        ];
+        $settings = config($settingsConfigKey, config('elasticsearch.indices.settings.default', $defaultSettings));
+        $mappings = config($mappingsConfigKey, config('elasticsearch.indices.mappings.default'));
 
         return new static($name, $settings, $mappings);
     }

diff --git a/src/ScoutElasticSearchServiceProvider.php b/src/ScoutElasticSearchServiceProvider.php
@@ -25,6 +25,10 @@ public function boot(): void
 
             return new ElasticSearchEngine($elasticsearch);
         });
+
+        $this->publishes([
+            __DIR__.'/../config/elasticsearch.php' => config_path('elasticsearch.php'),
+        ], 'config');
     }
 
     /**
@@ -36,11 +40,6 @@ public function register(): void
         $this->app->bind(Client::class, function () {
             return ClientBuilder::create()->setHosts([env('ELASTICSEARCH_HOST')])->build();
         });
-        config()->set('elasticsearch.indices.settings.default', [
-                'number_of_shards' => 1,
-                'number_of_replicas' => 0,
-
-        ]);
 
         $this->registerCommands();
     }

diff --git a/tests/Feature/ScoutElasticSearchServiceProviderTest.php b/tests/Feature/ScoutElasticSearchServiceProviderTest.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace Matchish\ScoutElasticSearch;
+
+use App\Product;
+use Tests\TestCase;
+use Matchish\ScoutElasticSearch\ElasticSearch\Index;
+
+class ScoutElasticSearchServiceProviderTest extends TestCase
+{
+    public function testConfigPublishing()
+    {
+        \File::delete(config_path('elasticsearch.php'));
+        $provider = new ScoutElasticSearchServiceProvider($this->app);
+        $provider->boot();
+
+        \Artisan::call('vendor:publish', [
+            '--tag' => 'config',
+        ]);
+
+        app('config')->set('elasticsearch', require config_path('elasticsearch.php'));
+
+        $this->assertFileExists(config_path('elasticsearch.php'));
+
+        $index = Index::fromSearchable(new Product());
+        $this->assertEquals([
+            'mappings' => [
+                '_doc' => [
+                    'properties' => [
+                        'created_at' => [
+                            'type' => 'date',
+                        ],
+                        'updated_at' => [
+                            'type' => 'date',
+                        ],
+                        'deleted_at' => [
+                            'type' => 'date',
+                        ],
+                    ],
+                ], ],
+            'settings' => [
+                'number_of_shards' => 1,
+                'number_of_replicas' => 0,
+            ],
+        ], $index->config());
+    }
+}
diff --git a/tests/laravel/config/elasticsearch.php b/tests/laravel/config/elasticsearch.php
@@ -0,0 +1,29 @@
+<?php
+
+return [
+    'indices' => [
+        'mappings' => [
+            'default' => [
+                '_doc' => [
+                    'properties' => [
+                        'created_at' => [
+                            'type' => 'date',
+                        ],
+                        'updated_at' => [
+                            'type' => 'date',
+                        ],
+                        'deleted_at' => [
+                            'type' => 'date',
+                        ],
+                    ],
+                ],
+            ],
+        ],
+        'settings' => [
+            'default' => [
+                'number_of_shards' => 1,
+                'number_of_replicas' => 0,
+            ],
+        ],
+    ],
+];