es_query_builder 2.0.0 → 2.0.1

data/lib/sort/nested_sort_builder.rb

@@ -0,0 +1,68 @@
+# Elasticsearch also supports sorting by fields that are inside one or more nested objects.
+require_relative 'sort_builder'
+module Sort
+  class NestedSortBuilder < SortBuilder
+
+    NAME = 'nested_sort'
+
+=begin
+    @params:
+      filter: A filter that the inner objects inside the nested path should match with in order for its field values to be taken into account by sorting.
+      max_children: The maximum number of children to consider per root document when picking the sort value.
+      nested_sort: Same as top-level nested but applies to another nested path within the current nested object.
+      path: Defines on which nested object to sort. The actual sort field must be a direct field inside this nested object.
+=end
+    
+    def initialize path:
+      @path = path
+      @filter = nil
+      @max_children = nil
+      @nested_sort = nil
+    end
+
+    def query
+      query = self.common_query
+      query[:path] = @path
+      query[:filter] = @filter.query if @filter.present?
+      query[:nested] = @nested_sort.query if @nested_sort.present?
+      query[:max_children] = @max_children if @max_children.present?
+      return query
+    end
+
+  # returns path
+    def path_expr
+      return @path
+    end
+
+  # returns filter
+    def filter_expr
+      return @filter
+    end
+  # sets filter
+    def filter filter
+      @filter = filter
+      return self
+    end
+
+  # returns max_children
+    def max_children_expr
+      return @max_children
+    end
+  # sets max_children
+    def max_children max_children
+      @max_children = max_children
+      return self
+    end
+
+  # returns nested_sort
+    def nested_sort_expr
+      return @nested_sort
+    end
+  # sets nested_sort
+    def nested_sort nested_sort
+      @nested_sort = nested_sort
+      return self
+    end
+
+  end
+end

data/lib/sort/score_sort_builder.rb

@@ -0,0 +1,16 @@
+# A sort builder allowing to sort by score.
+require_relative 'sort_builder'
+module Sort
+  class ScoreSortBuilder < SortBuilder
+
+    NAME = '_score'
+
+    def query
+      query = {}
+      score_query = self.common_query
+      query[name.intern] = score_query
+      return query
+    end
+
+  end
+end

data/lib/sort/script_sort_builder.rb

@@ -0,0 +1,83 @@
+# Script sort builder allows to sort based on a custom script expression.
+require_relative 'sort_builder'
+module Sort
+  class ScriptSortBuilder < SortBuilder
+
+    NAME = '_script'
+
+=begin
+    @params:
+      script: Script used in this sort.
+      type: Script sort type used in this sort, can be (number, string).
+      nested_sort: Nested path within current object.
+      sort_mode: Defines which distance to use for sorting in the case a document contains multiple values.
+=end
+
+    def initialize script:, type:
+      @script = script
+      @type = type.script_sort_type
+      @nested_sort = nil
+      @sort_mode = nil
+    end
+
+    def query
+      query = {}
+      script_query = self.common_query
+      script_query[:script] = @script.settings
+      script_query[:type] = @type
+      script_query[:nested] = @nested_sort.query if @nested_sort.present?
+      script_sort[:sort_mode] = @sort_mode if @sort_mode.present?
+      query[name.intern] = script_query
+      return query
+    end
+
+  # returns script
+    def script_expr
+      return @script
+    end
+
+  # returns type
+    def type_expr
+      return @type
+    end
+
+  # returns nested_sort
+    def nested_sort_expr
+      return @nested_sort
+    end
+  # sets nested_sort
+    def nested_sort nested_sort
+      @nested_sort = nested_sort
+      return self
+    end
+
+  # returns sort_mode
+    def sort_mode_expr
+      return @sort_mode
+    end
+  # sets sort_mode
+    def sort_mode sort_mode
+      @sort_mode = sort_mode.sort_mode
+      return self
+    end
+
+    class ScriptSortTypes
+
+      SCRIPT_SORT_TYPES = {number: "number", string: "string"}
+
+      attr_reader :script_sort_type
+
+      SCRIPT_SORT_TYPES.each do |script_type, es_value|
+        define_singleton_method(script_type) do
+          return self.new(es_value)
+        end
+      end
+
+      def initialize script_type
+        @script_sort_type = script_type
+      end
+
+    end
+
+  end
+end

data/lib/sort/sort_builder.rb

@@ -0,0 +1,28 @@
+require_relative 'abstract_sort_builder'
+module Sort  
+  class SortBuilder
+    include AttributesReader
+    include AbstractSortBuilder
+
+    def initialize
+      @order = nil
+    end
+
+    def common_query
+      query = {}
+      query[:order] = @order if @order.present?
+      return query
+    end
+
+  # returns order
+    def order_expr
+      return @order
+    end
+  # sets order
+    def order sort_order
+      @order = sort_order.sort_order
+      return self
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: es_query_builder
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Mohib Yousuf
@@ -86,18 +86,81 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/aggregation_builders.rb
+- lib/aggregations/buckets/date_histogram_aggregation_builder.rb
+- lib/aggregations/buckets/date_range_aggregation_builder.rb
+- lib/aggregations/buckets/filter_aggregation_builder.rb
+- lib/aggregations/buckets/filters_aggregation_builder.rb
+- lib/aggregations/buckets/geo_grid_aggregation_builder.rb
+- lib/aggregations/buckets/histogram_aggregation_builder.rb
+- lib/aggregations/buckets/nested_aggregation_builder.rb
+- lib/aggregations/buckets/range_aggregation_builder.rb
+- lib/aggregations/buckets/reverse_nested_aggregation_builder.rb
+- lib/aggregations/buckets/terms_aggregation_builder.rb
+- lib/aggregations/buckets/top_hits_aggregation_builder.rb
+- lib/aggregations/helpers/abstract_aggregation_helper.rb
+- lib/aggregations/helpers/abstract_range_helper.rb
+- lib/aggregations/helpers/aggregation_query_builder_helper.rb
+- lib/aggregations/helpers/values_source_aggregation_helper.rb
+- lib/aggregations/metrics/avg_aggregation_builder.rb
+- lib/aggregations/metrics/max_aggregation_builder.rb
+- lib/aggregations/metrics/min_aggregation_builder.rb
 - lib/attributes_reader.rb
 - lib/constants.rb
 - lib/elastic_search_query.rb
+- lib/enums/combine_functions.rb
+- lib/enums/distance_types.rb
+- lib/enums/distance_units.rb
+- lib/enums/fuzziness.rb
+- lib/enums/orders.rb
+- lib/enums/score_modes.rb
+- lib/enums/script_sort_types.rb
+- lib/enums/script_types.rb
+- lib/enums/shape_relations.rb
+- lib/enums/sort_modes.rb
+- lib/enums/sort_orders.rb
+- lib/enums/validation_methods.rb
+- lib/enums/zero_terms_query.rb
 - lib/es_query_builder.rb
 - lib/fetch_es_data.rb
 - lib/function_score_builders.rb
+- lib/function_scores/random_score_function_builder.rb
+- lib/function_scores/score_function_builder.rb
+- lib/function_scores/script_score_function_builder.rb
+- lib/function_scores/weighted_score_function_builder.rb
 - lib/indexer.rb
+- lib/misc/bucket_order.rb
+- lib/misc/geo_point.rb
+- lib/misc/range.rb
+- lib/misc/script.rb
+- lib/misc/terms_lookup.rb
 - lib/multi_search_request.rb
+- lib/queries/abstract_query_builder.rb
+- lib/queries/base_query_builder.rb
+- lib/queries/bool_query_builder.rb
+- lib/queries/constant_score_query_builder.rb
+- lib/queries/dis_max_query_builder.rb
+- lib/queries/exists_query_builder.rb
+- lib/queries/function_score_query_builder.rb
+- lib/queries/geo_distance_query_builder.rb
+- lib/queries/match_all_query_builder.rb
+- lib/queries/match_query_builder.rb
+- lib/queries/nested_query_builder.rb
+- lib/queries/nested_sort_query_builder.rb
+- lib/queries/query_builder.rb
+- lib/queries/range_query_builder.rb
+- lib/queries/term_query_builder.rb
+- lib/queries/terms_query_builder.rb
 - lib/query_builders.rb
 - lib/rest_client.rb
 - lib/search_request.rb
 - lib/search_source_builder.rb
+- lib/sort/abstract_sort_builder.rb
+- lib/sort/field_sort_builder.rb
+- lib/sort/geo_distance_sort_builder.rb
+- lib/sort/nested_sort_builder.rb
+- lib/sort/score_sort_builder.rb
+- lib/sort/script_sort_builder.rb
+- lib/sort/sort_builder.rb
 - lib/sort_builders.rb
 - lib/test_script.rb
 - lib/token_query_builder.rb