qiita-elasticsearch 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc0094615455695aa7148b67052af7b154c5e31e
-  data.tar.gz: 64562e5f4139f14eb727062d7caf39cf706f92eb
+  metadata.gz: 133b6b66d4231ea9d97e516812cc58b232981319
+  data.tar.gz: b70d9f047d78e461e4cd81a076e5f09418982682
 SHA512:
-  metadata.gz: 183fabc234d8480455a5804eb80a8ccca40cc0b0e39fc5f6ee2f75800958875170203063f76303c88ea68e45388f347aa000f14c13d204eb6f2f8317c213b5d7
-  data.tar.gz: 857a39fb54f660ed9a3edf6c74b45212589ba558586bd0966f2b388454099ce5aad322a7b77949d1a4129b10ae6e755eacf377b8c2eecf3e6a0f43a042637ba6
+  metadata.gz: 3d9776c15e61239299ec17682c62930e2fddade09934cccf08f236a8e85f38bb8788fc34703323a4e49d66094bc19c494a4b8e7cd6c3a567bdebab0a5b564e68
+  data.tar.gz: 93d80c35c9135c8f3cb0837731fccd55b60cca6a912e9a36e1f641f71984b7f815b1d945c2a9836295fad9389ecec433566a5c457907759f0157c027caeb7b7d

data/.rubocop.yml

@@ -39,3 +39,7 @@ Style/StringLiterals:
 
 Style/TrailingComma:
   Enabled: false
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.4.0
+- Change range fields to use integer
+- Support date fields
+- Support time_zone parameter
+- Rename range_fields parameter as int_fields
+- Return a null query if an invalid query string is given
+
 ## 0.3.0
 - Add downcased_fields options and update case rule
 

data/README.md

@@ -60,15 +60,36 @@ query_builder.build("tag:ruby")
 #=> {"filtered"=>{"filter"=>{"bool"=>{"should"=>[{"prefix"=>{"tag"=>"ruby/"}}, {"term"=>{"tag"=>"ruby"}}]}}}}
 ```
 
-### range_fields
-Pass `:range_fields` option with `:filterable_fields` to enable range filtered queries.
-With this option, `created_at:<2015-04-16` will hit documents created before 2015-04-16.
+### int_fields
+Pass `:int_fields` option with `:filterable_fields` to enable range filtered queries.
+With this option, `stocks:>100` will hit documents stocked by greater than 100 users.
 
 ```rb
-query_builder = Qiita::Elasticsearch::QueryBuilder.new(filterable_fields: ["created_at"], range_fields: ["created_at"])
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(filterable_fields: ["stocks"], int_fields: ["stocks"])
+
+query_builder.build("stocks:>100")
+#=> {"filtered"=>{"filter"=>{"range"=>{"stocks"=>{"gt"=>100}}}}}
+```
+
+### date_fields
+Pass `:date_fields` option with `:filterable_fields` to enable date filtered queries.
+With this option, `created_at:<2015-04-01` will hit documents created before 2015-04-01.
+
+```rb
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(filterable_fields: ["created_at"], date_fields: ["created_at"])
+
+query_builder.build("created_at:<2015-04-01")
+#=> {"filtered"=>{"filter"=>{"range"=>{"created_at"=>{"lt"=>"2015-04-01"}}}}}
+```
+
+### time_zone
+Pass `:time_zone` option to tell how move range field's input to UTC time based date.
+
+```rb
+query_builder = Qiita::Elasticsearch::QueryBuilder.new(filterable_fields: ["created_at"], date_fields: ["created_at"], time_zone: "+09:00")
 
 query_builder.build("created_at:<2015-04-16")
-#=> {"filtered"=>{"filter"=>{"range"=>{"created_at"=>{"lt"=>"2015-04-16"}}}}}
+#=> {"filtered"=>{"filter"=>{"range"=>{"created_at"=>{"lt"=>"2015-04-16","time_zone"=>"+09:00"}}}}}
 ```
 
 ### downcased_fields

data/lib/qiita/elasticsearch/concerns/range_operand_includable.rb

@@ -0,0 +1,42 @@
+require "active_support/concern"
+
+module Qiita
+  module Elasticsearch
+    module Concerns
+      module RangeOperandIncludable
+        extend ActiveSupport::Concern
+
+        RANGE_TERM_REGEXP = /\A(?<operand>\<=|\<|\>=|\>)(?<query>.*)\z/
+
+        private
+
+        # @return [String, nil]
+        # @example Suppose @term is "created_at:>=2015-04-16"
+        #   range_parameter #=> "gte"
+        def range_parameter
+          range_match[:operand] ? operand_map[range_match[:operand]] : nil
+        end
+
+        # @return [String, nil]
+        # @example Suppose @term is "created_at:>=2015-04-16"
+        #   range_query #=> "2015-04-16"
+        def range_query
+          range_match[:query]
+        end
+
+        def range_match
+          @range_match ||= RANGE_TERM_REGEXP.match(@term) || {}
+        end
+
+        def operand_map
+          {
+            ">" => "gt",
+            ">=" => "gte",
+            "<" => "lt",
+            "<=" => "lte",
+          }
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/date_token.rb

@@ -0,0 +1,93 @@
+require "active_support/core_ext/date"
+require "active_support/core_ext/integer"
+require "qiita/elasticsearch/concerns/range_operand_includable"
+require "qiita/elasticsearch/errors"
+require "qiita/elasticsearch/token"
+
+module Qiita
+  module Elasticsearch
+    class DateToken < Token
+      include Concerns::RangeOperandIncludable
+
+      # @note Matches to "YYYY", "YYYY-MM" and "YYYY-MM-DD"
+      DATE_PATTERN = /\A
+        (?<year>\d{4})
+        (?:
+          -
+          (?<month>\d{1,2})
+          (?:
+            -
+            (?<day>\d{1,2})
+          )?
+        )?
+      \z/x
+
+      attr_writer :time_zone
+
+      # @return [Hash]
+      # @raise [InvalidQuery]
+      def to_hash
+        if date_match
+          if range_parameter
+            {
+              "range" => {
+                @field_name => {
+                  range_parameter => range_query,
+                  "time_zone" => @time_zone,
+                }.reject do |key, value|
+                  key == "time_zone" && value.nil?
+                end,
+              },
+            }
+          else
+            {
+              "range" => {
+                @field_name => {
+                  "gte" => beginning_of_range.to_s,
+                  "lt" => end_of_range.to_s,
+                  "time_zone" => @time_zone,
+                }.reject do |key, value|
+                  key == "time_zone" && value.nil?
+                end,
+              },
+            }
+          end
+        else
+          fail InvalidQuery
+        end
+      end
+
+      private
+
+      def date_match
+        @date_match ||= DATE_PATTERN.match(range_query || @term)
+      end
+
+      # @return [Date]
+      def beginning_of_range
+        @beginning_of_range ||=
+          case
+          when date_match[:day]
+            Date.new(date_match[:year].to_i, date_match[:month].to_i, date_match[:day].to_i)
+          when date_match[:month]
+            Date.new(date_match[:year].to_i, date_match[:month].to_i)
+          else
+            Date.new(date_match[:year].to_i)
+          end
+      end
+
+      # @return [Date]
+      def end_of_range
+        @end_of_range ||=
+          case
+          when date_match[:day]
+            beginning_of_range + 1.day
+          when date_match[:month]
+            beginning_of_range + 1.month
+          else
+            beginning_of_range + 1.year
+          end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/errors.rb

@@ -0,0 +1,10 @@
+module Qiita
+  module Elasticsearch
+    # @note Custom error class for rescuing from all Qiita::Elasticsearch errors.
+    class Error < StandardError
+    end
+
+    class InvalidQuery < Error
+    end
+  end
+end

data/lib/qiita/elasticsearch/int_token.rb

@@ -0,0 +1,35 @@
+require "qiita/elasticsearch/concerns/range_operand_includable"
+require "qiita/elasticsearch/errors"
+require "qiita/elasticsearch/token"
+
+module Qiita
+  module Elasticsearch
+    class IntToken < Token
+      include Concerns::RangeOperandIncludable
+
+      INT_PATTERN = /\A\d+\z/
+
+      # @return [Hash]
+      # @raise [InvalidQuery]
+      def to_hash
+        if range_parameter && INT_PATTERN =~ range_query
+          {
+            "range" => {
+              @field_name => {
+                range_parameter => range_query.to_i,
+              },
+            },
+          }
+        elsif INT_PATTERN =~ @term
+          {
+            "term" => {
+              @field_name => @term.to_i,
+            },
+          }
+        else
+          fail InvalidQuery
+        end
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/query_builder.rb

@@ -1,3 +1,4 @@
+require "qiita/elasticsearch/errors"
 require "qiita/elasticsearch/nodes/null_node"
 require "qiita/elasticsearch/nodes/or_separatable_node"
 require "qiita/elasticsearch/tokenizer"
@@ -5,17 +6,21 @@ require "qiita/elasticsearch/tokenizer"
 module Qiita
   module Elasticsearch
     class QueryBuilder
+      # @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] range_fields
-      def initialize(downcased_fields: nil, hierarchal_fields: nil, filterable_fields: nil, matchable_fields: nil, range_fields: nil)
+      # @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)
+        @date_fields = date_fields
         @downcased_fields = downcased_fields
-        @hierarchal_fields = hierarchal_fields
         @filterable_fields = filterable_fields
+        @hierarchal_fields = hierarchal_fields
+        @int_fields = int_fields
         @matchable_fields = matchable_fields
-        @range_fields = range_fields
+        @time_zone = time_zone
       end
 
       # @param [String] query_string Raw query string
@@ -27,17 +32,21 @@ module Qiita
         else
           Nodes::OrSeparatableNode.new(tokens).to_hash
         end
+      rescue Error
+        Nodes::NullNode.new.to_hash
       end
 
       private
 
       def tokenizer
         @tokenizer ||= Tokenizer.new(
+          date_fields: @date_fields,
           downcased_fields: @downcased_fields,
-          hierarchal_fields: @hierarchal_fields,
           filterable_fields: @filterable_fields,
+          hierarchal_fields: @hierarchal_fields,
+          int_fields: @int_fields,
           matchable_fields: @matchable_fields,
-          range_fields: @range_fields,
+          time_zone: @time_zone,
         )
       end
     end

data/lib/qiita/elasticsearch/range_token.rb

@@ -3,7 +3,7 @@ require "qiita/elasticsearch/token"
 module Qiita
   module Elasticsearch
     class RangeToken < Token
-      RANGE_TERM_REGEXP = /\A(?<operand>\<|\<=|\>|\>=)(?<query>.*)\z/
+      RANGE_TERM_REGEXP = /\A(?<operand>\<=|\<|\>=|\>)(?<query>.*)\z/
 
       # @return [Hash]
       def to_hash
@@ -11,14 +11,14 @@ module Qiita
           {
             "range" => {
               @field_name => {
-                range_parameter => range_query,
+                range_parameter => range_query.to_i,
               },
             },
           }
         else
           {
             "term" => {
-              @field_name => proper_cased_term,
+              @field_name => proper_cased_term.to_i,
             },
           }
         end

data/lib/qiita/elasticsearch/tokenizer.rb

@@ -1,15 +1,17 @@
+require "qiita/elasticsearch/date_token"
 require "qiita/elasticsearch/filterable_token"
 require "qiita/elasticsearch/hierarchal_token"
 require "qiita/elasticsearch/matchable_token"
-require "qiita/elasticsearch/range_token"
+require "qiita/elasticsearch/int_token"
 
 module Qiita
   module Elasticsearch
     class Tokenizer
+      DEFAULT_DATE_FIELDS = []
       DEFAULT_DOWNCASED_FIELDS = []
       DEFAULT_FILTERABLE_FIELDS = []
       DEFAULT_HIERARCHAL_FIELDS = []
-      DEFAULT_RANGE_FIELDS = []
+      DEFAULT_INT_FIELDS = []
 
       TOKEN_PATTERN = /
         (?<token_string>
@@ -23,17 +25,21 @@ module Qiita
         )
       /x
 
+      # @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] range_fields
-      def initialize(downcased_fields: nil, filterable_fields: nil, hierarchal_fields: nil, matchable_fields: nil, range_fields: nil)
+      # @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
-        @range_fields = range_fields
+        @time_zone = time_zone
       end
 
       # @param [String] query_string Raw query string
@@ -54,12 +60,17 @@ module Qiita
             token_string: token_string,
           )
           token.matchable_fields = @matchable_fields if token.is_a?(MatchableToken)
+          token.time_zone = @time_zone if token.is_a?(DateToken)
           token
         end
       end
 
       private
 
+      def date_fields
+        @date_fields || DEFAULT_DATE_FIELDS
+      end
+
       def downcased_fields
         @downcased_fields || DEFAULT_DOWNCASED_FIELDS
       end
@@ -72,14 +83,16 @@ module Qiita
         @hierarchal_fields || DEFAULT_HIERARCHAL_FIELDS
       end
 
-      def range_fields
-        @range_fields || DEFAULT_RANGE_FIELDS
+      def int_fields
+        @int_fields || DEFAULT_INT_FIELDS
       end
 
       def token_class(field_name)
         case
-        when range_fields.include?(field_name)
-          RangeToken
+        when date_fields.include?(field_name)
+          DateToken
+        when int_fields.include?(field_name)
+          IntToken
         when hierarchal_fields.include?(field_name)
           HierarchalToken
         when filterable_fields.include?(field_name)

data/lib/qiita/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Elasticsearch
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/qiita-elasticsearch.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_dependency "activesupport"
   spec.add_development_dependency "bundler", ">= 1.7"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: qiita-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,8 +111,12 @@ files:
 - README.md
 - Rakefile
 - lib/qiita/elasticsearch.rb
+- lib/qiita/elasticsearch/concerns/range_operand_includable.rb
+- lib/qiita/elasticsearch/date_token.rb
+- lib/qiita/elasticsearch/errors.rb
 - lib/qiita/elasticsearch/filterable_token.rb
 - lib/qiita/elasticsearch/hierarchal_token.rb
+- lib/qiita/elasticsearch/int_token.rb
 - lib/qiita/elasticsearch/matchable_token.rb
 - lib/qiita/elasticsearch/nodes/filter_node.rb
 - lib/qiita/elasticsearch/nodes/filterable_node.rb
@@ -134,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Elasticsearch client helper for Qiita.