sunspot 1.0.5 → 1.1.0

data/spec/api/query/more_like_this_spec.rb

@@ -0,0 +1,140 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'more_like_this' do
+  before :each do
+    connection.expected_handler = :mlt
+  end
+
+  it_should_behave_like "scoped query"
+  it_should_behave_like "facetable query"
+  it_should_behave_like "query with advanced manipulation"
+  it_should_behave_like "query with connective scope"
+  it_should_behave_like "query with dynamic field support"
+  it_should_behave_like "sortable query"
+  it_should_behave_like "query with text field scoping"
+
+  it 'should query passed in object' do
+    p = Post.new
+    session.more_like_this(p)
+    connection.should have_last_search_with(:q => "id:Post\\ #{p.id}")
+  end
+
+  it 'should use more_like_this fields if no fields specified' do
+    session.more_like_this(Post.new)
+    connection.searches.last[:"mlt.fl"].split(',').sort.should == %w(body_textsv tags_textv)
+  end
+
+  it 'should use more_like_this fields if specified' do
+    session.more_like_this(Post.new) do
+      fields :body
+    end
+    connection.should have_last_search_with(:"mlt.fl" => "body_textsv")
+  end
+
+  it 'assigns boosts to fields when specified' do
+    session.more_like_this(Post.new) do
+      fields :body, :tags => 8
+    end
+    connection.searches.last[:"mlt.fl"].split(',').sort.should == %w(body_textsv tags_textv)
+    connection.should have_last_search_with(:qf => "tags_textv^8")
+  end
+
+  it 'doesn\'t assign boosts to fields when not specified' do
+    session.more_like_this(Post.new) do
+      fields :body
+    end
+    connection.should_not have_last_search_with(:qf)
+  end
+
+  it 'should raise ArgumentError if a field is not setup for more_like_this' do
+    lambda do
+      session.more_like_this(Post.new) do
+        fields :title
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it 'should accept options' do
+    session.more_like_this(Post.new) do
+      minimum_term_frequency 1
+      minimum_document_frequency 2
+      minimum_word_length 3
+      maximum_word_length 4
+      maximum_query_terms 5
+      boost_by_relevance false
+    end
+    connection.should have_last_search_with(:"mlt.mintf" => 1)
+    connection.should have_last_search_with(:"mlt.mindf" => 2)
+    connection.should have_last_search_with(:"mlt.minwl" => 3)
+    connection.should have_last_search_with(:"mlt.maxwl" => 4)
+    connection.should have_last_search_with(:"mlt.maxqt" => 5)
+    connection.should have_last_search_with(:"mlt.boost" => false)
+  end
+
+  it 'should accept short options' do
+    session.more_like_this(Post.new) do
+      mintf 1
+      mindf 2
+      minwl 3
+      maxwl 4
+      maxqt 5
+      boost true
+    end
+    connection.should have_last_search_with(:"mlt.mintf" => 1)
+    connection.should have_last_search_with(:"mlt.mindf" => 2)
+    connection.should have_last_search_with(:"mlt.minwl" => 3)
+    connection.should have_last_search_with(:"mlt.maxwl" => 4)
+    connection.should have_last_search_with(:"mlt.maxqt" => 5)
+    connection.should have_last_search_with(:"mlt.boost" => true)
+  end
+
+  it 'paginates using default per_page when page not provided' do
+    session.more_like_this(Post.new)
+    connection.should have_last_search_with(:rows => 30)
+  end
+
+  it 'paginates using default per_page when page provided' do
+    session.more_like_this(Post.new) do
+      paginate :page => 2
+    end
+    connection.should have_last_search_with(:rows => 30, :start => 30)
+  end
+
+  it 'paginates using provided per_page' do
+    session.more_like_this(Post.new) 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.more_like_this(Post.new) do
+      paginate :per_page => 15
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 0)
+  end
+
+  it 'paginates from string argument' do
+    session.more_like_this(Post.new) do
+      paginate :page => '3', :per_page => '15'
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 30)
+  end
+
+  it "should send query to solr with adjusted parameters (keyword example)" do
+    session.more_like_this(Post.new) do
+      adjust_solr_params do |params|
+        params[:q]    = 'new search'
+        params[:some] = 'param'
+      end
+    end
+    connection.should have_last_search_with(:q    => 'new search')
+    connection.should have_last_search_with(:some => 'param')
+  end
+
+  private
+
+  def search(*args, &block)
+    session.more_like_this(Post.new, *args, &block)
+  end
+end

data/spec/api/query/{ordering_pagination_spec.rb → ordering_pagination_examples.rb}

@@ -1,63 +1,63 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
-describe 'ordering and pagination' do
+shared_examples_for 'sortable query' do
   it 'paginates using default per_page when page not provided' do
-    session.search Post
+    search
     connection.should have_last_search_with(:rows => 30)
   end
 
   it 'paginates using default per_page when page provided' do
-    session.search Post do
+    search 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
+    search 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
+    search 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
+    search 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
+    search do
       order_by :average_rating, :desc
     end
-    connection.should have_last_search_with(:sort => 'average_rating_f desc')
+    connection.should have_last_search_with(:sort => 'average_rating_ft desc')
   end
 
   it 'orders by multiple fields' do
-    session.search Post do
+    search 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')
+    connection.should have_last_search_with(:sort => 'average_rating_ft desc, sort_title_s asc')
   end
 
   it 'orders by random' do
-    session.search Post do
+    search do
       order_by :random
     end
     connection.searches.last[:sort].should =~ /^random_\d+ asc$/
   end
 
   it 'orders by score' do
-    session.search Post do
+    search do
       order_by :score, :desc
     end
     connection.should have_last_search_with(:sort => 'score desc')
@@ -65,7 +65,7 @@ describe 'ordering and pagination' do
 
   it 'throws an ArgumentError if a bogus order direction is given' do
     lambda do
-      session.search Post do
+      search do
         order_by :sort_title, :sideways
       end
     end.should raise_error(ArgumentError)
@@ -73,7 +73,7 @@ describe 'ordering and pagination' do
 
   it 'throws an UnrecognizedFieldError if :distance is given for sort' do
     lambda do
-      session.search Post do
+      search do
         order_by :distance, :asc
       end
     end.should raise_error(Sunspot::UnrecognizedFieldError)
@@ -81,7 +81,7 @@ describe 'ordering and pagination' do
 
   it 'does not allow ordering by multiple-value fields' do
     lambda do
-      session.search Post do
+      search do
         order_by :category_ids
       end
     end.should raise_error(ArgumentError)
@@ -89,7 +89,7 @@ describe 'ordering and pagination' do
 
   it 'raises ArgumentError if bogus argument given to paginate' do
     lambda do
-      session.search Post do
+      search do
         paginate :page => 4, :ugly => :puppy
       end
     end.should raise_error(ArgumentError)

data/spec/api/query/{scope_spec.rb → scope_examples.rb}

@@ -1,22 +1,13 @@
-require File.join(File.dirname(__FILE__), 'spec_helper')
-
-describe 'scoped query', :type => :query do
-  it 'adds a no-op query to :q parameter when no :q provided' do
-    session.search Post do
-      with :title, 'My Pet Post'
-    end
-    connection.should have_last_search_with(:q => '*:*')
-  end
-
+shared_examples_for "scoped query" do
   it 'scopes by exact match with a string' do
-    session.search Post do
+    search do
       with :title, 'My Pet Post'
     end
     connection.should have_last_search_including(:fq, 'title_ss:My\ Pet\ Post')
   end
 
   it 'scopes by exact match with a special string' do
-    session.search Post do
+    search do
       with :title, 'OR'
     end
     connection.should have_last_search_including(:fq, 'title_ss:"OR"')
@@ -24,18 +15,18 @@ describe 'scoped query', :type => :query do
 
   it 'scopes by exact match with time' do
     time = Time.parse('1983-07-08 05:00:00 -0400')
-    session.search Post do
+    search do
       with :published_at, time
     end
     connection.should have_last_search_including(
       :fq,
-      'published_at_d:1983\-07\-08T09\:00\:00Z'
+      'published_at_dt:1983\-07\-08T09\:00\:00Z'
     )
   end
 
   it 'scopes by exact match with date' do
     date = Date.new(1983, 7, 8)
-    session.search Post do
+    search do
       with :expire_date, date
     end
     connection.should have_last_search_including(
@@ -45,148 +36,148 @@ describe 'scoped query', :type => :query do
   end
   
   it 'scopes by exact match with boolean' do
-    session.search Post do
+    search do
       with :featured, false
     end
     connection.should have_last_search_including(:fq, 'featured_b:false')
   end
 
   it 'scopes by less than match with float' do
-    session.search Post do
+    search do
       with(:average_rating).less_than 3.0
     end
-    connection.should have_last_search_including(:fq, 'average_rating_f:[* TO 3\.0]')
+    connection.should have_last_search_including(:fq, 'average_rating_ft:[* TO 3\.0]')
   end
 
   it 'should quote string with space in a less than match' do
-    session.search Post do
+    search do
       with(:title).less_than('test value')
     end
     connection.should have_last_search_including(:fq, 'title_ss:[* TO "test\ value"]')
   end
 
   it 'scopes by greater than match with float' do
-    session.search Post do
+    search do
       with(:average_rating).greater_than 3.0
     end
-    connection.should have_last_search_including(:fq, 'average_rating_f:[3\.0 TO *]')
+    connection.should have_last_search_including(:fq, 'average_rating_ft:[3\.0 TO *]')
   end
 
   it 'scopes by short-form between match with integers' do
-    session.search Post do
+    search do
       with :blog_id, 2..4
     end
     connection.should have_last_search_including(:fq, 'blog_id_i:[2 TO 4]')
   end
 
   it 'scopes by between match with float' do
-    session.search Post do
+    search do
       with(:average_rating).between 2.0..4.0
     end
-    connection.should have_last_search_including(:fq, 'average_rating_f:[2\.0 TO 4\.0]')
+    connection.should have_last_search_including(:fq, 'average_rating_ft:[2\.0 TO 4\.0]')
   end
 
   it 'automatically sorts ranges in between matches' do
-    session.search Post do
+    search do
       with(:blog_id).between(4..2)
     end
     connection.should have_last_search_including(:fq, 'blog_id_i:[2 TO 4]')
   end
 
   it 'scopes by any match with integer' do
-    session.search Post do
+    search do
       with(:category_ids).any_of [2, 7, 12]
     end
     connection.should have_last_search_including(: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
+    search do
       with :category_ids, [2, 7, 12]
     end
     connection.should have_last_search_including(:fq, 'category_ids_im:(2 OR 7 OR 12)')
   end
 
   it 'scopes by all match with integer' do
-    session.search Post do
+    search do
       with(:category_ids).all_of [2, 7, 12]
     end
     connection.should have_last_search_including(:fq, 'category_ids_im:(2 AND 7 AND 12)')
   end
 
   it 'scopes by prefix match with string' do
-    session.search Post do
+    search do
       with(:title).starting_with('tes')
     end
     connection.should have_last_search_including(:fq, 'title_ss:tes*')
   end
 
   it 'scopes by not equal match with string' do
-    session.search Post do
+    search do
       without :title, 'Bad Post'
     end
     connection.should have_last_search_including(:fq, '-title_ss:Bad\ Post')
   end
 
   it 'scopes by not less than match with float' do
-    session.search Post do
+    search do
       without(:average_rating).less_than 3.0
     end
-    connection.should have_last_search_including(:fq, '-average_rating_f:[* TO 3\.0]')
+    connection.should have_last_search_including(:fq, '-average_rating_ft:[* TO 3\.0]')
   end
 
   it 'scopes by not greater than match with float' do
-    session.search Post do
+    search do
       without(:average_rating).greater_than 3.0
     end
-    connection.should have_last_search_including(:fq, '-average_rating_f:[3\.0 TO *]')
+    connection.should have_last_search_including(:fq, '-average_rating_ft:[3\.0 TO *]')
   end
   
   it 'scopes by not between match with shorthand' do
-    session.search Post do
+    search do
       without(:blog_id, 2..4)
     end
     connection.should have_last_search_including(:fq, '-blog_id_i:[2 TO 4]')
   end
 
   it 'scopes by not between match with float' do
-    session.search Post do
+    search do
       without(:average_rating).between 2.0..4.0
     end
-    connection.should have_last_search_including(:fq, '-average_rating_f:[2\.0 TO 4\.0]')
+    connection.should have_last_search_including(:fq, '-average_rating_ft:[2\.0 TO 4\.0]')
   end
 
   it 'scopes by not any match with integer' do
-    session.search Post do
+    search do
       without(:category_ids).any_of [2, 7, 12]
     end
     connection.should have_last_search_including(:fq, '-category_ids_im:(2 OR 7 OR 12)')
   end
 
   it 'scopes by not all match with integer' do
-    session.search Post do
+    search do
       without(:category_ids).all_of [2, 7, 12]
     end
     connection.should have_last_search_including(:fq, '-category_ids_im:(2 AND 7 AND 12)')
   end
 
   it 'scopes by empty field' do
-    session.search Post do
+    search do
       with :average_rating, nil
     end
-    connection.should have_last_search_including(:fq, '-average_rating_f:[* TO *]')
+    connection.should have_last_search_including(:fq, '-average_rating_ft:[* TO *]')
   end
 
   it 'scopes by non-empty field' do
-    session.search Post do
+    search do
       without :average_rating, nil
     end
-    connection.should have_last_search_including(:fq, 'average_rating_f:[* TO *]')
+    connection.should have_last_search_including(:fq, 'average_rating_ft:[* TO *]')
   end
 
   it 'excludes by object identity' do
     post = Post.new
-    session.search Post do
+    search do
       without post
     end
     connection.should have_last_search_including(:fq, "-id:Post\\ #{post.id}")
@@ -194,7 +185,7 @@ describe 'scoped query', :type => :query do
 
   it 'excludes multiple objects passed as varargs by object identity' do
     post1, post2 = Post.new, Post.new
-    session.search Post do
+    search do
       without post1, post2
     end
     connection.should have_last_search_including(
@@ -206,7 +197,7 @@ describe 'scoped query', :type => :query do
 
   it 'excludes multiple objects passed as array by object identity' do
     posts = [Post.new, Post.new]
-    session.search Post do
+    search do
       without posts
     end
     connection.should have_last_search_including(
@@ -218,14 +209,14 @@ describe 'scoped query', :type => :query do
 
   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
+    search Post, Namespaced::Comment do
       with :published_at, time
     end
-    connection.should have_last_search_including(:fq, 'published_at_d:1983\-07\-08T09\:00\:00Z')
+    connection.should have_last_search_including(:fq, 'published_at_dt:1983\-07\-08T09\:00\:00Z')
   end
 
   it 'allows scoping on field not common to all types' do
-    session.search Post, Namespaced::Comment do
+    search Post, Namespaced::Comment do
       with :blog_id, 1
     end
     connection.should have_last_search_including(:fq, 'blog_id_i:1')
@@ -233,23 +224,15 @@ describe 'scoped query', :type => :query do
 
   it 'raises Sunspot::UnrecognizedFieldError if search scoped to field configured differently between types' do
     lambda do
-      session.search Post, Namespaced::Comment do
+      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
+      search do
         with :bogus, 'Field'
       end
     end.should raise_error(Sunspot::UnrecognizedFieldError)
@@ -257,7 +240,7 @@ describe 'scoped query', :type => :query do
 
   it 'raises NoMethodError if bogus operator referenced' do
     lambda do
-      session.search Post do
+      search do
         with(:category_ids).resembling :bogus_condition
       end
     end.should raise_error(NoMethodError)
@@ -265,7 +248,7 @@ describe 'scoped query', :type => :query do
 
   it 'should raise ArgumentError if more than two arguments passed to scope method' do
     lambda do
-      session.search Post do
+      search do
         with(:category_ids, 4, 5)
       end
     end.should raise_error(ArgumentError)

data/spec/api/query/standard_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+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 dynamic field support"
+  it_should_behave_like "facetable query"
+  it_should_behave_like "fulltext query"
+  it_should_behave_like "query with highlighting support"
+  it_should_behave_like "sortable query"
+  it_should_behave_like "spatial query"
+  it_should_behave_like "query with text field scoping"
+
+  it 'adds a no-op query to :q parameter when no :q provided' do
+    session.search Post do
+      with :title, 'My Pet Post'
+    end
+    connection.should have_last_search_with(:q => '*:*')
+  end
+
+  private
+
+  def search(*classes, &block)
+    classes[0] ||= Post
+    session.search(*classes, &block)
+  end
+end

data/spec/api/query/{text_field_scoping_spec.rb → text_field_scoping_examples.rb}

@@ -1,16 +1,16 @@
-describe 'scoping with text fields', :type => :query do
+shared_examples_for 'query with text field scoping' do
   it 'should scope with a text field' do
-    session.search(Post) do
+    search do
       text_fields do
         with(:body, 'test')
       end
     end
-    connection.should have_last_search_including(:fq, 'body_texts:test')
+    connection.should have_last_search_including(:fq, 'body_textsv:test')
   end
 
   it 'should raise an UnrecognizedFieldError if differently configured text field is used' do
     lambda do
-      session.search(Post, Namespaced::Comment) do
+      search(Post, Namespaced::Comment) do
         text_fields do
           with(:body, 'test')
         end
@@ -20,7 +20,7 @@ describe 'scoping with text fields', :type => :query do
 
   it 'should raise an UnrecognizedFieldError if no field exists' do
     lambda do
-      session.search(Post) do
+      search do
         text_fields do
           with(:bogus, 'test')
         end

data/spec/api/search/dynamic_fields_spec.rb

@@ -7,6 +7,12 @@ describe 'search with dynamic fields' do
     result.facet(:custom_string, :test).rows.map { |row| row.value }.should == ['two', 'one']
   end
 
+  it 'returns dynamic field facet with custom label' do
+    stub_facet(:"bogus", 'two' => 2, 'one' => 1)
+    result = session.search(Post) { dynamic(:custom_string) { facet(:test, :name => :bogus) }}
+    result.facet(:bogus).rows.map { |row| row.value }.should == ['two', 'one']
+  end
+
   it 'returns query facet specified in dynamic call' do
     stub_query_facet(
       'custom_string\:test_ss:(foo OR bar)' => 3