search_flip 2.3.2 → 3.0.0.beta

data/lib/search_flip/criteria.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::Criteria class serves the purpose of chaining various
   # filtering and aggregation methods. Each chainable method creates a new
@@ -14,15 +13,15 @@ module SearchFlip
   #   CommentIndex.sort("_doc").find_each { |comment| "..." }
 
   class Criteria
-    include SearchFlip::Filterable
-    include SearchFlip::PostFilterable
-    include SearchFlip::Aggregatable
+    include Filterable
+    include PostFilterable
+    include Aggregatable
     extend Forwardable
 
     attr_accessor :target, :profile_value, :source_value, :sort_values, :highlight_values, :suggest_values,
       :offset_value, :limit_value, :includes_values, :eager_load_values, :preload_values, :failsafe_value,
-      :scroll_args, :custom_value, :terminate_after_value, :timeout_value, :preference_value,
-      :search_type_value, :routing_value, :track_total_hits_value, :explain_value
+      :scroll_args, :custom_value, :terminate_after_value, :timeout_value, :preference_value, :search_type_value,
+      :routing_value, :track_total_hits_value, :explain_value
 
     # Creates a new criteria while merging the attributes (constraints,
     # settings, etc) of the current criteria with the attributes of another one
@@ -58,15 +57,11 @@ module SearchFlip
         criteria.includes_values = (criteria.includes_values || []) + other.includes_values if other.includes_values
         criteria.preload_values = (criteria.preload_values || []) + other.preload_values if other.preload_values
         criteria.eager_load_values = (criteria.eager_load_values || []) + other.eager_load_values if other.eager_load_values
-        criteria.search_values = (criteria.search_values || []) + other.search_values if other.search_values
         criteria.must_values = (criteria.must_values || []) + other.must_values if other.must_values
         criteria.must_not_values = (criteria.must_not_values || []) + other.must_not_values if other.must_not_values
-        criteria.should_values = (criteria.should_values || []) + other.should_values if other.should_values
         criteria.filter_values = (criteria.filter_values || []) + other.filter_values if other.filter_values
-        criteria.post_search_values = (criteria.post_search_values || []) + other.post_search_values if other.post_search_values
         criteria.post_must_values = (criteria.post_must_values || []) + other.post_must_values if other.post_must_values
         criteria.post_must_not_values = (criteria.post_must_not_values || []) + other.post_must_not_values if other.post_must_not_values
-        criteria.post_should_values = (criteria.post_should_values || []) + other.post_should_values if other.post_should_values
         criteria.post_filter_values = (criteria.post_filter_values || []) + other.post_filter_values if other.post_filter_values
 
         criteria.highlight_values = (criteria.highlight_values || {}).merge(other.highlight_values) if other.highlight_values
@@ -190,37 +185,6 @@ module SearchFlip
       end
     end
 
-    # Creates a new criteria while removing all specified scopes. Currently,
-    # you can unscope :search, :post_search, :sort, :highlight, :suggest, :custom
-    # and :aggregate.
-    #
-    # @example
-    #   CommentIndex.search("hello world").aggregate(:username).unscope(:search, :aggregate)
-    #
-    # @param scopes [Symbol] All scopes that you want to remove
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def unscope(*scopes)
-      warn "[DEPRECATION] unscope is deprecated and will be removed in search_flip 3"
-
-      unknown = scopes - [:search, :post_search, :sort, :highlight, :suggest, :custom, :aggregate]
-
-      raise(ArgumentError, "Can't unscope #{unknown.join(", ")}") if unknown.size > 0
-
-      scopes = scopes.to_set
-
-      fresh.tap do |criteria|
-        criteria.search_values = nil if scopes.include?(:search)
-        criteria.post_search_values = nil if scopes.include?(:post_search)
-        criteria.sort_values = nil if scopes.include?(:sort)
-        criteria.hightlight_values = nil if scopes.include?(:highlight)
-        criteria.suggest_values = nil if scopes.include?(:suggest)
-        criteria.custom_values = nil if scopes.include?(:custom)
-        criteria.aggregation_values = nil if scopes.include?(:aggregate)
-      end
-    end
-
     # @api private
     #
     # Convenience method to have a unified conversion api.
@@ -231,6 +195,8 @@ module SearchFlip
       self
     end
 
+    alias_method :all, :criteria
+
     # Creates a new SearchFlip::Criteria.
     #
     # @param attributes [Hash] Attributes to initialize the Criteria with
@@ -251,7 +217,7 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] Simply returns self
 
-    ruby2_keywords def with_settings(*args)
+    def with_settings(*args)
       fresh.tap do |criteria|
         criteria.target = target.with_settings(*args)
       end
@@ -266,36 +232,17 @@ module SearchFlip
     def request
       res = {}
 
-      if must_values || search_values || must_not_values || should_values || filter_values
-        if connection.version.to_i >= 2
-          res[:query] = {
-            bool: {}
-              .merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {})
-              .merge(must_not_values ? { must_not: must_not_values } : {})
-              .merge(should_values ? { should: should_values } : {})
-              .merge(filter_values ? { filter: filter_values } : {})
-          }
-        else
-          filters = (filter_values || []) + (must_not_values || []).map { |must_not_value| { not: must_not_value } }
-
-          queries = {}
-            .merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {})
-            .merge(should_values ? { should: should_values } : {})
-
-          res[:query] =
-            if filters.size > 0
-              {
-                filtered: {}
-                  .merge(queries.size > 0 ? { query: { bool: queries } } : {})
-                  .merge(filter: filters.size > 1 ? { and: filters } : filters.first)
-              }
-            else
-              { bool: queries }
-            end
-        end
+      if must_values || must_not_values || filter_values
+        res[:query] = {
+          bool: {
+            must: must_values.to_a,
+            must_not: must_not_values.to_a,
+            filter: filter_values.to_a
+          }.reject { |_, value| value.empty? }
+        }
       end
 
-      res.update from: offset_value_with_default, size: limit_value_with_default
+      res.update(from: offset_value_with_default, size: limit_value_with_default)
 
       res[:track_total_hits] = track_total_hits_value unless track_total_hits_value.nil?
       res[:explain] = explain_value unless explain_value.nil?
@@ -306,26 +253,14 @@ module SearchFlip
       res[:sort] = sort_values if sort_values
       res[:aggregations] = aggregation_values if aggregation_values
 
-      if post_must_values || post_search_values || post_must_not_values || post_should_values || post_filter_values
-        if connection.version.to_i >= 2
-          res[:post_filter] = {
-            bool: {}
-              .merge(post_must_values || post_search_values ? { must: (post_must_values || []) + (post_search_values || []) } : {})
-              .merge(post_must_not_values ? { must_not: post_must_not_values } : {})
-              .merge(post_should_values ? { should: post_should_values } : {})
-              .merge(post_filter_values ? { filter: post_filter_values } : {})
-          }
-        else
-          post_filters = (post_filter_values || []) + (post_must_not_values || []).map { |post_must_not_value| { not: post_must_not_value } }
-
-          post_queries = {}
-            .merge(post_must_values || post_search_values ? { must: (post_must_values || []) + (post_search_values || []) } : {})
-            .merge(post_should_values ? { should: post_should_values } : {})
-
-          post_filters_and_queries = post_filters + (post_queries.size > 0 ? [bool: post_queries] : [])
-
-          res[:post_filter] = post_filters_and_queries.size > 1 ? { and: post_filters_and_queries } : post_filters_and_queries.first
-        end
+      if post_must_values || post_must_not_values || post_filter_values
+        res[:post_filter] = {
+          bool: {
+            must: post_must_values.to_a,
+            must_not: post_must_not_values.to_a,
+            filter: post_filter_values.to_a
+          }.reject { |_, value| value.empty? }
+        }
       end
 
       res[:_source] = source_value unless source_value.nil?
@@ -633,6 +568,8 @@ module SearchFlip
       end
     end
 
+    # @api private
+    #
     # Returns the offset value or, if not yet set,  the default limit value (0).
     #
     # @return [Fixnum] The offset value
@@ -658,6 +595,8 @@ module SearchFlip
       end
     end
 
+    # @api private
+    #
     # Returns the limit value or, if not yet set, the default limit value (30).
     #
     # @return [Fixnum] The limit value
@@ -678,7 +617,7 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def paginate(page:, per_page: limit_value_with_default)
+    def paginate(page: 1, per_page: 30)
       page = [page.to_i, 1].max
       per_page = per_page.to_i
 
@@ -686,11 +625,11 @@ module SearchFlip
     end
 
     def page(value)
-      paginate(page: value)
+      paginate(page: value, per_page: limit_value_with_default)
     end
 
     def per(value)
-      paginate(page: offset_value_with_default / limit_value_with_default + 1, per_page: value)
+      paginate(page: 1 + (offset_value_with_default / limit_value_with_default), per_page: value)
     end
 
     # Fetches the records specified by the criteria in batches using the
@@ -811,17 +750,11 @@ module SearchFlip
 
         http_response =
           if scroll_args && scroll_args[:id]
-            if connection.version.to_i >= 2
-              http_request.post(
-                "#{connection.base_url}/_search/scroll",
-                params: request_params,
-                json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
-              )
-            else
-              http_request
-                .headers(content_type: "text/plain")
-                .post("#{connection.base_url}/_search/scroll", params: request_params.merge(scroll: scroll_args[:timeout]), body: scroll_args[:id])
-            end
+            http_request.post(
+              "#{connection.base_url}/_search/scroll",
+              params: request_params,
+              json: { scroll: scroll_args[:timeout], scroll_id: scroll_args[:id] }
+            )
           elsif scroll_args
             http_request.post(
               "#{target.type_url}/_search",
@@ -886,7 +819,7 @@ module SearchFlip
       target.respond_to?(name, *args)
     end
 
-    ruby2_keywords def method_missing(name, *args, &block)
+    def method_missing(name, *args, &block)
       if target.respond_to?(name)
         merge(target.send(name, *args, &block))
       else

data/lib/search_flip/exceptions.rb

@@ -1,5 +1,3 @@
-
 module SearchFlip
   class MethodNotImplemented < StandardError; end
 end
-

data/lib/search_flip/filterable.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::Filterable mixin provides chainable methods like
   # #where, #exists, #range, etc to add search filters to a criteria.
@@ -11,7 +10,7 @@ module SearchFlip
   module Filterable
     def self.included(base)
       base.class_eval do
-        attr_accessor :search_values, :must_values, :must_not_values, :should_values, :filter_values
+        attr_accessor :must_values, :must_not_values, :filter_values
       end
     end
 
@@ -30,11 +29,9 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def search(q, options = {})
-      fresh.tap do |criteria|
-        if q.to_s.strip.length > 0
-          criteria.search_values = (search_values || []) + [query_string: { query: q, default_operator: :AND }.merge(options)]
-        end
-      end
+      return self if q.to_s.strip.length.zero?
+
+      must(query_string: { query: q, default_operator: :AND }.merge(options))
     end
 
     # Adds filters to your criteria for the supplied hash composed of
@@ -57,13 +54,13 @@ module SearchFlip
     def where(hash)
       hash.inject(fresh) do |memo, (key, value)|
         if value.is_a?(Array)
-          memo.filter terms: { key => value }
+          memo.filter(terms: { key => value })
         elsif value.is_a?(Range)
-          memo.filter range: { key => { gte: value.min, lte: value.max } }
+          memo.filter(range: { key => { gte: value.min, lte: value.max } })
         elsif value.nil?
-          memo.exists_not key
+          memo.must_not(exists: { field: key })
         else
-          memo.filter term: { key => value }
+          memo.filter(term: { key => value })
         end
       end
     end
@@ -88,13 +85,13 @@ module SearchFlip
     def where_not(hash)
       hash.inject(fresh) do |memo, (key, value)|
         if value.is_a?(Array)
-          memo.must_not terms: { key => value }
+          memo.must_not(terms: { key => value })
         elsif value.is_a?(Range)
-          memo.must_not range: { key => { gte: value.min, lte: value.max } }
+          memo.must_not(range: { key => { gte: value.min, lte: value.max } })
         elsif value.nil?
-          memo.exists key
+          memo.filter(exists: { field: key })
         else
-          memo.must_not term: { key => value }
+          memo.must_not(term: { key => value })
         end
       end
     end
@@ -109,9 +106,9 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def filter(*args)
+    def filter(clause)
       fresh.tap do |criteria|
-        criteria.filter_values = (filter_values || []) + args
+        criteria.filter_values = (filter_values || []) + Helper.wrap_array(clause)
       end
     end
 
@@ -125,9 +122,9 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def must(*args)
+    def must(clause, bool_options = {})
       fresh.tap do |criteria|
-        criteria.must_values = (must_values || []) + args
+        criteria.must_values = (must_values || []) + Helper.wrap_array(clause)
       end
     end
 
@@ -141,28 +138,45 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def must_not(*args)
+    def must_not(clause)
       fresh.tap do |criteria|
-        criteria.must_not_values = (must_not_values || []) + args
+        criteria.must_not_values = (must_not_values || []) + Helper.wrap_array(clause)
       end
     end
 
-    # Adds raw should queries to the criteria.
+    # Returns all added queries and filters, including post filters, as a raw
+    # query.
     #
     # @example
-    #   CommentIndex.should(term: { state: "new" })
-    #   CommentIndex.should(range: { created_at: { gt: Time.parse"2016-01-01") }})
+    #   CommentIndex.where(state: "new").search("text").to_query
+    #   # => {:bool=>{:filter=>[{:term=>{:state=>"new"}}], :must=>[{:query_string=>{:query=>"text", ...}}]}}
     #
-    # @param args [Array, Hash] The raw should query arguments
+    # @return [Hash] The raw query
+
+    def to_query
+      {
+        bool: {
+          must: must_values.to_a,
+          must_not: must_not_values.to_a + post_must_not_values.to_a,
+          filter: post_must_values.to_a + filter_values.to_a + post_filter_values.to_a
+        }.reject { |_, value| value.empty? }
+      }
+    end
+
+    # Adds a raw should query to the criteria.
+    #
+    # @example
+    #   CommentIndex.should([
+    #     { term: { state: "new" } },
+    #     { term: { state: "reviewed" } }
+    #   ])
+    #
+    # @param args [Array] The raw should query arguments
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def should(*args)
-      warn "[DEPRECATION] should will change in search_flip 3. Please use .must(bool: { should: ... }) until release."
-
-      fresh.tap do |criteria|
-        criteria.should_values = (should_values || []) + args
-      end
+    def should(clause)
+      must(bool: { should: clause })
     end
 
     # Adds a range filter to the criteria without being forced to specify the
@@ -181,10 +195,10 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def range(field, options = {})
-      filter range: { field => options }
+      filter(range: { field => options })
     end
 
-    # Adds a match all filter/query to the criteria, which simply matches all
+    # Adds a match all filter to the criteria, which simply matches all
     # documents. This can be eg be used within filter aggregations or for
     # filter chaining. Check out the Elasticsearch docs for further details.
     #
@@ -209,7 +223,7 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def match_all(options = {})
-      filter match_all: options
+      filter(match_all: options)
     end
 
     # Adds an exists filter to the criteria, which selects all documents for
@@ -223,10 +237,10 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def exists(field)
-      filter exists: { field: field }
+      filter(exists: { field: field })
     end
 
-    # Adds an exists not filter to the criteria, which selects all documents
+    # Adds an exists not query to the criteria, which selects all documents
     # for which the specified field's value is null.
     #
     # @example
@@ -237,8 +251,7 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def exists_not(field)
-      must_not exists: { field: field }
+      must_not(exists: { field: field })
     end
   end
 end
-

data/lib/search_flip/helper.rb

@@ -0,0 +1,13 @@
+module SearchFlip
+  module Helper
+    def self.wrap_array(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+  end
+end

data/lib/search_flip/http_client.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # @api private
   #
@@ -26,21 +25,17 @@ module SearchFlip
           client.request = request.send(method, *args)
         end
       end
-
-      ruby2_keywords method
     end
 
     [:get, :post, :put, :delete, :head].each do |method|
       define_method method do |*args|
         execute(method, *args)
       end
-
-      ruby2_keywords method
     end
 
     private
 
-    ruby2_keywords def execute(method, *args)
+    def execute(method, *args)
       response = request.send(method, *args)
 
       raise SearchFlip::ResponseError.new(code: response.code, body: response.body.to_s) unless response.status.success?
@@ -51,4 +46,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/index.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::Index mixin makes your class correspond to an
   # Elasticsearch index. Your class can then create or delete the index, modify
@@ -248,13 +247,13 @@ module SearchFlip
         SearchFlip::Criteria.new(target: self)
       end
 
-      def_delegators :criteria, :profile, :where, :where_not, :filter, :range, :match_all, :exists,
+      def_delegators :criteria, :all, :profile, :where, :where_not, :filter, :range, :match_all, :exists,
         :exists_not, :post_where, :post_where_not, :post_range, :post_exists, :post_exists_not,
         :post_filter, :post_must, :post_must_not, :post_should, :aggregate, :scroll, :source,
         :includes, :eager_load, :preload, :sort, :resort, :order, :reorder, :offset, :limit, :paginate,
         :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_results_in_batches,
         :find_each, :find_each_result, :failsafe, :total_entries, :total_count, :timeout, :terminate_after,
-        :records, :results, :should, :should_not, :must, :must_not, :preference, :search_type, :routing,
+        :records, :results, :must, :must_not, :should, :preference, :search_type, :routing,
         :track_total_hits, :explain
 
       # Override to specify the type name used within Elasticsearch. Recap,
@@ -354,6 +353,24 @@ module SearchFlip
         connection.open_index(index_name_with_prefix)
       end
 
+      # Freezes the index within Elasticsearch. Raises SearchFlip::ResponseError
+      # in case any errors occur.
+      #
+      # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+      def freeze_index
+        connection.freeze_index(index_name_with_prefix)
+      end
+
+      # Unfreezes the index within Elasticsearch. Raises SearchFlip::ResponseError
+      # in case any errors occur.
+      #
+      # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+      def unfreeze_index
+        connection.unfreeze_index(index_name_with_prefix)
+      end
+
       # Updates the index settings within Elasticsearch according to the index
       # settings specified. Raises SearchFlip::ResponseError in case any
       # errors occur.
@@ -481,7 +498,7 @@ module SearchFlip
       #
       # @see #index See #index for more details
 
-      ruby2_keywords def import(*args)
+      def import(*args)
         index(*args)
       end
 

data/lib/search_flip/json.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   class JSON
     @default_options = {
@@ -15,4 +14,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/model.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   module Model
     def self.included(base)
@@ -18,4 +17,3 @@ module SearchFlip
     end
   end
 end
-