sunspot 0.9.8 → 0.10.0

data/spec/api/query/highlighting_spec.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'highlighted fulltext queries', :type => :query do
+  it 'should not send highlight parameter when highlight not requested' do
+    session.search(Post) do
+      keywords 'test'
+    end
+    connection.should_not have_last_search_with(:hl)
+  end
+
+  it 'should enable highlighting when highlighting requested as keywords argument' do
+    session.search(Post) 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
+    session.search(Post) 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
+    session.search(Post) do
+      keywords 'test', :highlight => [:title, :body]
+    end
+
+    connection.should have_last_search_with(:hl => 'on', :'hl.fl' => %w(title_text body_texts))
+  end
+
+  it 'should raise UnrecognizedFieldError if try to highlight unexisting field via keywords argument' do
+    lambda {
+      session.search(Post) 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
+    session.search(Post) do
+      keywords 'test' do
+        highlight :title, :body
+      end
+    end
+
+    connection.should have_last_search_with(:hl => 'on', :'hl.fl' => %w(title_text body_texts))
+  end
+
+  it 'should raise UnrecognizedFieldError if try to highlight unexisting field via block call' do
+    lambda {
+      session.search(Post) do
+        keywords 'test' do
+          highlight :unknown_field
+        end
+      end
+    }.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'should set internal formatting' do
+    session.search(Post) do
+      keywords 'test', :highlight => true
+    end
+    connection.should have_last_search_with(
+      :"hl.simple.pre" => '@@@hl@@@',
+      :"hl.simple.post" => '@@@endhl@@@'
+    )
+  end
+
+  it 'should set options and hihglight fields' do
+    session.search(Post) do
+      keywords 'test' do
+        highlight :title, :max_snippets => 3
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.fl"       => %w(title_text),
+      :"hl.snippets" => 3
+    )
+  end
+
+  it 'should set maximum highlights per field' do
+    session.search(Post) do
+      keywords 'test' do
+        highlight :max_snippets => 3
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.snippets" => 3
+    )
+  end
+
+  it 'should set the maximum size' do
+    session.search(Post) do
+      keywords 'text' do
+        highlight :fragment_size => 200
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.fragsize" => 200
+    )
+  end
+
+  it 'enables merging of continuous fragments' do
+    session.search(Post) do
+      keywords 'test' do
+        highlight :merge_continuous_fragments => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.mergeContinuous" => 'true'
+    )
+  end
+
+  it 'enables use of phrase highlighter' do #TODO figure out what the hell this means
+    session.search(Post) do
+      keywords 'test' do
+        highlight :phrase_highlighter => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.usePhraseHighlighter" => 'true'
+    )
+  end
+
+  it 'requires field match if requested' do
+    session.search(Post) do
+      keywords 'test' do
+        highlight :phrase_highlighter => true, :require_field_match => true
+      end
+    end
+    connection.should have_last_search_with(
+      :"hl.requireFieldMatch" => 'true'
+    )
+  end
+
+end

data/spec/api/query/local_spec.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'local query' do
+  it 'sets query type to geo when geo search performed' do
+    session.search Post do
+      near [40.7, -73.5], 5
+    end
+    connection.should have_last_search_with(:qt => 'geo')
+  end
+
+  it 'sets lat and lng when geo search is performed' do
+    session.search Post do
+      near [40.7, -73.5], 5
+    end
+    connection.should have_last_search_with(:lat => 40.7, :long => -73.5)
+  end
+
+  it 'sets radius when geo search is performed' do
+    session.search Post do
+      near [40.7, -73.5], 5
+    end
+    connection.should have_last_search_with(:radius => 5)
+  end
+
+  it 'puts all scope parameters into :q parameter when geo search is performed' do
+    session.search Post do
+      with :blog_id, 1
+      near [40.7, -73.5], 5
+    end
+    connection.should have_last_search_with(:q => '(type:Post AND blog_id_i:1)')
+  end
+
+  it 'raises error if keywords specified in local search' do
+    lambda do
+      session.search Post do
+        keywords 'fail'
+        near [40.7, -73.5], 5
+      end
+    end.should raise_error(Sunspot::IllegalSearchError)
+  end
+
+  [
+    [:lat, :lng],
+    [:lat, :lon],
+    [:lat, :long]
+  ].each do |lat_attr, lng_attr|
+    it "sets coordinates using #{lat_attr.inspect}, #{lng_attr.inspect}" do
+      session.search Post do
+        near OpenStruct.new(lat_attr => 40.7, lng_attr => -73.5), 5
+      end
+      connection.should have_last_search_with(:lat => 40.7, :long => -73.5)
+    end
+  end
+end

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,266 @@
+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
+
+  it 'scopes by exact match with a string' do
+    session.search Post 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 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_including(
+      :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_including(
+      :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_including(: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_including(: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_including(: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_including(: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_including(: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_including(: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_including(: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_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
+      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
+      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
+      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
+      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
+      without(:average_rating).less_than 3.0
+    end
+    connection.should have_last_search_including(: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_including(: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_including(: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_including(: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_including(: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_including(: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_including(: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_including(: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_including(: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_including(
+      :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_including(
+      :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_including(: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_including(: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_including(: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(:fq => ['type:Namespaced\:\:Comment'])
+  end
+
+  it 'builds search for multiple types' do
+    session.search(Post, Namespaced::Comment)
+    connection.should have_last_search_with(:fq => ['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(:fq => ['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