sunspot 2.5.0 → 2.6.0

data/lib/sunspot.rb

@@ -40,6 +40,12 @@ module Sunspot
   NoSetupError = Class.new(StandardError)
   IllegalSearchError = Class.new(StandardError)
   NotImplementedError = Class.new(StandardError)
+  AtomicUpdateRequireInstanceForCompositeIdMessage = lambda do |class_name|
+    "WARNING: `id_prefix` is defined for #{class_name}. Use instance as key for `atomic_update` instead of ID."
+  end
+  RemoveByIdNotSupportCompositeIdMessage = lambda do |class_name|
+    "WARNING: `id_prefix` is defined for #{class_name}. `remove_by_id` does not support it. Use `remove` instead."
+  end
 
   autoload :Installer, File.join(File.dirname(__FILE__), 'sunspot', 'installer')
 
@@ -208,6 +214,8 @@ module Sunspot
     #
     #   post1, post2 = new Array(2) { Post.create }
     #   Sunspot.atomic_update(Post, post1.id => {title: 'New Title'}, post2.id => {description: 'new description'})
+    #   Or
+    #   Sunspot.atomic_update(Post, post1 => {title: 'New Title'}, post2 => {description: 'new description'})
     #
     # Note that indexed objects won't be reflected in search until a commit is
     # sent - see Sunspot.index! and Sunspot.commit
@@ -223,7 +231,7 @@ module Sunspot
     # ==== Parameters
     #
     # clazz<Class>:: the class of the objects to be updated
-    # updates<Hash>:: hash of updates where keys are model ids
+    # updates<Hash>:: hash of updates where keys are models or model ids
     #                 and values are hash with property name/values to be updated
     #
     def atomic_update!(clazz, updates = {})

data/spec/api/indexer/removal_spec.rb

@@ -60,4 +60,91 @@ describe 'document removal', :type => :indexer do
     end
     expect(connection).to have_delete_by_query("(type:Post AND title_ss:monkeys)")
   end
+
+  context 'when call #remove_by_id' do
+    let(:post) { clazz.new(title: 'A Title') }
+    before(:each) { index_post(post) }
+
+    context 'and `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+        let(:id_prefix) { lambda { |post| "USERDATA-#{post.id}!" } }
+
+        it 'prints warning' do
+          expect do
+            session.remove_by_id(clazz, post.id)
+          end.to output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'does not remove record' do
+          session.remove_by_id(clazz, post.id)
+          expect(connection).to have_no_delete(post_solr_id)
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+        let(:id_prefix) { lambda { |post| "#{post.title}!" } }
+
+        it 'prints warning' do
+          expect do
+            session.remove_by_id(clazz, post.id)
+          end.to output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'does not remove record' do
+          session.remove_by_id(clazz, post.id)
+          expect(connection).to have_no_delete(post_solr_id)
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+        let(:id_prefix) { 'USERDATA!' }
+
+        it 'does not print warning' do
+          expect do
+            session.remove_by_id(clazz, post.id)
+          end.to_not output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'removes record' do
+          session.remove_by_id(clazz, post.id)
+          expect(connection).to have_delete(post_solr_id)
+        end
+      end
+    end
+
+    context 'and `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+      let(:id_prefix) { nil }
+
+      it 'does not print warning' do
+        expect do
+          session.remove_by_id(clazz, post.id)
+        end.to_not output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+      end
+
+      it 'removes record' do
+        session.remove_by_id(clazz, post.id)
+        expect(connection).to have_delete(post_solr_id)
+      end
+    end
+
+    context 'and `id_prefix` is passed along with `class_name`' do
+      let(:clazz) { PostWithProcPrefixId }
+      let(:id_prefix) { lambda { |post| "USERDATA-#{post.id}!" } }
+
+      it 'does not print warning' do
+        expect do
+          session.remove_by_id("USERDATA-#{post.id}!#{clazz.name}", post.id)
+        end.to_not output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+      end
+
+      it 'removes record' do
+        session.remove_by_id("USERDATA-#{post.id}!#{clazz.name}", post.id)
+        expect(connection).to have_delete(post_solr_id)
+      end
+    end
+  end
 end

data/spec/api/query/connective_boost_examples.rb

@@ -0,0 +1,85 @@
+shared_examples_for "query with connective scope and boost" do
+  it 'creates a boost query' do
+    search do
+      boost(10) do
+        any_of do
+          with(:coordinates_new).in_bounding_box([23, -46], [25, -44])
+          with(:coordinates_new).in_bounding_box([42, 56], [43, 58])
+        end
+      end
+    end
+
+    expect(connection).to have_last_search_including(
+      :bq, '(coordinates_new_ll:[23,-46 TO 25,-44] OR coordinates_new_ll:[42,56 TO 43,58])^10'
+    )
+
+    expect(connection).to have_last_search_including(
+      :defType, 'edismax'
+    )
+  end
+
+  it 'creates a boost function' do
+    search do
+      boost(function() { field(:average_rating) })
+    end
+
+    expect(connection).to have_last_search_including(
+      :bf, 'field(average_rating_ft)'
+    )
+
+    expect(connection).to have_last_search_including(
+      :defType, 'edismax'
+    )
+  end
+
+  it 'creates a multiplicative boost function' do
+    search do
+      boost_multiplicative(function() { field(:average_rating) })
+    end
+
+    expect(connection).to have_last_search_including(
+      :boost, 'field(average_rating_ft)'
+    )
+
+    expect(connection).to have_last_search_including(
+      :defType, 'edismax'
+    )
+  end
+
+  it 'creates combined boost search' do
+    search do
+      boost(10) do
+        any_of do
+          with(:coordinates_new).in_bounding_box([23, -46], [25, -44])
+          with(:coordinates_new).in_bounding_box([42, 56], [43, 58])
+        end
+      end
+
+      boost(function() { field(:average_rating) })
+      boost_multiplicative(function() { field(:average_rating) })
+    end
+
+    expect(connection).to have_last_search_including(
+      :bq, '(coordinates_new_ll:[23,-46 TO 25,-44] OR coordinates_new_ll:[42,56 TO 43,58])^10'
+    )
+
+    expect(connection).to have_last_search_including(
+      :bf, 'field(average_rating_ft)'
+    )
+
+    expect(connection).to have_last_search_including(
+      :boost, 'field(average_rating_ft)'
+    )
+  end
+
+  it 'avoids duplicate boost functions' do
+    search do
+      boost(function() { field(:average_rating) })
+      boost(function() { field(:average_rating) })
+      boost_multiplicative(function() { field(:average_rating) })
+    end
+
+    expect(connection.searches.last[:bf]).to eq ['field(average_rating_ft)']
+    expect(connection.searches.last[:boost]).to eq ['field(average_rating_ft)']
+  end
+end

data/spec/api/query/join_spec.rb

@@ -6,7 +6,7 @@ describe 'join' do
       with(:caption, 'blah')
     end
     expect(connection).to have_last_search_including(
-      :fq, "{!join from=photo_container_id_i to=id_i}caption_s:blah")
+      :fq, "{!join from=photo_container_id_i to=id_i v='type:\"Photo\" AND caption_s:\"blah\"'}")
   end
 
   it 'should greater_than search by join' do
@@ -14,6 +14,6 @@ describe 'join' do
       with(:photo_rating).greater_than(3)
     end
     expect(connection).to have_last_search_including(
-      :fq, "{!join from=photo_container_id_i to=id_i}average_rating_ft:{3\\.0 TO *}")
+      :fq, "{!join from=photo_container_id_i to=id_i v='type:\"Photo\" AND average_rating_ft:{3\\.0 TO *}'}")
   end
 end

data/spec/api/query/standard_spec.rb

@@ -4,6 +4,7 @@ describe 'standard query', :type => :query do
   it_should_behave_like "scoped query"
   it_should_behave_like "query with advanced manipulation"
   it_should_behave_like "query with connective scope"
+  it_should_behave_like "query with connective scope and boost"
   it_should_behave_like "query with dynamic field support"
   it_should_behave_like "facetable query"
   it_should_behave_like "fulltext query"
@@ -22,6 +23,15 @@ describe 'standard query', :type => :query do
     expect(connection).to have_last_search_with(:q => '*:*')
   end
 
+  it 'adds a no-op query to :q parameter when only a boost query provided' do
+    session.search Post do
+      boost(2) do
+        with :title, 'My Pet Post'
+      end
+    end
+    expect(connection).to have_last_search_with(:q => '*:*')
+  end
+
   private
 
   def search(*classes, &block)

data/spec/api/setup_spec.rb

@@ -0,0 +1,99 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Setup do
+  context '#id_prefix_for_class' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_for_class }
+
+    context 'when `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+
+        it 'returns `id_prefix` value' do
+          is_expected.to eq('USERDATA!')
+        end
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns nil' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  context '#id_prefix_defined?' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_defined? }
+
+    context 'when `id_prefix` is defined on model' do
+      let(:clazz) { PostWithProcPrefixId }
+
+      it 'returns true' do
+        is_expected.to be_truthy
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns false' do
+        is_expected.to be_falsey
+      end
+    end
+  end
+
+  context '#id_prefix_requires_instance?' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_requires_instance? }
+
+    context 'when `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+
+        it 'returns true' do
+          is_expected.to be_truthy
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+
+        it 'returns true' do
+          is_expected.to be_truthy
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+
+        it 'returns false' do
+          is_expected.to be_falsey
+        end
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns false' do
+        is_expected.to be_falsey
+      end
+    end
+  end
+end

data/spec/helpers/indexer_helper.rb

@@ -14,4 +14,26 @@ module IndexerHelper
   def values_in_last_document_for(field_name)
     @connection.adds.last.last.fields_by_name(field_name).map { |field| field.value }
   end
+
+  def index_post(post)
+    Sunspot.index!(post)
+    hit = find_post(post)
+    expect(hit).not_to be_nil
+    hit
+  end
+
+  def find_post(post)
+    Sunspot.search(clazz).hits.find { |h| h.primary_key.to_i == post.id && h.id_prefix == id_prefix_value(post, id_prefix) }
+  end
+
+  def id_prefix_value(post, id_prefix)
+    return unless id_prefix
+    return id_prefix if id_prefix.is_a?(String)
+
+    id_prefix.call(post)
+  end
+
+  def post_solr_id
+    "#{id_prefix_value(post, id_prefix)}#{clazz} #{post.id}"
+  end
 end

data/spec/integration/atomic_updates_spec.rb

@@ -1,6 +1,79 @@
 require File.expand_path('../spec_helper', File.dirname(__FILE__))
 
-describe 'atomic updates' do
+shared_examples 'atomic update with instance as key' do
+  it 'updates record' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post => { title: 'A New Title' })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: true)
+
+    Sunspot.atomic_update!(clazz, post => { featured: false })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: false)
+  end
+
+  it 'does not print warning' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    expect do
+      Sunspot.atomic_update!(clazz, post => { title: 'A New Title' })
+    end.to_not output(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz)).to_stderr
+  end
+
+  it 'does not create duplicate document' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post => { title: 'A New Title' })
+    hit = find_indexed_post_with_prefix_id(post, nil)
+    expect(hit).to be_nil
+  end
+end
+
+shared_examples 'atomic update with id as key' do
+  it 'does not update record' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A Title', featured: true)
+
+    Sunspot.atomic_update!(clazz, post.id => { featured: false })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A Title', featured: true)
+  end
+
+  it 'prints warning' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    expect do
+      Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+    end.to output(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz) + "\n").to_stderr
+  end
+
+  it 'creates duplicate document that have only fields provided for update' do
+    post = clazz.new(title: 'A Title', featured: true)
+    Sunspot.index!(post)
+
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+    Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+    validate_hit(find_and_validate_indexed_post_with_prefix_id(post, nil), title: 'A New Title', featured: nil)
+  end
+end
+
+describe 'Atomic Update feature' do
   before :all do
     Sunspot.remove_all
   end
@@ -18,10 +91,27 @@ describe 'atomic updates' do
     hit
   end
 
-  it 'should update single record fields one by one' do
+  def find_and_validate_indexed_post_with_prefix_id(post, id_prefix)
+    hit = find_indexed_post_with_prefix_id(post, id_prefix_value(post, id_prefix))
+    expect(hit).not_to be_nil
+    hit
+  end
+
+  def find_indexed_post_with_prefix_id(post, id_prefix)
+    Sunspot.search(post.class).hits.find { |h| h.primary_key.to_i == post.id && h.id_prefix == id_prefix }
+  end
+
+  def id_prefix_value(post, id_prefix)
+    return unless id_prefix
+    return id_prefix if id_prefix.is_a?(String)
+
+    id_prefix.call(post)
+  end
+
+  it 'updates single record fields one by one' do
     post = Post.new(title: 'A Title', featured: true)
     Sunspot.index!(post)
-    
+
     validate_hit(find_indexed_post(post.id), title: post.title, featured: post.featured)
 
     Sunspot.atomic_update!(Post, post.id => {title: 'A New Title'})
@@ -31,7 +121,7 @@ describe 'atomic updates' do
     validate_hit(find_indexed_post(post.id), title: 'A New Title', featured: false)
   end
 
-  it 'should update fields for multiple records' do
+  it 'updates fields for multiple records' do
     post1 = Post.new(title: 'A First Title', featured: true)
     post2 = Post.new(title: 'A Second Title', featured: false)
     Sunspot.index!(post1, post2)
@@ -44,7 +134,7 @@ describe 'atomic updates' do
     validate_hit(find_indexed_post(post2.id), title: 'A Second Title', featured: true)
   end
 
-  it 'should clear field value properly' do
+  it 'clears field value properly' do
     post = Post.new(title: 'A Title', tags: %w(tag1 tag2), featured: true)
     Sunspot.index!(post)
     validate_hit(find_indexed_post(post.id), title: post.title, tag_list: post.tags, featured: true)
@@ -55,4 +145,78 @@ describe 'atomic updates' do
     Sunspot.atomic_update!(Post, post.id => {featured: nil})
     validate_hit(find_indexed_post(post.id), title: post.title, tag_list: nil, featured: nil)
   end
+
+  context 'when `id_prefix` is defined on model' do
+    context 'as Proc' do
+      let(:clazz) { PostWithProcPrefixId }
+      let(:id_prefix) { lambda { |post| "USERDATA-#{post.id}!" } }
+
+      context 'and instance passed as key' do
+        include_examples 'atomic update with instance as key'
+      end
+
+      context 'and id passed as key' do
+        include_examples 'atomic update with id as key'
+      end
+    end
+
+    context 'as Symbol' do
+      let(:clazz) { PostWithSymbolPrefixId }
+      let(:id_prefix) { lambda { |post| "#{post.title}!" } }
+
+      context 'and instance passed as key' do
+        include_examples 'atomic update with instance as key'
+      end
+
+      context 'and id passed as key' do
+        include_examples 'atomic update with id as key'
+      end
+    end
+
+    context 'as String' do
+      let(:clazz) { PostWithStringPrefixId }
+      let(:id_prefix) { 'USERDATA!' }
+
+      context 'and instance passed as key' do
+        include_examples 'atomic update with instance as key'
+      end
+
+      context 'and id passed as key' do
+        it 'updates record' do
+          post = clazz.new(title: 'A Title', featured: true)
+          Sunspot.index!(post)
+
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+          Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: true)
+
+          Sunspot.atomic_update!(clazz, post.id => { featured: false })
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: 'A New Title', featured: false)
+        end
+
+        it 'does not print warning' do
+          post = clazz.new(title: 'A Title', featured: true)
+          Sunspot.index!(post)
+
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+          expect do
+            Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+          end.to_not output(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'does not create duplicate document' do
+          post = clazz.new(title: 'A Title', featured: true)
+          Sunspot.index!(post)
+
+          validate_hit(find_and_validate_indexed_post_with_prefix_id(post, id_prefix), title: post.title, featured: post.featured)
+
+          Sunspot.atomic_update!(clazz, post.id => { title: 'A New Title' })
+          hit = find_indexed_post_with_prefix_id(post, nil)
+          expect(hit).to be_nil
+        end
+      end
+    end
+  end
 end