elastic_ar_sync 0.1.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a997c8ae813e7a3e34ab3d5dc557e5282322078416597e85608aa34b33c18a
-  data.tar.gz: 3f0785cd76f8ca81283119fc6ddc04262f52275645db6986aab779fd1b4c2259
+  metadata.gz: cf6c9a44b983540db39c6a9542af4a731d49975ca4f1b12f46911eb1e1dd98d0
+  data.tar.gz: 40906b515c533360c1eb36301c22a8325dcb3570cd87a7aad6728641456f60c3
 SHA512:
-  metadata.gz: f1ec8db00e1d659cf7884db47befbf49cd4a3b087b37c74ad1352c5510dd2b6667a469a36bad3d620549325c38307dcbcd08c725ae7e42a05ca349183db42bff
-  data.tar.gz: 14d0ec670343d14d8d399ad3dcb00bca90987593a545f1d5dad888d1543ebfc180d618e1da95793aaf930c2910f42d2d6b34e50ec0bd8543147ef5371f2b3c07
+  metadata.gz: 625d2d7cbfc2c08bada8d98cf63302ea3f2bd7b3951696b21ceb3f1a9ff2b87ed1c826904a7e6031ddf0a2bb52eee57efd65d3c7480e2b01b12ba59b78d30670
+  data.tar.gz: b614f8ce783f01c6c32f68b11276668d31586da5aa6025a7e08db5e12070b53a2c10d418cd1b52711221ce8f341f8babaa8f06ad2908d608c097586eb8ad40bd

data/README.md

@@ -9,11 +9,16 @@ Install `gem elasticsearch-rails`, `gem elasticsearch-model` and `gem elasticsea
 
 Include module `ElasticArSync::Elastic::Syncable` on your Model class which is inherited ActiveRecord.
 
+and define `index_config` after `include ElasticArSync::Elastic::Syncable` if you use this module normally.
+
+you can override index_config described after.
+
 example below
 
 ```ruby
 class XXXXX < ActiveRecord
   include ElasticArSync::Elastic::Syncable
+  index_config
 end
 ```
 
@@ -24,6 +29,13 @@ update and delete is same as create.
 
 this module contains class method `index_setup` to setup index.
 
+setup means create new index and put alias to new index and sync whole records of RDB with new index,
+then you can use new index without any command.
+
+```ruby
+XXXXX.index_setup
+```
+
 ### usable methods
 if your Model class included `ElasticArSync::Elastic::Syncable`, it can use class methods below.
 
@@ -66,17 +78,34 @@ you can use `index_config` after `include ElasticArSync::Elastic::Syncable`.
 
 example below
 
-you can override argus `dynamic`, `number_of_shards`, `attr_mappings`.
+you can override args `dynamic`, `number_of_shards`, `attr_mappings`.
 especially default mapping is whole attributes of your Model class, so you can customize mapping attributes by overriding attr_mappings.
 ```ruby
 index_config(dynamic: 'false', number_of_shards: 1, attr_mappings: { id: 'integer', name: 'text', birth: 'date' })
 ```
 
-if you define your original mapping additionally, you can define like below.
+you can also override part of attributes by `override_mappings` like below
 
-tips: just reference here.
+＊As a premise, your model contain [id: integer, name: string, birth: date]
+
+```ruby
+index_config(override_mappings: { birth: :keyword })
+```
+
+then birth will mapping as keyword type in index of elasticsearch.
+
+if you want add mapping which is not defined as schema column of model, you can save method result as well like below.
+
+```ruby
+index_config(override_mappings: { full_name: :keyword })
+```
+
+＊`full_name` is instance method
+
+then full_name will mapped to index mapping as keyword type. but you have to define instance method full_name to your model class.
+
+if you define your original mapping additionally, you can also define like below.
 
-https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model
 ```ruby
   settings index: { number_of_shards: number_of_shards } do
     mappings do
@@ -85,6 +114,9 @@ https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model
   end
 ```
 
+tips: just reference here.
+
+https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/elastic_ar_sync/elastic/syncable.rb

@@ -37,7 +37,9 @@ module ElasticArSync
         end
 
         def as_indexed_json(_option = {})
-          attributes.symbolize_keys.select { |key, _| self.class.mapping_list_keys.include?(key) }
+          hash = {}
+          self.class.mapping_list_keys.each { |key| hash[key.to_s] = send(key) }
+          hash.as_json
         end
       end
 
@@ -67,24 +69,68 @@ module ElasticArSync
           ElasticArSync::Elastic::Services::IndexHandler.new(self).switch_alias(alias_name: index_name, new_index_name: new_index_name)
         end
 
-        def index_config(dynamic: 'false', number_of_shards: 1, attr_mappings: default_index_mapping)
-          settings index: { number_of_shards: number_of_shards } do
+        def index_config(dynamic: 'false', override_settings: {}, attr_mappings: default_index_mapping, override_mappings: {}, kuromoji_default: false)
+          attr_mappings.merge!(override_mappings) if override_mappings.present?
+
+          settings default_index_setting(kuromoji_default).merge!(override_settings) do
             # ES6からStringが使えないのでtextかkeywordにする。
             mappings dynamic: dynamic do
               attr_mappings.each do |key, value|
-                indexes key, type: value
+                next unless value.is_a?(Hash)
+
+                if value[:type].to_s == 'nested'
+                  indexes key ,value.reject { |k, _| k.to_sym == :nested_attr } do
+                    value[:nested_attr].each { |key, value| indexes key, value }
+                  end
+                  next
+                end
+
+                indexes key, value
               end
             end
           end
         end
 
+        def default_index_setting(kuromoji_default = false)
+          setting_attr = { index: { number_of_shards: 1 } }
+          setting_attr.merge!(ja_analyze_default) if kuromoji_default
+          setting_attr
+        end
+
+        def ja_analyze_default
+          {
+            "analysis": {
+              "analyzer": {
+                "normal_ja_analyzer": {
+                  "type": "custom",
+                  "tokenizer": "kuromiji_tokenizer",
+                  "mode": "search",
+                  "char_filter": [
+                    "icu_normalizer", # ユニコード正規化
+                    "kuromoji_iteration_mark" # 踊り字の正規化(時々=>時時、こゝろ=>こころ)
+                  ],
+                  "filter": [
+                    "kuromoji_baseform",
+                    "kuromoji_part_of_speech",
+                    "ja_stop",
+                    "lowercase",
+                    "kuromoji_number",
+                    "kuromoji_stemmer"
+                  ]
+                }
+              }
+            }
+          }
+        end
+
         def default_index_mapping
           mapping = {}
           attribute_types.each do |attribute, active_model_type|
             type = active_model_type.type
-            type = :text if (active_model_type.type.to_sym == :string) || (type == :integer && defined_enums.symbolize_keys.keys.include?(attribute.to_sym))
+            type = :text if (active_model_type.type.to_sym == :string)
+            type = :keyword if type == :integer && defined_enums.symbolize_keys.keys.include?(attribute.to_sym)
             type = :date if active_model_type.type == :datetime
-            mapping[attribute.to_sym] = type
+            mapping[attribute.to_sym] = { type: type }
           end
           mapping
         end
@@ -100,6 +146,14 @@ module ElasticArSync
             raise Elasticsearch::Transport::Transport::Errors::NotFound, "インデックスがありません alias_name: #{alias_name}"
           end
         end
+
+        def current_index
+          get_aliases.select { |_, value| value["aliases"].present? }.keys.first
+        end
+
+        def current_mapping
+          __elasticsearch__.client.indices.get_mapping[current_index]["mappings"]["_doc"]["properties"]
+        end
       end
     end
   end

data/lib/elastic_ar_sync/version.rb

@@ -1,3 +1,3 @@
 module ElasticArSync
-  VERSION = '0.1.1'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_ar_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.7
 platform: ruby
 authors:
 - KitakatsuTed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails