es_query_builder 2.0.0 → 2.0.1

data/lib/aggregations/buckets/top_hits_aggregation_builder.rb

@@ -0,0 +1,78 @@
+module Aggregations
+  module Buckets
+    # Elasticsearch Top Hits Aggregation
+    class TopHitsAggregationBuilder
+
+      include ::Aggregations::Helpers::AbstractAggregationHelper
+      include ::Aggregations::Helpers::AggregationQueryBuilderHelper
+      include ::AttributesReader
+
+      ATTRIBUTES = [:size, :sort, :_source]
+
+      # @param [String] name : Aggregation name
+      def initialize name:
+        @name = name.intern
+        @type = :top_hits
+        @query = {
+          @name => {
+            @type => {}
+          }
+        }
+      end
+
+      # @param [Integer] size
+      # @return [TopHitsAggregationBuilder]
+      def size size
+        @size = size
+        self
+      end
+
+      # @return [Integer]
+      def size_expr
+        @size
+      end
+
+      # @param [Sort::SortBuilder] sort : use SortBuilders factory
+      # @return [TopHitsAggregationBuilder]
+      def add_sort sort
+        @sort ||= []
+        @sort << sort
+        self
+      end
+
+      # @return [Sort::SortBuilder]
+      def sort_expr
+        @sort
+      end
+
+      # @param [Array] include_list
+      # @return [TopHitsAggregationBuilder]
+      def source_include include_list
+        @_source ||= {}
+        @_source[:include] = include_list if include_list.present?
+        self
+      end
+
+      # @param [Array] exclude_list
+      # @return [TopHitsAggregationBuilder]
+      def source_exclude exclude_list
+        @_source ||= {}
+        @_source[:exclude] = exclude_list if exclude_list.present?
+        self
+      end
+
+      # @return [Array]
+      def source_include_expr
+        return [] unless @_source.present?
+        @_source[:include]
+      end
+
+      # @return [Array]
+      def source_exclude_expr
+        return [] unless @_source.present?
+        @_source[:exclude]
+      end
+      
+    end
+  end
+end

data/lib/aggregations/helpers/abstract_aggregation_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Aggregations
+  module Helpers
+    # A helper module for aggregations, defines sub aggregation attributes.
+    module AbstractAggregationHelper
+      # helper method to add abstract aggregation attributes to aggregation.
+      def abstract_agg_builder
+        builder = {}
+        builder[:aggs] = build_sub_aggs_struct if @sub_aggregations.present?
+        builder
+      end
+
+      # @param [AggregationQueryBuilderHelper] sub_agg : AggregationBuilders factory
+      # @return [AbstractAggregationHelper] : aggregation object
+      def sub_aggregation(sub_agg)
+        @sub_aggregations = [] if @sub_aggregations.nil?
+        @sub_aggregations = @sub_aggregations.append(sub_agg)
+        self
+      end
+
+      # @return [AbstractAggregationHelper] : aggregation object
+      def sub_aggregation_expr
+        @sub_aggregations
+      end
+
+      private
+
+      def build_sub_aggs_struct
+        @sub_aggregations.each_with_object({}) do |ag, qr|
+          qr.merge!(ag.attributes.query)
+          qr
+        end
+      end
+    end
+  end
+end

data/lib/aggregations/helpers/abstract_range_helper.rb

@@ -0,0 +1,40 @@
+# A helper module for aggregations, defines ranges, keyed attributes.
+module Aggregations
+  module Helpers
+    module AbstractRangeHelper
+
+      # helper method to add abstract range attributes to aggregation.
+      def abstract_range_builder
+        builder = {}
+        builder[:ranges] = @ranges if @ranges.present?
+        builder[:keyed] = @keyed if @keyed.present?
+        builder
+      end
+
+      # @param [Misc::Range] range
+      # @return [AbstractRangeHelper], can be chained for adding multiple ranges.
+      def add_range range
+        @ranges ||= []
+        @ranges << range.settings
+        self
+      end
+
+      # @return [Array]
+      def ranges_expr
+        @ranges
+      end
+
+      # @param [Boolean] keyed
+      def keyed keyed
+        @keyed = keyed
+        self
+      end
+
+      # @return [Boolean]
+      def keyed_expr
+        @keyed
+      end
+
+    end
+  end
+end

data/lib/aggregations/helpers/aggregation_query_builder_helper.rb

@@ -0,0 +1,61 @@
+# A helper module for aggregations, builds aggregation query from attributes.
+module Aggregations
+  module Helpers
+    module AggregationQueryBuilderHelper
+
+      OBJECT_ARRAY_SETTINGS_FIELDS = [:order]
+      OBJECT_ARRAY_QUERY_FIELDS = [:sort]
+
+      # @return [String] : Aggregation name
+      def name_expr
+        @name.to_s
+      end
+
+      # @return [String] : Aggregation type
+      def type_expr
+        @type.to_s
+      end
+
+      # @return [Hash] : Aggregation query
+      def query
+        add_value_source_agg_builder if self.class.included_modules.include?(ValuesSourceAggregationHelper)
+        add_abstract_agg_builder if self.class.included_modules.include?(AbstractAggregationHelper)
+        add_abstract_range_builder if self.class.included_modules.include?(AbstractRangeHelper)
+        add_class_attributes if ("#{self.class.name}::ATTRIBUTES".constantize rescue nil).present?
+        @query
+      end
+
+      alias_method :query_expr, :query
+
+      private
+      
+      def add_value_source_agg_builder
+        @query[@name][@type].merge!(value_source_agg_builder)
+      end
+
+      def add_class_attributes
+        "#{self.class.name}::ATTRIBUTES".constantize.each do |attr|
+          attr_inst = instance_variable_get("@#{attr.to_s}")
+          if attr_inst.present?
+            if OBJECT_ARRAY_SETTINGS_FIELDS.include?(attr)
+              @query[@name][@type][attr] = attr_inst.map{|obj| obj.settings}
+            elsif OBJECT_ARRAY_QUERY_FIELDS.include?(attr)
+              @query[@name][@type][attr] = attr_inst.map{|obj| obj.query}
+            else
+              @query[@name][@type][attr] = attr_inst
+            end
+          end
+        end
+      end
+
+      def add_abstract_agg_builder
+        @query[@name].merge!(abstract_agg_builder)
+      end
+
+      def add_abstract_range_builder
+        @query[@name][@type].merge!(abstract_range_builder)
+      end
+
+    end
+  end
+end

data/lib/aggregations/helpers/values_source_aggregation_helper.rb

@@ -0,0 +1,53 @@
+# A helper module for aggregations, defines field, script, missing attributes.
+module Aggregations
+  module Helpers
+    module ValuesSourceAggregationHelper
+
+      # helper method to add values source attributes to aggregation.
+      def value_source_agg_builder
+        builder = {}
+        builder[:field] = @field if @field.present?
+        builder[:script] = @script.settings if @script.present?
+        builder[:missing] = @missing if @missing.present?
+        builder
+      end
+
+      # @param [String] field
+      # @return [ValuesSourceAggregationHelper]
+      def field field
+        @field = field
+        self
+      end
+
+      # @return [String]
+      def field_expr
+        @field
+      end
+
+      # @param [Misc::Script] script
+      # @return [ValuesSourceAggregationHelper]
+      def script script
+        @script = script
+        self
+      end
+
+      # @return [Misc::Script]
+      def script_expr
+        @script
+      end
+
+      # @param [String]
+      # @return [ValuesSourceAggregationHelper]
+      def missing missing
+        @missing = missing
+        self
+      end
+
+      # @return [String]
+      def missing_expr
+        @missing
+      end
+
+    end
+  end
+end

data/lib/aggregations/metrics/avg_aggregation_builder.rb

@@ -0,0 +1,24 @@
+module Aggregations
+  module Metrics
+    # Elasticsearch Avg Aggregation
+    class AvgAggregationBuilder
+
+      include ::Aggregations::Helpers::ValuesSourceAggregationHelper
+      include ::Aggregations::Helpers::AbstractAggregationHelper
+      include ::Aggregations::Helpers::AggregationQueryBuilderHelper
+      include ::AttributesReader
+
+      # @param [String] name : Aggregation name
+      def initialize name:
+        @name = name.intern
+        @type = :avg
+        @query = {
+          @name => {
+            @type => {}
+          }
+        }
+      end
+      
+    end
+  end
+end

data/lib/aggregations/metrics/max_aggregation_builder.rb

@@ -0,0 +1,24 @@
+module Aggregations
+  module Metrics
+    # Elasticsearch Max Aggregation
+    class MaxAggregationBuilder
+
+      include ::Aggregations::Helpers::ValuesSourceAggregationHelper
+      include ::Aggregations::Helpers::AbstractAggregationHelper
+      include ::Aggregations::Helpers::AggregationQueryBuilderHelper
+      include ::AttributesReader
+
+      # @param [String] name : Aggregation name
+      def initialize name:
+        @name = name.intern
+        @type = :max
+        @query = {
+          @name => {
+            @type => {}
+          }
+        }
+      end
+      
+    end
+  end
+end

data/lib/aggregations/metrics/min_aggregation_builder.rb

@@ -0,0 +1,24 @@
+module Aggregations
+  module Metrics
+    # Elasticsearch Min Aggregation
+    class MinAggregationBuilder
+
+      include ::Aggregations::Helpers::ValuesSourceAggregationHelper
+      include ::Aggregations::Helpers::AbstractAggregationHelper
+      include ::Aggregations::Helpers::AggregationQueryBuilderHelper
+      include ::AttributesReader
+
+      # @param [String] name : Aggregation name
+      def initialize name:
+        @name = name.intern
+        @type = :min
+        @query = {
+          @name => {
+            @type => {}
+          }
+        }
+      end
+      
+    end
+  end
+end

data/lib/enums/combine_functions.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for boost modes while combining aggregated function
+  # scores together with the sub query score
+  class CombineFunctions
+    # @!visibility protected
+    COMBINE_FUNCTIONS = { multiply: 'multiply', replace: 'replace', sum: 'sum',
+                          avg: 'avg', max: 'max', min: 'min' }.freeze
+    # @!visibility protected
+    attr_reader :combine_function
+
+    COMBINE_FUNCTIONS.each do |comb_fnctn, es_value|
+      define_singleton_method(comb_fnctn) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method multiply
+    # @return [CombineFunctions] CombineFunctions object
+    #   corresponding to elasticsearch option of 'multiply'
+
+    # @!scope class
+    # @!method replace
+    # @return [CombineFunctions] CombineFunctions object
+    #   corresponding to elasticsearch option of 'replace'
+
+    # @!scope class
+    # @!method sum
+    # @return [CombineFunctions] CombineFunctions object
+    #   corresponding to elasticsearch option of 'sum'
+
+    # @!scope class
+    # @!method avg
+    # @return [CombineFunctions] CombineFunctions object
+    #   corresponding to elasticsearch option of 'avg'
+
+    # @!scope class
+    # @!method max
+    # @return [CombineFunctions] CombineFunctions object
+    #   corresponding to elasticsearch option of 'max'
+
+    # @!scope class
+    # @!method min
+    # @return [CombineFunctions] CombineFunctions object
+    #   corresponding to elasticsearch option of 'min'
+
+    # @!visibility protected
+    def initialize(combine_function)
+      @combine_function = combine_function
+    end
+  end
+end

data/lib/enums/distance_types.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for type of measurement of geo distance.
+  class DistanceTypes
+    # @!visibility protected
+    DISTANCE_TYPES = { arc: 'arc', plane: 'plane' }.freeze
+
+    # @!visibility protected
+    attr_reader :distance_type
+
+    # @!visibility protected
+    DISTANCE_TYPES.each do |distn_type, es_value|
+      define_singleton_method(distn_type) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method arc
+    # default type
+    # @return [DistanceTypes] DistanceTypes object
+    #   corresponding to elasticsearch option of 'arc'
+
+    # @!scope class
+    # @!method plane
+    # faster, but inaccurate on long distances and close to the poles
+    # @return [DistanceTypes] DistanceTypes object
+    #   corresponding to elasticsearch option of 'plane'
+
+    # @!visibility protected
+    def initialize(distn_type)
+      @distance_type = distn_type
+    end
+  end
+end