qiita-elasticsearch 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 133b6b66d4231ea9d97e516812cc58b232981319
-  data.tar.gz: b70d9f047d78e461e4cd81a076e5f09418982682
+  metadata.gz: 2ac89f9676b05d247337d139e417cb55d449152c
+  data.tar.gz: 44965231890460369545280221bedb008090743a
 SHA512:
-  metadata.gz: 3d9776c15e61239299ec17682c62930e2fddade09934cccf08f236a8e85f38bb8788fc34703323a4e49d66094bc19c494a4b8e7cd6c3a567bdebab0a5b564e68
-  data.tar.gz: 93d80c35c9135c8f3cb0837731fccd55b60cca6a912e9a36e1f641f71984b7f815b1d945c2a9836295fad9389ecec433566a5c457907759f0157c027caeb7b7d
+  metadata.gz: 0b507ea1cffce78984dd9e59a0d22b61727d1331a602f094b6731fe8784810495c3e65d09ffde4fce3c41dd9f747ed13087af9f400eefb677f8e8a8212eee030
+  data.tar.gz: 02286a98b45cfaca0f8bd6570d39faf5d3f21f68ca8b5cffa27a1430f00d7ec857ff25cf90032a68da59e6f48adc7c4a1285afa7505dd19e6127ae9b3c8d3119

data/.rubocop.yml

@@ -22,6 +22,9 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Style/CaseEquality:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.5.0
+- Change `QueryBuilder#build` to return `Query` object
+
 ## 0.4.0
 - Change range fields to use integer
 - Support date fields

data/lib/qiita/elasticsearch/date_token.rb

@@ -1,7 +1,6 @@
 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
@@ -53,16 +52,12 @@ module Qiita
             }
           end
         else
-          fail InvalidQuery
+          Nodes::NullNode.new.to_hash
         end
       end
 
       private
 
-      def date_match
-        @date_match ||= DATE_PATTERN.match(range_query || @term)
-      end
-
       # @return [Date]
       def beginning_of_range
         @beginning_of_range ||=
@@ -76,6 +71,10 @@ module Qiita
           end
       end
 
+      def date_match
+        @date_match ||= DATE_PATTERN.match(range_query || @term)
+      end
+
       # @return [Date]
       def end_of_range
         @end_of_range ||=
@@ -88,6 +87,11 @@ module Qiita
             beginning_of_range + 1.year
           end
       end
+
+      # @note Override
+      def has_invalid_term?
+        !!date_match
+      end
     end
   end
 end

data/lib/qiita/elasticsearch/int_token.rb

@@ -1,5 +1,4 @@
 require "qiita/elasticsearch/concerns/range_operand_includable"
-require "qiita/elasticsearch/errors"
 require "qiita/elasticsearch/token"
 
 module Qiita
@@ -12,7 +11,7 @@ module Qiita
       # @return [Hash]
       # @raise [InvalidQuery]
       def to_hash
-        if range_parameter && INT_PATTERN =~ range_query
+        if range_parameter && has_valid_range_query?
           {
             "range" => {
               @field_name => {
@@ -20,16 +19,39 @@ module Qiita
               },
             },
           }
-        elsif INT_PATTERN =~ @term
+        elsif has_valid_int_term?
           {
             "term" => {
               @field_name => @term.to_i,
             },
           }
         else
-          fail InvalidQuery
+          Nodes::NullNode.new.to_hash
         end
       end
+
+      private
+
+      def has_invalid_range_query?
+        has_range_query? && !has_valid_range_query?
+      end
+
+      # @note Override
+      def has_invalid_term?
+        range_parameter && has_invalid_range_query? || !has_valid_int_term?
+      end
+
+      def has_range_query?
+        !range_query.nil?
+      end
+
+      def has_valid_int_term?
+        INT_PATTERN === @term
+      end
+
+      def has_valid_range_query?
+        INT_PATTERN === range_query
+      end
     end
   end
 end

data/lib/qiita/elasticsearch/nodes/or_separatable_node.rb

@@ -31,7 +31,7 @@ module Qiita
 
         # @return [Array<Array<Qiita::Elasticsearch::Token>>]
         def tokens_grouped_by_or_token
-          @tokens_grouped_by_or_token ||= @tokens.each_with_object([[]]) do |token, groups|
+          @tokens_grouped_by_or_token ||= @tokens.reject(&:ignorable?).each_with_object([[]]) do |token, groups|
             if token.or?
               groups << []
             else

data/lib/qiita/elasticsearch/query.rb

@@ -0,0 +1,96 @@
+require "qiita/elasticsearch/nodes/null_node"
+require "qiita/elasticsearch/nodes/or_separatable_node"
+require "qiita/elasticsearch/tokenizer"
+
+module Qiita
+  module Elasticsearch
+    class Query
+      # @param [Array<Qiita::Elasticsearch::Token>] tokens
+      # @param [Hash] query_builder_options For building new query from this query
+      def initialize(tokens, query_builder_options = nil)
+        @query_builder_options = query_builder_options
+        @tokens = tokens
+      end
+
+      # @param [String] field_name
+      # @param [String] term
+      # @return [Qiita::Elasticsearch::Query]
+      # @example query.append_field_token(field_name: "tag", term: "Ruby")
+      def append_field_token(field_name: nil, term: nil)
+        build_query([*@tokens, "#{field_name}:#{term}"].join(" "))
+      end
+
+      # @param [String] field_name
+      # @param [String] term
+      # @return [Qiita::Elasticsearch::Query]
+      # @example query.delete_field_token(field_name: "tag", term: "Ruby")
+      def delete_field_token(field_name: nil, term: nil)
+        build_query(
+          @tokens.reject do |token|
+            token.field_name == field_name && token.term == term
+          end.join(" ")
+        )
+      end
+
+      # @param [String] field_name
+      # @param [String] term
+      # @example query.has_field_token?(field_name: "tag", term: "Ruby")
+      def has_field_token?(field_name: nil, term: nil)
+        @tokens.any? do |token|
+          token.field_name == field_name && token.term == term
+        end
+      end
+
+      # @return [Hash]
+      # @example query.to_hash
+      def to_hash
+        if has_empty_tokens?
+          Nodes::NullNode.new.to_hash
+        else
+          Nodes::OrSeparatableNode.new(@tokens).to_hash
+        end
+      end
+
+      # @return [String] query string generated from its tokens
+      def to_s
+        @tokens.join(" ")
+      end
+
+      # @param [String] field_name
+      # @param [String] term
+      # @return [Qiita::Elasticsearch::Query]
+      # @example query.update_field_token(field_name: "tag", term: "Ruby")
+      def update_field_token(field_name: nil, term: nil)
+        build_query(
+          @tokens.reject do |token|
+            token.field_name == field_name
+          end.map(&:to_s).push("#{field_name}:#{term}").join(" ")
+        )
+      end
+
+      private
+
+      # Build a new query from query string
+      # @param [String] query_string
+      # @return [Qiita::Elasticsearch::Query]
+      # @example build_query("test tag:Ruby")
+      def build_query(query_string)
+        query_builder.build(query_string)
+      end
+
+      def has_empty_tokens?
+        @tokens.size.zero?
+      end
+
+      # @return [Qiita::Elasticsearch::QueryBuilder]
+      def query_builder
+        QueryBuilder.new(query_builder_options)
+      end
+
+      # @return [Hash]
+      def query_builder_options
+        @query_builder_options || {}
+      end
+    end
+  end
+end

data/lib/qiita/elasticsearch/query_builder.rb

@@ -1,7 +1,6 @@
-require "qiita/elasticsearch/errors"
 require "qiita/elasticsearch/nodes/null_node"
 require "qiita/elasticsearch/nodes/or_separatable_node"
-require "qiita/elasticsearch/tokenizer"
+require "qiita/elasticsearch/query"
 
 module Qiita
   module Elasticsearch
@@ -24,16 +23,17 @@ module Qiita
       end
 
       # @param [String] query_string Raw query string
-      # @return [Hash]
+      # @return [Qiita::Elasticsearch::Query]
       def build(query_string)
-        tokens = tokenizer.tokenize(query_string)
-        if tokens.size.zero?
-          Nodes::NullNode.new.to_hash
-        else
-          Nodes::OrSeparatableNode.new(tokens).to_hash
-        end
-      rescue Error
-        Nodes::NullNode.new.to_hash
+        Query.new(
+          tokenizer.tokenize(query_string),
+          downcased_fields: @downcased_fields,
+          filterable_fields: @filterable_fields,
+          hierarchal_fields: @hierarchal_fields,
+          int_fields: @int_fields,
+          matchable_fields: @matchable_fields,
+          time_zone: @time_zone,
+        )
       end
 
       private

data/lib/qiita/elasticsearch/token.rb

@@ -3,11 +3,16 @@ module Qiita
     class Token
       attr_reader :field_name, :term
 
-      # @param [true, false] downcased
-      def initialize(downcased: nil, field_name: nil, minus: nil, quoted: nil, term: nil, token_string: nil)
+      # @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 [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)
         @downcased = downcased
         @field_name = field_name
-        @minus = minus
+        @negative = negative
         @quoted = quoted
         @term = term
         @token_string = token_string
@@ -22,14 +27,15 @@ module Qiita
         @downcased_term ||= term.downcase
       end
 
-      def to_hash
-        fail NotImplementedError
-      end
-
       def filter?
         !field_name.nil? || negative?
       end
 
+      # @return [true, false] True if this token is ignorable on building query (e.g. "-stocked:foo")
+      def ignorable?
+        negative? && !field_name.nil? && has_invalid_term?
+      end
+
       def must?
         !field_name.nil? && positive?
       end
@@ -43,7 +49,7 @@ module Qiita
       #             ^^^^^
       #             This
       def negative?
-        !positive?
+        !!@negative
       end
 
       # @return [true, false] True if this token is for OR filter
@@ -56,7 +62,7 @@ module Qiita
 
       # @return [true, false] Opposite of #negative?
       def positive?
-        @minus.nil?
+        !negative?
       end
 
       # @return [String] Downcased or not-downcased term
@@ -75,6 +81,25 @@ module Qiita
       def quoted?
         !!@quoted
       end
+
+      # @note Override me
+      def to_hash
+        fail NotImplementedError
+      end
+
+      # @note Override
+      # @return [String]
+      def to_s
+        @token_string.to_s
+      end
+
+      private
+
+      # @note Override me if needed
+      # @return [true, false] True if its term is invalid value
+      def has_invalid_term?
+        false
+      end
     end
   end
 end

data/lib/qiita/elasticsearch/tokenizer.rb

@@ -54,7 +54,7 @@ module Qiita
           token = token_class(field_name).new(
             downcased: downcased_fields.include?(field_name),
             field_name: field_name,
-            minus: minus,
+            negative: !minus.nil?,
             quoted: !quoted_term.nil?,
             term: term,
             token_string: token_string,

data/lib/qiita/elasticsearch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,7 +113,6 @@ files:
 - 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
@@ -126,6 +125,7 @@ files:
 - lib/qiita/elasticsearch/nodes/or_separatable_node.rb
 - lib/qiita/elasticsearch/nodes/query_node.rb
 - lib/qiita/elasticsearch/nodes/term_node.rb
+- lib/qiita/elasticsearch/query.rb
 - lib/qiita/elasticsearch/query_builder.rb
 - lib/qiita/elasticsearch/range_token.rb
 - lib/qiita/elasticsearch/token.rb
@@ -152,8 +152,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Elasticsearch client helper for Qiita.
 test_files: []
+has_rdoc: 

data/lib/qiita/elasticsearch/errors.rb

@@ -1,10 +0,0 @@
-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