nuatt_sunspot 1.1.0.3

data/spec/api/query/fulltext_examples.rb

@@ -0,0 +1,315 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+shared_examples_for 'fulltext query' do
+  it 'searches by keywords' do
+    search do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:q => 'keyword search')
+  end
+
+  it 'ignores keywords if empty' do
+    search do
+      keywords ''
+    end
+    connection.should_not have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'ignores keywords if nil' do
+    search do
+      keywords nil
+    end
+    connection.should_not have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'ignores keywords with only whitespace' do
+    search do
+      keywords "  \t"
+    end
+    connection.should_not have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'gracefully ignores keywords block if keywords ignored' do
+    search do
+      keywords(nil) { fields(:title) }
+    end
+  end
+
+  it 'sets default query parser to dismax when keywords used' do
+    search do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'searches types in filter query if keywords used' do
+    search do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:fq => ['type:Post'])
+  end
+
+  describe 'with multiple keyword components' do
+    before :each do
+      session.search Post do
+        keywords 'first search', :fields => :title
+        keywords 'second search'
+      end
+    end
+
+    it 'puts specified keywords in subquery' do
+      subqueries(:q).map { |subquery| subquery[:v] }.should ==
+        ['first search', 'second search']
+    end
+
+    it 'puts specified dismax parameters in subquery' do
+      subqueries(:q).first[:qf].should == 'title_text'
+    end
+
+    it 'puts default dismax parameters in subquery' do
+      subqueries(:q).last[:qf].split(' ').sort.should == %w(backwards_title_text body_textsv tags_textv title_text)
+    end
+
+    it 'puts automatic dismax parameters in subquery' do
+      subqueries(:q).each { |subquery| subquery[:fl].should == '* score' }
+    end
+  end
+
+  it 'searches all text fields for searched class' do
+    search = search do
+      keywords 'keyword search'
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(backwards_title_text body_textsv tags_textv title_text)
+  end
+
+  it 'searches both stored and unstored text fields' do
+    search Post, Namespaced::Comment do
+      keywords 'keyword search'
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(author_name_text backwards_title_text body_text body_textsv tags_textv title_text)
+  end
+
+  it 'searches only specified text fields when specified' do
+    search do
+      keywords 'keyword search', :fields => [:title, :body]
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_textsv title_text)
+  end
+
+  it 'excludes text fields when instructed' do
+    search do
+      keywords 'keyword search' do
+        exclude_fields :backwards_title, :body_mlt
+      end
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_textsv tags_textv title_text)
+  end
+
+  it 'assigns boost to fields when specified' do
+    search do
+      keywords 'keyword search' do
+        fields :title => 2.0, :body => 0.75
+      end
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_textsv^0.75 title_text^2.0)
+  end
+
+  it 'allows assignment of boosted and unboosted fields' do
+    search do
+      keywords 'keyword search' do
+        fields :body, :title => 2.0
+      end
+    end
+  end
+
+  it 'searches both unstored and stored text field with same name when specified' do
+    search Post, Namespaced::Comment do
+      keywords 'keyword search', :fields => [:body]
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_text body_textsv)
+  end
+
+  it 'requests score when keywords used' do
+    search do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:fl => '* score')
+  end
+
+  it 'does not request score when keywords not used' do
+    search Post
+    connection.should_not have_last_search_with(:fl)
+  end
+
+  it 'sets phrase fields' do
+    search do
+      keywords 'great pizza' do
+        phrase_fields :title => 2.0
+      end
+    end
+    connection.should have_last_search_with(:pf => 'title_text^2.0')
+  end
+
+  it 'sets phrase fields with boost' do
+    search do
+      keywords 'great pizza' do
+        phrase_fields :title => 1.5
+      end
+    end
+    connection.should have_last_search_with(:pf => 'title_text^1.5')
+  end
+
+  it 'sets phrase slop from DSL' do
+    search do
+      keywords 'great pizza' do
+        phrase_slop 2
+      end
+    end
+    connection.should have_last_search_with(:ps => 2)
+  end
+
+  it 'sets boost for certain fields without restricting fields' do
+    search do
+      keywords 'great pizza' do
+        boost_fields :title => 1.5
+      end
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(backwards_title_text body_textsv tags_textv title_text^1.5)
+  end
+
+  it 'ignores boost fields that do not apply' do
+    search do
+      keywords 'great pizza' do
+        boost_fields :bogus => 1.2, :title => 1.5
+      end
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(backwards_title_text body_textsv tags_textv title_text^1.5)
+  end
+
+  it 'sets default boost with default fields' do
+    search Photo do
+      keywords 'great pizza'
+    end
+    connection.should have_last_search_with(:qf => 'caption_text^1.5')
+  end
+
+  it 'sets default boost with fields specified in options' do
+    search Photo do
+      keywords 'great pizza', :fields => [:caption]
+    end
+    connection.should have_last_search_with(:qf => 'caption_text^1.5')
+  end
+
+  it 'sets default boost with fields specified in DSL' do
+    search Photo do
+      keywords 'great pizza' do
+        fields :caption
+      end
+    end
+    connection.should have_last_search_with(:qf => 'caption_text^1.5')
+  end
+
+  it 'overrides default boost when specified in DSL' do
+    search Photo do
+      keywords 'great pizza' do
+        fields :caption => 2.0
+      end
+    end
+    connection.should have_last_search_with(:qf => 'caption_text^2.0')
+  end
+
+  it 'creates boost query' do
+    search do
+      keywords 'great pizza' do
+        boost 2.0 do
+          with(:average_rating).greater_than(2.0)
+        end
+      end
+    end
+    connection.should have_last_search_with(:bq => ['average_rating_ft:[2\.0 TO *]^2.0'])
+  end
+
+  it 'creates multiple boost queries' do
+    search do
+      keywords 'great pizza' do
+        boost(2.0) do
+          with(:average_rating).greater_than(2.0)
+        end
+        boost(1.5) do
+          with(:featured, true)
+        end
+      end
+    end
+    connection.should have_last_search_with(
+      :bq => [
+        'average_rating_ft:[2\.0 TO *]^2.0',
+        'featured_b:true^1.5'
+      ]
+    )
+  end
+
+  it 'sends minimum match parameter from options' do
+    search do
+      keywords 'great pizza', :minimum_match => 2
+    end
+    connection.should have_last_search_with(:mm => 2)
+  end
+
+  it 'sends minimum match parameter from DSL' do
+    search do
+      keywords('great pizza') { minimum_match(2) }
+    end
+    connection.should have_last_search_with(:mm => 2)
+  end
+
+  it 'sends tiebreaker parameter from options' do
+    search do
+      keywords 'great pizza', :tie => 0.1
+    end
+    connection.should have_last_search_with(:tie => 0.1)
+  end
+
+  it 'sends tiebreaker parameter from DSL' do
+    search do
+      keywords('great pizza') { tie(0.1) }
+    end
+    connection.should have_last_search_with(:tie => 0.1)
+  end
+
+  it 'sends query phrase slop from options' do
+    search do
+      keywords 'great pizza', :query_phrase_slop => 2
+    end
+    connection.should have_last_search_with(:qs => 2)
+  end
+
+  it 'sends query phrase slop from DSL' do
+    search do
+      keywords('great pizza') { query_phrase_slop(2) }
+    end
+    connection.should have_last_search_with(:qs => 2)
+  end
+
+  it 'allows specification of a text field that only exists in one type' do
+    search Post, Namespaced::Comment do
+      keywords 'keywords', :fields => :author_name
+    end
+    connection.searches.last[:qf].should == 'author_name_text'
+  end
+
+  it 'raises Sunspot::UnrecognizedFieldError for nonexistant fields in keywords' do
+    lambda do
+      search do
+        keywords :text, :fields => :bogus
+      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
+      search Post, Namespaced::Comment do
+        keywords 'fulltext', :fields => :bogus
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+end

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_including(:bf, 'average_rating_ft')
+  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_including(:bf, '10.5')
+  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_including(:bf, '2010-03-25T18:13:00Z')
+  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_including(:bf, 'product(average_rating_ft,10)')
+  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_including(:bf, 'product(average_rating_ft,sum(average_rating_ft,20))')
+  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