sunspot 1.0.5 → 1.1.0

data/spec/api/query/{faceting_spec.rb → faceting_examples.rb}

@@ -1,42 +1,42 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
-describe 'faceting' do
+shared_examples_for "facetable query" do
   describe 'on fields' do
     it 'does not turn faceting on if no facet requested' do
-      session.search(Post)
+      search
       connection.should_not have_last_search_with('facet')
     end
 
     it 'turns faceting on if facet is requested' do
-      session.search Post do
+      search do
         facet :category_ids
       end
       connection.should have_last_search_with(:facet => 'true')
     end
 
     it 'requests single field facet' do
-      session.search Post 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
-      session.search Post 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
-      session.search Post 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
-      session.search Post do
+      search do
         facet :category_ids, :sort => :index
       end
       connection.should have_last_search_with(:"f.category_ids_im.facet.sort" => 'false')
@@ -44,49 +44,63 @@ describe 'faceting' do
 
     it 'raises ArgumentError if bogus facet sort provided' do
       lambda do
-        session.search Post do
+        search do
           facet :category_ids, :sort => :sideways
         end
       end.should raise_error(ArgumentError)
     end
 
     it 'sets the facet limit' do
-      session.search Post 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
-      session.search Post 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
-      session.search Post 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
-      session.search Post 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
-      session.search Post 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
-      session.search Post do
+      search do
         facet :category_ids, :extra => :none
       end
       connection.should have_last_search_with(:"facet.query" => "-category_ids_im:[* TO *]")
@@ -94,11 +108,100 @@ describe 'faceting' do
 
     it 'raises an ArgumentError if bogus extra is passed' do
       lambda do
-        session.search Post 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
@@ -108,46 +211,46 @@ describe 'faceting' do
     end
 
     it 'does not send date facet parameters if time range is not specified' do
-      session.search Post do |query|
+      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
-      session.search Post do |query|
+      search do |query|
         query.facet :published_at, :time_range => @time_range
       end
-      connection.should have_last_search_with(:"facet.date" => ['published_at_d'])
+      connection.should have_last_search_with(:"facet.date" => ['published_at_dt'])
     end
 
     it 'sets the facet start and end' do
-      session.search Post do |query|
+      search 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'
+        :"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
-      session.search Post do |query|
+      search 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")
+      connection.should have_last_search_with(:"f.published_at_dt.facet.date.gap" => "+86400SECONDS")
     end
 
     it 'uses custom time interval' do
-      session.search Post do |query|
+      search 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")
+      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
-        session.search Post do |query|
+        search do |query|
           query.facet :blog_id, :time_range => @time_range
         end
       end.should raise_error(ArgumentError)
@@ -156,7 +259,7 @@ describe 'faceting' do
 
   describe 'using queries' do
     it 'turns faceting on' do
-      session.search Post do
+      search do
         facet :foo do
           row :bar do
             with(:average_rating).between(4.0..5.0)
@@ -167,18 +270,18 @@ describe 'faceting' do
     end
 
     it 'facets by query' do
-      session.search Post 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_f:[4\.0 TO 5\.0]')
+      connection.should have_last_search_with(:"facet.query" => 'average_rating_ft:[4\.0 TO 5\.0]')
     end
 
     it 'requests multiple query facets' do
-      session.search Post do
+      search do
         facet :foo do
           row :bar do
             with(:average_rating).between(3.0..4.0)
@@ -190,14 +293,14 @@ describe 'faceting' do
       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]'
+          '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
-      session.search Post do
+      search do
         facet :foo do
           row :bar do
             with(:category_ids, 1)
@@ -211,7 +314,7 @@ describe 'faceting' do
     end
 
     it 'requests query facet with disjunction' do
-      session.search Post do
+      search do
         facet :foo do
           row :bar do
             any_of do
@@ -227,7 +330,7 @@ describe 'faceting' do
     end
 
     it 'builds query facets when passed :only argument to field facet declaration' do
-      session.search Post do
+      search do
         facet :category_ids, :only => [1, 3]
       end
       connection.should have_last_search_with(
@@ -236,26 +339,26 @@ describe 'faceting' do
     end
 
     it 'converts limited query facet values to the correct type' do
-      session.search Post 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_d:2009\-08\-28T15\:33\:00Z',
-          'published_at_d:2008\-08\-28T15\:33\:00Z'
+          '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
-      session.search Post 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
-      session.search Post do
+      search do
         facet :foo do
           row(:bar) do
             with(:blog_id, 1)
@@ -267,7 +370,7 @@ describe 'faceting' do
     end
 
     it 'ignores facet query with only empty rows' do
-      session.search Post do
+      search do
         facet :foo do
           row(:bar) {}
         end
@@ -277,7 +380,7 @@ describe 'faceting' do
 
     it 'does not allow 0 arguments to facet method with block' do
       lambda do
-        session.search Post do
+        search do
           facet do
           end
         end
@@ -286,7 +389,7 @@ describe 'faceting' do
 
     it 'does not allow more than 1 argument to facet method with block' do
       lambda do
-        session.search Post do
+        search do
           facet :foo, :bar do
           end
         end