es_query_builder 2.0.0 → 2.0.1

data/lib/enums/distance_units.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for diatnce units.
+  class DistanceUnits
+    # @!visibility protected
+    DISTANCE_UNITS = { miles: 'mi', yards: 'yd', feet: 'ft', inches: 'in',
+                       kilometers: 'km', meters: 'm', centimeters: 'cm',
+                       millimeters: 'mm', nauticalmiles: 'nmi' }.freeze
+
+    # @!visibility protected
+    attr_reader :distance_unit
+
+    # @!visibility protected
+    DISTANCE_UNITS.each do |du, es_value|
+      define_singleton_method(du) do
+        new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method miles
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'mi'
+
+    # @!scope class
+    # @!method yards
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'yd'
+
+    # @!scope class
+    # @!method feet
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'ft'
+
+    # @!scope class
+    # @!method inches
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'in'
+
+    # @!scope class
+    # @!method kilometers
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'kme'
+
+    # @!scope class
+    # @!method meters
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'm'
+
+    # @!scope class
+    # @!method centimeters
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'cm'
+
+    # @!scope class
+    # @!method millimeters
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'mm'
+
+    # @!scope class
+    # @!method nauticalmiles
+    # @return [DistanceUnits] DistanceUnits object
+    #   corresponding to elasticsearch option of 'nmi'
+
+    # @!visibility protected
+    def initialize(distance_unit)
+      @distance_unit = distance_unit
+    end
+  end
+end

data/lib/enums/fuzziness.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Enums
+  # A unit class that encapsulates all in-exact search parsing and
+  # conversion from similarities to edit distances etc.
+  class Fuzziness
+    # @!visibility protected
+    AUTO = 'AUTO'
+    # @!visibility protected
+    ZERO = 0
+    # @!visibility protected
+    ONE = 1
+    # @!visibility protected
+    TWO = 2
+    # @!visibility protected
+    attr_reader :fuzziness
+
+    # @return [Fuzziness] returns Fuzziness object corresponding to
+    #   exact match
+    def self.zero
+      new(ZERO)
+    end
+
+    # @return [Fuzziness] returns a fuzziness object with
+    #   maximum levenshtein distance as one.
+    def self.one
+      new(ONE)
+    end
+
+    # @return [Fuzziness] returns a fuzziness object with
+    #   maximum levenshtein distance as two.
+    def self.two
+      new(TWO)
+    end
+
+    # Returns a fuzziness object with maximum levenshtein distance in auto mode.
+    #   Generates an edit distance based on the length of the term.
+    #   Low and high distance arguments may be optionally provided
+    #   AUTO:[low],[high]. If not specified, the default values are 3 and 6,
+    #   equivalent to AUTO:3,6 that make for lengths:
+    #     0..2
+    #       Must match exactly
+    #     3..5
+    #       One edit allowed
+    #     >5
+    #       Two edits allowed
+    #   AUTO should generally be the preferred value for fuzziness.
+    def self.auto(low = nil, high = nil)
+      new("#{AUTO}:#{low},#{high}")
+    end
+    # @!visibility protected
+    def initialize(fuzziness_value)
+      @fuzziness = fuzziness_value
+    end
+  end
+end

data/lib/enums/orders.rb

@@ -0,0 +1,17 @@
+class Orders
+
+  ORDERS = {desc: 'desc', asc: 'asc'}
+
+  attr_reader :order
+
+  ORDERS.keys.each do |order|
+    define_singleton_method(order) do
+      return self.new(ORDERS[order])
+    end
+  end
+
+  def initialize value
+    @order = value
+  end
+  
+end

data/lib/enums/score_modes.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for how results of individual
+  # score functions will be aggregated
+  class ScoreModes
+    # @!visibility protected
+    SCORE_MODES = { multiply: 'multiply', sum: 'sum', avg: 'avg',
+                    first: 'first', max: 'max', min: 'min' }.freeze
+    # @!visibility protected
+    attr_reader :score_mode
+    # @!visibility protected
+    SCORE_MODES.each do |sc_md, es_value|
+      define_singleton_method(sc_md) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method multiply
+    # @return [ScoreModes] ScoreModes object
+    #   corresponding to elasticsearch option of 'multiply'
+
+    # @!scope class
+    # @!method sum
+    # @return [ScoreModes] ScoreModes object
+    #   corresponding to elasticsearch option of 'sum'
+
+    # @!scope class
+    # @!method avg
+    # @return [ScoreModes] ScoreModes object
+    #   corresponding to elasticsearch option of 'avg'
+
+    # @!scope class
+    # @!method first
+    # @return [ScoreModes] ScoreModes object
+    #   corresponding to elasticsearch option of 'first'
+
+    # @!scope class
+    # @!method max
+    # @return [ScoreModes] ScoreModes object
+    #   corresponding to elasticsearch option of 'max'
+
+    # @!scope class
+    # @!method min
+    # @return [ScoreModes] ScoreModes object
+    #   corresponding to elasticsearch option of 'min'
+
+    # @!visibility protected
+    def initialize(score_mode)
+      @score_mode = score_mode
+    end
+  end
+end

data/lib/enums/script_sort_types.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for types of scripts in sorting.
+  class ScriptSortTypes
+    # @!visibility protected
+    SCRIPT_SORT_TYPES = { number: 'number', string: 'string' }.freeze
+    # @!visibility protected
+    attr_reader :script_sort_type
+    # @!visibility protected
+    SCRIPT_SORT_TYPES.each do |script_type, es_value|
+      define_singleton_method(script_type) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method number
+    # @return [ScriptSortTypes] ScriptSortTypes object
+    #   corresponding to elasticsearch option of 'multiply'
+
+    # @!scope class
+    # @!method string
+    # @return [ScriptSortTypes] ScriptSortTypes object
+    #   corresponding to elasticsearch option of 'string'
+
+    # @!visibility protected
+    def initialize(script_type)
+      @script_sort_type = script_type
+    end
+  end
+end

data/lib/enums/script_types.rb

@@ -0,0 +1,19 @@
+module Enums
+  class ScriptTypes
+
+    SCRIPT_TYPES = {:inline => :inline, :stored => :stored}
+
+    attr_reader :script_type
+
+    SCRIPT_TYPES.each do |type, es_value|
+      define_singleton_method(type) do
+        return self.new(es_value)
+      end
+    end
+
+    def initialize type
+      @script_type = type
+    end
+
+  end
+end

data/lib/enums/shape_relations.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enum class representing the relationship
+  # between a Query / Filter Shape
+  # and indexed Shapes that will be used to determine
+  # if a Document should be matched or not
+  class ShapeRelations
+    # @!visibility protected
+    WITHIN = 'within'
+    # @!visibility protected
+    CONTAINS = 'contains'
+    # @!visibility protected
+    INTERSECTS = 'intersects'
+    # @!visibility protected
+    attr_reader :relation
+
+    # @!scope class
+    # @!method number
+    # @return [ShapeRelations] ShapeRelations object
+    #   corresponding to elasticsearch option of 'within'
+    def self.within
+      new(WITHIN)
+    end
+
+    # @!scope class
+    # @!method number
+    # @return [ShapeRelations] ShapeRelations object
+    #   corresponding to elasticsearch option of 'contains'
+    def self.contains
+      new(CONTAINS)
+    end
+
+    # @!scope class
+    # @!method number
+    # @return [ShapeRelations] ShapeRelations object
+    #   corresponding to elasticsearch option of 'intersects'
+    def self.intersects
+      new(INTERSECTS)
+    end
+
+    # @!visibility protected
+    def initialize(value)
+      @relation = value
+    end
+  end
+end

data/lib/enums/sort_modes.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Enums
+  # Elasticsearch supports sorting by array or multi-valued fields.
+  # The SortMode option controls what array value is picked for sorting
+  # the document it belongs to. The mode option can have the following values:  
+  # *min* - Pick the lowest value.  
+  # *max* - Pick the highest value.  
+  # *sum* - Use the sum of all values as sort value.
+  # Only applicable for number based array fields.  
+  # *avg* - Use the average of all values as sort value.
+  # Only applicable for number based array fields.  
+  # *median* - Use the median of all values as sort value.
+  # Only applicable for number based array fields.
+  class SortModes
+    # @!visibility protected
+    SORT_MODES = { min: 'min', max: 'max',
+                   sum: 'sum', avg: 'avg', median: 'median' }.freeze
+    # @!visibility protected
+    attr_reader :sort_mode
+
+    # @!visibility protected
+    SORT_MODES.each do |sort_mode, es_value|
+      define_singleton_method(sort_mode) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method min
+    # @return [SortModes] SortModes object
+    #   corresponding to elasticsearch option of 'min'
+
+    # @!scope class
+    # @!method max
+    # @return [SortModes] SortModes object
+    #   corresponding to elasticsearch option of 'max'
+
+    # @!scope class
+    # @!method sum
+    # @return [SortModes] SortModes object
+    #   corresponding to elasticsearch option of 'sum'
+
+    # @!scope class
+    # @!method avg
+    # @return [SortModes] SortModes object
+    #   corresponding to elasticsearch option of 'avg'
+
+    # @!scope class
+    # @!method median
+    # @return [SortModes] SortModes object
+    #   corresponding to elasticsearch option of 'median'
+
+    # @!visibility protected
+    def initialize(sort_mode)
+      @sort_mode = sort_mode
+    end
+  end
+end

data/lib/enums/sort_orders.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Enums
+  # Enumerator class for sort ordering
+  class SortOrders
+    # @!visibility protected
+    SORT_ORDERS = { asc: 'asc', desc: 'desc' }.freeze
+    # @!visibility protected
+    attr_reader :sort_order
+
+    # @!visibility protected
+    SORT_ORDERS.each do |sort_order, es_value|
+      define_singleton_method(sort_order) do
+        return new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method asc
+    # @return [SortOrders] SortOrders object
+    #   corresponding to elasticsearch option of 'asc'
+
+    # @!scope class
+    # @!method desc
+    # @return [SortOrders] SortOrders object
+    #   corresponding to elasticsearch option of 'desc'
+
+    # @!visibility protected
+    def initialize(sort_order)
+      @sort_order = sort_order
+    end
+  end
+end

data/lib/enums/validation_methods.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Enums
+  # This enum is used to determine how to deal with invalid
+  # geo coordinates in geo related queries: On STRICT validation
+  # invalid coordinates cause an exception to be thrown.
+  # On IGNORE_MALFORMED invalid coordinates are being accepted.
+  # On COERCE invalid coordinates are being corrected to
+  # the most likely valid coordinate.
+  class ValidationMethods
+    # @!visibility protected
+    VALIDATION_METHODS = { coerce: 'COERCE',
+                           ignore_malformed: 'IGNORE_MALFORMED',
+                           strict: 'STRICT' }.freeze
+    # @!visibility protected
+    attr_reader :validation_method
+    # @!visibility protected
+    VALIDATION_METHODS.each do |validation_method, es_value|
+      define_singleton_method(validation_method) do
+        new(es_value)
+      end
+    end
+
+    # @!scope class
+    # @!method coerce
+    # @return [ValidationMethods] ValidationMethods object
+    #   corresponding to elasticsearch option of 'COERCE'
+
+    # @!scope class
+    # @!method ignore_malformed
+    # @return [ValidationMethods] ValidationMethods object
+    #   corresponding to elasticsearch option of 'IGNORE_MALFORMED'
+
+    # @!scope class
+    # @!method strict
+    # @return [ValidationMethods] ValidationMethods object
+    #   corresponding to elasticsearch option of 'STRICT'
+
+    # @!visibility protected
+    def initialize(validation_method)
+      @validation_method = validation_method
+    end
+  end
+end