qiita-elasticsearch 0.14.3 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f9fa6ee033eee2b5e4e95384bbfd34ba7e9311b
-  data.tar.gz: 06355fdf4dbc5e734b1335d9b716a5dd93fe57cf
+  metadata.gz: d55e5e12468e89a3e9b902858d5bb4c50e70604c
+  data.tar.gz: 432915c14a639a533c206592df5f1df5ba5dfc9f
 SHA512:
-  metadata.gz: 6b15d24f4500f5760c56181eccdc19fed7e60990acdca48e284028c15f6f29e39feb75ed9cc3cfb5f783e711a94e22f15d7c081beeed2638476ba5c9fa22ab92
-  data.tar.gz: aff8bbea70b132a1e31426f0a9b83d3bc3c4dfc1698d4c37f8ed7a1462c17977998c34b3e9a134597c3b7912bf19e63810ccc207ada872c5859730e0861ce3dd
+  metadata.gz: bc55dc75f2de4fa3791796f11c43006975e6be87ed2c30d02dddd3eeb6ff63f3fd63419e231e3315c796df6488f516a63ad77f3ace5a908bdfae31c215b9d733
+  data.tar.gz: 5197b2b423fd8447914f3e4e14cd781eae6eb262bc719c1c736b7e70f6d6191ec294382567b52a4327f1e3cc5e7f591622f812721583056e70a9e2bcf8a5ac27

data/.gitignore

@@ -5,5 +5,6 @@
 /coverage/
 /doc/
 /pkg/
+/spec/examples.txt
 /spec/reports/
 /tmp/

data/README.md

@@ -23,11 +23,11 @@ query_builder.build("a OR b")
 #=> {"bool"=>{"should"=>[{"match"=>{"_all"=>"a"}}, {"match"=>{"_all"=>"b"}}]}}
 ```
 
-### matchable_fields
-Pass `:matchable_fields` option to tell matchable field names (default: `_all`).
+### default_fields
+Pass `:default_fields` option to tell default (matchable) field names (default: `_all`).
 
 ```rb
-query_builder = Qiita::Elasticsearch::QueryBuilder.new(matchable_fields: ["body", "title"])
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(default_fields: ["body", "title"])
 
 query_builder.build("a")
 #=> {"multi_match"=>{"fields"=>["body", "title"], "query"=>"a"}}

data/lib/qiita/elasticsearch/matchable_token.rb

@@ -5,7 +5,7 @@ module Qiita
     class MatchableToken < Token
       RELATIVE_BEST_FIELDS_QUERY_WEIGHT = 0.5
 
-      attr_writer :matchable_fields
+      attr_writer :default_fields
 
       # @return [Hash]
       def to_hash
@@ -30,12 +30,22 @@ module Qiita
         {
           "multi_match" => {
             "boost" => boost,
-            "fields" => @matchable_fields || ["_all"],
+            "fields" => matchable_fields,
             "query" => @term,
             "type" => type,
           },
         }
       end
+
+      def matchable_fields
+        if field_name
+          [field_name]
+        elsif @default_fields && !@default_fields.empty?
+          @default_fields
+        else
+          ["_all"]
+        end
+      end
     end
   end
 end

data/lib/qiita/elasticsearch/query_builder.rb

@@ -5,20 +5,22 @@ require "qiita/elasticsearch/query"
 module Qiita
   module Elasticsearch
     class QueryBuilder
+      # @param [Array<String>, nil] all_fields
       # @param [Array<String>, nil] date_fields
       # @param [Array<String>, nil] downcased_fields
       # @param [Array<String>, nil] filterable_fields
       # @param [Array<String>, nil] hierarchal_fields
       # @param [Array<String>, nil] int_fields
-      # @param [Array<String>, nil] matchable_fields
+      # @param [Array<String>, nil] default_fields
       # @param [String, nil] time_zone
-      def initialize(date_fields: nil, downcased_fields: nil, hierarchal_fields: nil, filterable_fields: nil, int_fields: nil, matchable_fields: nil, time_zone: nil)
+      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)
+        @all_fields = all_fields
         @date_fields = date_fields
         @downcased_fields = downcased_fields
         @filterable_fields = filterable_fields
         @hierarchal_fields = hierarchal_fields
         @int_fields = int_fields
-        @matchable_fields = matchable_fields
+        @default_fields = default_fields
         @time_zone = time_zone
       end
 
@@ -31,7 +33,7 @@ module Qiita
           filterable_fields: @filterable_fields,
           hierarchal_fields: @hierarchal_fields,
           int_fields: @int_fields,
-          matchable_fields: @matchable_fields,
+          default_fields: @default_fields,
           time_zone: @time_zone,
         )
       end
@@ -40,12 +42,13 @@ module Qiita
 
       def tokenizer
         @tokenizer ||= Tokenizer.new(
+          all_fields: @all_fields,
           date_fields: @date_fields,
           downcased_fields: @downcased_fields,
           filterable_fields: @filterable_fields,
           hierarchal_fields: @hierarchal_fields,
           int_fields: @int_fields,
-          matchable_fields: @matchable_fields,
+          default_fields: @default_fields,
           time_zone: @time_zone,
         )
       end

data/lib/qiita/elasticsearch/token.rb

@@ -15,15 +15,17 @@ module Qiita
 
       # @param [true, false] downcased True if given term must be downcased on query representation
       # @param [String, nil] field_name Field name part
-      # @param [true, fales] negative True if this term represents negative token (e.g. "-Perl")
-      # @param [true, false] quoted Given term is quoted or note
+      # @param [true, false] negative True if this term represents negative token (e.g. "-Perl")
+      # @param [true, false] quoted Given term is quoted or not
+      # @param [true, false] filter True if this term should be used as filter
       # @param [String] term Term part
       # @param [String] token_string Original entire string
-      def initialize(downcased: nil, field_name: nil, negative: nil, quoted: nil, term: nil, token_string: nil)
+      def initialize(downcased: nil, field_name: nil, negative: nil, quoted: nil, filter: nil, term: nil, token_string: nil)
         @downcased = downcased
         @field_name = field_name
         @negative = negative
         @quoted = quoted
+        @filter = filter
         @term = term
         @token_string = token_string
       end
@@ -38,7 +40,7 @@ module Qiita
       end
 
       def filter?
-        !field_name.nil? || negative?
+        !!@filter || negative?
       end
 
       # @return [true, false] True if this token is for query

data/lib/qiita/elasticsearch/tokenizer.rb

@@ -12,6 +12,7 @@ module Qiita
       DEFAULT_FILTERABLE_FIELDS = []
       DEFAULT_HIERARCHAL_FIELDS = []
       DEFAULT_INT_FIELDS = []
+      DEFAULT_DEFAULT_FIELDS = []
       EXTRA_DATE_FIELDS = %w(created updated)
       EXTRA_FILTERABLE_FIELDS = %w(created is sort updated)
 
@@ -27,20 +28,22 @@ module Qiita
         )
       /x
 
+      # @param [Array<String>, nil] all_fields
       # @param [Array<String>, nil] date_fields
       # @param [Array<String>, nil] downcased_fields
       # @param [Array<String>, nil] filterable_fields
       # @param [Array<String>, nil] hierarchal_fields
       # @param [Array<String>, nil] int_fields
-      # @param [Array<String>, nil] matchable_fields
+      # @param [Array<String>, nil] default_fields
       # @param [String, nil] time_zone
-      def initialize(date_fields: nil, downcased_fields: nil, filterable_fields: nil, hierarchal_fields: nil, int_fields: nil, matchable_fields: nil, time_zone: nil)
-        @date_fields = date_fields
-        @downcased_fields = downcased_fields
-        @filterable_fields = filterable_fields
-        @hierarchal_fields = hierarchal_fields
-        @int_fields = int_fields
-        @matchable_fields = matchable_fields
+      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)
+        @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
+        @hierarchal_fields = hierarchal_fields || DEFAULT_HIERARCHAL_FIELDS
+        @int_fields = int_fields || DEFAULT_INT_FIELDS
+        @default_fields = default_fields || DEFAULT_DEFAULT_FIELDS
+        @all_fields = aggregate_all_fields(all_fields)
         @time_zone = time_zone
       end
 
@@ -49,19 +52,20 @@ 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? && !filterable_fields.include?(field_name)
+          if !field_name.nil? && !@all_fields.include?(field_name)
             term = "#{field_name}:#{term}"
             field_name = nil
           end
           token = token_class(field_name).new(
-            downcased: downcased_fields.include?(field_name),
+            downcased: @downcased_fields.include?(field_name),
             field_name: field_name,
             negative: !minus.nil?,
             quoted: !quoted_term.nil?,
+            filter: @filterable_fields.include?(field_name),
             term: term,
             token_string: token_string,
           )
-          token.matchable_fields = @matchable_fields if token.is_a?(MatchableToken)
+          token.default_fields = @default_fields if token.is_a?(MatchableToken)
           token.time_zone = @time_zone if token.is_a?(DateToken)
           token
         end
@@ -69,35 +73,29 @@ module Qiita
 
       private
 
-      def date_fields
-        (@date_fields || DEFAULT_DATE_FIELDS) | EXTRA_DATE_FIELDS
-      end
-
-      def downcased_fields
-        @downcased_fields || DEFAULT_DOWNCASED_FIELDS
-      end
-
-      def filterable_fields
-        (@filterable_fields || DEFAULT_FILTERABLE_FIELDS) | EXTRA_FILTERABLE_FIELDS
-      end
-
-      def hierarchal_fields
-        @hierarchal_fields || DEFAULT_HIERARCHAL_FIELDS
-      end
+      def aggregate_all_fields(base)
+        fields = [
+          base,
+          @date_fields,
+          @downcased_fields,
+          @filterable_fields,
+          @hierarchal_fields,
+          @int_fields,
+          @default_fields
+        ].flatten.compact
 
-      def int_fields
-        @int_fields || DEFAULT_INT_FIELDS
+        fields.map { |field| field.sub(/\^\d+\z/, "") }.uniq
       end
 
       def token_class(field_name)
         case
-        when date_fields.include?(field_name)
+        when @date_fields.include?(field_name)
           DateToken
-        when int_fields.include?(field_name)
+        when @int_fields.include?(field_name)
           IntToken
-        when hierarchal_fields.include?(field_name)
+        when @hierarchal_fields.include?(field_name)
           HierarchalToken
-        when filterable_fields.include?(field_name)
+        when @filterable_fields.include?(field_name)
           FilterableToken
         else
           MatchableToken

data/lib/qiita/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Elasticsearch
-    VERSION = "0.14.3"
+    VERSION = "0.15.0"
   end
 end

data/qiita-elasticsearch.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.7"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "rubocop", "0.29.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.15.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,16 +70,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Elasticsearch client helper for Qiita.