qiita-elasticsearch 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cf12d1404cd16ad0ca66e662c930573cf6bead9
-  data.tar.gz: cc701f849847a2c85140115a1a04d261dbc30009
+  metadata.gz: cfdec470b174315379e53ff2fe1108f8fc2caf05
+  data.tar.gz: 641ac30583600765c5659b355a53a8e59dc72235
 SHA512:
-  metadata.gz: 79d36cd192a2efc54cd5a1d8b0ede53dc315c7d949f4a238cfa8ac55bc642e1589c413f607e3d4d9b4dcac43c8c92acfd20b391f088fb11255c563a1b0f27154
-  data.tar.gz: adae64c88cdc0b142a63b16b27218ba891c60f935d18e53b34c6e74ac0bcaff86f4e16481893acb714090d455b20f07d6d1833f9c20af4374522ee8fba4ae175
+  metadata.gz: cbfbb70e49fcddc7d91b2b513bc784d15f7726570960d5d21300b268c1478031282a0afb460774ebcf0d2261f3683718325a246989321b3fb8ee69d8555a77ca
+  data.tar.gz: 00dea5c36f96a43fc7c6b2b98ea8c054439a1d3a4857fdb86e304bab38db6ad4d0f458a282624a14965779c43fabd53a40f9473722279357909263a5522245de

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.19.0
+
+* Introduce field alias mapping, which enables conversion of arbitrary field name in user query to Elasticsearch field names
+
 ## 0.18.0
 
 * Change the relative date expression format (Past date must be prefixed with `-` like `-30d`)

data/README.md

@@ -102,3 +102,14 @@ query_builder = Qiita::Elasticsearch::QueryBuilder.new(downcased_fields: ["tag"]
 query_builder.build("tag:Ruby")
 #=> {"filtered"=>{"filter"=>{"term"=>{"tag"=>"ruby"}}}}
 ```
+
+### field_mapping
+Pass `:field_mapping` option to search with aliases of field names.
+Users can search with alias fields which could not exist in the mapping of Elasticsearch nodes.
+
+```rb
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(field_mapping: { "headline" =>  ["title", "title.ngram"]} )
+
+query_builder.build("headline:Ruby")
+#=> {"multi_match"=>{ "fields"=>["title", "title.ngram"], "query"=>"Ruby"}
+```

data/lib/qiita/elasticsearch/matchable_token.rb

@@ -6,6 +6,7 @@ module Qiita
       RELATIVE_BEST_FIELDS_QUERY_WEIGHT = 0.5
 
       attr_writer :default_fields
+      attr_accessor :field_mapping
 
       # @return [Hash]
       def to_hash
@@ -27,6 +28,10 @@ module Qiita
 
       # @return [Hash]
       def build_multi_match_query(type: nil, boost: 1)
+        { "multi_match" => build_query(boost, type) }
+      end
+
+      def build_query(boost, type)
         query = {
           "boost" => boost,
           "fields" => matchable_fields,
@@ -34,18 +39,25 @@ module Qiita
           "type" => type,
         }
         query.merge!(options)
-        { "multi_match" => query }
       end
 
       def matchable_fields
         if field_name
-          [field_name]
+          target_fields
         elsif @default_fields && !@default_fields.empty?
           @default_fields
         else
           ["_all"]
         end
       end
+
+      def target_fields
+        @target_fields ||= field_aliases ? field_aliases : [field_name]
+      end
+
+      def field_aliases
+        field_mapping[field_name]
+      end
     end
   end
 end

data/lib/qiita/elasticsearch/query_builder.rb

@@ -12,10 +12,11 @@ module Qiita
       # @param [Array<String>, nil] hierarchal_fields
       # @param [Array<String>, nil] int_fields
       # @param [Array<String>, nil] default_fields
-      # @param [Hash] matchable_options
       # @param [String, nil] time_zone
+      # @param [Hash, nil] matchable_options
+      # @param [Hash, nil] field_mapping for field aliasing
       def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, hierarchal_fields: nil,
-                     filterable_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil, matchable_options: nil)
+                     filterable_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil, matchable_options: nil, field_mapping: nil)
         @all_fields = all_fields
         @date_fields = date_fields
         @downcased_fields = downcased_fields
@@ -25,6 +26,7 @@ module Qiita
         @default_fields = default_fields
         @time_zone = time_zone
         @matchable_options = matchable_options
+        @field_mapping = field_mapping
       end
 
       # @param [String] query_string Raw query string
@@ -54,6 +56,7 @@ module Qiita
           default_fields: @default_fields,
           time_zone: @time_zone,
           matchable_options: @matchable_options,
+          field_mapping: @field_mapping
         )
       end
     end

data/lib/qiita/elasticsearch/tokenizer.rb

@@ -17,6 +17,7 @@ module Qiita
       EXTRA_DATE_FIELDS = %w(created updated)
       EXTRA_FILTERABLE_FIELDS = %w(created is sort updated)
       DEFAULT_MATCHABLE_OPTIONS = {}
+      DEFAULT_FIELD_MAPPING = {}
 
       TOKEN_PATTERN = /
         (?<token_string>
@@ -37,9 +38,10 @@ module Qiita
       # @param [Array<String>, nil] hierarchal_fields
       # @param [Array<String>, nil] int_fields
       # @param [Array<String>, nil] default_fields
-      # @param [Hash] matchable_options Optional search parameters for MatchableToken
+      # @param [Hash, nil] matchable_options Optional search parameters for MatchableToken
+      # @param [Hash, nil] field_mapping alias of fields
       # @param [String, nil] time_zone
-      def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, filterable_fields: nil, hierarchal_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil, matchable_options: nil)
+      def initialize(all_fields: nil, date_fields: nil, downcased_fields: nil, filterable_fields: nil, hierarchal_fields: nil, int_fields: nil, default_fields: nil, time_zone: nil, matchable_options: nil, field_mapping: nil)
         @date_fields = (date_fields || DEFAULT_DATE_FIELDS) | EXTRA_DATE_FIELDS
         @downcased_fields = downcased_fields || DEFAULT_DOWNCASED_FIELDS
         @filterable_fields = (filterable_fields || DEFAULT_FILTERABLE_FIELDS) | EXTRA_FILTERABLE_FIELDS
@@ -47,6 +49,7 @@ module Qiita
         @int_fields = int_fields || DEFAULT_INT_FIELDS
         @default_fields = default_fields || DEFAULT_DEFAULT_FIELDS
         @matchable_options = matchable_options || DEFAULT_MATCHABLE_OPTIONS
+        @field_mapping = field_mapping || DEFAULT_FIELD_MAPPING
         @all_fields = aggregate_all_fields(all_fields)
         @time_zone = time_zone
       end
@@ -56,7 +59,7 @@ module Qiita
       def tokenize(query_string)
         query_string.scan(TOKEN_PATTERN).map do |token_string, minus, field_name, quoted_term, term|
           term ||= quoted_term
-          if !field_name.nil? && !@all_fields.include?(field_name)
+          if !field_name.nil? && !@all_fields.include?(field_name) && !@field_mapping.key?(field_name)
             term = "#{field_name}:#{term}"
             field_name = nil
           end
@@ -71,6 +74,7 @@ module Qiita
           )
           token.options = @matchable_options if token.is_a?(MatchableToken)
           token.default_fields = @default_fields if token.is_a?(MatchableToken)
+          token.field_mapping = @field_mapping if token.is_a?(MatchableToken)
           token.time_zone = @time_zone if token.is_a?(DateToken)
           token
         end

data/lib/qiita/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Elasticsearch
-    VERSION = "0.18.0"
+    VERSION = "0.19.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport