benjaminkrause-sunspot 0.9.7

data/spec/api/search/hits_spec.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+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 '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 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 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 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 geo distance' do
+    stub_full_results('instance' => Post.new, 'geo_distance' => '1.23')
+    session.search(Post).hits.first.distance.should == 1.23
+  end
+
+  it 'should return nil if no geo distance' do
+    stub_results(Post.new)
+    session.search(Post).hits.first.distance.should be_nil
+  end
+end

data/spec/api/search/results_spec.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+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
+
+  if ENV['USE_WILL_PAGINATE']
+
+    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
+
+  else
+
+    it 'returns vanilla array if WillPaginate is not available' do
+      stub_results(Post.new)
+      session.search(Post) do
+        paginate(:page => 1)
+      end.results.should_not respond_to(:total_entries)
+    end
+
+  end
+
+  it 'should return total' do
+    stub_results(Post.new, Post.new, 4)
+    session.search(Post) { paginate(:page => 1) }.total.should == 4
+  end
+end

data/spec/api/search/search_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+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
+end

data/spec/api/search/spec_helper.rb

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

data/spec/api/session_spec.rb

@@ -0,0 +1,157 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+shared_examples_for 'all sessions' do
+  context '#index()' do
+    before :each do
+      @session.index(Post.new)
+    end
+
+    it 'should add document to connection' do
+      connection.should have(1).adds
+    end
+  end
+
+  context '#index!()' do
+    before :each do
+      @session.index!(Post.new)
+    end
+
+    it 'should add document to connection' do
+      connection.should have(1).adds
+    end
+
+    it 'should commit' do
+      connection.should have(1).commits
+    end
+  end
+
+  context '#commit()' do
+    before :each do
+      @session.commit
+    end
+
+    it 'should commit' do
+      connection.should have(1).commits
+    end
+  end
+
+  context '#search()' do
+    before :each do
+      @session.search(Post)
+    end
+
+    it 'should search' do
+      connection.should have(1).searches
+    end
+  end
+end
+
+describe 'Session' do
+  before :each do
+    @connection_factory = Mock::ConnectionFactory.new
+    Sunspot::Session.connection_class = @connection_factory
+  end
+
+  after :each do
+    Sunspot::Session.connection_class = nil
+    Sunspot.reset!
+  end
+
+  context 'singleton session' do
+    before :each do
+      Sunspot.reset!
+      @session = Sunspot
+    end
+
+    it_should_behave_like 'all sessions'
+
+    it 'should open connection with defaults if nothing specified' do
+      Sunspot.commit
+      connection.adapter.opts[:url].should == 'http://127.0.0.1:8983/solr'
+    end
+
+    it 'should open a connection with custom host' do
+      Sunspot.config.solr.url = 'http://127.0.0.1:8981/solr'
+      Sunspot.commit
+      connection.adapter.opts[:url].should == 'http://127.0.0.1:8981/solr'
+    end
+
+    it 'should use Net::HTTP adapter by default' do
+      Sunspot.commit
+      connection.adapter.connector.adapter_name.should == :net_http
+    end
+
+    it 'should use Net::HTTP adapter when specified' do
+      Sunspot.config.http_client = :curb
+      Sunspot.commit
+      connection.adapter.connector.adapter_name.should == :curb
+    end
+  end
+
+  context 'custom session' do
+    before :each do
+      @session = Sunspot::Session.new
+    end
+
+    it_should_behave_like 'all sessions'
+
+    it 'should open a connection with custom host' do
+      session = Sunspot::Session.new do |config|
+        config.solr.url = 'http://127.0.0.1:8982/solr'
+      end
+      session.commit
+      connection.adapter.opts[:url].should == 'http://127.0.0.1:8982/solr'
+    end
+  end
+
+  context 'dirty sessions' do
+    before :each do
+      @session = Sunspot::Session.new
+    end
+
+    it 'should start out not dirty' do
+      @session.dirty?.should be_false
+    end
+
+    it 'should be dirty after adding an item' do
+      @session.index(Post.new)
+      @session.dirty?.should be_true
+    end
+
+    it 'should be dirty after deleting an item' do
+      @session.remove(Post.new)
+      @session.dirty?.should be_true
+    end
+
+    it 'should be dirty after a remove_all for a class' do
+      @session.remove_all(Post)
+      @session.dirty?.should be_true
+    end
+
+    it 'should be dirty after a global remove_all' do
+      @session.remove_all
+      @session.dirty?.should be_true
+    end
+
+    it 'should not be dirty after a commit' do
+      @session.index(Post.new)
+      @session.commit
+      @session.dirty?.should be_false
+    end
+
+    it 'should not commit when commit_if_dirty called on clean session' do
+      @session.commit_if_dirty
+      connection.should have(0).commits
+    end
+
+    it 'should commit when commit_if_dirty called on dirty session' do
+      @session.index(Post.new)
+      @session.commit_if_dirty
+      connection.should have(1).commits
+    end
+  end
+
+  def connection
+    @connection_factory.instance
+  end
+end

data/spec/api/spec_helper.rb

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

data/spec/api/sunspot_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Sunspot do
+  describe "reset!" do
+    it "should reset current session" do
+      old_session = Sunspot.send(:session)
+      Sunspot.reset!(true)
+      Sunspot.send(:session).should_not == old_session
+    end
+
+    it "should keep keep configuration if specified" do
+      Sunspot.config.solr.url = "http://localhost:9999/path/solr"
+      config_before_reset = Sunspot.config
+      Sunspot.reset!(true)
+      Sunspot.config.should == config_before_reset
+    end
+  end
+end

data/spec/helpers/indexer_helper.rb

@@ -0,0 +1,29 @@
+module IndexerHelper
+  def config
+    Sunspot::Configuration.build
+  end
+
+  def connection
+    @connection ||= Mock::Connection.new
+  end
+
+  def session
+    @session ||= Sunspot::Session.new(config, connection)
+  end
+
+  def post(attrs = {})
+    @post ||= Post.new(attrs)
+  end
+
+  def last_add
+    @connection.adds.last
+  end
+
+  def value_in_last_document_for(field_name)
+    @connection.adds.last.last.field_by_name(field_name).value
+  end
+
+  def values_in_last_document_for(field_name)
+    @connection.adds.last.last.fields_by_name(field_name).map { |field| field.value }
+  end
+end

data/spec/helpers/query_helper.rb

@@ -0,0 +1,13 @@
+module QueryHelper
+  def config
+    @config ||= Sunspot::Configuration.build
+  end
+
+  def connection
+    @connection ||= Mock::Connection.new
+  end
+
+  def session
+    @session ||= Sunspot::Session.new(config, connection)
+  end
+end

data/spec/helpers/search_helper.rb

@@ -0,0 +1,78 @@
+module SearchHelper
+  def stub_full_results(*results)
+    count =
+      if results.last.is_a?(Integer) then results.pop
+      else results.length
+      end
+    docs = results.map do |result|
+      instance = result.delete('instance')
+      result.merge('id' => "#{instance.class.name} #{instance.id}")
+    end
+    response = {
+      'response' => {
+        'docs' => docs,
+        'numFound' => count
+      }
+    }
+    connection.stub!(:select).and_return(response)
+    response
+  end
+
+  def stub_results(*results)
+    stub_full_results(
+      *results.map do |result|
+        if result.is_a?(Integer)
+          result
+        else
+          { 'instance' => result }
+        end
+      end
+    )
+  end
+
+  def stub_facet(name, values)
+    connection.stub!(:select).and_return(
+      'facet_counts' => {
+        'facet_fields' => {
+          name.to_s => values.to_a.sort_by { |value, count| -count }.flatten
+        }
+      }
+    )
+  end
+
+  def stub_date_facet(name, gap, values)
+    connection.stub!(:select).and_return(
+      'facet_counts' => {
+        'facet_dates' => {
+          name.to_s => { 'gap' => "+#{gap}SECONDS" }.merge(values)
+        }
+      }
+    )
+  end
+
+  def stub_query_facet(values)
+    connection.stub!(:select).and_return(
+      'facet_counts' => { 'facet_queries' => values }
+    )
+  end
+
+  def facet_values(result, field_name)
+    result.facet(field_name).rows.map { |row| row.value }
+  end
+
+  def facet_counts(result, field_name)
+    result.facet(field_name).rows.map { |row| row.count }
+  end
+
+  def config
+    @config ||= Sunspot::Configuration.build
+  end
+
+  def connection
+    @connection ||= mock('connection')
+  end
+
+  def session
+    @session ||= Sunspot::Session.new(config, connection)
+  end
+end

data/spec/integration/dynamic_fields_spec.rb

@@ -0,0 +1,55 @@
+describe 'dynamic fields' do
+  before :each do
+    Sunspot.remove_all
+    @posts = Post.new(:custom_string => { :cuisine => 'Pizza' }),
+             Post.new(:custom_string => { :cuisine => 'Greek' }),
+             Post.new(:custom_string => { :cuisine => 'Greek' })
+    Sunspot.index!(@posts)
+  end
+
+  it 'should search for dynamic string field' do
+    Sunspot.search(Post) do
+      dynamic(:custom_string) do
+        with(:cuisine, 'Pizza')
+      end
+    end.results.should == [@posts.first]
+  end
+
+  describe 'faceting' do
+    before :each do
+      @search = Sunspot.search(Post) do
+        dynamic :custom_string do
+          facet :cuisine
+        end
+      end
+    end
+
+    it 'should return value "value" with count 2' do
+      row = @search.dynamic_facet(:custom_string, :cuisine).rows[0]
+      row.value.should == 'Greek'
+      row.count.should == 2
+    end
+
+    it 'should return value "other" with count 1' do
+      row = @search.dynamic_facet(:custom_string, :cuisine).rows[1]
+      row.value.should == 'Pizza'
+      row.count.should == 1
+    end
+  end
+
+  it 'should order by dynamic string field ascending' do
+    Sunspot.search(Post) do
+      dynamic :custom_string do
+        order_by :cuisine, :asc
+      end
+    end.results.last.should == @posts.first
+  end
+
+  it 'should order by dynamic string field descending' do
+    Sunspot.search(Post) do
+      dynamic :custom_string do
+        order_by :cuisine, :desc
+      end
+    end.results.first.should == @posts.first
+  end
+end

data/spec/integration/faceting_spec.rb

@@ -0,0 +1,169 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'search faceting' do
+  def self.test_field_type(name, attribute, field, value1, value2)
+    context "with field of type #{name}" do
+      before :all do
+        Sunspot.remove_all
+        2.times do
+          Sunspot.index(Post.new(attribute => value1))
+        end
+        Sunspot.index(Post.new(attribute => value2))
+        Sunspot.commit
+      end
+
+      before :each do
+        @search = Sunspot.search(Post) do
+          facet(field)
+        end
+      end
+
+      it "should return value #{value1.inspect} with count 2" do
+        row = @search.facet(field).rows[0]
+        row.value.should == value1
+        row.count.should == 2
+      end
+
+      it "should return value #{value2.inspect} with count 1" do
+        row = @search.facet(field).rows[1]
+        row.value.should == value2
+        row.count.should == 1
+      end
+    end
+  end
+
+  test_field_type('String', :title, :title, 'Title 1', 'Title 2')
+  test_field_type('Integer', :blog_id, :blog_id, 3, 4)
+  test_field_type('Float', :ratings_average, :average_rating, 2.2, 1.1)
+  test_field_type('Time', :published_at, :published_at, Time.mktime(2008, 02, 17, 17, 45, 04),
+                                                        Time.mktime(2008, 07, 02, 03, 56, 22))
+  test_field_type('Boolean', :featured, :featured, true, false)
+
+  context 'facet options' do
+    before :all do
+      Sunspot.remove_all
+      facet_values = %w(zero one two three four)
+      facet_values.each_with_index do |value, i|
+        i.times { Sunspot.index(Post.new(:title => value, :blog_id => 1)) }
+      end
+      Sunspot.index(Post.new(:title => 'zero', :blog_id => 2))
+      Sunspot.commit
+    end
+
+    it 'should limit the number of facet rows' do
+      search = Sunspot.search(Post) do
+        facet :title, :limit => 3
+      end
+      search.facet(:title).should have(3).rows
+    end
+
+    it 'should not return zeros by default' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title
+      end
+      search.facet(:title).rows.map { |row| row.value }.should_not include('zero')
+    end
+
+    it 'should return zeros when specified' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :zeros => true
+      end
+      search.facet(:title).rows.map { |row| row.value }.should include('zero')
+    end
+
+    it 'should return a specified minimum count' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :minimum_count => 2
+      end
+      search.facet(:title).rows.map { |row| row.value }.should == %w(four three two)
+    end
+
+    it 'should order facets lexically' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :sort => :index
+      end
+      search.facet(:title).rows.map { |row| row.value }.should == %w(four one three two)
+    end
+
+    it 'should order facets by count' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :sort => :count
+      end
+      search.facet(:title).rows.map { |row| row.value }.should == %w(four three two one)
+    end
+  end
+
+  context 'date facets' do
+    before :all do
+      Sunspot.remove_all
+      time = Time.utc(2009, 7, 8)
+      Sunspot.index!(
+        (0..2).map { |i| Post.new(:published_at => time + i*60*60*16) }
+      )
+    end
+
+    it 'should return time ranges' do
+      time = Time.utc(2009, 7, 8)
+      search = Sunspot.search(Post) do
+        facet :published_at, :time_range => time..(time + 60*60*24*2), :sort => :count
+      end
+      search.facet(:published_at).rows.first.value.should == (time..(time + 60*60*24))
+      search.facet(:published_at).rows.first.count.should == 2
+      search.facet(:published_at).rows.last.value.should == ((time + 60*60*24)..(time + 60*60*24*2))
+      search.facet(:published_at).rows.last.count.should == 1
+    end
+  end
+
+  context 'class facets' do
+    before :all do
+      Sunspot.remove_all
+      Sunspot.index!(Post.new, Post.new, Namespaced::Comment.new)
+    end
+
+    it 'should return classes' do
+      search = Sunspot.search(Post, Namespaced::Comment) do
+        facet(:class, :sort => :count)
+      end
+      search.facet(:class).rows.first.value.should == Post
+      search.facet(:class).rows.first.count.should == 2
+      search.facet(:class).rows.last.value.should == Namespaced::Comment
+      search.facet(:class).rows.last.count.should == 1
+    end
+  end
+
+  context 'query facets' do
+    before :all do
+      Sunspot.remove_all
+      Sunspot.index!(
+        [1.1, 1.2, 3.2, 3.4, 3.9, 4.1].map do |rating|
+          Post.new(:ratings_average => rating)
+        end
+      )
+    end
+
+    it 'should return specified facets' do
+      search = Sunspot.search(Post) do
+        facet :rating_range, :sort => :count do
+          for rating in [1.0, 2.0, 3.0, 4.0]
+            range = rating..(rating + 1.0)
+            row range do
+              with :average_rating, rating..(rating + 1.0)
+            end
+          end
+        end
+      end
+      facet = search.facet(:rating_range)
+      facet.rows[0].value.should == (3.0..4.0)
+      facet.rows[0].count.should == 3
+      facet.rows[1].value.should == (1.0..2.0)
+      facet.rows[1].count.should == 2
+      facet.rows[2].value.should == (4.0..5.0)
+      facet.rows[2].count.should == 1
+    end
+  end
+end

data/spec/integration/highlighting_spec.rb

@@ -0,0 +1,22 @@
+describe 'keyword highlighting' do
+  before :all do
+    @posts = []
+    @posts << Post.new(:body => 'And the fox laughed')
+    @posts << Post.new(:body => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit', :blog_id => 1)
+    Sunspot.index!(*@posts)
+    @search_result = Sunspot.search(Post) { keywords 'fox', :highlight => true }
+  end
+  
+  it 'should include highlights in the results' do
+    @search_result.hits.first.highlights.length.should == 1
+  end
+  
+  it 'should return formatted highlight fragments' do
+    @search_result.hits.first.highlights(:body).first.format.should == 'And the <em>fox</em> laughed'
+  end
+  
+  it 'should be empty for non-keyword searches' do
+    search_result = Sunspot.search(Post){ with :blog_id, 1 }
+    search_result.hits.first.highlights.should be_empty
+  end
+end