elasticband 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjQyMGZiM2RiNGJhODg2M2Y2NzViZjNlOGQ4NmNlNWU3YzE2NGEyNA==
+    YmE0MWFkZjBhOWEzNjY1ODgzZTkwZGIwMWE2YTc2OWVlZjUwZDc3NQ==
   data.tar.gz: !binary |-
-    M2JmMzRkMmZiMDM0NWI5ZWFmNDgwOTVlOTNjN2VmY2IzNTQ5MmVkNg==
+    NDNlMGI1Y2VjNjA3ZGYyN2ViZDg2ODhkNzY5YjQ5OTFlMDRkODEyYw==
 SHA512:
   metadata.gz: !binary |-
-    ZTQwYTA5ZDA0ZmJiMmEwYzkwNGVhZmQyYmRkZmUwY2MxODJjYzU5ZjBkOTFl
-    NWMxMmJjZDI1NjQ5ZDUyZWMzNDU1NjUzY2VkYjgyNTBmNzk2ZGFlNWI0MGJh
-    N2YwY2MwN2JmNDRkZDliYWZkZjY1NjRjNjM1NmUyNjU1ZTc5OGU=
+    Yjg1MzQ3M2U4ZmY0YWZhNTVhZDVjOThiOGE3NTEwMGY2NWQ0ZDAxNTllODc3
+    ZThjZjQ0NDlmMzMwMDg0OWI4NjZhM2MxNjQ4ODQ1OTFiMTgyMmI5NmE0YmQ4
+    YTVlZGM1NGQzNDBhNTc4NDMzMGNlNThiMDE3YzJkNTRjY2Y0NDc=
   data.tar.gz: !binary |-
-    OGUwMmE0Y2RiMDJiNzdmY2UxMWYzZWYyNTMwNzA4NjkyMzI3YjQzZTQxNmMy
-    ZGNkYWRmN2Q4NTZlMTMzM2ZhNmJjMGE0OTZlNDY4NTgzNmQ1YmViNTBiODU3
-    MTU1YTFhMDBkMGRjNzA3MzRhMGE5YTgxZGMxMDBjNGYwMTA4N2I=
+    YWYyMmEzMzBhOWQ3Y2ZjZWY4YmVkMmFmODlhNTA0MWI2YWJmNjg4YmNjMGUx
+    OWQ2Njk4NTRkMGFlOTQzMmYyNGY1ZmQ4YzkyNGM3YjAzMmQyMzI0MTJkOWY2
+    YTViNWEwNTNlMWMzNmIzYWM5MTg3MTU4M2RiMjA5MjM4OGIwMWQ=

data/lib/elasticband/filter/near.rb

@@ -0,0 +1,23 @@
+module Elasticband
+  class Filter
+    class Near < Filter
+      attr_accessor :on, :latitude, :longitude, :distance
+
+      def initialize(on: :location, latitude: nil, longitude: nil, distance: '100km')
+        self.on = on
+        self.latitude = latitude
+        self.longitude = longitude
+        self.distance = distance
+      end
+
+      def to_h
+        {
+          geo_distance: {
+            on => { lat: latitude, lon: longitude },
+            distance: distance
+          }
+        }
+      end
+    end
+  end
+end

data/lib/elasticband/filter.rb

@@ -2,12 +2,13 @@ require 'elasticband/filter/and'
 require 'elasticband/filter/not'
 require 'elasticband/filter/query'
 require 'elasticband/filter/range'
+require 'elasticband/filter/near'
 require 'elasticband/filter/term'
 require 'elasticband/filter/terms'
 
 module Elasticband
   class Filter
-    PARSE_FILTERS = %i(only except includes range)
+    PARSE_FILTERS = %i(only except includes range near)
 
     def to_h
       { match_all: {} }
@@ -22,6 +23,7 @@ module Elasticband
       # * `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.
       #
       # #### Examples
       # ```
@@ -36,35 +38,48 @@ module Elasticband
       #
       # 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' })
+      # => { geo_distance: { location: { lat: 12, lon: 34 } }, distance: '5km' }
       # ```
       def parse(options = {})
         return {} if options.blank?
 
-        filter = parse_filters(options[:only])
-        filter += parse_filters(options[:except]).map { |f| Filter::Not.new(f) }
-        filter += parse_includes_filter(options[:includes])
-        filter += parse_range_filter(options[:range])
+        filter = only_and_except_filters(options[:only], options[:except])
+        filter += includes_filter(options[:includes])
+        filter += range_filter(options[:range])
+        filter += near_filter(options[:near])
         join_filters(filter).to_h
       end
 
       private
 
+      def only_and_except_filters(only_options, except_options)
+        parse_filters(only_options) + parse_filters(except_options).map { |f| Filter::Not.new(f) }
+      end
+
       def join_filters(filters)
         filters.count > 1 ? Filter::And.new(filters) : filters.first
       end
 
-      def parse_includes_filter(includes_options)
+      def includes_filter(includes_options)
         return [] if includes_options.blank?
 
         [Filter::Query.new(Elasticband::Query.parse(*includes_options))]
       end
 
-      def parse_range_filter(range_options)
+      def range_filter(range_options)
         return [] if range_options.blank?
 
         [Filter::Range.new(range_options.keys.first, range_options.values.first)]
       end
 
+      def near_filter(options)
+        return [] if options.blank?
+
+        [Filter::Near.new(options)]
+      end
+
       def parse_filters(options)
         return [] if options.blank?
 

data/lib/elasticband/query.rb

@@ -81,6 +81,14 @@ module Elasticband
       #      function_score: {
       #        query: ...,
       #        gauss: { location: { origin: { lat: 12, lon: 34 }, offset: '5km', scale: '10km' } } } }
+      #
+      # Query.parse('foo', near: { on: :location, latitude: 12, longitude: 34, distance: '5km' })
+      # => {
+      #      filtered: {
+      #        query: ...,
+      #        filter: { geo_distance: { location: { lat: 12, lon: 34 } }, distance: '5km' }
+      #      }
+      #    }
       # ```
       def parse(query_text, options = {})
         query = parse_on(query_text, options[:on])

data/lib/elasticband/version.rb

@@ -1,3 +1,3 @@
 module Elasticband
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/filter/near_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Filter::Near do
+  describe '#to_h' do
+    subject { described_class.new(options).to_h }
+
+    context 'with `:latidute` and `:latidute` option' do
+      let(:options) { { latitude: 12.5, longitude: -34.6 } }
+
+      it { is_expected.to eq(geo_distance: { location: { lat: 12.5, lon: -34.6 }, distance: '100km' }) }
+    end
+
+    context 'with `:on` option' do
+      let(:options) { { on: :loc, latitude: 12.5, longitude: -34.6 } }
+
+      it { is_expected.to eq(geo_distance: { loc: { lat: 12.5, lon: -34.6 }, distance: '100km' }) }
+    end
+
+    context 'with `:distance` option' do
+      let(:options) { { distance: '5km', latitude: 12.5, longitude: -34.6 } }
+
+      it { is_expected.to eq(geo_distance: { location: { lat: 12.5, lon: -34.6 }, distance: '5km' }) }
+    end
+  end
+end

data/spec/filter_spec.rb

@@ -97,5 +97,12 @@ RSpec.describe Elasticband::Filter do
         it { is_expected.to eq(range: { foo: { gt: 1, lt: 2 } }) }
       end
     end
+
+    context 'with `:near` option' do
+      let(:options) { { near: { on: :location, latitude: 12.5, longitude: -34.9, distance: '5km' } } }
+      let(:filter) { { geo_distance: { location: { lat: 12.5, lon: -34.9 }, distance: '5km' } } }
+
+      it { is_expected.to eq(filter) }
+    end
   end
 end

data/spec/query_spec.rb

@@ -260,6 +260,17 @@ RSpec.describe Elasticband::Query do
           )
         end
       end
+
+      context 'with near option' do
+        let(:options) { { near: { on: :location, latitude: 12.5, longitude: -34.9, distance: '5km' } } }
+
+        let(:query) { { match: { _all: 'foo' } } }
+        let(:filter) { { geo_distance: { location: { lat: 12.5, lon: -34.9 }, distance: '5km' } } }
+
+        it 'return a filtered query by geo_distance' do
+          is_expected.to eq(filtered: { query: query, filter: filter })
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticband
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.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/near.rb
 - lib/elasticband/filter/not.rb
 - lib/elasticband/filter/query.rb
 - lib/elasticband/filter/range.rb
@@ -153,6 +154,7 @@ files:
 - spec/aggregation/top_hits_spec.rb
 - spec/aggregation_spec.rb
 - spec/filter/and_spec.rb
+- spec/filter/near_spec.rb
 - spec/filter/not_spec.rb
 - spec/filter/query_spec.rb
 - spec/filter/range_spec.rb