search_flip 3.0.0.beta2 → 3.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8594c0c22592c2dfa8fb54097151a87db3746221586b8c28e4c6c3c5c02dff6c
-  data.tar.gz: 55b27e4f8e3bc04c4420280d1dccafbf66e5f7e53cf6914c16f5e5dd3cb5ae10
+  metadata.gz: 417bf711946ace4812485ea2efdfefdeb36414e7e8e8d8ed24b10b4807050be9
+  data.tar.gz: c8a9f7392d77f15c4714c40756c032a2bb3bc12c363a9e956a6b9e184c8e4c17
 SHA512:
-  metadata.gz: d54c4c22ba4637573d590288cf1a2407d0ff066e9c4505e3ee851a431ff6ebdc318424ea3af63b2c4d426f74521e27a1800c361feb97dec37c7d1159328dc819
-  data.tar.gz: 1b1bd5e46c5edfc2f1c7d3674564b1bb5627956aee05e16d06e1bdbf1107a70cdd1114bc530cb380db40cc16f383481bafc573c63e1ac3e26b218df97f0d65ed
+  metadata.gz: c62c6d3bc17ec18da5b304dfbddbafc29e35013bcc6b0b906858380b01a263b2e534986cd41f9e90d13de99820f9cbf11a173802910737bf33d8ae5653230af1
+  data.tar.gz: 3b6ee6d16086e451f6f6e6d7c718d6a30c30115d91c6ba9e69113faa19b9abc35d04c8c179dc9ca5ac49418877c0c5828435d71c1dab7b71d4afe2e31da88762

data/CHANGELOG.md

@@ -21,6 +21,8 @@
 * `Connection#freeze_index`, `Connection#unfreeze_index`, `Index#freeze_index`
    and `Index#unfreeze_index` added
 * Added `SearchFlip::Result.from_hit`
+* Added support for `source`, `sort`, `page`, `per`, `paginate`, `explain`, and
+  `highlight` to aggregations
 
 ## v2.3.1
 

data/README.md

@@ -505,6 +505,14 @@ end
 query.aggregations(:average_price).average_price.value
 ```
 
+Even various criteria for top hits aggregations can be specified elegantly:
+
+```ruby
+query = ProductIndex.aggregate(sponsored: { top_hits: {} }) do |aggregation|
+  aggregation.sort(:rank).highlight(:title).source([:id, :title])
+end
+```
+
 Checkout [Aggregatable](http://www.rubydoc.info/github/mrkamel/search_flip/SearchFlip/Aggregatable)
 as well as [Aggregation](http://www.rubydoc.info/github/mrkamel/search_flip/SearchFlip/Aggregation)
 for a complete API reference.

data/lib/search_flip/aggregatable.rb

@@ -57,7 +57,14 @@ module SearchFlip
         if block
           aggregation = yield(SearchFlip::Aggregation.new(target: target))
 
-          field_or_hash.is_a?(Hash) ? hash[field_or_hash.keys.first].merge!(aggregation.to_hash) : hash[field_or_hash].merge!(aggregation.to_hash)
+          if field_or_hash.is_a?(Hash)
+            value = field_or_hash.values.first
+            value = value.values.first if value.is_a?(Hash) && !value.empty?
+
+            value.merge!(aggregation.to_hash)
+          else
+            hash[field_or_hash].merge!(aggregation.to_hash)
+          end
         end
 
         criteria.aggregation_values = (aggregation_values || {}).merge(hash)

data/lib/search_flip/aggregation.rb

@@ -6,6 +6,12 @@ module SearchFlip
   class Aggregation
     include Filterable
     include Aggregatable
+    include Paginatable
+    include Highlightable
+    include Explainable
+    include Sourceable
+    include Sortable
+    include Customable
 
     attr_reader :target
 
@@ -40,6 +46,15 @@ module SearchFlip
         end
       end
 
+      res.update(from: offset_value_with_default, size: limit_value_with_default) if offset_value || limit_value
+
+      res[:explain] = explain_value unless explain_value.nil?
+      res[:highlight] = highlight_values if highlight_values
+      res[:sort] = sort_values if sort_values
+      res[:_source] = source_value unless source_value.nil?
+
+      res.update(custom_value) if custom_value
+
       res
     end
 
@@ -56,11 +71,9 @@ module SearchFlip
 
       fresh.tap do |aggregation|
         unsupported_methods = [
-          :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
-          :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
-          :includes_values, :preload_values, :eager_load_values, :post_must_values,
-          :post_must_not_values, :post_filter_values, :preference_value,
-          :search_type_value, :routing_value
+          :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :scroll_args,
+          :suggest_values, :includes_values, :preload_values, :eager_load_values, :post_must_values,
+          :post_must_not_values, :post_filter_values, :preference_value, :search_type_value, :routing_value
         ]
 
         unsupported_methods.each do |unsupported_method|
@@ -69,10 +82,19 @@ module SearchFlip
           end
         end
 
+        aggregation.source_value = other.source_value if other.source_value
+        aggregation.offset_value = other.offset_value if other.offset_value
+        aggregation.limit_value = other.limit_value if other.limit_value
+        aggregation.scroll_args = other.scroll_args if other.scroll_args
+        aggregation.explain_value = other.explain_value unless other.explain_value.nil?
+
+        aggregation.sort_values = (aggregation.sort_values || []) + other.sort_values if other.sort_values
         aggregation.must_values = (aggregation.must_values || []) + other.must_values if other.must_values
         aggregation.must_not_values = (aggregation.must_not_values || []) + other.must_not_values if other.must_not_values
         aggregation.filter_values = (aggregation.filter_values || []) + other.filter_values if other.filter_values
 
+        aggregation.highlight_values = (aggregation.highlight_values || {}).merge(other.highlight_values) if other.highlight_values
+        aggregation.custom_value = (aggregation.custom_value || {}).merge(other.custom_value) if other.custom_value
         aggregation.aggregation_values = (aggregation.aggregation_values || {}).merge(other.aggregation_values) if other.aggregation_values
       end
     end

data/lib/search_flip/criteria.rb

@@ -13,15 +13,20 @@ module SearchFlip
   #   CommentIndex.sort("_doc").find_each { |comment| "..." }
 
   class Criteria
+    include Sortable
+    include Sourceable
+    include Highlightable
+    include Explainable
+    include Paginatable
+    include Customable
     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
+    attr_accessor :target, :profile_value, :source_value, :suggest_values, :includes_values,
+      :eager_load_values, :preload_values, :failsafe_value, :scroll_args, :terminate_after_value,
+      :timeout_value, :preference_value, :search_type_value, :routing_value, :track_total_hits_value
 
     # Creates a new criteria while merging the attributes (constraints,
     # settings, etc) of the current criteria with the attributes of another one
@@ -71,22 +76,6 @@ module SearchFlip
       end
     end
 
-    # Specifies whether or not to enable explanation for each hit on how
-    # its score was computed.
-    #
-    # @example
-    #   CommentIndex.explain(true)
-    #
-    # @param value [Boolean] The value for explain
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def explain(value)
-      fresh.tap do |criteria|
-        criteria.explain_value = value
-      end
-    end
-
     # Specifies if or how many hits should be counted/tracked. Check out the
     # elasticsearch docs for futher details.
     #
@@ -271,43 +260,6 @@ module SearchFlip
       res
     end
 
-    # Adds highlighting of the given fields to the request.
-    #
-    # @example
-    #   CommentIndex.highlight([:title, :message])
-    #   CommentIndex.highlight(:title).highlight(:description)
-    #   CommentIndex.highlight(:title, require_field_match: false)
-    #   CommentIndex.highlight(title: { type: "fvh" })
-    #
-    # @example
-    #   query = CommentIndex.highlight(:title).search("hello")
-    #   query.results[0].highlight.title # => "<em>hello</em> world"
-    #
-    # @param fields [Hash, Array, String, Symbol] The fields to highligt.
-    #   Supports raw Elasticsearch values by passing a Hash.
-    #
-    # @param options [Hash] Extra highlighting options. Check out the Elasticsearch
-    #   docs for further details.
-    #
-    # @return [SearchFlip::Criteria] A new criteria including the highlighting
-
-    def highlight(fields, options = {})
-      fresh.tap do |criteria|
-        criteria.highlight_values = (criteria.highlight_values || {}).merge(options)
-
-        hash =
-          if fields.is_a?(Hash)
-            fields
-          elsif fields.is_a?(Array)
-            fields.each_with_object({}) { |field, h| h[field] = {} }
-          else
-            { fields => {} }
-          end
-
-        criteria.highlight_values[:fields] = (criteria.highlight_values[:fields] || {}).merge(hash)
-      end
-    end
-
     # Adds a suggestion section with the given name to the request.
     #
     # @example
@@ -397,24 +349,6 @@ module SearchFlip
       true
     end
 
-    # Use to specify which fields of the source document you want Elasticsearch
-    # to return for each matching result.
-    #
-    # @example
-    #   CommentIndex.source([:id, :message]).search("hello world")
-    #   CommentIndex.source(exclude: "description")
-    #   CommentIndex.source(false)
-    #
-    # @param value Pass any allowed value to restrict the returned source
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def source(value)
-      fresh.tap do |criteria|
-        criteria.source_value = value
-      end
-    end
-
     # Specify associations of the target model you want to include via
     # ActiveRecord's or other ORM's mechanisms when records get fetched from
     # the database.
@@ -472,166 +406,6 @@ module SearchFlip
       end
     end
 
-    # Specify the sort order you want Elasticsearch to use for sorting the
-    # results. When you call this multiple times, the sort orders are appended
-    # to the already existing ones. The sort arguments get passed to
-    # Elasticsearch without modifications, such that you can use sort by
-    # script, etc here as well.
-    #
-    # @example Default usage
-    #   CommentIndex.sort(:user_id, :id)
-    #
-    #   # Same as
-    #
-    #   CommentIndex.sort(:user_id).sort(:id)
-    #
-    # @example Default hash usage
-    #   CommentIndex.sort(user_id: "asc").sort(id: "desc")
-    #
-    #   # Same as
-    #
-    #   CommentIndex.sort({ user_id: "asc" }, { id: "desc" })
-    #
-    # @example Sort by native script
-    #   CommentIndex.sort("_script" => "sort_script", lang: "native", order: "asc", type: "number")
-    #
-    # @param args The sort values that get passed to Elasticsearch
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def sort(*args)
-      fresh.tap do |criteria|
-        criteria.sort_values = (sort_values || []) + args
-      end
-    end
-
-    alias_method :order, :sort
-
-    # Specify the sort order you want Elasticsearch to use for sorting the
-    # results with already existing sort orders being removed.
-    #
-    # @example
-    #   CommentIndex.sort(user_id: "asc").resort(id: "desc")
-    #
-    #   # Same as
-    #
-    #   CommentIndex.sort(id: "desc")
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-    #
-    # @see #sort See #sort for more details
-
-    def resort(*args)
-      fresh.tap do |criteria|
-        criteria.sort_values = args
-      end
-    end
-
-    alias_method :reorder, :resort
-
-    # Adds a fully custom field/section to the request, such that upcoming or
-    # minor Elasticsearch features as well as other custom requirements can be
-    # used without having yet specialized criteria methods.
-    #
-    # @note Use with caution, because using #custom will potentiall override
-    #   other sections like +aggregations+, +query+, +sort+, etc if you use the
-    #   the same section names.
-    #
-    # @example
-    #   CommentIndex.custom(section: { argument: "value" }).request
-    #   => {:section=>{:argument=>"value"},...}
-    #
-    # @param hash [Hash] The custom section that is added to the request
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def custom(hash)
-      fresh.tap do |criteria|
-        criteria.custom_value = (custom_value || {}).merge(hash)
-      end
-    end
-
-    # Sets the request offset, ie SearchFlip's from parameter that is used
-    # to skip results in the result set from being returned.
-    #
-    # @example
-    #   CommentIndex.offset(100)
-    #
-    # @param value [Fixnum] The offset value, ie the number of results that are
-    #   skipped in the result set
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def offset(value)
-      fresh.tap do |criteria|
-        criteria.offset_value = value.to_i
-      end
-    end
-
-    # @api private
-    #
-    # Returns the offset value or, if not yet set,  the default limit value (0).
-    #
-    # @return [Fixnum] The offset value
-
-    def offset_value_with_default
-      (offset_value || 0).to_i
-    end
-
-    # Sets the request limit, ie Elasticsearch's size parameter that is used
-    # to restrict the results that get returned.
-    #
-    # @example
-    #   CommentIndex.limit(100)
-    #
-    # @param value [Fixnum] The limit value, ie the max number of results that
-    #   should be returned
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def limit(value)
-      fresh.tap do |criteria|
-        criteria.limit_value = value.to_i
-      end
-    end
-
-    # @api private
-    #
-    # Returns the limit value or, if not yet set, the default limit value (30).
-    #
-    # @return [Fixnum] The limit value
-
-    def limit_value_with_default
-      (limit_value || 30).to_i
-    end
-
-    # Sets pagination parameters for the criteria by using offset and limit,
-    # ie Elasticsearch's from and size parameters.
-    #
-    # @example
-    #   CommentIndex.paginate(page: 3)
-    #   CommentIndex.paginate(page: 5, per_page: 60)
-    #
-    # @param page [#to_i] The current page
-    # @param per_page [#to_i] The number of results per page
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
-
-    def paginate(page: 1, per_page: 30)
-      page = [page.to_i, 1].max
-      per_page = per_page.to_i
-
-      offset((page - 1) * per_page).limit(per_page)
-    end
-
-    def page(value)
-      paginate(page: value, per_page: limit_value_with_default)
-    end
-
-    def per(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
     # ElasicSearch scroll API and yields each batch. The batch size and scroll
     # API timeout can be specified. Check out the Elasticsearch docs for

data/lib/search_flip/customable.rb

@@ -0,0 +1,34 @@
+module SearchFlip
+  # The SearchFlip::Sortable mixin provides the chainable #custom method to
+  # add arbitrary sections to the elasticsearch request
+
+  module Customable
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :custom_value
+      end
+    end
+
+    # Adds a fully custom field/section to the request, such that upcoming or
+    # minor Elasticsearch features as well as other custom requirements can be
+    # used without having yet specialized criteria methods.
+    #
+    # @note Use with caution, because using #custom will potentiall override
+    #   other sections like +aggregations+, +query+, +sort+, etc if you use the
+    #   the same section names.
+    #
+    # @example
+    #   CommentIndex.custom(section: { argument: "value" }).request
+    #   => {:section=>{:argument=>"value"},...}
+    #
+    # @param hash [Hash] The custom section that is added to the request
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def custom(hash)
+      fresh.tap do |criteria|
+        criteria.custom_value = (custom_value || {}).merge(hash)
+      end
+    end
+  end
+end

data/lib/search_flip/explainable.rb

@@ -0,0 +1,28 @@
+module SearchFlip
+  # The SearchFlip::Sortable mixin provides the chainable #explain method to
+  # control elasticsearch query explanations
+
+  module Explainable
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :explain_value
+      end
+    end
+
+    # Specifies whether or not to enable explanation for each hit on how
+    # its score was computed.
+    #
+    # @example
+    #   CommentIndex.explain(true)
+    #
+    # @param value [Boolean] The value for explain
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def explain(value)
+      fresh.tap do |criteria|
+        criteria.explain_value = value
+      end
+    end
+  end
+end

data/lib/search_flip/highlightable.rb

@@ -0,0 +1,49 @@
+module SearchFlip
+  # The SearchFlip::Sortable mixin provides the chainable #highlight method to
+  # use elasticsearch highlighting
+
+  module Highlightable
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :highlight_values
+      end
+    end
+
+    # Adds highlighting of the given fields to the request.
+    #
+    # @example
+    #   CommentIndex.highlight([:title, :message])
+    #   CommentIndex.highlight(:title).highlight(:description)
+    #   CommentIndex.highlight(:title, require_field_match: false)
+    #   CommentIndex.highlight(title: { type: "fvh" })
+    #
+    # @example
+    #   query = CommentIndex.highlight(:title).search("hello")
+    #   query.results[0].highlight.title # => "<em>hello</em> world"
+    #
+    # @param fields [Hash, Array, String, Symbol] The fields to highligt.
+    #   Supports raw Elasticsearch values by passing a Hash.
+    #
+    # @param options [Hash] Extra highlighting options. Check out the Elasticsearch
+    #   docs for further details.
+    #
+    # @return [SearchFlip::Criteria] A new criteria including the highlighting
+
+    def highlight(fields, options = {})
+      fresh.tap do |criteria|
+        criteria.highlight_values = (criteria.highlight_values || {}).merge(options)
+
+        hash =
+          if fields.is_a?(Hash)
+            fields
+          elsif fields.is_a?(Array)
+            fields.each_with_object({}) { |field, h| h[field] = {} }
+          else
+            { fields => {} }
+          end
+
+        criteria.highlight_values[:fields] = (criteria.highlight_values[:fields] || {}).merge(hash)
+      end
+    end
+  end
+end

data/lib/search_flip/paginatable.rb

@@ -0,0 +1,93 @@
+module SearchFlip
+  # The SearchFlip::Paginatable mixin provides chainable methods to allow
+  # paginating the search results
+
+  module Paginatable
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :offset_value, :limit_value
+      end
+    end
+
+    # Sets the request offset, ie SearchFlip's from parameter that is used
+    # to skip results in the result set from being returned.
+    #
+    # @example
+    #   CommentIndex.offset(100)
+    #
+    # @param value [Fixnum] The offset value, ie the number of results that are
+    #   skipped in the result set
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def offset(value)
+      fresh.tap do |criteria|
+        criteria.offset_value = value.to_i
+      end
+    end
+
+    # @api private
+    #
+    # Returns the offset value or, if not yet set,  the default limit value (0).
+    #
+    # @return [Fixnum] The offset value
+
+    def offset_value_with_default
+      (offset_value || 0).to_i
+    end
+
+    # Sets the request limit, ie Elasticsearch's size parameter that is used
+    # to restrict the results that get returned.
+    #
+    # @example
+    #   CommentIndex.limit(100)
+    #
+    # @param value [Fixnum] The limit value, ie the max number of results that
+    #   should be returned
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def limit(value)
+      fresh.tap do |criteria|
+        criteria.limit_value = value.to_i
+      end
+    end
+
+    # @api private
+    #
+    # Returns the limit value or, if not yet set, the default limit value (30).
+    #
+    # @return [Fixnum] The limit value
+
+    def limit_value_with_default
+      (limit_value || 30).to_i
+    end
+
+    # Sets pagination parameters for the criteria by using offset and limit,
+    # ie Elasticsearch's from and size parameters.
+    #
+    # @example
+    #   CommentIndex.paginate(page: 3)
+    #   CommentIndex.paginate(page: 5, per_page: 60)
+    #
+    # @param page [#to_i] The current page
+    # @param per_page [#to_i] The number of results per page
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def paginate(page: 1, per_page: 30)
+      page = [page.to_i, 1].max
+      per_page = per_page.to_i
+
+      offset((page - 1) * per_page).limit(per_page)
+    end
+
+    def page(value)
+      paginate(page: value, per_page: limit_value_with_default)
+    end
+
+    def per(value)
+      paginate(page: 1 + (offset_value_with_default / limit_value_with_default), per_page: value)
+    end
+  end
+end

data/lib/search_flip/sortable.rb

@@ -0,0 +1,69 @@
+module SearchFlip
+  # The SearchFlip::Sortable mixin provides the chainable methods #sort as
+  # well as #resort
+
+  module Sortable
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :sort_values
+
+        alias_method :order, :sort
+      end
+    end
+
+    # Specify the sort order you want Elasticsearch to use for sorting the
+    # results. When you call this multiple times, the sort orders are appended
+    # to the already existing ones. The sort arguments get passed to
+    # Elasticsearch without modifications, such that you can use sort by
+    # script, etc here as well.
+    #
+    # @example Default usage
+    #   CommentIndex.sort(:user_id, :id)
+    #
+    #   # Same as
+    #
+    #   CommentIndex.sort(:user_id).sort(:id)
+    #
+    # @example Default hash usage
+    #   CommentIndex.sort(user_id: "asc").sort(id: "desc")
+    #
+    #   # Same as
+    #
+    #   CommentIndex.sort({ user_id: "asc" }, { id: "desc" })
+    #
+    # @example Sort by native script
+    #   CommentIndex.sort("_script" => "sort_script", lang: "native", order: "asc", type: "number")
+    #
+    # @param args The sort values that get passed to Elasticsearch
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def sort(*args)
+      fresh.tap do |criteria|
+        criteria.sort_values = (sort_values || []) + args
+      end
+    end
+
+    # Specify the sort order you want Elasticsearch to use for sorting the
+    # results with already existing sort orders being removed.
+    #
+    # @example
+    #   CommentIndex.sort(user_id: "asc").resort(id: "desc")
+    #
+    #   # Same as
+    #
+    #   CommentIndex.sort(id: "desc")
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+    #
+    # @see #sort See #sort for more details
+
+    def resort(*args)
+      fresh.tap do |criteria|
+        criteria.sort_values = args
+      end
+    end
+
+    alias_method :reorder, :resort
+  end
+end

data/lib/search_flip/sourceable.rb

@@ -0,0 +1,30 @@
+module SearchFlip
+  # The SearchFlip::Sortable mixin provides the chainable #source method to
+  # use elasticsearch source filtering
+
+  module Sourceable
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :source_value
+      end
+    end
+
+    # Use to specify which fields of the source document you want Elasticsearch
+    # to return for each matching result.
+    #
+    # @example
+    #   CommentIndex.source([:id, :message]).search("hello world")
+    #   CommentIndex.source(exclude: "description")
+    #   CommentIndex.source(false)
+    #
+    # @param value Pass any allowed value to restrict the returned source
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def source(value)
+      fresh.tap do |criteria|
+        criteria.source_value = value
+      end
+    end
+  end
+end

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.0.0.beta2"
+  VERSION = "3.0.0.beta3"
 end

data/lib/search_flip.rb

@@ -14,6 +14,12 @@ require "search_flip/config"
 require "search_flip/connection"
 require "search_flip/bulk"
 require "search_flip/filterable"
+require "search_flip/customable"
+require "search_flip/explainable"
+require "search_flip/highlightable"
+require "search_flip/paginatable"
+require "search_flip/sortable"
+require "search_flip/sourceable"
 require "search_flip/post_filterable"
 require "search_flip/aggregatable"
 require "search_flip/aggregation"

data/search_flip.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = <<~MESSAGE
     Thanks for using search_flip!
-    When upgrading from 1.x to 2.x, please check out
+    When upgrading to 3.x, please check out
     https://github.com/mrkamel/search_flip/blob/master/UPDATING.md
   MESSAGE
 

data/spec/search_flip/aggregation_spec.rb

@@ -271,8 +271,8 @@ RSpec.describe SearchFlip::Aggregation do
 
       ProductIndex.import [product1, product2, product3, product4]
 
-      query = ProductIndex.aggregate(categories: {}) do |agg|
-        agg.merge(ProductIndex.where(price: 100..200)).aggregate(:category)
+      query = ProductIndex.aggregate(categories: {}) do |aggregation|
+        aggregation.merge(ProductIndex.where(price: 100..200)).aggregate(:category)
       end
 
       result = query.aggregations(:categories).category.buckets.each_with_object({}) do |bucket, hash|
@@ -282,33 +282,24 @@ RSpec.describe SearchFlip::Aggregation do
       expect(result).to eq("category1" => 2, "category2" => 1)
     end
 
-    describe "unsupported methods" do
-      unsupported_methods = [
-        :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
-        :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
-        :includes_values, :preload_values, :eager_load_values, :post_must_values,
-        :post_must_not_values, :post_filter_values, :preference_value,
-        :search_type_value, :routing_value
-      ]
+    describe "assignments" do
+      methods = [:offset_value, :limit_value, :source_value, :explain_value]
 
-      unsupported_methods.each do |unsupported_method|
-        it "raises a NotSupportedError #{unsupported_method}" do
-          block = lambda do
-            TestIndex.aggregate(field: {}) do |agg|
-              criteria = SearchFlip::Criteria.new(target: TestIndex)
-              criteria.send("#{unsupported_method}=", "value")
+      methods.each do |method|
+        it "replaces the values" do
+          aggregation = SearchFlip::Aggregation.new(target: TestIndex)
+          aggregation.send("#{method}=", "value1")
 
-              agg.merge(criteria)
-            end
-          end
+          criteria = SearchFlip::Criteria.new(target: TestIndex)
+          criteria.send("#{method}=", "value2")
 
-          expect(&block).to raise_error(SearchFlip::NotSupportedError)
+          expect(aggregation.merge(criteria).send(method)).to eq("value2")
         end
       end
     end
 
     describe "array concatenations" do
-      methods = [:must_values, :must_not_values, :filter_values]
+      methods = [:sort_values, :must_values, :must_not_values, :filter_values]
 
       methods.each do |method|
         it "concatenates the values for #{method}" do
@@ -326,7 +317,7 @@ RSpec.describe SearchFlip::Aggregation do
     end
 
     describe "hash merges" do
-      methods = [:aggregation_values]
+      methods = [:highlight_values, :custom_value, :aggregation_values]
 
       methods.each do |method|
         it "merges the values for #{method}" do
@@ -342,6 +333,29 @@ RSpec.describe SearchFlip::Aggregation do
         end
       end
     end
+
+    describe "unsupported methods" do
+      unsupported_methods = [
+        :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :scroll_args,
+        :suggest_values, :includes_values, :preload_values, :eager_load_values, :post_must_values,
+        :post_must_not_values, :post_filter_values, :preference_value, :search_type_value, :routing_value
+      ]
+
+      unsupported_methods.each do |unsupported_method|
+        it "raises a NotSupportedError #{unsupported_method}" do
+          block = lambda do
+            aggregation = SearchFlip::Aggregation.new(target: TestIndex)
+
+            criteria = SearchFlip::Criteria.new(target: TestIndex)
+            criteria.send("#{unsupported_method}=", "value")
+
+            aggregation.merge(criteria)
+          end
+
+          expect(&block).to raise_error(SearchFlip::NotSupportedError)
+        end
+      end
+    end
   end
 
   describe "#respond_to?" do
@@ -369,8 +383,8 @@ RSpec.describe SearchFlip::Aggregation do
 
       temp_index.import [product1, product2, product3, product4]
 
-      query = temp_index.aggregate(categories: {}) do |agg|
-        agg.merge(temp_index.with_price_range(100..200)).aggregate(:category)
+      query = temp_index.aggregate(categories: {}) do |aggregation|
+        aggregation.merge(temp_index.with_price_range(100..200)).aggregate(:category)
       end
 
       result = query.aggregations(:categories).category.buckets.each_with_object({}) do |bucket, hash|
@@ -380,4 +394,144 @@ RSpec.describe SearchFlip::Aggregation do
       expect(result).to eq("category1" => 2, "category2" => 1)
     end
   end
+
+  describe "#explain" do
+    it "returns the explaination" do
+      ProductIndex.import create(:product)
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.explain(true)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.first.key?("_explanation")).to eq(true)
+    end
+  end
+
+  describe "#custom" do
+    it "adds a custom entry to the request" do
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.custom(custom_key: "custom_value")
+      end
+
+      expect(query.request[:aggregations][:top_hits][:top_hits][:custom_key]).to eq("custom_value")
+    end
+  end
+
+  describe "#highlight" do
+    it "adds a custom entry to the request" do
+      ProductIndex.import create(:product, title: "Title highlight")
+
+      query = ProductIndex.search("title:highlight").aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.highlight([:title])
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.first.highlight.title).to be_present
+    end
+  end
+
+  describe "#page" do
+    it "returns the respective result window" do
+      product1, product2 = create_list(:product, 2)
+
+      ProductIndex.import [product1, product2]
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.sort(:id).per(1).page(2)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.first._id).to eq(product2.id.to_s)
+    end
+  end
+
+  describe "#per" do
+    it "returns the respective result window" do
+      ProductIndex.import create_list(:product, 2)
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.per(1)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.size).to eq(1)
+    end
+  end
+
+  describe "#paginate" do
+    it "returns the respective result window" do
+      product1, product2 = create_list(:product, 2)
+
+      ProductIndex.import [product1, product2]
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.sort(:id).paginate(page: 2, per_page: 1)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.first._id).to eq(product2.id.to_s)
+    end
+  end
+
+  describe "#limit" do
+    it "returns the respective result window" do
+      ProductIndex.import create_list(:product, 2)
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.limit(1)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.size).to eq(1)
+    end
+  end
+
+  describe "#offset" do
+    it "returns the respective result window" do
+      product1, product2 = create_list(:product, 2)
+
+      ProductIndex.import [product1, product2]
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.sort(:id).limit(1).offset(1)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.first._id).to eq(product2.id.to_s)
+    end
+  end
+
+  describe "#sort" do
+    it "returns the results in the specified order" do
+      product1, product2 = create_list(:product, 2)
+
+      ProductIndex.import [product1, product2]
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.sort(id: "desc")
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.map(&:_id)).to eq([product2, product1].map(&:id).map(&:to_s))
+    end
+  end
+
+  describe "#resort" do
+    it "overrides the previous sorting and returns the results in the specified order" do
+      product1, product2 = create_list(:product, 2)
+
+      ProductIndex.import [product1, product2]
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.sort(id: "desc").resort(:id)
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.map(&:_id)).to eq([product1, product2].map(&:id).map(&:to_s))
+    end
+  end
+
+  describe "#source" do
+    it "returns the specified fields only" do
+      ProductIndex.import create(:product)
+
+      query = ProductIndex.aggregate(top_hits: { top_hits: {} }) do |aggregation|
+        aggregation.source([:id, :title])
+      end
+
+      expect(query.aggregations("top_hits").hits.hits.first._source.keys).to eq(["id", "title"])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.0.0.beta3
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -202,16 +202,22 @@ files:
 - lib/search_flip/config.rb
 - lib/search_flip/connection.rb
 - lib/search_flip/criteria.rb
+- lib/search_flip/customable.rb
 - lib/search_flip/exceptions.rb
+- lib/search_flip/explainable.rb
 - lib/search_flip/filterable.rb
 - lib/search_flip/helper.rb
+- lib/search_flip/highlightable.rb
 - lib/search_flip/http_client.rb
 - lib/search_flip/index.rb
 - lib/search_flip/json.rb
 - lib/search_flip/model.rb
+- lib/search_flip/paginatable.rb
 - lib/search_flip/post_filterable.rb
 - lib/search_flip/response.rb
 - lib/search_flip/result.rb
+- lib/search_flip/sortable.rb
+- lib/search_flip/sourceable.rb
 - lib/search_flip/to_json.rb
 - lib/search_flip/version.rb
 - search_flip.gemspec
@@ -233,7 +239,7 @@ licenses:
 metadata: {}
 post_install_message: |
   Thanks for using search_flip!
-  When upgrading from 1.x to 2.x, please check out
+  When upgrading to 3.x, please check out
   https://github.com/mrkamel/search_flip/blob/master/UPDATING.md
 rdoc_options: []
 require_paths: