ruben-sunspot 1.1.0

data/spec/api/query/function_spec.rb

@@ -0,0 +1,70 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'function query' do
+  it "should send query to solr with boost function" do
+    session.search Post do
+      keywords('pizza') do
+        boost(function { :average_rating })
+      end
+    end
+    connection.should have_last_search_boosted('average_rating_ft', 'pizza')
+  end
+
+  it "should handle boost function with constant float" do
+    session.search Post do
+      keywords('pizza') do
+        boost(function { 10.5 })
+      end
+    end
+    connection.should have_last_search_boosted('10.5', 'pizza')
+  end
+
+  it "should handle boost function with time literal" do
+    session.search Post do
+      keywords('pizza') do
+        boost(function { Time.parse('2010-03-25 14:13:00 EDT') })
+      end
+    end
+    connection.should have_last_search_boosted('2010-03-25T18:13:00Z', 'pizza')
+  end
+ 
+  it "should handle arbitrary functions in a function query block" do
+    session.search Post do
+      keywords('pizza') do
+        boost(function { product(:average_rating, 10) })
+      end
+    end
+    connection.should have_last_search_boosted('product(average_rating_ft,10)', 'pizza')
+  end
+ 
+  it "should handle nested functions in a function query block" do
+    session.search Post do
+      keywords('pizza') do
+        boost(function { product(:average_rating, sum(:average_rating, 20)) })
+      end
+    end
+    connection.should have_last_search_boosted('product(average_rating_ft,sum(average_rating_ft,20))', 'pizza')
+  end
+
+  # TODO SOLR 1.5
+  it "should raise ArgumentError if string literal passed" do
+    lambda do
+      session.search Post do
+        keywords('pizza') do
+          boost(function { "hello world" })
+        end
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it "should raise UnrecognizedFieldError if bogus field name passed" do
+    lambda do
+      session.search Post do
+        keywords('pizza') do
+          boost(function { :bogus })
+        end
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+end
+

data/spec/api/query/highlighting_examples.rb

@@ -0,0 +1,225 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+shared_examples_for "query with highlighting support" do
+  it 'should not send highlight parameter when highlight not requested' do
+    search do
+      keywords 'test'
+    end
+    connection.should_not have_last_search_with(:hl)
+  end
+
+  it 'should enable highlighting when highlighting requested as keywords argument' do
+    search do
+      keywords 'test', :highlight => true
+    end
+    connection.should have_last_search_with(:hl => 'on')
+  end
+
+  it 'should not set highlight fields parameter if highlight fields are not passed' do
+    search do
+      keywords 'test', :highlight => true, :fields => [:title]
+    end
+    connection.should_not have_last_search_with(:'hl.fl')
+  end
+
+  it 'should enable highlighting on multiple fields when highlighting requested as array of fields via keywords argument' do
+    search do
+      keywords 'test', :highlight => [:title, :body]
+    end
+
+    connection.should have_last_search_with(:hl => 'on', :'hl.fl' => %w(title_text body_textsv))
+  end
+
+  it 'should raise UnrecognizedFieldError if try to highlight unexisting field via keywords argument' do
+    lambda {
+      search do
+        keywords 'test', :highlight => [:unknown_field]
+      end
+    }.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'should enable highlighting on multiple fields when highlighting requested as list of fields via block call' do
+    search do
+      keywords 'test' do
+        highlight :title, :body
+      end
+    end
+
+    connection.should have_last_search_with(:hl => 'on', :'hl.fl' => %w(title_text body_textsv))
+  end
+
+  it 'should enable highlighting on multiple fields for multiple search types' do
+    session.search(Post, Namespaced::Comment) do
+      keywords 'test' do
+        highlight :body
+      end
+    end
+    connection.searches.last[:'hl.fl'].to_set.should == Set['body_text', 'body_textsv']
+  end
+
+  it 'should raise UnrecognizedFieldError if try to highlight unexisting field via block call' do
+    lambda {
+      search do
+        keywords 'test' do
+          highlight :unknown_field
+        end
+      end
+    }.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'should set internal formatting' do
+    search do
+      keywords 'test', :highlight => true
+    end
+    connection.should have_last_search_with(
+      :"hl.simple.pre" => '@@@hl@@@',
+      :"hl.simple.post" => '@@@endhl@@@'
+    )
+  end
+
+  it 'should set highlight fields from DSL' do
+    search do
+      keywords 'test' do
+        highlight :title
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.fl" => %w(title_text)
+    )
+  end
+
+  it 'should not set formatting params specific to fields if fields specified' do
+    search do
+      keywords 'test', :highlight => :body
+    end
+    connection.should have_last_search_with(
+      :"hl.simple.pre" => '@@@hl@@@',
+      :"hl.simple.post" => '@@@endhl@@@'
+    )
+  end
+
+  it 'should set maximum highlights per field' do
+    search do
+      keywords 'test' do
+        highlight :max_snippets => 3
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.snippets" => 3
+    )
+  end
+
+  it 'should set max snippets specific to highlight fields' do
+    search do
+      keywords 'test' do
+        highlight :title, :max_snippets => 3
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.fl"       => %w(title_text),
+      :"f.title_text.hl.snippets" => 3
+    )
+  end
+
+  it 'should set the maximum size' do
+    search do
+      keywords 'text' do
+        highlight :fragment_size => 200
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.fragsize" => 200
+    )
+  end
+
+  it 'should set the maximum size for specific fields' do
+    search do
+      keywords 'text' do
+        highlight :title, :fragment_size => 200
+      end
+    end
+    connection.should have_last_search_with(
+      :"f.title_text.hl.fragsize" => 200
+    )
+  end
+
+  it 'enables merging of contiguous fragments' do
+    search do
+      keywords 'test' do
+        highlight :merge_contiguous_fragments => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.mergeContiguous" => 'true'
+    )
+  end
+
+  it 'enables merging of contiguous fragments for specific fields' do
+    search do
+      keywords 'test' do
+        highlight :title, :merge_contiguous_fragments => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"f.title_text.hl.mergeContiguous" => 'true'
+    )
+  end
+
+  it 'enables use of phrase highlighter' do
+    search do
+      keywords 'test' do
+        highlight :phrase_highlighter => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.usePhraseHighlighter" => 'true'
+    )
+  end
+
+  it 'enables use of phrase highlighter for specific fields' do
+    search do
+      keywords 'test' do
+        highlight :title, :phrase_highlighter => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"f.title_text.hl.usePhraseHighlighter" => 'true'
+    )
+  end
+
+  it 'requires field match if requested' do
+    search do
+      keywords 'test' do
+        highlight :phrase_highlighter => true, :require_field_match => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.requireFieldMatch" => 'true'
+    )
+  end
+
+  it 'requires field match for specified field if requested' do
+    search do
+      keywords 'test' do
+        highlight :title, :phrase_highlighter => true, :require_field_match => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"f.title_text.hl.requireFieldMatch" => 'true'
+    )
+  end
+
+  it 'sets field specific params for different fields if different params given' do
+    search do
+      keywords 'test' do
+        highlight :title, :max_snippets => 2
+        highlight :body, :max_snippets => 1
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.fl" => %w(title_text body_textsv),
+      :"f.title_text.hl.snippets" => 2,
+      :"f.body_textsv.hl.snippets" => 1
+    )
+  end
+end

data/spec/api/query/local_examples.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+shared_examples_for "spatial query" do
+  it 'sends lat and lng, and distance when geo search is performed' do
+    search do
+      near [40.7, -73.5], :distance => 5
+    end
+    connection.should have_last_search_with(:spatial => "{!radius=5}40.7,-73.5")
+  end
+
+  it 'sets lat, lng, and sort flag when sorted geo search is performed' do
+    search do
+      near [40.7, -73.5], :sort => true
+    end
+    connection.should have_last_search_with(:spatial => "{!sort=true}40.7,-73.5")
+  end
+
+  it 'sets radius and sort when both are specified' do
+    search do
+      near [40.7, -73.5], :distance => 5, :sort => true
+    end
+    connection.should have_last_search_with(:spatial => "{!radius=5 sort=true}40.7,-73.5")
+  end
+
+  [
+    [:lat, :lng],
+    [:lat, :lon],
+    [:lat, :long],
+    [:latitude, :longitude]
+  ].each do |lat_attr, lng_attr|
+    it "sets coordinates using #{lat_attr.inspect}, #{lng_attr.inspect}" do
+      search do
+        near OpenStruct.new(lat_attr => 40.7, lng_attr => -73.5), :distance => 5
+      end
+      connection.should have_last_search_with(:spatial => "{!radius=5}40.7,-73.5")
+    end
+  end
+end

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