elasticband 0.1.8 → 0.1.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGRjZjQxZjYzZWIxYmM2MTNjODZkOTE5OTM4OGJhZjUyYmZlY2Q4Yw==
+    MGNmMTIxZjU0NmI4MjA2MGQxMmU3Y2UwZWYyZDlkMmU4MDJlMmFiYg==
   data.tar.gz: !binary |-
-    MjIzZjRkY2YyMjU2ZGFkNWFlNDg2MWZmOGMwNTcyYzRkMTBhNWVhYg==
+    ZGM2YmVjZTc4MmQzNjJhNmE4OTBiMzJkNWE3MjVmNzBjMjI5MTJiZg==
 SHA512:
   metadata.gz: !binary |-
-    ZGE5ZmU3YjkyYWM4NWY5MTBhNTVkMzE2NDI2ZWVmNWJlNDEyYmIyMjI1ZjMx
-    ZDFhZjQ2YTdkMGZjN2NkY2RmYzlhOTVmODcyYzJiNGUzYTc0MTE5MWI0OTVh
-    ZmFkZmZmYzk4NjBiNjBkMGU1ZWRhYmY4MzEyZmI3MWIwYjRjYjU=
+    ZDc2Yzg4M2VkYzIyZDI5ZDMyOTQ3OTNmNWI2YTYyMTcxOTg1MDZjM2Y4YTBk
+    OWU3Yzk5MzFlNGVmOWNjMDkzNWIzNDkwMzllNjAwZDRhYzNmYTUwMDE4NWEw
+    OTNlMjkzYTI4NWM0NWVjYmUyYjM0NGM2YWJkNzgwNmEwOTYxMDE=
   data.tar.gz: !binary |-
-    Y2EyNWVjNDM1MDVlYzRiZGEwZjM2Y2EyNGUxNjliZDgyNDc2YzNhYWE1MThl
-    YTNlMGI5Y2JmNDVjNDA4OWVmODk5ZGUxZWM4ZDQ0ZWQzZjJlM2JiNDZmNTlm
-    N2NmMDFkOWFkMTgwMzEwZjE4ODBjOWQzNTc4NzZmZGY0ZjJjMTk=
+    MGM5OTc3Y2NkMmY5MWY3OGVhNTZlZTM3OTlhYjlhYjFiNDA0MmEyMmJlNzhh
+    ZDE1Njg5NzNmZmNjMWIzZTg1ZDMxMzM1NzFlZDFjYTg4OTdlYWQ5ZDgwZDc2
+    NDFkMTIxMzc0Yzc5ODE3YjcxMDJkMTNiNWIwNTk1YWQzNmMzMzQ=

data/lib/elasticband/query/function_score.rb

@@ -1,12 +1,13 @@
 module Elasticband
   class Query
     class FunctionScore < Query
-      attr_accessor :query_or_filter, :function, :options
+      attr_accessor :query_or_filter, :function, :score_mode, :boost_mode
 
-      def initialize(query_or_filter, function, options = {})
+      def initialize(query_or_filter, function, score_mode, boost_mode)
         self.query_or_filter = query_or_filter
         self.function = function
-        self.options = options
+        self.score_mode = score_mode
+        self.boost_mode = boost_mode
       end
 
       def to_h
@@ -16,7 +17,7 @@ module Elasticband
       private
 
       def function_score_hash
-        query_or_filter_hash.merge!(function_hash).merge!(options)
+        query_or_filter_hash.merge!(function_hash).merge(score_mode.to_h).merge(boost_mode.to_h)
       end
 
       def query_or_filter_hash

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

@@ -0,0 +1,21 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class BoostMode < ScoreFunction
+        attr_accessor :mode
+
+        MODES = %i(multiply replace sum avg max min)
+
+        def initialize(mode = nil)
+          self.mode = mode
+        end
+
+        def to_h
+          return {} unless mode && MODES.include?(mode)
+
+          { boost_mode: mode }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class ScoreMode < ScoreFunction
+        attr_accessor :mode
+
+        MODES = %i(multiply mult sum avg first max min)
+
+        def initialize(mode = nil)
+          self.mode = mode
+        end
+
+        def to_h
+          return {} unless mode && MODES.include?(mode)
+
+          { score_mode: mode }
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/query/score_function.rb

@@ -2,6 +2,8 @@ require 'elasticband/query/score_function/boost_factor'
 require 'elasticband/query/score_function/field_value_factor'
 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'
 
 module Elasticband
   class Query

data/lib/elasticband/query.rb

@@ -22,6 +22,8 @@ module Elasticband
       # * `boost_where:` Boosts the score of a query result where some condition is `true`.
       #   This score will be multiplied by 1000 (arbitrary, based on gem `searchkick`)
       # * `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.
       #
       # #### Examples
       # ```
@@ -49,6 +51,12 @@ module Elasticband
       # Query.parse('foo', boost_function: "_score * doc['users_count'].value")
       # => { function_score: { query: ..., script_score: { script: '_score * doc['users_count'].value' } } }
       #
+      # Query.parse('foo', boost_function: ..., boost_mode: :multiply)
+      # => { function_score: { query: ..., boost_mode: :multiply, script_score: { script: ... } } }
+      #
+      # Query.parse('foo', boost_function: ..., score_mode: :multiply)
+      # => { function_score: { query: ..., score_mode: :multiply, script_score: { script: ... } } }
+      #
       # Query.parse('foo', boost_where: { company: { id: 1 } })
       # => {
       #      function_score: {
@@ -62,7 +70,12 @@ module Elasticband
       def parse(query_text, options = {})
         query = parse_on(query_text, options[:on])
         query = parse_query_filters(query, options)
-        query = parse_boost(query, options.slice(:boost_by, :boost_where, :boost_function))
+        query = parse_boost(
+          query,
+          options.slice(:boost_by, :boost_where, :boost_function),
+          options.slice(:score_mode),
+          options.slice(:boost_mode)
+        )
         query.to_h
       end
 
@@ -84,11 +97,14 @@ module Elasticband
         filter.blank? ? query : Query::Filtered.new(filter, query)
       end
 
-      def parse_boost(query, boost_options)
+      def parse_boost(query, boost_options, score_mode_option, boost_mode_option)
         return query if boost_options.blank?
 
         function = parse_boost_function(boost_options)
-        Query::FunctionScore.new(query, function)
+        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)
       end
 
       def parse_boost_function(boost_options)

data/lib/elasticband/version.rb

@@ -1,3 +1,3 @@
 module Elasticband
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/spec/query/function_score_spec.rb

@@ -6,6 +6,8 @@ RSpec.describe Elasticband::Query::FunctionScore do
     let(:filter) { Elasticband::Filter.new }
     let(:score_function_1) { Elasticband::Query::ScoreFunction.new }
     let(:score_function_2) { Elasticband::Query::ScoreFunction.new }
+    let(:boost_mode) { Elasticband::Query::ScoreFunction::BoostMode.new }
+    let(:score_mode) { Elasticband::Query::ScoreFunction::ScoreMode.new }
 
     before do
       allow(other_query).to receive(:to_h) { 'query' }
@@ -16,20 +18,22 @@ RSpec.describe Elasticband::Query::FunctionScore do
 
     context 'with a single function' do
       context 'with a query' do
-        subject { described_class.new(other_query, score_function_1).to_h }
+        subject { described_class.new(other_query, score_function_1, boost_mode, score_mode).to_h }
 
         it { is_expected.to eq(function_score: { query: 'query', score_function_1: 'score_function_1' }) }
       end
 
       context 'with filter' do
-        subject { described_class.new(filter, score_function_1).to_h }
+        subject { described_class.new(filter, score_function_1, boost_mode, score_mode).to_h }
 
         it { is_expected.to eq(function_score: { filter: 'filter', score_function_1: 'score_function_1' }) }
       end
     end
 
     context 'with multiple functions' do
-      subject { described_class.new(other_query, [score_function_1, score_function_2]).to_h }
+      subject do
+        described_class.new(other_query, [score_function_1, score_function_2], boost_mode, score_mode).to_h
+      end
 
       it 'returns a hash with the query/filter and an array with the functions' do
         is_expected.to eq(
@@ -44,30 +48,48 @@ RSpec.describe Elasticband::Query::FunctionScore do
       end
     end
 
-    context 'with options' do
-      subject { described_class.new(other_query, score_function_1, boost: 1.2).to_h }
+    context 'with a filtered function' do
+      let(:filtered_function) { Elasticband::Query::ScoreFunction::Filtered.new(filter, score_function_1) }
+
+      subject { described_class.new(other_query, filtered_function, boost_mode, score_mode).to_h }
 
-      it 'returns a hash with the query, function and options' do
+      it 'returns a hash with the query/filter and an array with the function' do
+        is_expected.to eq(
+          function_score: {
+            query: 'query',
+            functions: [{ filter: 'filter', score_function_1: 'score_function_1' }]
+          }
+        )
+      end
+    end
+
+    context 'with a boost mode' do
+      let(:boost_mode) { Elasticband::Query::ScoreFunction::BoostMode.new(:multiply) }
+
+      subject { described_class.new(other_query, score_function_1, boost_mode, score_mode).to_h }
+
+      it 'returns a hash with the query/filter and the given boost_mode' do
         is_expected.to eq(
           function_score: {
             query: 'query',
             score_function_1: 'score_function_1',
-            boost: 1.2
+            boost_mode: :multiply
           }
         )
       end
     end
 
-    context 'with a filtered function' do
-      let(:filtered_function) { Elasticband::Query::ScoreFunction::Filtered.new(filter, score_function_1) }
+    context 'with a score mode' do
+      let(:score_mode) { Elasticband::Query::ScoreFunction::ScoreMode.new(:multiply) }
 
-      subject { described_class.new(other_query, filtered_function).to_h }
+      subject { described_class.new(other_query, score_function_1, boost_mode, score_mode).to_h }
 
-      it 'returns a hash with the query/filter and an array with the function' do
+      it 'returns a hash with the query/filter and the given score_mode' do
         is_expected.to eq(
           function_score: {
             query: 'query',
-            functions: [{ filter: 'filter', score_function_1: 'score_function_1' }]
+            score_function_1: 'score_function_1',
+            score_mode: :multiply
           }
         )
       end

data/spec/query/score_function/boost_mode_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Query::ScoreFunction::BoostMode do
+  describe '#to_h' do
+    subject { described_class.new(mode).to_h }
+
+    let(:mode) { :multiply }
+
+    it { is_expected.to eq(boost_mode: :multiply) }
+
+    context 'with an unpermitted mode' do
+      let(:mode) { :foo }
+
+      it { is_expected.to be_empty }
+    end
+  end
+end

data/spec/query/score_function/score_mode_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Elasticband::Query::ScoreFunction::ScoreMode do
+  describe '#to_h' do
+    subject { described_class.new(mode).to_h }
+
+    let(:mode) { :multiply }
+
+    it { is_expected.to eq(score_mode: :multiply) }
+
+    context 'with an unpermitted mode' do
+      let(:mode) { :foo }
+
+      it { is_expected.to be_empty }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticband
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Glauber Campinho
@@ -135,8 +135,10 @@ files:
 - lib/elasticband/query/multi_match.rb
 - lib/elasticband/query/score_function.rb
 - lib/elasticband/query/score_function/boost_factor.rb
+- 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/score_mode.rb
 - lib/elasticband/query/score_function/script_score.rb
 - lib/elasticband/search.rb
 - lib/elasticband/sort.rb
@@ -160,8 +162,10 @@ files:
 - spec/query/match_spec.rb
 - spec/query/multi_match_spec.rb
 - spec/query/score_function/boost_factor_spec.rb
+- 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/score_mode_spec.rb
 - spec/query/score_function/script_score_spec.rb
 - spec/query/score_function_spec.rb
 - spec/query_spec.rb