benjaminkrause-sunspot 0.9.7

data/spec/api/query/dynamic_fields_spec.rb

@@ -0,0 +1,148 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'dynamic field query', :type => :query do
+  it 'restricts by dynamic string field with equality restriction' do
+    session.search Post do
+      dynamic :custom_string do
+        with :test, 'string'
+      end
+    end
+    connection.should have_last_search_with(:fq => ['custom_string\:test_s:string'])
+  end
+
+  it 'restricts by dynamic integer field with less than restriction' do
+    session.search Post do
+      dynamic :custom_integer do
+        with(:test).less_than(1)
+      end
+    end
+    connection.should have_last_search_with(:fq => ['custom_integer\:test_i:[* TO 1]'])
+  end
+
+  it 'restricts by dynamic float field with between restriction' do
+    session.search Post do
+      dynamic :custom_float do
+        with(:test).between(2.2..3.3)
+      end
+    end
+    connection.should have_last_search_with(:fq => ['custom_float\:test_fm:[2\.2 TO 3\.3]'])
+  end
+
+  it 'restricts by dynamic time field with any of restriction' do
+    session.search Post do
+      dynamic :custom_time do
+        with(:test).any_of([Time.parse('2009-02-10 14:00:00 UTC'),
+                            Time.parse('2009-02-13 18:00:00 UTC')])
+      end
+    end
+    connection.should have_last_search_with(:fq => ['custom_time\:test_d:(2009\-02\-10T14\:00\:00Z OR 2009\-02\-13T18\:00\:00Z)'])
+  end
+
+  it 'restricts by dynamic boolean field with equality restriction' do
+    session.search Post do
+      dynamic :custom_boolean do
+        with :test, false
+      end
+    end
+    connection.should have_last_search_with(:fq => ['custom_boolean\:test_b:false'])
+  end
+
+  it 'negates a dynamic field restriction' do
+    session.search Post do
+      dynamic :custom_string do
+        without :test, 'foo'
+      end
+    end
+    connection.should have_last_search_with(:fq => ['-custom_string\:test_s:foo'])
+  end
+
+  it 'scopes by a dynamic field inside a disjunction' do
+    session.search Post do
+      any_of do
+        dynamic :custom_string do
+          with :test, 'foo'
+        end
+        with :title, 'bar'
+      end
+    end
+    connection.should have_last_search_with(
+      :fq => '(custom_string\:test_s:foo OR title_ss:bar)'
+    )
+  end
+
+  it 'orders by a dynamic field' do
+    session.search Post do
+      dynamic :custom_integer do
+        order_by :test, :desc
+      end
+    end
+    connection.should have_last_search_with(:sort => 'custom_integer:test_i desc')
+  end
+
+  it 'orders by a dynamic field and static field, with given precedence' do
+    session.search Post do
+      dynamic :custom_integer do
+        order_by :test, :desc
+      end
+      order_by :sort_title, :asc
+    end
+    connection.should have_last_search_with(:sort => 'custom_integer:test_i desc, sort_title_s asc')
+  end
+
+  it 'raises an UnrecognizedFieldError if an unknown dynamic field is searched by' do
+    lambda do
+      session.search Post do
+        dynamic(:bogus) { with :some, 'value' }
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
+  it 'raises a NoMethodError if pagination is attempted in a dynamic query' do
+    lambda do
+      session.search Post do
+        dynamic :custom_string do
+          paginate 3, 10
+        end
+      end
+    end.should raise_error(NoMethodError)
+  end
+
+  it 'requests query facet with internal dynamic field' do
+    session.search Post do
+      facet :test do
+        row 'foo' do
+          dynamic :custom_string do
+            with :test, 'foo'
+          end
+        end
+      end
+    end
+    connection.should have_last_search_with(
+      :"facet.query" => 'custom_string\:test_s:foo'
+    )
+  end
+
+  it 'requests query facet with external dynamic field' do
+    session.search Post do
+      dynamic :custom_string do
+        facet :test do
+          row 'foo' do
+            with :test, 'foo'
+          end
+        end
+      end
+    end
+    connection.should have_last_search_with(
+      :"facet.query" => 'custom_string\:test_s:foo'
+    )
+  end
+
+  it 'allows scoping on dynamic fields common to all types' do
+    session.search Post, Namespaced::Comment do
+      dynamic :custom_string do
+        with(:test, 'test')
+      end
+    end
+    connection.should have_last_search_with(:fq => ['custom_string\\:test_s:test'])
+  end
+end

data/spec/api/query/faceting_spec.rb

@@ -0,0 +1,272 @@
+describe 'faceting' do
+  describe 'on fields' do
+    it 'does not turn faceting on if no facet requested' do
+      session.search(Post)
+      connection.should_not have_last_search_with('facet')
+    end
+
+    it 'turns faceting on if facet is requested' do
+      session.search Post do
+        facet :category_ids
+      end
+      connection.should have_last_search_with(:facet => 'true')
+    end
+
+    it 'requests single field facet' do
+      session.search Post do
+        facet :category_ids
+      end
+      connection.should have_last_search_with(:"facet.field" => %w(category_ids_im))
+    end
+
+    it 'requests multiple field facets' do
+      session.search Post do
+        facet :category_ids, :blog_id
+      end
+      connection.should have_last_search_with(:"facet.field" => %w(category_ids_im blog_id_i))
+    end
+
+    it 'sets facet sort by count' do
+      session.search Post do
+        facet :category_ids, :sort => :count
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.sort" => 'true')
+    end
+
+    it 'sets facet sort by index' do
+      session.search Post do
+        facet :category_ids, :sort => :index
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.sort" => 'false')
+    end
+
+    it 'raises ArgumentError if bogus facet sort provided' do
+      lambda do
+        session.search Post do
+          facet :category_ids, :sort => :sideways
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it 'sets the facet limit' do
+      session.search Post do
+        facet :category_ids, :limit => 10
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.limit" => 10)
+    end
+
+    it 'sets the facet minimum count' do
+      session.search Post do
+        facet :category_ids, :minimum_count => 5
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.mincount" => 5)
+    end
+
+    it 'sets the facet minimum count to zero if zeros are allowed' do
+      session.search Post do
+        facet :category_ids, :zeros => true
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.mincount" => 0)
+    end
+
+    it 'sets the facet minimum count to one by default' do
+      session.search Post do
+        facet :category_ids
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.mincount" => 1)
+    end
+  end
+
+  describe 'on time ranges' do
+    before :each do
+      @time_range = (Time.parse('2009-06-01 00:00:00 -0400')..
+                     Time.parse('2009-07-01 00:00:00 -0400'))
+    end
+
+    it 'does not send date facet parameters if time range is not specified' do
+      session.search Post do |query|
+        query.facet :published_at
+      end
+      connection.should_not have_last_search_with(:"facet.date")
+    end
+
+    it 'sets the facet to a date facet if time range is specified' do
+      session.search Post do |query|
+        query.facet :published_at, :time_range => @time_range
+      end
+      connection.should have_last_search_with(:"facet.date" => ['published_at_d'])
+    end
+
+    it 'sets the facet start and end' do
+      session.search Post do |query|
+        query.facet :published_at, :time_range => @time_range
+      end
+      connection.should have_last_search_with(
+        :"f.published_at_d.facet.date.start" => '2009-06-01T04:00:00Z',
+        :"f.published_at_d.facet.date.end" => '2009-07-01T04:00:00Z'
+      )
+    end
+
+    it 'defaults the time interval to 1 day' do
+      session.search Post do |query|
+        query.facet :published_at, :time_range => @time_range
+      end
+      connection.should have_last_search_with(:"f.published_at_d.facet.date.gap" => "+86400SECONDS")
+    end
+
+    it 'uses custom time interval' do
+      session.search Post do |query|
+        query.facet :published_at, :time_range => @time_range, :time_interval => 3600
+      end
+      connection.should have_last_search_with(:"f.published_at_d.facet.date.gap" => "+3600SECONDS")
+    end
+
+    it 'does not allow date faceting on a non-date field' do
+      lambda do
+        session.search Post do |query|
+          query.facet :blog_id, :time_range => @time_range
+        end
+      end.should raise_error(ArgumentError)
+    end
+  end
+
+  describe 'using queries' do
+    it 'turns faceting on' do
+      session.search Post do
+        facet :foo do
+          row :bar do
+            with(:average_rating).between(4.0..5.0)
+          end
+        end
+      end
+      connection.should have_last_search_with(:facet => 'true')
+    end
+
+    it 'facets by query' do
+      session.search Post do
+        facet :foo do
+          row :bar do
+            with(:average_rating).between(4.0..5.0)
+          end
+        end
+      end
+      connection.should have_last_search_with(:"facet.query" => 'average_rating_f:[4\.0 TO 5\.0]')
+    end
+
+    it 'requests multiple query facets' do
+      session.search Post do
+        facet :foo do
+          row :bar do
+            with(:average_rating).between(3.0..4.0)
+          end
+          row :baz do
+            with(:average_rating).between(4.0..5.0)
+          end
+        end
+      end
+      connection.should have_last_search_with(
+        :"facet.query" => [
+          'average_rating_f:[3\.0 TO 4\.0]',
+          'average_rating_f:[4\.0 TO 5\.0]'
+        ]
+      )
+    end
+
+    it 'requests query facet with multiple conditions' do
+      session.search Post do
+        facet :foo do
+          row :bar do
+            with(:category_ids, 1)
+            with(:blog_id, 2)
+          end
+        end
+      end
+      connection.should have_last_search_with(
+        :"facet.query" => '(category_ids_im:1 AND blog_id_i:2)'
+      )
+    end
+
+    it 'requests query facet with disjunction' do
+      session.search Post do
+        facet :foo do
+          row :bar do
+            any_of do
+              with(:category_ids, 1)
+              with(:blog_id, 2)
+            end
+          end
+        end
+      end
+      connection.should have_last_search_with(
+        :"facet.query" => '(category_ids_im:1 OR blog_id_i:2)'
+      )
+    end
+
+    it 'builds query facets when passed :only argument to field facet declaration' do
+      session.search Post do
+        facet :category_ids, :only => [1, 3]
+      end
+      connection.should have_last_search_with(
+        :"facet.query" => ['category_ids_im:1', 'category_ids_im:3']
+      )
+    end
+
+    it 'converts limited query facet values to the correct type' do
+      session.search Post do
+        facet :published_at, :only => [Time.utc(2009, 8, 28, 15, 33), Time.utc(2008,8, 28, 15, 33)]
+      end
+      connection.should have_last_search_with(
+        :"facet.query" => [
+          'published_at_d:2009\-08\-28T15\:33\:00Z',
+          'published_at_d:2008\-08\-28T15\:33\:00Z'
+        ]
+      )
+    end
+
+    it 'ignores facet query with no rows' do
+      session.search Post do
+        facet(:foo) {}
+      end
+      connection.should_not have_last_search_with(:"facet.query")
+    end
+
+    it 'ignores facet query row with no restrictions' do
+      session.search Post do
+        facet :foo do
+          row(:bar) do
+            with(:blog_id, 1)
+          end
+          row(:baz) {}
+        end
+      end
+      connection.searches.last[:"facet.query"].should be_a(String)
+    end
+
+    it 'ignores facet query with only empty rows' do
+      session.search Post do
+        facet :foo do
+          row(:bar) {}
+        end
+      end
+      connection.should_not have_last_search_with(:"facet.query")
+    end
+
+    it 'does not allow 0 arguments to facet method with block' do
+      lambda do
+        session.search Post do
+          facet do
+          end
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it 'does not allow more than 1 argument to facet method with block' do
+      lambda do
+        session.search Post do
+          facet :foo, :bar do
+          end
+        end
+      end.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/api/query/fulltext_spec.rb

@@ -0,0 +1,152 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'fulltext query', :type => :query do
+  it 'searches by keywords' do
+    session.search Post do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:q => 'keyword search')
+  end
+
+  it 'ignores keywords if empty' do
+    session.search Post do
+      keywords ''
+    end
+    connection.should_not have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'ignores keywords if nil' do
+    session.search Post do
+      keywords nil
+    end
+    connection.should_not have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'ignores keywords with only whitespace' do
+    session.search Post do
+      keywords "  \t"
+    end
+    connection.should_not have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'gracefully ignores keywords block if keywords ignored' do
+    session.search Post do
+      keywords(nil) { fields(:title) }
+    end
+  end
+
+  it 'sets default query parser to dismax when keywords used' do
+    session.search Post do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:defType => 'dismax')
+  end
+
+  it 'searches types in filter query if keywords used' do
+    session.search Post do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:fq => 'type:Post')
+  end
+
+  it 'searches all text fields for searched class' do
+    search = session.search Post do
+      keywords 'keyword search'
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(backwards_title_text body_texts title_text)
+  end
+
+  it 'searches both stored and unstored text fields' do
+    session.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_texts title_text)
+  end
+
+  it 'searches only specified text fields when specified' do
+    session.search Post do
+      keywords 'keyword search', :fields => [:title, :body]
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_texts title_text)
+  end
+
+  it 'assigns boost to fields when specified' do
+    session.search Post do
+      keywords 'keyword search' do
+        fields :title => 2.0, :body => 0.75
+      end
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_texts^0.75 title_text^2.0)
+  end
+
+  it 'allows assignment of boosted and unboosted fields' do
+    session.search Post 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
+    session.search Post, Namespaced::Comment do
+      keywords 'keyword search', :fields => [:body]
+    end
+    connection.searches.last[:qf].split(' ').sort.should == %w(body_text body_texts)
+  end
+
+  it 'requests score when keywords used' do
+    session.search Post do
+      keywords 'keyword search'
+    end
+    connection.should have_last_search_with(:fl => '* score')
+  end
+
+  it 'does not request score when keywords not used' do
+    session.search Post
+    connection.should_not have_last_search_with(:fl)
+  end
+
+  it 'sets phrase fields' do
+    session.search Post do
+      keywords 'great pizza' do
+        phrase_fields :title
+      end
+    end
+    connection.should have_last_search_with(:pf => 'title_text')
+  end
+
+  it 'sets phrase fields with boost' do
+    session.search Post 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 'creates boost query' do
+    session.search Post 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_f:[2\.0 TO *]^2.0')
+  end
+
+  it 'allows specification of a text field that only exists in one type' do
+    session.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
+      session.search Post do
+        keywords :text, :fields => :bogus
+      end
+    end.should raise_error(Sunspot::UnrecognizedFieldError)
+  end
+end

data/spec/api/query/highlighting_spec.rb

@@ -0,0 +1,82 @@
+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 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 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,37 @@
+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
+
+  [
+    [: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