elasticband 0.1.10 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWFmNDU0YTUwMGZjYmQwOWU1ZTBkMWMyNWJmMzNhYmQ0NjM4NmMxMQ==
+    YjQyMGZiM2RiNGJhODg2M2Y2NzViZjNlOGQ4NmNlNWU3YzE2NGEyNA==
   data.tar.gz: !binary |-
-    Yzg4YTQzM2M3ODM5Zjk3Nzg3MWYyY2JmOTFjY2U5MDAzMmI2OGVhOQ==
+    M2JmMzRkMmZiMDM0NWI5ZWFmNDgwOTVlOTNjN2VmY2IzNTQ5MmVkNg==
 SHA512:
   metadata.gz: !binary |-
-    N2NkOGUwZGUzMWIzNjBiMmZkZWRkOGQ1NTBhOGUwYWQ5ZDA3YTFmOTg5OGQ0
-    ODFjMjdiZWNiMWFiNGIyZjc1YWE0ZjhkYmNkY2UyZjVmYmRjYjRiYTQ0YWRm
-    YjBmODRmMmZjZGVlZTRjM2JhNmIwOTEyYmEyMzE0YjFmZjExNWE=
+    ZTQwYTA5ZDA0ZmJiMmEwYzkwNGVhZmQyYmRkZmUwY2MxODJjYzU5ZjBkOTFl
+    NWMxMmJjZDI1NjQ5ZDUyZWMzNDU1NjUzY2VkYjgyNTBmNzk2ZGFlNWI0MGJh
+    N2YwY2MwN2JmNDRkZDliYWZkZjY1NjRjNjM1NmUyNjU1ZTc5OGU=
   data.tar.gz: !binary |-
-    YzUzMGVkM2FjY2IzMDIzZTM4M2VjMWQwODYxYmQzYTg2ODkzMWEzMzE1ODhm
-    NDc0ZmY1ODBiMWZmNzhiOWMzMjVhMmY4MjZjNTJjYzgyNDNiZjY2MjQwNWRh
-    MWMwZjY3NjU1YmJiY2RhYzljM2YyYzAzNTllYTc3ODk5OWYxOWY=
+    OGUwMmE0Y2RiMDJiNzdmY2UxMWYzZWYyNTMwNzA4NjkyMzI3YjQzZTQxNmMy
+    ZGNkYWRmN2Q4NTZlMTMzM2ZhNmJjMGE0OTZlNDY4NTgzNmQ1YmViNTBiODU3
+    MTU1YTFhMDBkMGRjNzA3MzRhMGE5YTgxZGMxMDBjNGYwMTA4N2I=

data/lib/elasticband/query.rb

@@ -24,6 +24,7 @@ module Elasticband
       # * `boost_function:` Boosts using the function passed.
       # * `boost_mode:` Defines how the function_score will be used.
       # * `score_mode:` Defines how the query score will be used.
+      # * `geo_location:` Defines query by geo location.
       #
       # #### Examples
       # ```
@@ -66,12 +67,27 @@ module Elasticband
       #        ]
       #      }
       #    }
+      #
+      # Query.parse(
+      #   'foo',
+      #   geo_location: {
+      #     on: :location,
+      #     latitude: 12,
+      #     longitude: 34,
+      #     distance: { same_score: '5km', half_score: '10km' }
+      #   }
+      # )
+      # => {
+      #      function_score: {
+      #        query: ...,
+      #        gauss: { location: { origin: { lat: 12, lon: 34 }, offset: '5km', scale: '10km' } } } }
       # ```
       def parse(query_text, options = {})
         query = parse_on(query_text, options[:on])
         query = parse_query_filters(query, options)
         query = parse_boost(
           query,
+          options[:geo_location],
           options.slice(:boost_by, :boost_where, :boost_function),
           options[:score_mode],
           options[:boost_mode]
@@ -97,14 +113,21 @@ module Elasticband
         filter.blank? ? query : Query::Filtered.new(filter, query)
       end
 
-      def parse_boost(query, boost_options, score_mode_option, boost_mode_option)
-        return query if boost_options.blank?
+      def parse_boost(query, geo_location_options, boost_options, score_mode_option, boost_mode_option)
+        return query if boost_options.blank? && geo_location_options.blank?
 
-        function = parse_boost_function(boost_options)
+        functions = score_functions(geo_location_options, boost_options)
         score_mode = Query::ScoreFunction::ScoreMode.new(score_mode_option)
         boost_mode = Query::ScoreFunction::BoostMode.new(boost_mode_option)
 
-        Query::FunctionScore.new(query, function, score_mode, boost_mode)
+        Query::FunctionScore.new(query, functions, score_mode, boost_mode)
+      end
+
+      def score_functions(geo_location_options, boost_options)
+        functions = []
+        functions << Query::ScoreFunction::GeoLocation.new(geo_location_options) if geo_location_options
+        functions << parse_boost_function(boost_options) if boost_options.present?
+        functions
       end
 
       def parse_boost_function(boost_options)

data/lib/elasticband/query/function_score.rb

@@ -30,16 +30,16 @@ module Elasticband
 
       def function_hash
         if function.is_a?(Enumerable)
-          { functions: function.map(&:to_h) }
+          function.size > 1 ? { functions: function.map(&:to_h) } : single_function_hash(function.first)
         else
-          function_hash = function.to_h
-          if function_hash.key?(:filter)
-            { functions: [function_hash] }
-          else
-            function_hash
-          end
+          single_function_hash(function)
         end
       end
+
+      def single_function_hash(function)
+        function_hash = function.to_h
+        function_hash.key?(:filter) ? { functions: [function_hash] } : function_hash
+      end
     end
   end
 end

data/lib/elasticband/query/score_function.rb

@@ -4,6 +4,8 @@ require 'elasticband/query/score_function/filtered'
 require 'elasticband/query/score_function/script_score'
 require 'elasticband/query/score_function/boost_mode'
 require 'elasticband/query/score_function/score_mode'
+require 'elasticband/query/score_function/gauss'
+require 'elasticband/query/score_function/geo_location'
 
 module Elasticband
   class Query

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

@@ -0,0 +1,19 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class Gauss < ScoreFunction
+        attr_accessor :options
+
+        def initialize(options)
+          self.options = options
+        end
+
+        def to_h
+          return {} unless options
+
+          { gauss: options }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class GeoLocation < Gauss
+        def initialize(options)
+          return unless options.present?
+
+          origin = { lat: options[:latitude], lon: options[:longitude] }
+          distance = options[:distance]
+          location = { origin: origin, offset: distance[:same_score], scale: distance[:half_score] }
+          field = options[:on] || :location
+
+          super(field => location)
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/version.rb

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

data/spec/query/score_function/gauss_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Query::ScoreFunction::Gauss do
+  describe '#to_h' do
+    subject { described_class.new(options).to_h }
+
+    let(:options) { { origin: { lat: 5, lon: 2 } } }
+
+    it { is_expected.to eq(gauss: { origin: { lat: 5, lon: 2 } }) }
+  end
+end

data/spec/query/score_function/geo_location_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Query::ScoreFunction::GeoLocation do
+  describe '#to_h' do
+    subject { described_class.new(options).to_h }
+
+    let(:options) { { latitude: 5.1, longitude: -2.3, distance: { same_score: '10km', half_score: '15km' } } }
+    let(:origin) { { lat: 5.1, lon: -2.3 } }
+
+    it { is_expected.to eq(gauss: { location: { origin: origin, offset: '10km', scale: '15km' } }) }
+
+    context 'with `on` option' do
+      let(:options) do
+        { on: :loc, latitude: 5.1, longitude: -2.3, distance: { same_score: '10km', half_score: '15km' } }
+      end
+      let(:origin) { { lat: 5.1, lon: -2.3 } }
+
+      it { is_expected.to eq(gauss: { loc: { origin: origin, offset: '10km', scale: '15km' } }) }
+    end
+
+    context 'with nil options' do
+      let(:options) { nil }
+
+      it { is_expected.to eq({}) }
+    end
+
+    context 'with empty options' do
+      let(:options) { {} }
+
+      it { is_expected.to eq({}) }
+    end
+  end
+end

data/spec/query_spec.rb

@@ -233,6 +233,33 @@ RSpec.describe Elasticband::Query do
           end
         end
       end
+
+      context 'with `:geo_location` options' do
+        let(:options) do
+          {
+            geo_location: {
+              latitude: 12.5,
+              longitude: -34.9,
+              distance: { same_score: '5km', half_score: '10km' }
+            }
+          }
+        end
+
+        it 'returns a function score query with the score_mode' do
+          is_expected.to eq(
+            function_score: {
+              query: { match: { _all: 'foo' } },
+              gauss: {
+                location: {
+                  origin: { lat: 12.5, lon: -34.9 },
+                  offset: '5km',
+                  scale: '10km'
+                }
+              }
+            }
+          )
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticband
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Glauber Campinho
@@ -138,6 +138,8 @@ files:
 - lib/elasticband/query/score_function/boost_mode.rb
 - lib/elasticband/query/score_function/field_value_factor.rb
 - lib/elasticband/query/score_function/filtered.rb
+- lib/elasticband/query/score_function/gauss.rb
+- lib/elasticband/query/score_function/geo_location.rb
 - lib/elasticband/query/score_function/score_mode.rb
 - lib/elasticband/query/score_function/script_score.rb
 - lib/elasticband/search.rb
@@ -165,6 +167,8 @@ files:
 - spec/query/score_function/boost_mode_spec.rb
 - spec/query/score_function/field_value_factor_spec.rb
 - spec/query/score_function/filtered_spec.rb
+- spec/query/score_function/gauss_spec.rb
+- spec/query/score_function/geo_location_spec.rb
 - spec/query/score_function/score_mode_spec.rb
 - spec/query/score_function/script_score_spec.rb
 - spec/query/score_function_spec.rb