sunspot_rails 2.0.0.pre.120720 → 2.0.0.pre.120924

data/sunspot/spec/api/search/highlighting_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'search with highlighting results', :type => :search do
+  before :each do
+    @posts = Array.new(2) { Post.new }
+    stub_results_with_highlighting(
+      @posts[0],
+      { 'title_text' => ['one @@@hl@@@two@@@endhl@@@ three'] },
+      @posts[1],
+      { 'title_text' => ['three four @@@hl@@@five@@@endhl@@@'],
+        'body_text' => ['@@@hl@@@five@@@ six seven', '@@@hl@@@eight@@@endhl@@@ nine @@@hl@@@ten@@@endhl@@@'] }
+    )
+    @search = session.search(Post)
+  end
+
+  it 'returns all highlights' do
+    @search.hits.last.should have(3).highlights
+  end
+
+  it 'returns all highlights for a specified field' do
+    @search.hits.last.should have(2).highlights(:body)
+  end
+
+  it 'returns first highlight for a specified field' do
+    @search.hits.first.highlight(:title).format.should == 'one <em>two</em> three'
+  end
+
+  it 'returns an empty array if a given field does not have a highlight' do
+    @search.hits.first.highlights(:body).should == []
+  end
+
+  it 'formats hits with <em> by default' do
+    highlight = @search.hits.first.highlights(:title).first.formatted
+    highlight.should == 'one <em>two</em> three'
+  end
+
+  it 'formats hits with provided block' do
+    highlight = @search.hits.first.highlights(:title).first.format do |word|
+      "<i>#{word}</i>"
+    end
+    highlight.should == 'one <i>two</i> three'
+  end
+
+  it 'handles multiple highlighted words' do
+    highlight = @search.hits.last.highlights(:body).last.format do |word|
+      "<b>#{word}</b>"
+    end
+    highlight.should == '<b>eight</b> nine <b>ten</b>'
+  end
+
+  private
+
+  def stub_results_with_highlighting(*instances_and_highlights)
+    docs, highlights = [], []
+    instances_and_highlights.each_slice(2) do |doc, highlight|
+      docs << doc
+      highlights << highlight
+    end
+    response = stub_full_results(*docs.map { |doc| { 'instance' => doc }})
+    highlighting = response['highlighting'] = {}
+    highlights.each_with_index do |highlight, i|
+      if highlight
+        instance = docs[i]
+        highlighting["#{instance.class.name} #{instance.id}"] = highlight
+      end
+    end
+    response
+  end
+end

data/sunspot/spec/api/search/hits_spec.rb

@@ -0,0 +1,147 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'hits', :type => :search do
+  it 'should return hits without loading instances' do
+    post_1, post_2 = Array.new(2) { Post.new }
+    stub_results(post_1, post_2)
+    %w(load load_all).each do |message|
+      MockAdapter::DataAccessor.should_not_receive(message)
+    end
+    session.search(Post).hits.map do |hit|
+      [hit.class_name, hit.primary_key]
+    end.should == [['Post', post_1.id.to_s], ['Post', post_2.id.to_s]]
+  end
+
+  it 'returns search total as attribute of hits' do
+    stub_results(Post.new, 4)
+    session.search(Post) do
+      paginate(:page => 1)
+    end.hits.total_entries.should == 4
+  end
+
+  it 'returns search total as attribute of verified hits' do
+    stub_results(Post.new, 4)
+    session.search(Post) do
+      paginate(:page => 1)
+    end.hits(:verify => true).total_entries.should == 4
+  end
+
+  it 'should return instance from hit' do
+    posts = Array.new(2) { Post.new }
+    stub_results(*posts)
+    session.search(Post).hits.first.instance.should == posts.first
+  end
+
+  it 'should return the instance primary key when you use it as a param' do
+    posts = Array.new(2) { Post.new }
+    stub_results(*posts)
+    session.search(Post).hits.first.to_param.should == posts.first.id.to_s
+  end
+
+  it 'should provide iterator over hits with instances' do
+    posts = Array.new(2) { Post.new }
+    stub_results(*posts)
+    search = session.search(Post)
+    hits, results = [], []
+
+    search.each_hit_with_result do |hit, result|
+      hits << hit
+      results << result
+    end
+
+    hits.should have(2).hits
+    results.should have(2).results
+  end
+
+  it 'should provide an Enumerator over hits with instances' do
+    posts = Array.new(2) { Post.new }
+    stub_results(*posts)
+    search = session.search(Post)
+    hits, results = [], []
+    search.each_hit_with_result.with_index do |(hit, result), index|
+      hit.should be_kind_of(Sunspot::Search::Hit)
+      result.should be_kind_of(Post)
+      index.should be_kind_of(Integer)
+    end
+  end
+
+  it 'should hydrate all hits when an instance is requested from a hit' do
+    posts = Array.new(2) { Post.new }
+    stub_results(*posts)
+    search = session.search(Post)
+    search.hits.first.instance
+    %w(load load_all).each do |message|
+      MockAdapter::DataAccessor.should_not_receive(message)
+    end
+    search.hits.last.instance.should == posts.last
+  end
+
+  it 'should return only hits whose referenced object exists in the data store if :verify option passed' do
+    posts = Array.new(2) { Post.new }
+    posts.last.destroy
+    stub_results(*posts)
+    search = session.search(Post)
+    search.hits(:verify => true).map { |hit| hit.instance }.should == posts[0..0]
+  end
+
+  it 'should return verified and unverified hits from the same search' do
+    posts = Array.new(2) { Post.new }
+    posts.last.destroy
+    stub_results(*posts)
+    search = session.search(Post)
+    search.hits(:verify => true).map { |hit| hit.instance }.should == posts[0..0]
+    search.hits.map { |hit| hit.instance }.should == [posts.first, nil]
+  end
+
+  it 'should attach score to hits' do
+    stub_full_results('instance' => Post.new, 'score' => 1.23)
+    session.search(Post).hits.first.score.should == 1.23
+  end
+
+  it 'should return stored field values in hits' do
+    stub_full_results('instance' => Post.new, 'title_ss' => 'Title')
+    session.search(Post).hits.first.stored(:title).should == 'Title'
+  end
+
+  it 'should return stored field values for searches against multiple types' do
+    stub_full_results('instance' => Post.new, 'title_ss' => 'Title')
+    session.search(Post, Namespaced::Comment).hits.first.stored(:title).should == 'Title'
+  end
+
+  it 'should return stored field values for searches against base type when subtype matches' do
+    class SubclassedPost < Post; end;
+    stub_full_results('instance' => SubclassedPost.new, 'title_ss' => 'Title')
+    session.search(Post).hits.first.stored(:title).should == 'Title'
+  end
+
+  it 'should return stored text fields' do
+    stub_full_results('instance' => Post.new, 'body_textsv' => 'Body')
+    session.search(Post, Namespaced::Comment).hits.first.stored(:body).should == 'Body'
+  end
+
+  it 'should return stored boolean fields' do
+    stub_full_results('instance' => Post.new, 'featured_bs' => true)
+    session.search(Post, Namespaced::Comment).hits.first.stored(:featured).should be_true
+  end
+
+  it 'should return stored boolean fields that evaluate to false' do
+    stub_full_results('instance' => Post.new, 'featured_bs' => false)
+    session.search(Post, Namespaced::Comment).hits.first.stored(:featured).should == false
+  end
+
+  it 'should return stored dynamic fields' do
+    stub_full_results('instance' => Post.new, 'custom_string:test_ss' => 'Custom')
+    session.search(Post, Namespaced::Comment).hits.first.stored(:custom_string, :test).should == 'Custom'
+  end
+
+  it 'should typecast stored field values in hits' do
+    time = Time.utc(2008, 7, 8, 2, 45)
+    stub_full_results('instance' => Post.new, 'last_indexed_at_ds' => time.xmlschema)
+    session.search(Post).hits.first.stored(:last_indexed_at).should == time
+  end
+
+  it 'should return stored values for multi-valued fields' do
+    stub_full_results('instance' => User.new, 'role_ids_ims' => %w(1 4 5))
+    session.search(User).hits.first.stored(:role_ids).should == [1, 4, 5]
+  end
+end

data/sunspot/spec/api/search/paginated_collection_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe "PaginatedCollection" do
+  subject { Sunspot::Search::PaginatedCollection.new [], 1, 10, 20 }
+
+  it { subject.should be_an(Array) }
+
+  context "behaves like a WillPaginate::Collection" do
+    it { subject.total_entries.should eql(20) }
+    it { subject.total_pages.should eql(2) }
+    it { subject.current_page.should eql(1) }
+    it { subject.per_page.should eql(10) }
+    it { subject.previous_page.should be_nil }
+    it { subject.next_page.should eql(2) }
+    it { subject.out_of_bounds?.should_not be_true }
+    it { subject.offset.should eql(0) }
+
+    it 'should allow setting total_count' do
+      subject.total_count = 1
+      subject.total_count.should eql(1)
+    end
+
+    it 'should allow setting total_entries' do
+      subject.total_entries = 1
+      subject.total_entries.should eql(1)
+    end
+  end
+
+  context "behaves like Kaminari" do
+    it { subject.total_count.should eql(20) }
+    it { subject.num_pages.should eql(2) }
+    it { subject.limit_value.should eql(10) }
+    it { subject.first_page?.should be_true }
+    it { subject.last_page?.should_not be_true }
+  end
+end

data/sunspot/spec/api/search/results_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'search results', :type => :search do
+  it 'loads single result' do
+    post = Post.new
+    stub_results(post)
+    session.search(Post).results.should == [post]
+  end
+
+  it 'loads multiple results in order' do
+    post_1, post_2 = Post.new, Post.new
+    stub_results(post_1, post_2)
+    session.search(Post).results.should == [post_1, post_2]
+    stub_results(post_2, post_1)
+    session.search(Post).results.should == [post_2, post_1]
+  end
+
+  # This is a reduction of a crazy bug I found in production where some hits
+  # were inexplicably not being populated.
+  it 'properly loads results of multiple classes that have the same primary key' do
+    Post.reset!
+    Namespaced::Comment.reset!
+    results = [Post.new, Namespaced::Comment.new]
+    stub_results(*results)
+    session.search(Post, Namespaced::Comment).results.should == results
+  end
+
+  it 'gracefully returns empty results when response is nil' do
+    stub_nil_results
+    session.search(Post).results.should == []
+  end
+
+  it 'returns search total as attribute of results' do
+    stub_results(Post.new, 4)
+    session.search(Post) do
+      paginate(:page => 1)
+    end.results.total_entries.should == 4
+  end
+
+  it 'returns total' do
+    stub_results(Post.new, Post.new, 4)
+    session.search(Post) { paginate(:page => 1) }.total.should == 4
+  end
+
+  it 'returns query time' do
+    stub_nil_results
+    connection.response['responseHeader'] = { 'QTime' => 42 }
+    session.search(Post) { paginate(:page => 1) }.query_time.should == 42
+  end
+
+  it 'returns total for nil search' do
+    stub_nil_results
+    session.search(Post).total.should == 0
+  end
+
+  it 'returns available results if some results are not available from data store' do
+    posts = [Post.new, Post.new]
+    posts.last.destroy
+    stub_results(*posts)
+    session.search(Post).results.should == posts[0..0]
+  end
+
+  it 'does not attempt to query the data store more than once when results are unavailable' do
+    posts = [Post.new, Post.new]
+    posts.each { |post| post.destroy }
+    stub_results(*posts)
+    search = session.search(Post) do
+      data_accessor_for(Post).should_receive(:load_all).once.and_return([])
+    end
+    search.results.should == []
+  end
+end

data/sunspot/spec/api/search/search_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Search do
+  it 'should allow access to the data accessor' do
+    stub_results(posts = Post.new)
+    search = session.search Post do
+      data_accessor_for(Post).custom_title = 'custom title'
+    end
+    search.results.first.title.should == 'custom title'
+  end
+  
+  it 'should re-execute search' do
+    post_1, post_2 = Post.new, Post.new
+    
+    stub_results(post_1)
+    search = session.search Post
+    search.results.should == [post_1]
+    
+    stub_results(post_2)
+    search.execute!
+    search.results.should == [post_2]
+  end
+end

data/sunspot/spec/api/search/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path('spec_helper', File.join(File.dirname(__FILE__), '..'))

data/sunspot/spec/api/session_proxy/class_sharding_session_proxy_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::SessionProxy::ClassShardingSessionProxy do
+  before do
+    @proxy = MockClassShardingSessionProxy.new(session)
+  end
+
+  [:index, :index!, :remove, :remove!].each do |method|
+    it "should delegate #{method} to appropriate shard" do
+      post = Post.new
+      photo = Photo.new
+      @proxy.post_session.should_receive(method).with([post])
+      @proxy.photo_session.should_receive(method).with([photo])
+      @proxy.send(method, post)
+      @proxy.send(method, photo)
+    end
+  end
+
+  [:remove_by_id, :remove_by_id!].each do |method|
+    it "should delegate #{method} to appropriate shard" do
+      @proxy.post_session.should_receive(method).with(Post, 1)
+      @proxy.photo_session.should_receive(method).with(Photo, 1)
+      @proxy.send(method, Post, 1)
+      @proxy.send(method, Photo, 1)
+    end
+  end
+
+  [:remove_all, :remove_all!].each do |method|
+    it "should delegate #{method} with argument to appropriate shard" do
+      @proxy.post_session.should_receive(method).with(Post)
+      @proxy.photo_session.should_receive(method).with(Photo)
+      @proxy.send(method, Post)
+      @proxy.send(method, Photo)
+    end
+
+    it "should delegate #{method} without argument to all shards" do
+      @proxy.post_session.should_receive(method)
+      @proxy.photo_session.should_receive(method)
+      @proxy.send(method)
+    end
+  end
+
+  [:commit, :commit_if_dirty, :commit_if_delete_dirty, :optimize].each do |method|
+    it "should delegate #{method} to all sessions" do
+      [@proxy.post_session, @proxy.photo_session].each do |session|
+        session.should_receive(method)
+      end
+      @proxy.send(method)
+    end
+  end
+
+  it "should not support the :batch method" do
+    lambda { @proxy.batch }.should raise_error(Sunspot::SessionProxy::NotSupportedError)
+  end
+
+  it "should delegate new_search to search session, adding in shards parameter" do
+    search = @proxy.new_search(Post)
+    search.query[:shards].should ==
+      'http://photos.solr.local/solr,http://posts.solr.local/solr'
+  end
+
+  it "should delegate search to search session, adding in shards parameter" do
+    @proxy.search(Post)
+    connection.should have_last_search_with(
+      :shards => 'http://photos.solr.local/solr,http://posts.solr.local/solr'
+    )
+  end
+
+  [:dirty, :delete_dirty].each do |method|
+    it "should be dirty if any of the sessions are dirty" do
+      @proxy.post_session.stub!(:"#{method}?").and_return(true)
+      @proxy.should send("be_#{method}")
+    end
+
+    it "should not be dirty if none of the sessions are dirty" do
+      @proxy.should_not send("be_#{method}")
+    end
+  end
+
+  it "should raise a NotSupportedError when :config is called" do
+    lambda { @proxy.config }.should raise_error(Sunspot::SessionProxy::NotSupportedError)
+  end
+
+  it_should_behave_like 'session proxy'
+end

data/sunspot/spec/api/session_proxy/id_sharding_session_proxy_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::SessionProxy::ShardingSessionProxy do
+  before do
+    search_session = Sunspot::Session.new
+    @sessions = Array.new(2) { Sunspot::Session.new }
+    @proxy = Sunspot::SessionProxy::IdShardingSessionProxy.new(search_session, @sessions)
+  end
+
+  [:index, :index!, :remove, :remove!].each do |method|
+    it "should delegate #{method} to appropriate shard" do
+      posts = [Post.new(:id => 2), Post.new(:id => 1)]
+      @proxy.sessions[0].should_receive(method).with([posts[0]])
+      @proxy.sessions[1].should_receive(method).with([posts[1]])
+      @proxy.send(method, posts[0])
+      @proxy.send(method, posts[1])
+    end
+  end
+
+  [:remove_by_id, :remove_by_id!].each do |method|
+    it "should delegate #{method} to appropriate session" do
+      @proxy.sessions[0].should_receive(method).with(Post, 2)
+      @proxy.sessions[1].should_receive(method).with(Post, 1)
+      @proxy.send(method, Post, 1)
+      @proxy.send(method, Post, 2)
+    end
+  end
+
+  it_should_behave_like 'session proxy'
+end