benjaminkrause-sunspot 0.9.7

data/spec/api/query/ordering_pagination_spec.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'ordering and pagination' do
+  it 'paginates using default per_page when page not provided' do
+    session.search Post
+    connection.should have_last_search_with(:rows => 30)
+  end
+
+  it 'paginates using default per_page when page provided' do
+    session.search Post do
+      paginate :page => 2
+    end
+    connection.should have_last_search_with(:rows => 30, :start => 30)
+  end
+
+  it 'paginates using provided per_page' do
+    session.search Post do
+      paginate :page => 4, :per_page => 15
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 45)
+  end
+
+  it 'defaults to page 1 if no :page argument given' do
+    session.search Post do
+      paginate :per_page => 15
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 0)
+  end
+
+  it 'paginates from string argument' do
+    session.search Post do
+      paginate :page => '3', :per_page => '15'
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 30)
+  end
+
+  it 'orders by a single field' do
+    session.search Post do
+      order_by :average_rating, :desc
+    end
+    connection.should have_last_search_with(:sort => 'average_rating_f desc')
+  end
+
+  it 'orders by multiple fields' do
+    session.search Post do
+      order_by :average_rating, :desc
+      order_by :sort_title, :asc
+    end
+    connection.should have_last_search_with(:sort => 'average_rating_f desc, sort_title_s asc')
+  end
+
+  it 'orders by random' do
+    session.search Post do
+      order_by :random
+    end
+    connection.searches.last[:sort].should =~ /^random_\d+ asc$/
+  end
+
+  it 'orders by score' do
+    session.search Post do
+      order_by :score, :desc
+    end
+    connection.should have_last_search_with(:sort => 'score desc')
+  end
+
+  it 'orders by geo distance' do
+    session.search Post do
+      order_by :distance, :asc
+    end
+  end
+
+  it 'throws an ArgumentError if a bogus order direction is given' do
+    lambda do
+      session.search Post do
+        order_by :sort_title, :sideways
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it 'does not allow ordering by multiple-value fields' do
+    lambda do
+      session.search Post do
+        order_by :category_ids
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it 'raises ArgumentError if bogus argument given to paginate' do
+    lambda do
+      session.search Post do
+        paginate :page => 4, :ugly => :puppy
+      end
+    end.should raise_error(ArgumentError)
+  end
+end

data/spec/api/query/scope_spec.rb

@@ -0,0 +1,253 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'scoped query', :type => :query do
+  it 'scopes by exact match with a string' do
+    session.search Post do
+      with :title, 'My Pet Post'
+    end
+    connection.should have_last_search_with(:fq => ['title_ss:My\ Pet\ Post'])
+  end
+
+  it 'scopes by exact match with time' do
+    time = Time.parse('1983-07-08 05:00:00 -0400')
+    session.search Post do
+      with :published_at, time
+    end
+    connection.should have_last_search_with(
+      :fq => ['published_at_d:1983\-07\-08T09\:00\:00Z']
+    )
+  end
+
+  it 'scopes by exact match with date' do
+    date = Date.new(1983, 7, 8)
+    session.search Post do
+      with :expire_date, date
+    end
+    connection.should have_last_search_with(
+      :fq => ['expire_date_d:1983\-07\-08T00\:00\:00Z']
+    )
+  end
+  
+  it 'scopes by exact match with boolean' do
+    session.search Post do
+      with :featured, false
+    end
+    connection.should have_last_search_with(:fq => ['featured_b:false'])
+  end
+
+  it 'scopes by less than match with float' do
+    session.search Post do
+      with(:average_rating).less_than 3.0
+    end
+    connection.should have_last_search_with(:fq => ['average_rating_f:[* TO 3\.0]'])
+  end
+
+  it 'should quote string with space in a less than match' do
+    session.search Post do
+      with(:title).less_than('test value')
+    end
+    connection.should have_last_search_with(:fq => ['title_ss:[* TO "test\ value"]'])
+  end
+
+  it 'scopes by greater than match with float' do
+    session.search Post do
+      with(:average_rating).greater_than 3.0
+    end
+    connection.should have_last_search_with(:fq => ['average_rating_f:[3\.0 TO *]'])
+  end
+
+  it 'scopes by short-form between match with integers' do
+    session.search Post do
+      with :blog_id, 2..4
+    end
+    connection.should have_last_search_with(:fq => ['blog_id_i:[2 TO 4]'])
+  end
+
+  it 'scopes by between match with float' do
+    session.search Post do
+      with(:average_rating).between 2.0..4.0
+    end
+    connection.should have_last_search_with(:fq => ['average_rating_f:[2\.0 TO 4\.0]'])
+  end
+
+  it 'automatically sorts ranges in between matches' do
+    session.search Post do
+      with(:blog_id).between(4..2)
+    end
+    connection.should have_last_search_with(:fq => ['blog_id_i:[2 TO 4]'])
+  end
+
+  it 'scopes by any match with integer' do
+    session.search Post do
+      with(:category_ids).any_of [2, 7, 12]
+    end
+    connection.should have_last_search_with(:fq => ['category_ids_im:(2 OR 7 OR 12)'])
+  end
+
+  it 'scopes by short-form any-of match with integers' do
+    session.search Post do
+      with :category_ids, [2, 7, 12]
+    end
+    connection.should have_last_search_with(:fq => ['category_ids_im:(2 OR 7 OR 12)'])
+  end
+
+  it 'scopes by all match with integer' do
+    session.search Post do
+      with(:category_ids).all_of [2, 7, 12]
+    end
+    connection.should have_last_search_with(:fq => ['category_ids_im:(2 AND 7 AND 12)'])
+  end
+
+  it 'scopes by prefix match with string' do
+    session.search Post do
+      with(:title).starting_with('tes')
+    end
+    connection.should have_last_search_with(:fq => ['title_ss:tes*'])
+  end
+
+  it 'scopes by not equal match with string' do
+    session.search Post do
+      without :title, 'Bad Post'
+    end
+    connection.should have_last_search_with(:fq => ['-title_ss:Bad\ Post'])
+  end
+
+  it 'scopes by not less than match with float' do
+    session.search Post do
+      without(:average_rating).less_than 3.0
+    end
+    connection.should have_last_search_with(:fq => ['-average_rating_f:[* TO 3\.0]'])
+  end
+
+  it 'scopes by not greater than match with float' do
+    session.search Post do
+      without(:average_rating).greater_than 3.0
+    end
+    connection.should have_last_search_with(:fq => ['-average_rating_f:[3\.0 TO *]'])
+  end
+  
+  it 'scopes by not between match with shorthand' do
+    session.search Post do
+      without(:blog_id, 2..4)
+    end
+    connection.should have_last_search_with(:fq => ['-blog_id_i:[2 TO 4]'])
+  end
+
+  it 'scopes by not between match with float' do
+    session.search Post do
+      without(:average_rating).between 2.0..4.0
+    end
+    connection.should have_last_search_with(:fq => ['-average_rating_f:[2\.0 TO 4\.0]'])
+  end
+
+  it 'scopes by not any match with integer' do
+    session.search Post do
+      without(:category_ids).any_of [2, 7, 12]
+    end
+    connection.should have_last_search_with(:fq => ['-category_ids_im:(2 OR 7 OR 12)'])
+  end
+
+  it 'scopes by not all match with integer' do
+    session.search Post do
+      without(:category_ids).all_of [2, 7, 12]
+    end
+    connection.should have_last_search_with(:fq => ['-category_ids_im:(2 AND 7 AND 12)'])
+  end
+
+  it 'scopes by empty field' do
+    session.search Post do
+      with :average_rating, nil
+    end
+    connection.should have_last_search_with(:fq => ['-average_rating_f:[* TO *]'])
+  end
+
+  it 'scopes by non-empty field' do
+    session.search Post do
+      without :average_rating, nil
+    end
+    connection.should have_last_search_with(:fq => ['average_rating_f:[* TO *]'])
+  end
+
+  it 'excludes by object identity' do
+    post = Post.new
+    session.search Post do
+      without post
+    end
+    connection.should have_last_search_with(:fq => ["-id:Post\\ #{post.id}"])
+  end
+
+  it 'excludes multiple objects passed as varargs by object identity' do
+    post1, post2 = Post.new, Post.new
+    session.search Post do
+      without post1, post2
+    end
+    connection.should have_last_search_with(
+      :fq => ["-id:Post\\ #{post1.id}", "-id:Post\\ #{post2.id}"]
+    )
+  end
+
+  it 'excludes multiple objects passed as array by object identity' do
+    posts = [Post.new, Post.new]
+    session.search Post do
+      without posts
+    end
+    connection.should have_last_search_with(
+      :fq => ["-id:Post\\ #{posts.first.id}", "-id:Post\\ #{posts.last.id}"]
+    )
+  end
+
+  it 'allows scoping on fields common to all types' do
+    time = Time.parse('1983-07-08 05:00:00 -0400')
+    session.search Post, Namespaced::Comment do
+      with :published_at, time
+    end
+    connection.should have_last_search_with(:fq => ['published_at_d:1983\-07\-08T09\:00\:00Z'])
+  end
+
+  it 'allows scoping on field not common to all types' do
+    session.search Post, Namespaced::Comment do
+      with :blog_id, 1
+    end
+    connection.should have_last_search_with(:fq => ['blog_id_i:1'])
+  end
+
+  it 'raises Sunspot::UnrecognizedFieldError if search scoped to field configured differently between types' do
+    lambda do
+      session.search Post, Namespaced::Comment do
+        with :average_rating, 2.2 # this is a float in Post but an integer in Comment
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'raises Sunspot::UnrecognizedFieldError if a text field that does not exist for any type is specified' do
+    lambda do
+      session.search Post, Namespaced::Comment do
+        keywords 'fulltext', :fields => :bogus
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'raises Sunspot::UnrecognizedFieldError for nonexistant fields in block scope' do
+    lambda do
+      session.search Post do
+        with :bogus, 'Field'
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'raises NoMethodError if bogus operator referenced' do
+    lambda do
+      session.search Post do
+        with(:category_ids).resembling :bogus_condition
+      end
+    end.should raise_error(NoMethodError)
+  end
+
+  it 'should raise ArgumentError if more than two arguments passed to scope method' do
+    lambda do
+      session.search Post do
+        with(:category_ids, 4, 5)
+      end
+    end.should raise_error(ArgumentError)
+  end
+end

data/spec/api/query/spec_helper.rb

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

data/spec/api/query/text_field_scoping_spec.rb

@@ -0,0 +1,30 @@
+describe 'scoping with text fields', :type => :query do
+  it 'should scope with a text field' do
+    session.search(Post) do
+      text_fields do
+        with(:body, 'test')
+      end
+    end
+    connection.should have_last_search_with(:fq => ['body_texts:test'])
+  end
+
+  it 'should raise an UnrecognizedFieldError if differently configured text field is used' do
+    lambda do
+      session.search(Post, Namespaced::Comment) do
+        text_fields do
+          with(:body, 'test')
+        end
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'should raise an UnrecognizedFieldError if no field exists' do
+    lambda do
+      session.search(Post) do
+        text_fields do
+          with(:bogus, 'test')
+        end
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+end

data/spec/api/query/types_spec.rb

@@ -0,0 +1,20 @@
+describe 'typed query' do
+  it 'properly escapes namespaced type names' do
+    session.search(Namespaced::Comment)
+    connection.should have_last_search_with(:q => 'type:Namespaced\:\:Comment')
+  end
+
+  it 'builds search for multiple types' do
+    session.search(Post, Namespaced::Comment)
+    connection.should have_last_search_with(:q => 'type:(Post OR Namespaced\:\:Comment)')
+  end
+
+  it 'searches type of subclass when superclass is configured' do
+    session.search PhotoPost
+    connection.should have_last_search_with(:q => 'type:PhotoPost')
+  end
+
+  it 'raises an ArgumentError if no types given to search' do
+    lambda { session.search }.should raise_error(ArgumentError)
+  end
+end

data/spec/api/search/dynamic_fields_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'search with dynamic fields' do
+  it 'returns dynamic string facet' do
+    stub_facet(:"custom_string:test_s", 'two' => 2, 'one' => 1)
+    result = session.search(Post) { dynamic(:custom_string) { facet(:test) }}
+    result.dynamic_facet(:custom_string, :test).rows.map { |row| row.value }.should == ['two', 'one']
+  end
+
+  it 'returns query facet specified in dynamic call' do
+    stub_query_facet(
+      'custom_string\:test_s:(foo OR bar)' => 3
+    )
+    search = session.search(Post) do
+      dynamic :custom_string do
+        facet :test do
+          row :foo_bar do
+            with :test, %w(foo bar)
+          end
+        end
+      end
+    end
+    facet = search.facet(:test)
+    facet.rows.first.value.should == :foo_bar
+    facet.rows.first.count.should == 3
+  end
+end

data/spec/api/search/faceting_spec.rb

@@ -0,0 +1,206 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'faceting', :type => :search do
+  it 'returns field name for facet' do
+    stub_facet(:title_ss, {})
+    result = session.search Post do
+      facet :title
+    end
+    result.facet(:title).field_name.should == :title
+  end
+
+  it 'returns string facet' do
+    stub_facet(:title_ss, 'Author 1' => 2, 'Author 2' => 1)
+    result = session.search Post do
+      facet :title
+    end
+    facet_values(result, :title).should == ['Author 1', 'Author 2']
+  end
+
+  it 'returns counts for facet' do
+    stub_facet(:title_ss, 'Author 1' => 2, 'Author 2' => 1)
+    result = session.search Post do
+      facet :title
+    end
+    facet_counts(result, :title).should == [2, 1]
+  end
+
+  it 'returns integer facet' do
+    stub_facet(:blog_id_i, '3' => 2, '1' => 1)
+    result = session.search Post do
+      facet :blog_id
+    end
+    facet_values(result, :blog_id).should == [3, 1]
+  end
+
+  it 'returns float facet' do
+    stub_facet(:average_rating_f, '9.3' => 2, '1.1' => 1)
+    result = session.search Post do
+      facet :average_rating
+    end
+    facet_values(result, :average_rating).should == [9.3, 1.1]
+  end
+
+  it 'returns time facet' do
+    stub_facet(
+      :published_at_d,
+      '2009-04-07T20:25:23Z' => 3,
+      '2009-04-07T20:26:19Z' => 1
+    )
+    result = session.search Post do
+      facet :published_at
+    end
+    facet_values(result, :published_at).should ==
+      [Time.gm(2009, 04, 07, 20, 25, 23),
+       Time.gm(2009, 04, 07, 20, 26, 19)]
+  end
+
+  it 'should return date facet' do
+    stub_facet(
+      :expire_date_d,
+      '2009-07-13T00:00:00Z' => 3,
+      '2009-04-01T00:00:00Z' => 1
+    )
+    result = session.search(Post) do
+      facet :expire_date
+    end
+    facet_values(result, :expire_date).should ==
+      [Date.new(2009, 07, 13),
+       Date.new(2009, 04, 01)]
+  end
+
+  it 'should return boolean facet' do
+    stub_facet(:featured_b, 'true' => 3, 'false' => 1)
+    result = session.search(Post) { facet(:featured) }
+    facet_values(result, :featured).should == [true, false]
+  end
+
+  it 'should return class facet' do
+    stub_facet(:class_name, 'Post' => 3, 'Namespaced::Comment' => 1)
+    result = session.search(Post) { facet(:class) }
+    facet_values(result, :class).should == [Post, Namespaced::Comment]
+  end
+
+  it 'should return date range facet' do
+    stub_date_facet(:published_at_d, 60*60*24, '2009-07-08T04:00:00Z' => 2, '2009-07-07T04:00:00Z' => 1)
+    start_time = Time.utc(2009, 7, 7, 4)
+    end_time = start_time + 2*24*60*60
+    result = session.search(Post) { facet(:published_at, :time_range => start_time..end_time) }
+    facet = result.facet(:published_at)
+    facet.rows.first.value.should == (start_time..(start_time+24*60*60))
+    facet.rows.last.value.should == ((start_time+24*60*60)..end_time)
+  end
+
+  it 'returns query facet' do
+    stub_query_facet(
+      'average_rating_f:[3\.0 TO 5\.0]' => 3,
+      'average_rating_f:[1\.0 TO 3\.0]' => 1
+    )
+    search = session.search(Post) do
+      facet :average_rating do
+        row 3.0..5.0 do
+          with :average_rating, 3.0..5.0
+        end
+        row 1.0..3.0 do
+          with :average_rating, 1.0..3.0
+        end
+      end
+    end
+    facet = search.facet(:average_rating)
+    facet.rows.first.value.should == (3.0..5.0)
+    facet.rows.first.count.should == 3
+    facet.rows.last.value.should == (1.0..3.0)
+    facet.rows.last.count.should == 1
+  end
+
+  describe 'query facet option handling' do
+    def facet_values_from_options(options = {})
+      session.search(Post) do
+        facet :average_rating, options do
+          row(1) { with(:average_rating, 1.0..2.0) }
+          row(2) { with(:average_rating, 2.0..3.0) }
+          row(3) { with(:average_rating, 3.0..4.0) }
+        end
+      end.facet(:average_rating).rows.map { |row| row.value }
+    end
+
+    before :each do
+      stub_query_facet(
+        'average_rating_f:[1\.0 TO 2\.0]' => 1,
+        'average_rating_f:[2\.0 TO 3\.0]' => 2,
+        'average_rating_f:[3\.0 TO 4\.0]' => 0
+      )
+    end
+
+    it 'sorts lexically by default if no limit is given' do
+      facet_values_from_options.should == [1, 2]
+    end
+
+    it 'sorts by count by default if limit is given' do
+      facet_values_from_options(:limit => 2).should == [2, 1]
+    end
+
+    it 'sorts by count if count option is specified' do
+      facet_values_from_options(:sort => :count).should == [2, 1]
+    end
+
+    it 'sorts lexically if lexical option is specified even if limit is given' do
+      facet_values_from_options(:sort => :index, :limit => 2).should == [1, 2]
+    end
+
+    it 'limits facets if limit option is given' do
+      facet_values_from_options(:limit => 1).should == [2]
+    end
+
+    it 'allows zero count if specified' do
+      facet_values_from_options(:zeros => true).should == [1, 2, 3]
+    end
+
+    it 'sets minimum count' do
+      facet_values_from_options(:minimum_count => 2).should == [2]
+    end
+  end
+
+  it 'returns limited field facet' do
+    stub_query_facet(
+      'category_ids_im:1' => 3,
+      'category_ids_im:3' => 1
+    )
+    search = session.search(Post) do
+      facet :category_ids, :only => [1, 3, 5]
+    end
+    facet = search.facet(:category_ids)
+    facet.rows.first.value.should == 1
+    facet.rows.first.count.should == 3
+    facet.rows.last.value.should == 3
+    facet.rows.last.count.should == 1
+  end
+
+  it 'returns instantiated facet values' do
+    blogs = Array.new(2) { Blog.new }
+    stub_facet(:blog_id_i, blogs[0].id.to_s => 2, blogs[1].id.to_s => 1)
+    search = session.search(Post) { facet(:blog_id) }
+    search.facet(:blog_id).rows.map { |row| row.instance }.should == blogs
+  end
+
+  it 'returns instantiated facet values for limited field facet' do
+    blogs = Array.new(2) { Blog.new }
+    stub_query_facet(
+      "blog_id_i:#{blogs[0].id}" => 3,
+      "blog_id_i:#{blogs[1].id}" => 1
+    )
+    search = session.search(Post) do
+      facet(:blog_id, :only => blogs.map { |blog| blog.id })
+    end
+    search.facet(:blog_id).rows.map { |row| row.instance }.should == blogs
+  end
+
+  it 'only queries the persistent store once for an instantiated facet' do
+    query_count = Blog.query_count
+    blogs = Array.new(2) { Blog.new }
+    stub_facet(:blog_id_i, blogs[0].id.to_s => 2, blogs[1].id.to_s => 1)
+    result = session.search(Post) { facet(:blog_id) }
+    result.facet(:blog_id).rows.each { |row| row.instance }
+    (Blog.query_count - query_count).should == 1
+  end
+end

data/spec/api/search/highlighting_spec.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+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 nil if a given field does not have a highlight' do
+    @search.hits.first.highlights(:body).should be_nil
+  end
+
+  it 'should format hits with <em> by default' do
+    highlight = @search.hits.first.highlights(:title).first.formatted
+    highlight.should == 'one <em>two</em> three'
+  end
+
+  it 'should format 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 'should handle 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