gojee-sunspot 2.0.3 → 2.0.4

data/spec/api/query/faceting_examples.rb

@@ -0,0 +1,397 @@
+shared_examples_for "facetable query" do
+  describe 'on fields' do
+    it 'does not turn faceting on if no facet requested' do
+      search
+      connection.should_not have_last_search_with('facet')
+    end
+
+    it 'turns faceting on if facet is requested' do
+      search do
+        facet :category_ids
+      end
+      connection.should have_last_search_with(:facet => 'true')
+    end
+
+    it 'requests single field facet' do
+      search do
+        facet :category_ids
+      end
+      connection.should have_last_search_with(:"facet.field" => %w(category_ids_im))
+    end
+
+    it 'requests multiple field facets' do
+      search 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
+      search 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
+      search 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
+        search do
+          facet :category_ids, :sort => :sideways
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it 'sets the facet limit' do
+      search 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
+      search 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
+      search 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
+      search do
+        facet :category_ids
+      end
+      connection.should have_last_search_with(:"f.category_ids_im.facet.mincount" => 1)
+    end
+
+    it 'sets the facet prefix' do
+      search do
+        facet :title, :prefix => 'Test'
+      end
+      connection.should have_last_search_with(:"f.title_ss.facet.prefix" => 'Test')
+    end
+
+    it 'escapes the facet prefix' do
+      search do
+        facet :title, :prefix => 'Test Title'
+      end
+      connection.should have_last_search_with(:"f.title_ss.facet.prefix" => 'Test\ Title')
+    end
+
+    it 'sends a query facet for :any extra' do
+      search do
+        facet :category_ids, :extra => :any
+      end
+      connection.should have_last_search_with(:"facet.query" => "category_ids_im:[* TO *]")
+    end
+
+    it 'sends a query facet for :none extra' do
+      search do
+        facet :category_ids, :extra => :none
+      end
+      connection.should have_last_search_with(:"facet.query" => "-category_ids_im:[* TO *]")
+    end
+
+    it 'raises an ArgumentError if bogus extra is passed' do
+      lambda do
+        search do
+          facet :category_ids, :extra => :bogus
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it 'tags and excludes a scope filter in a field facet' do
+      search do
+        blog_filter = with(:blog_id, 1)
+        facet(:blog_id, :exclude => blog_filter)
+      end
+      filter_tag = get_filter_tag('blog_id_i:1')
+      connection.should have_last_search_with(
+        :"facet.field" => %W({!ex=#{filter_tag}}blog_id_i)
+      )
+    end
+
+    it 'tags and excludes a disjunction filter in a field facet' do
+      search do
+        blog_filter = any_of do
+          with(:blog_id, 1)
+          with(:blog_id, 2)
+        end
+        facet(:blog_id, :exclude => blog_filter)
+      end
+      filter_tag = get_filter_tag('(blog_id_i:1 OR blog_id_i:2)')
+      connection.should have_last_search_with(
+        :"facet.field" => %W({!ex=#{filter_tag}}blog_id_i)
+      )
+    end
+
+    it 'tags and excludes multiple filters in a field facet' do
+      search do
+        blog_filter = with(:blog_id, 1)
+        category_filter = with(:category_ids, 2)
+        facet(:blog_id, :exclude => [blog_filter, category_filter])
+      end
+      filter_tags = %w(blog_id_i:1 category_ids_im:2).map do |phrase|
+        get_filter_tag(phrase)
+      end.join(',')
+      connection.should have_last_search_with(
+        :"facet.field" => %W({!ex=#{filter_tags}}blog_id_i)
+      )
+    end
+
+    it 'does not tag a filter if it is not excluded' do
+      search do
+        with(:blog_id, 1)
+      end
+      connection.should have_last_search_including(:fq, "blog_id_i:1")
+    end
+
+    it 'names a field facet' do
+      search do
+        facet(:blog_id, :name => :blog)
+      end
+      connection.should have_last_search_including(:"facet.field", "{!key=blog}blog_id_i")
+    end
+
+    it 'uses the custom field facet name in facet option parameters' do
+      search do
+        facet(:blog_id, :name => :blog, :sort => :count)
+      end
+      connection.should have_last_search_with(:"f.blog.facet.sort" => 'true')
+    end
+
+    it 'raises an ArgumentError if exclusion attempted on a query facet' do
+      lambda do
+        search do
+          blog_filter = with(:blog_id, 1)
+          facet(:bad, :exclude => blog_filter) do
+            row(:bogus) { with(:blog_id, 1) }
+          end
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it 'raises an ArgumentError if exclusion attempted on a restricted field facet' do
+      lambda do
+        search do
+          blog_filter = with(:blog_id, 1)
+          facet(:blog_id, :only => 1, :exclude => blog_filter)
+        end
+      end.should raise_error(ArgumentError)
+    end
+
+    it 'raises an ArgumentError if exclusion attempted on a facet with :extra' do
+      lambda do
+        search do
+          blog_filter = with(:blog_id, 1)
+          facet(:blog_id, :extra => :all, :exclude => blog_filter)
+        end
+      end.should raise_error(ArgumentError)
+    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
+      search 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
+      search do |query|
+        query.facet :published_at, :time_range => @time_range
+      end
+      connection.should have_last_search_with(:"facet.date" => ['published_at_dt'])
+    end
+
+    it 'sets the facet start and end' do
+      search do |query|
+        query.facet :published_at, :time_range => @time_range
+      end
+      connection.should have_last_search_with(
+        :"f.published_at_dt.facet.date.start" => '2009-06-01T04:00:00Z',
+        :"f.published_at_dt.facet.date.end" => '2009-07-01T04:00:00Z'
+      )
+    end
+
+    it 'defaults the time interval to 1 day' do
+      search do |query|
+        query.facet :published_at, :time_range => @time_range
+      end
+      connection.should have_last_search_with(:"f.published_at_dt.facet.date.gap" => "+86400SECONDS")
+    end
+
+    it 'uses custom time interval' do
+      search do |query|
+        query.facet :published_at, :time_range => @time_range, :time_interval => 3600
+      end
+      connection.should have_last_search_with(:"f.published_at_dt.facet.date.gap" => "+3600SECONDS")
+    end
+
+    it 'does not allow date faceting on a non-date field' do
+      lambda do
+        search 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
+      search 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
+      search 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_ft:[4\.0 TO 5\.0]')
+    end
+
+    it 'requests multiple query facets' do
+      search 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_ft:[3\.0 TO 4\.0]',
+          'average_rating_ft:[4\.0 TO 5\.0]'
+        ]
+      )
+    end
+
+    it 'requests query facet with multiple conditions' do
+      search 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
+      search 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
+      search 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
+      search 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_dt:2009\-08\-28T15\:33\:00Z',
+          'published_at_dt:2008\-08\-28T15\:33\:00Z'
+        ]
+      )
+    end
+
+    it 'ignores facet query with no rows' do
+      search do
+        facet(:foo) {}
+      end
+      connection.should_not have_last_search_with(:"facet.query")
+    end
+
+    it 'ignores facet query row with no restrictions' do
+      search 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
+      search 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
+        search 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
+        search do
+          facet :foo, :bar do
+          end
+        end
+      end.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/api/query/fulltext_examples.rb

@@ -0,0 +1,313 @@
+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 field list in main query' do
+      connection.should have_last_search_with(:fl => '* 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_bs: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