CloudSesame 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df36ec7f54090afad31846caaf48225e66624419
-  data.tar.gz: 8a33dcb2a00013bf5f69df87926ce2c8deffb336
+  metadata.gz: 45e91a7582d996276e3fc0b28078ab0bf8ca64cd
+  data.tar.gz: 5d7ac46418e7ff5ca948b70c4abea3ae265b3794
 SHA512:
-  metadata.gz: a24f0e5741265a7390a5667b6fcf530ce539faacda9023a19a29e6c384830d6e5217efebb26d3c2388ee25e8b74102fd87e65d5720b505a68fd90b832a865ea5
-  data.tar.gz: a1dd6df1cb83a7c7cf7beb036b3b323fda9bb265b0edfe42d07856627d4c4f9d31c42c61cb938cc95b3e1de747b9aee918f3a8781e37c29fa99a8bd6f674d985
+  metadata.gz: 4fab65fb6973916daf9462762667db1a8b8016113e569403ac709eeab784f6ddb36994cb63d0ba9064c554486d832e942ab734a3503f7f3adf8e9abaa1f6cb12
+  data.tar.gz: 144650056b9cef90fabf98ea06e91c654b314c51022f18dd8db4bfee51b5885675010f30f6e18202c6a88f6fceb8712250e1cdecc070b71467195e85474b73cc

data/.gitignore

@@ -5,4 +5,5 @@ tmp
 # IDE files
 .idea
 *.iml
+coverage
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    CloudSesame (0.9.0)
+    CloudSesame (0.9.1)
       aws-sdk (~> 2)
 
 GEM

data/cloud_sesame.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'CloudSesame'
-  s.version     = '0.9.0'
-  s.date        = '2016-09-07'
+  s.version     = '0.9.1'
+  s.date        = '2016-09-12'
   s.summary     = "AWS CloudSearch Query DSL"
   s.description = "AWS CloudSearch Query DSL"
   s.authors = [

data/lib/cloud_sesame/query/builder.rb

@@ -12,6 +12,7 @@ module CloudSesame
       include DSL::ScopeAccessors
       include DSL::SortMethods
       include DSL::KGramPhraseMethods
+      include DSL::AnyTermMethods
 
       # ClassSpecific construct class callback
       #

data/lib/cloud_sesame/query/domain/block.rb

@@ -10,6 +10,7 @@ module CloudSesame
         include DSL::ScopeAccessors
         include DSL::BindCaller
         include DSL::KGramPhraseMethods
+        include DSL::AnyTermMethods
 
         after_construct { |_, field_accessor| include field_accessor }
 

data/lib/cloud_sesame/query/dsl/any_term_methods.rb

@@ -0,0 +1,19 @@
+module CloudSesame
+  module Query
+    module DSL
+      module AnyTermMethods
+        def any_term(field, words, options = {})
+          if words && words.length > 0
+            or!(options) do
+              words.map do |word|
+                literal field, term(word)
+              end
+            end
+          end
+
+          _return != _scope ? _return : self
+        end
+      end
+    end
+  end
+end

data/lib/cloud_sesame/query/dsl/k_gram_phrase_methods.rb

@@ -3,29 +3,30 @@ module CloudSesame
     module DSL
       module KGramPhraseMethods
         DELIMITER = / |-/.freeze
-        MULTIPLIER = 5
+        MULTIPLIER = 10 # Even number that controls the separation between k-grams
 
         def k_gram_phrase(field, value, options = {})
           if value && !value.empty?
             words = value.split(DELIMITER).compact
 
             or!(options) do
-              literal field, phrase(value, boost: MULTIPLIER * words.size)
+              literal field, phrase(value, boost: MULTIPLIER * words.size + MULTIPLIER)
 
               each_k_gram_combination(words, options[:min]) do |combination, original|
                 remaining_terms = (original - combination).join(' ')
                 unique_phrase = combination.join(' ')
-                k = MULTIPLIER * combination.size
+                boost = MULTIPLIER * combination.size
 
-                and!(boost: k + 2) do
+                and!(boost: boost + MULTIPLIER / 2) do
                   literal field, phrase(unique_phrase)
                   literal field, term(remaining_terms)
                 end
 
-                literal field, phrase(unique_phrase, boost: k)
+                literal field, phrase(unique_phrase, boost: boost)
               end
 
-              literal field, term(value)
+              literal field, term(value, boost: MULTIPLIER)
+              any_term(field, words)
             end
           end
 
@@ -47,4 +48,4 @@ module CloudSesame
       end
     end
   end
-end
+end

data/lib/cloud_sesame.rb

@@ -38,6 +38,7 @@ require 'cloud_sesame/query/dsl/response_methods'
 require 'cloud_sesame/query/dsl/return_methods'
 require 'cloud_sesame/query/dsl/sort_methods'
 require 'cloud_sesame/query/dsl/k_gram_phrase_methods'
+require 'cloud_sesame/query/dsl/any_term_methods'
 
 # Query Query Domain Objects
 # ===============================================

data/spec/cloud_sesame/query/dsl/any_term_methods_spec.rb

@@ -0,0 +1,44 @@
+module CloudSesame
+  module Query
+    module DSL
+      describe AnyTermMethods do
+        class Product
+          include CloudSesame
+          define_cloudsearch do
+            field :name, query: { weight: 2 }, type: :string
+            field :description, query: { weight: 0.4 }, type: :string
+          end
+        end
+
+        subject(:cloudsearch) { Product.cloudsearch.builder }
+        let(:root) { cloudsearch.request.filter_query.root }
+
+        describe '#any_term' do
+          let(:words) { %w(listerine mouth wash) }
+
+          it 'inserts an OR node at its scope level' do
+            expect { cloudsearch.any_term(:name, words) }.to change { root.children }.by([AST::Or])
+          end
+
+          describe 'in the OR node' do
+            let(:or_node) { root.children.first }
+
+            it 'builds a term node with each word' do
+              cloudsearch.any_term(:name, words)
+
+              expect(or_node.children[0]).to be_kind_of AST::Term
+              expect(or_node.children[0].child.value).to eq('listerine')
+            end
+          end
+
+          context 'when words is empty or nil' do
+            it 'does not build anything' do
+              expect { cloudsearch.any_term(:name, nil) }.to_not change { root.children }
+              expect { cloudsearch.any_term(:name, []) }.to_not change { root.children }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/cloud_sesame/query/dsl/k_gram_phrase_methods_spec.rb

@@ -30,38 +30,40 @@ module CloudSesame
               phrase_node = or_node.children.first
               expect(phrase_node).to be_kind_of AST::Phrase
               expect(phrase_node.child.value).to eq(phrase)
+              expect(phrase_node.options[:boost]).to eq(KGramPhraseMethods::MULTIPLIER * 3 + KGramPhraseMethods::MULTIPLIER)
             end
 
             it 'builds a term node with original term' do
               cloudsearch.k_gram_phrase(:name, phrase)
 
-              term_node = or_node.children.last
+              term_node = or_node.children[-2]
               expect(term_node).to be_kind_of AST::Term
               expect(term_node.child.value).to eq(phrase)
+              expect(term_node.options[:boost]).to eq(KGramPhraseMethods::MULTIPLIER)
             end
 
             it 'builds bunch of phrase nodes with k grams' do
               cloudsearch.k_gram_phrase(:name, phrase)
-              k_nodes = or_node.children[1..-1]
+              k_nodes = or_node.children[1..-2]
 
               expect(k_nodes[0]).to be_kind_of AST::And
 
               expect(k_nodes[1]).to be_kind_of AST::Phrase
-              expect(k_nodes[1].options[:boost]).to eq(10)
+              expect(k_nodes[1].options[:boost]).to eq(KGramPhraseMethods::MULTIPLIER * 2)
               expect(k_nodes[1].child.value).to eq('listerine mouth')
 
               expect(k_nodes[2]).to be_kind_of AST::And
 
               expect(k_nodes[3]).to be_kind_of AST::Phrase
-              expect(k_nodes[3].options[:boost]).to eq(10)
+              expect(k_nodes[3].options[:boost]).to eq(KGramPhraseMethods::MULTIPLIER * 2)
               expect(k_nodes[3].child.value).to eq('mouth wash')
             end
 
-            it 'builds the correct first And node' do
+            it 'builds the correct first And node (for k-gram plus excluded terms)' do
               cloudsearch.k_gram_phrase(:name, phrase)
-              and_node = or_node.children[1..-1][0]
+              and_node = or_node.children[1..-2][0]
 
-              expect(and_node.options[:boost]).to eq(12)
+              expect(and_node.options[:boost]).to eq(KGramPhraseMethods::MULTIPLIER * 2 + KGramPhraseMethods::MULTIPLIER / 2)
 
               expect(and_node.children.first).to be_kind_of AST::Phrase
               expect(and_node.children.first.child.value).to eq('listerine mouth')
@@ -70,11 +72,11 @@ module CloudSesame
               expect(and_node.children.last.child.value).to eq('wash')
             end
 
-            it 'builds the correct second And node' do
+            it 'builds the correct second And node (for k-gram plus excluded terms)' do
               cloudsearch.k_gram_phrase(:name, phrase)
-              and_node = or_node.children[1..-1][2]
+              and_node = or_node.children[1..-2][2]
 
-              expect(and_node.options[:boost]).to eq(12)
+              expect(and_node.options[:boost]).to eq(KGramPhraseMethods::MULTIPLIER * 2 + KGramPhraseMethods::MULTIPLIER / 2)
 
               expect(and_node.children.first).to be_kind_of AST::Phrase
               expect(and_node.children.first.child.value).to eq('mouth wash')
@@ -82,6 +84,20 @@ module CloudSesame
               expect(and_node.children.last).to be_kind_of AST::Term
               expect(and_node.children.last.child.value).to eq('listerine')
             end
+
+            it 'builds an or node with term nodes for each word' do
+              cloudsearch.k_gram_phrase(:name, phrase)
+              node = or_node.children.last
+
+              expect(node).to be_kind_of(AST::Or)
+              expect(node.children.length).to eq(3)
+              expect(node.children[0]).to be_kind_of(AST::Term)
+              expect(node.children[0].child.value).to eq('listerine')
+              expect(node.children[1]).to be_kind_of(AST::Term)
+              expect(node.children[1].child.value).to eq('mouth')
+              expect(node.children[2]).to be_kind_of(AST::Term)
+              expect(node.children[2].child.value).to eq('wash')
+            end
           end
 
           context 'when phrase is empty' do
@@ -96,4 +112,4 @@ module CloudSesame
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CloudSesame
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Scott Chu
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -184,6 +184,7 @@ files:
 - lib/cloud_sesame/query/domain/block.rb
 - lib/cloud_sesame/query/domain/chaining_block.rb
 - lib/cloud_sesame/query/domain/literal.rb
+- lib/cloud_sesame/query/dsl/any_term_methods.rb
 - lib/cloud_sesame/query/dsl/applied_filter_query.rb
 - lib/cloud_sesame/query/dsl/bind_caller.rb
 - lib/cloud_sesame/query/dsl/block_styled_operators.rb
@@ -245,6 +246,7 @@ files:
 - spec/cloud_sesame/query/ast/value_spec.rb
 - spec/cloud_sesame/query/builder_spec.rb
 - spec/cloud_sesame/query/domain/block_spec.rb
+- spec/cloud_sesame/query/dsl/any_term_methods_spec.rb
 - spec/cloud_sesame/query/dsl/applied_filter_query_spec.rb
 - spec/cloud_sesame/query/dsl/block_styled_operators_spec.rb
 - spec/cloud_sesame/query/dsl/k_gram_phrase_methods_spec.rb
@@ -287,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: AWS CloudSearch Query DSL
@@ -318,6 +320,7 @@ test_files:
 - spec/cloud_sesame/query/ast/value_spec.rb
 - spec/cloud_sesame/query/builder_spec.rb
 - spec/cloud_sesame/query/domain/block_spec.rb
+- spec/cloud_sesame/query/dsl/any_term_methods_spec.rb
 - spec/cloud_sesame/query/dsl/applied_filter_query_spec.rb
 - spec/cloud_sesame/query/dsl/block_styled_operators_spec.rb
 - spec/cloud_sesame/query/dsl/k_gram_phrase_methods_spec.rb