elasticband 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWU0ZWNlNDdlMmZkM2YzMjBmOTc0MjNlMmZiNWM5MjdiMjY3MDM5NQ==
+    YWVjNzAzOTVlY2JlZGI0NmE3ZTRjOTYzNDNjNWUwMzQzZGVmODVkZg==
   data.tar.gz: !binary |-
-    ZjI5MGQ5ZGY1MWEwM2IwMGQzODQ0NTBlYTlkZDliZDIzNDk1ZDVlNg==
+    MzJkYTMzMzQ5ODE5NWUyMDEyYTViNjg3OWYzNWIyMWE5MmRjMjg3MQ==
 SHA512:
   metadata.gz: !binary |-
-    OTk5YjUyZjBkNDNiZTI4MzI3MDI0N2YyNDJiNmU2NWZkNjg1ZDRlYzk1YjFj
-    NWY4MDliM2M0OThkYzMzNzVkNmE2MTg3N2NlZGMxY2Q4OTZlNjYyZGJlNWQ2
-    Yzk0MmU2NDQ1NjM0ZGIwMjIwYzEzNjA0NWI4MGEyZGZhOWM0YjU=
+    NjRlM2EwMWIyYzU0YzViYjM3OWNjNjRmNjg0M2ZhY2U4OGM3OWU0ZjYzM2Iy
+    MjcyZDE4N2IwMTEyZTVmNDlhMDQ2NDE5MDk3MDg0M2M4ZWE2NjYwYzAzYWMy
+    YTRmNjU2NTE5Y2Y2ZmY2NmQxN2Y5NWJiOGQ1NWY5MmY1OTVhNjg=
   data.tar.gz: !binary |-
-    YjcxNjU3OGFjMGVkZDZjNGM5OGQ1ZWUxNjQ5MDlmYjY3NDVjNDdkYWQzMDU0
-    YjZkYTg2NmQ5MmFkMDkxOTE3NWYxMDc0NDZiYjk0NTM3OTAwYjE0ZDA4NTcw
-    NzYwODE5MjlmYzdmMDE4NTJmNmQ0N2I2YmY1NjE1OGJlZjNiMmU=
+    ZGQxMjNiYzhjZjUxODdkMThmYjY3YTJkMDE3YmI1ZGE2MTU3NzYyMzQ0NDNi
+    M2Q2ZjE2YTBlODY4YzNkNWZhOTU3NmY5ZDcxNmRhZmY2YmRjZGM1ZTcxYzM5
+    NmNlZGIwODI0NmQ4NDU3MjFmYjBkYjFmMWYzNDRhN2UzYzM4M2I=

data/.rubocop.yml

@@ -3,3 +3,6 @@ Style/Documentation:
 
 Metrics/LineLength:
   Max: 110
+
+AllCops:
+  TargetRubyVersion: 2.0

data/lib/elasticband/aggregation.rb

@@ -7,7 +7,7 @@ require 'elasticband/aggregation/top_hits'
 
 module Elasticband
   class Aggregation
-    PARSE_AGGREGATIONS = %i(group_by group_max top_hits group_by_filter)
+    PARSE_AGGREGATIONS = %i(group_by group_max top_hits group_by_filter).freeze
 
     attr_accessor :name
 

data/lib/elasticband/aggregation/field_based.rb

@@ -14,7 +14,7 @@ module Elasticband
       end
 
       def type
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       private

data/lib/elasticband/filter.rb

@@ -1,4 +1,5 @@
 require 'elasticband/filter/and'
+require 'elasticband/filter/exists'
 require 'elasticband/filter/not'
 require 'elasticband/filter/query'
 require 'elasticband/filter/range'
@@ -9,117 +10,127 @@ require 'elasticband/filter/script'
 
 module Elasticband
   class Filter
-    PARSE_FILTERS = %i(only except includes range near)
+    PARSE_FILTERS = %i(only except exists includes range near).freeze
+
+    attr_reader :options
+
+    # Parses filter options to a Elasticsearch syntax
+    #
+    # #### Options
+    #
+    # * `only:` Filter the search results where the condition is `true`
+    # * `except`: Filter the search results where the condition is `false`.
+    # * `includes:` Filter the search results with a `Match` query.
+    # * `range:` Filter the search results where the condition is on the given range.
+    # * `near:` Filter the search results where the results are near a geo point.
+    # * `script:` Filter the search results where the results match the script.
+    #
+    # #### Examples
+    # ```
+    # Filter.parse(only: { status: :published })
+    # => { term: { status: :published } }
+    #
+    # Filter.parse(exists: :status)
+    # => { exists: { field: :status } }
+    #
+    # Filter.parse(except: { company: { id: 1 } })
+    # => { not: { term: { status: :published } } }
+    #
+    # Filter.parse(includes: ['company', on: :description])
+    # => { query: { match: { description: 'company' } } }
+    #
+    # Filter.parse(range: { companies_count: { gt: 1, gteq: 1, lt: 1, lteq: 1 } })
+    # => { range: { companies_count: { gt: 1, gte: 1, lt: 1, lte: 1 } } }
+    #
+    # Filter.parse(near: { latitude: 12, longitude: 34, distance: '5km', type: :arc })
+    # => { geo_distance: { location: { lat: 12, lon: 34 } }, distance: '5km', distance_type: :arc }
+    #
+    # Filter.parse(script: ['(param1 + param2) > 0', param1: 1, param2: 1])
+    # => { script: { script: '(param1 + param2) > 0', params: { param1: 1, param2: 1 } } }
+    # ```
+
+    def self.parse(options = {})
+      new(options).parse
+    end
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def parse
+      return {} if options.blank?
+
+      join_filters(filters).to_h
+    end
 
     def to_h
       { match_all: {} }
     end
 
-    class << self
-      # Parses filter options to a Elasticsearch syntax
-      #
-      # #### Options
-      #
-      # * `only:` Filter the search results where the condition is `true`
-      # * `except`: Filter the search results where the condition is `false`.
-      # * `includes:` Filter the search results with a `Match` query.
-      # * `range:` Filter the search results where the condition is on the given range.
-      # * `near:` Filter the search results where the results are near a geo point.
-      # * `script:` Filter the search results where the results match the script.
-      #
-      # #### Examples
-      # ```
-      # Filter.parse(only: { status: :published })
-      # => { term: { status: :published } }
-      #
-      # Filter.parse(except: { company: { id: 1 } })
-      # => { not: { term: { status: :published } } }
-      #
-      # Filter.parse(includes: ['company', on: :description])
-      # => { query: { match: { description: 'company' } } }
-      #
-      # Filter.parse(range: { companies_count: { gt: 1, gteq: 1, lt: 1, lteq: 1 } })
-      # => { range: { companies_count: { gt: 1, gte: 1, lt: 1, lte: 1 } } }
-      #
-      # Filter.parse(near: { latitude: 12, longitude: 34, distance: '5km', type: :arc })
-      # => { geo_distance: { location: { lat: 12, lon: 34 } }, distance: '5km', distance_type: :arc }
-      #
-      # Filter.parse(script: ['(param1 + param2) > 0', param1: 1, param2: 1])
-      # => { script: { script: '(param1 + param2) > 0', params: { param1: 1, param2: 1 } } }
-      # ```
-      def parse(options = {})
-        return {} if options.blank?
-
-        filters = map_filters(options)
-
-        join_filters(filters).to_h
-      end
+    private
 
-      private
+    def filters
+      only_and_except_filters + exists_filter + includes_filter + range_filter + near_filter + script_filter
+    end
 
-      def map_filters(options)
-        filters = only_and_except_filters(options[:only], options[:except])
-        filters += includes_filter(options[:includes])
-        filters += range_filter(options[:range])
-        filters += near_filter(options[:near])
-        filters += script_filter(options[:script])
+    def only_and_except_filters
+      parse_filters(options[:only]) + parse_filters(options[:except]).map { |f| Filter::Not.new(f) }
+    end
 
-        filters
-      end
+    def exists_filter
+      return [] if options[:exists].blank?
 
-      def only_and_except_filters(only_options, except_options)
-        parse_filters(only_options) + parse_filters(except_options).map { |f| Filter::Not.new(f) }
-      end
+      [Filter::Exists.new(options[:exists])]
+    end
 
-      def join_filters(filters)
-        filters.count > 1 ? Filter::And.new(filters) : filters.first
-      end
+    def includes_filter
+      return [] if options[:includes].blank?
+
+      [Filter::Query.new(Elasticband::Query.parse(*options[:includes]))]
+    end
 
-      def includes_filter(includes_options)
-        return [] if includes_options.blank?
+    def range_filter
+      return [] if options[:range].blank?
 
-        [Filter::Query.new(Elasticband::Query.parse(*includes_options))]
-      end
+      [Filter::Range.new(options[:range].keys.first, options[:range].values.first)]
+    end
 
-      def range_filter(range_options)
-        return [] if range_options.blank?
+    def join_filters(filters)
+      filters.count > 1 ? Filter::And.new(filters) : filters.first
+    end
 
-        [Filter::Range.new(range_options.keys.first, range_options.values.first)]
-      end
+    def near_filter
+      return [] if options[:near].blank?
 
-      def near_filter(options)
-        return [] if options.blank?
+      [Filter::Near.new(options[:near])]
+    end
 
-        [Filter::Near.new(options)]
-      end
+    def script_filter
+      return [] if options[:script].blank?
 
-      def script_filter(script_options)
-        return [] if script_options.blank?
+      [Filter::Script.new(*options[:script])]
+    end
 
-        [Filter::Script.new(*script_options)]
-      end
+    def parse_filters(filter)
+      return [] if filter.blank?
 
-      def parse_filters(options)
-        return [] if options.blank?
+      to_dotted_notation(filter).map { |attribute, value| parse_filter(attribute, value) }
+    end
 
-        to_dotted_notation(options).map { |attribute, value| parse_filter(attribute, value) }
+    def parse_filter(attribute, value)
+      if value.is_a?(Enumerable)
+        Filter::Terms.new(value, attribute)
+      else
+        Filter::Term.new(value, attribute)
       end
+    end
 
-      def parse_filter(attribute, value)
-        if value.is_a?(Enumerable)
-          Filter::Terms.new(value, attribute)
+    def to_dotted_notation(hash_params, prefix = nil, dotted_hash = {})
+      hash_params.each_with_object(dotted_hash) do |(key, val), hash|
+        if val.is_a?(Hash)
+          to_dotted_notation(val, "#{prefix}#{key}.", hash)
         else
-          Filter::Term.new(value, attribute)
-        end
-      end
-
-      def to_dotted_notation(hash_params, prefix = nil, dotted_hash = {})
-        hash_params.each_with_object(dotted_hash) do |(key, val), hash|
-          if val.is_a?(Hash)
-            to_dotted_notation(val, "#{prefix}#{key}.", hash)
-          else
-            hash["#{prefix}#{key}"] = val
-          end
+          hash["#{prefix}#{key}"] = val
         end
       end
     end

data/lib/elasticband/filter/exists.rb

@@ -0,0 +1,15 @@
+module Elasticband
+  class Filter
+    class Exists < Filter
+      attr_accessor :field
+
+      def initialize(field)
+        self.field = field.to_sym
+      end
+
+      def to_h
+        { exists: { field: field } }
+      end
+    end
+  end
+end

data/lib/elasticband/filter/range.rb

@@ -3,7 +3,7 @@ module Elasticband
     class Range < Filter
       attr_accessor :field, :ranges
 
-      RANGES = %i(gt gteq lt lteq)
+      RANGES = %i(gt gteq lt lteq).freeze
 
       def initialize(field, ranges)
         self.field = field.to_sym

data/lib/elasticband/query/score_function/boost_mode.rb

@@ -4,7 +4,7 @@ module Elasticband
       class BoostMode < ScoreFunction
         attr_accessor :mode
 
-        MODES = %i(multiply replace sum avg max min)
+        MODES = %i(multiply replace sum avg max min).freeze
 
         def initialize(mode = nil)
           self.mode = mode

data/lib/elasticband/query/score_function/score_mode.rb

@@ -4,7 +4,7 @@ module Elasticband
       class ScoreMode < ScoreFunction
         attr_accessor :mode
 
-        MODES = %i(multiply mult sum avg first max min)
+        MODES = %i(multiply mult sum avg first max min).freeze
 
         def initialize(mode = nil)
           self.mode = mode

data/lib/elasticband/version.rb

@@ -1,3 +1,3 @@
 module Elasticband
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'.freeze
 end

data/spec/filter/exists_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Filter::Exists do
+  describe '#to_h' do
+    subject { described_class.new('user').to_h }
+
+    it { is_expected.to eq(exists: { field: :user }) }
+  end
+end

data/spec/filter_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe Elasticband::Filter do
         context 'with a nested attribute' do
           let(:options) { { only: { company: { id: 1 } } } }
 
-          it { is_expected.to eq(term: { 'company.id': 1 }) }
+          it { is_expected.to eq(term: { :'company.id' => 1 }) }
         end
 
         context 'with multiple values' do
@@ -57,7 +57,7 @@ RSpec.describe Elasticband::Filter do
         context 'with a nested attribute' do
           let(:options) { { except: { company: { id: 1 } } } }
 
-          it { is_expected.to eq(not: { term: { 'company.id': 1 } }) }
+          it { is_expected.to eq(not: { term: { :'company.id' => 1 } }) }
         end
 
         context 'with multiple values' do
@@ -107,6 +107,13 @@ RSpec.describe Elasticband::Filter do
       it { is_expected.to eq(filter) }
     end
 
+    context 'with `:exists` option' do
+      let(:options) { { exists: :user } }
+      let(:filter) { { exists: { field: :user } } }
+
+      it { is_expected.to eq(filter) }
+    end
+
     context 'with `:script` option' do
       let(:options) { { script: ['(param1 + param2) > 0', param1: 1, param2: 1] } }
       let(:filter) { { script: { script: '(param1 + param2) > 0', params: { param1: 1, param2: 1 } } } }

data/spec/query_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe Elasticband::Query do
         context 'with a composed name on `:on` option' do
           let(:options) { { on: 'company.name' } }
 
-          it { is_expected.to eq(match: { 'company.name': 'foo' }) }
+          it { is_expected.to eq(match: { :'company.name' => 'foo' }) }
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticband
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Glauber Campinho
@@ -123,6 +123,7 @@ files:
 - lib/elasticband/aggregation/top_hits.rb
 - lib/elasticband/filter.rb
 - lib/elasticband/filter/and.rb
+- lib/elasticband/filter/exists.rb
 - lib/elasticband/filter/near.rb
 - lib/elasticband/filter/not.rb
 - lib/elasticband/filter/query.rb
@@ -155,6 +156,7 @@ files:
 - spec/aggregation/top_hits_spec.rb
 - spec/aggregation_spec.rb
 - spec/filter/and_spec.rb
+- spec/filter/exists_spec.rb
 - spec/filter/near_spec.rb
 - spec/filter/not_spec.rb
 - spec/filter/query_spec.rb