gojee-sunspot 2.0.3 → 2.0.4

data/spec/api/query/function_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+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 the sub function in a function query block" do
+    session.search Post do
+      keywords('pizza') do
+        boost(function { sub(:average_rating, 10) })
+      end
+    end
+    connection.should have_last_search_including(:bf, 'sub(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/geo_examples.rb

@@ -0,0 +1,68 @@
+require 'bigdecimal'
+
+shared_examples_for 'geohash query' do
+  it 'searches for nearby points with defaults' do
+    search do
+      with(:coordinates).near(40.7, -73.5)
+    end
+    connection.should have_last_search_including(:q, build_geo_query)
+  end
+
+  it 'searches for nearby points with non-Float arguments' do
+    search do
+      with(:coordinates).near(BigDecimal.new('40.7'), BigDecimal.new('-73.5'))
+    end
+    connection.should have_last_search_including(:q, build_geo_query)
+  end
+
+  it 'searches for nearby points with given precision' do
+    search do
+      with(:coordinates).near(40.7, -73.5, :precision => 10)
+    end
+    connection.should have_last_search_including(:q, build_geo_query(:precision => 10))
+  end
+
+  it 'searches for nearby points with given precision factor' do
+    search do
+      with(:coordinates).near(40.7, -73.5, :precision_factor => 1.5)
+    end
+    connection.should have_last_search_including(:q, build_geo_query(:precision_factor => 1.5))
+  end
+
+  it 'searches for nearby points with given boost' do
+    search do
+      with(:coordinates).near(40.7, -73.5, :boost => 2.0)
+    end
+    connection.should have_last_search_including(:q, build_geo_query(:boost => 2.0))
+  end
+
+  it 'performs both dismax search and location search' do
+    search do
+      fulltext 'pizza', :fields => :title
+      with(:coordinates).near(40.7, -73.5)
+    end
+    expected = 
+      "{!dismax fl='* score' qf='title_text'}pizza (#{build_geo_query})"
+    connection.should have_last_search_including(
+      :q,
+      %Q(_query_:"{!dismax qf='title_text'}pizza" (#{build_geo_query}))
+    )
+  end
+
+  private
+
+  def build_geo_query(options = {})
+    precision = options[:precision] || 7
+    precision_factor = options[:precision_factor] || 16.0
+    boost = options[:boost] || 1.0
+    hash = 'dr5xx3nytvgs'
+    (precision..12).map do |i|
+      phrase = 
+        if i == 12 then hash
+        else "#{hash[0, i]}*"
+        end
+      precision_boost = Sunspot::Util.format_float(boost*precision_factor**(i-12.0), 3)
+      "coordinates_s:#{phrase}^#{precision_boost}"
+    end.reverse.join(' OR ')
+  end
+end

data/spec/api/query/group_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe "field grouping" do
+  it "sends grouping parameters to solr" do
+    session.search Post do
+      group :title
+    end
+
+    connection.should have_last_search_including(:group, "true")
+    connection.should have_last_search_including(:"group.field", "title_ss")
+  end
+
+  it "sends grouping limit parameters to solr" do
+    session.search Post do
+      group :title do
+        limit 2
+      end
+    end
+
+    connection.should have_last_search_including(:"group.limit", 2)
+  end
+
+  it "sends grouping sort parameters to solr" do
+    session.search Post do
+      group :title do
+        order_by :average_rating
+      end
+    end
+
+    connection.should have_last_search_including(:"group.sort", "average_rating_ft asc")
+  end
+end

data/spec/api/query/highlighting_examples.rb

@@ -0,0 +1,245 @@
+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
+
+  it 'sets the formatter for highlight output' do
+    search do
+      keywords 'test' do
+        highlight :title, :formatter => 'formatter'
+      end
+    end
+    connection.should have_last_search_with(
+      :"f.title_text.hl.formatter" => 'formatter'
+    )
+  end
+
+  it 'sets the text snippet generator for highlighted text' do
+    search do
+      keywords 'test' do
+        highlight :title, :fragmenter => 'example_fragmenter'
+      end
+    end
+    connection.should have_last_search_with(
+      :"f.title_text.hl.fragmenter" => 'example_fragmenter'
+    )
+  end
+end

data/spec/api/query/more_like_this_spec.rb

@@ -0,0 +1,140 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+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_examples.rb

@@ -0,0 +1,116 @@
+shared_examples_for 'sortable query' do
+  it 'paginates using default per_page when page not provided' do
+    search
+    connection.should have_last_search_with(:rows => 30)
+  end
+
+  it 'paginates using default per_page when page provided' 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
+    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
+    search do
+      paginate :per_page => 15
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 0)
+  end
+
+  it 'paginates with an offset' do
+    search do
+      paginate :per_page => 15, :offset => 3
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 3)
+  end
+
+  it 'paginates with an offset as a string' do
+    search do
+      paginate :per_page => 15, :offset => '3'
+    end
+    connection.should have_last_search_with(:rows => 15, :start => 3)
+  end
+
+  it 'paginates from string argument' 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
+    search do
+      order_by :average_rating, :desc
+    end
+    connection.should have_last_search_with(:sort => 'average_rating_ft desc')
+  end
+
+  it 'orders by multiple fields' do
+    search do
+      order_by :average_rating, :desc
+      order_by :sort_title, :asc
+    end
+    connection.should have_last_search_with(:sort => 'average_rating_ft desc, sort_title_s asc')
+  end
+
+  it 'orders by random' do
+    search do
+      order_by :random
+    end
+    connection.searches.last[:sort].should =~ /^random_\d+ asc$/
+  end
+
+  it 'orders by score' do
+    search do
+      order_by :score, :desc
+    end
+    connection.should have_last_search_with(:sort => 'score desc')
+  end
+
+  it 'orders by geodist' do
+    search do
+      order_by_geodist :coordinates_new, 32, -68, :desc
+    end
+    connection.should have_last_search_with(:sort => 'geodist(coordinates_new_ll,32,-68) desc')
+  end
+
+  it 'throws an ArgumentError if a bogus order direction is given' do
+    lambda do
+      search do
+        order_by :sort_title, :sideways
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it 'throws an UnrecognizedFieldError if :distance is given for sort' do
+    lambda do
+      search do
+        order_by :distance, :asc
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'does not allow ordering by multiple-value fields' do
+    lambda do
+      search do
+        order_by :category_ids
+      end
+    end.should raise_error(ArgumentError)
+  end
+
+  it 'raises ArgumentError if bogus argument given to paginate' do
+    lambda do
+      search do
+        paginate :page => 4, :ugly => :puppy
+      end
+    end.should raise_error(ArgumentError)
+  end
+end