sunspot 0.10.5 → 0.10.6

data/lib/sunspot/setup.rb

@@ -10,6 +10,7 @@ module Sunspot
       @field_factories, @text_field_factories, @dynamic_field_factories,
         @field_factories_cache, @text_field_factories_cache,
         @dynamic_field_factories_cache = *Array.new(6) { Hash.new }
+      @stored_field_factories_cache = Hash.new { |h, k| h[k] = [] }
       @dsl = DSL::Fields.new(self)
       add_field_factory(:class, Type::ClassType)
     end
@@ -19,16 +20,16 @@ module Sunspot
     end
 
     # 
-    # Add field_factories for scope/ordering
-    # 
-    # ==== Parameters
-    #
-    # field_factories<Array>:: Array of Sunspot::Field objects
+    # Add field factory for scope/ordering
     #
     def add_field_factory(name, type, options = {}, &block)
+      stored = options[:stored]
       field_factory = FieldFactory::Static.new(name, type, options, &block)
       @field_factories[field_factory.signature] = field_factory
       @field_factories_cache[field_factory.name] = field_factory
+      if stored
+        @stored_field_factories_cache[field_factory.name] << field_factory
+      end
     end
 
     # 
@@ -39,9 +40,13 @@ module Sunspot
     # field_factories<Array>:: Array of Sunspot::Field objects
     #
     def add_text_field_factory(name, options = {}, &block)
+      stored = options[:stored]
       field_factory = FieldFactory::Static.new(name, Type::TextType, options, &block)
       @text_field_factories[name] = field_factory
       @text_field_factories_cache[field_factory.name] = field_factory
+      if stored
+        @stored_field_factories_cache[field_factory.name] << field_factory
+      end
     end
 
     #
@@ -62,8 +67,8 @@ module Sunspot
     # of documents during index, but does not actually generate fields (since
     # the field names used in search are static).
     #
-    def set_coordinates_field(name)
-      @coordinates_field_factory = FieldFactory::Coordinates.new(name)
+    def set_coordinates_field(name = nil, &block)
+      @coordinates_field_factory = FieldFactory::Coordinates.new(name, &block)
     end
 
     # 
@@ -123,6 +128,16 @@ module Sunspot
       [text_field]
     end
 
+    #
+    # Return one or more stored fields (can be either attribute or text fields)
+    # for the given name.
+    #
+    def stored_fields(field_name)
+      @stored_field_factories_cache[field_name.to_sym].map do |field_factory|
+        field_factory.build
+      end
+    end
+
     # 
     # Return the DynamicFieldFactory with the given base name
     #

data/lib/sunspot/type.rb

@@ -33,6 +33,10 @@ module Sunspot
         def to_indexed(value) #:nodoc:
           value.to_s if value
         end
+
+        def cast(text)
+          text
+        end
       end
     end
 

data/lib/sunspot/util.rb

@@ -87,6 +87,14 @@ module Sunspot
         end
       end
 
+      def extract_options_from(args)
+        if args.last.is_a?(Hash)
+          args.pop
+        else
+          {}
+        end
+      end
+
       # 
       # Perform a deep merge of hashes, returning the result as a new hash.
       # See #deep_merge_into for rules used to merge the hashes

data/lib/sunspot.rb

@@ -1,6 +1,8 @@
+require 'set'
+require 'time'
+require 'date'
+require 'enumerator'
 begin
-  require 'time'
-  require 'date'
   require 'rsolr'
 rescue LoadError
   require 'rubygems'
@@ -10,8 +12,7 @@ end
 require File.join(File.dirname(__FILE__), 'light_config')
 
 %w(util adapters configuration setup composite_setup text_field_setup field
-   field_factory data_extractor indexer query search facet facet_row
-   instantiated_facet instantiated_facet_row facet_data session type
+   field_factory data_extractor indexer query search session type
    dsl).each do |filename|
   require File.join(File.dirname(__FILE__), 'sunspot', filename)
 end
@@ -210,7 +211,7 @@ module Sunspot
     # ==== Parameters
     #
     # types<Class>...::
-    #   Zero, one, or more types to search for. If no types are passed, all
+    #   One or more types to search for. If no types are passed, all
     #   configured types will be searched for.
     #
     # ==== Returns
@@ -229,7 +230,7 @@ module Sunspot
     # ==== Parameters
     #
     # types<Class>...::
-    #   Zero, one, or more types to search for. If no types are passed, all
+    #   One or more types to search for. If no types are passed, all
     #   configured types will be searched.
     #
     # ==== Returns

data/solr/solr/conf/solrconfig.xml

@@ -682,9 +682,7 @@
   </queryResponseWriter> 
 
 
-  <!-- example of registering a query parser
   <queryParser name="lucene" class="org.apache.solr.search.LuceneQParserPlugin"/>
-  -->
 
   <!-- example of registering a custom function parser 
   <valueSourceParser name="myfunc" class="com.mycompany.MyValueSourceParser" />
@@ -715,6 +713,7 @@
     <str name='lngField'>long</str>
   </searchComponent>
   <requestHandler class='org.apache.solr.handler.component.SearchHandler' name='geo'>
+    <str name="defType">lucene</str>
     <arr name='components'>
       <str>localsolr</str>
       <str>facet</str>

data/spec/api/indexer/attributes_spec.rb

@@ -66,6 +66,11 @@ describe 'indexing attribute fields', :type => :indexer do
     end
   end
 
+  it 'should index latitude and longitude from a block' do
+    session.index(Photo.new(:lat => 30, :lng => -60))
+    connection.should have_add_with(:lat => 30, :long => -60)
+  end
+
   it 'should correctly index an attribute field with block access' do
     session.index(post(:title => 'The Blog Post'))
     connection.should have_add_with(:sort_title_s => 'blog post')

data/spec/api/query/faceting_spec.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
 describe 'faceting' do
   describe 'on fields' do
     it 'does not turn faceting on if no facet requested' do
@@ -75,6 +77,28 @@ describe 'faceting' do
       end
       connection.should have_last_search_with(:"f.category_ids_im.facet.mincount" => 1)
     end
+
+    it 'sends a query facet for :any extra' do
+      session.search Post 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
+        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
+        session.search Post do
+          facet :category_ids, :extra => :bogus
+        end
+      end.should raise_error(ArgumentError)
+    end
   end
 
   describe 'on time ranges' do

data/spec/api/query/fulltext_spec.rb

@@ -70,6 +70,15 @@ describe 'fulltext query', :type => :query do
     connection.searches.last[:qf].split(' ').sort.should == %w(body_texts title_text)
   end
 
+  it 'excludes text fields when instructed' do
+    session.search Post do
+      keywords 'keyword search' do
+        exclude_fields :backwards_title
+      end
+    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
@@ -124,6 +133,15 @@ describe 'fulltext query', :type => :query do
     connection.should have_last_search_with(:pf => 'title_text^1.5')
   end
 
+  it 'sets phrase slop from DSL' do
+    session.search Post 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
     session.search Post do
       keywords 'great pizza' do
@@ -173,7 +191,68 @@ describe 'fulltext query', :type => :query do
         end
       end
     end
-    connection.should have_last_search_with(:bq => 'average_rating_f:[2\.0 TO *]^2.0')
+    connection.should have_last_search_with(:bq => ['average_rating_f:[2\.0 TO *]^2.0'])
+  end
+
+  it 'creates multiple boost queries' do
+    session.search Post 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_f:[2\.0 TO *]^2.0',
+        'featured_b:true^1.5'
+      ]
+    )
+  end
+
+  it 'sends minimum match parameter from options' do
+    session.search Post 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
+    session.search Post do
+      keywords('great pizza') { minimum_match(2) }
+    end
+    connection.should have_last_search_with(:mm => 2)
+  end
+
+  it 'sends tiebreaker parameter from options' do
+    session.search Post 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
+    session.search Post 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
+    session.search Post 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
+    session.search Post 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

data/spec/api/query/highlighting_spec.rb

@@ -77,15 +77,24 @@ describe 'highlighted fulltext queries', :type => :query do
     )
   end
 
-  it 'should set options and hihglight fields' do
+  it 'should set highlight fields from DSL' do
     session.search(Post) do
       keywords 'test' do
-        highlight :title, :max_snippets => 3
+        highlight :title
       end
     end
     connection.should have_last_search_with(
-      :"hl.fl"       => %w(title_text),
-      :"hl.snippets" => 3
+      :"hl.fl" => %w(title_text)
+    )
+  end
+
+  it 'should not set formatting params specific to fields if fields specified' do
+    session.search(Post) do
+      keywords 'test', :highlight => :body
+    end
+    connection.should have_last_search_with(
+      :"hl.simple.pre" => '@@@hl@@@',
+      :"hl.simple.post" => '@@@endhl@@@'
     )
   end
 
@@ -100,6 +109,18 @@ describe 'highlighted fulltext queries', :type => :query do
     )
   end
 
+  it 'should set max snippets specific to highlight 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),
+      :"f.title_text.hl.snippets" => 3
+    )
+  end
+
   it 'should set the maximum size' do
     session.search(Post) do
       keywords 'text' do
@@ -111,7 +132,18 @@ describe 'highlighted fulltext queries', :type => :query do
     )
   end
 
-  it 'enables merging of continuous fragments' do
+  it 'should set the maximum size for specific fields' do
+    session.search(Post) 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
     session.search(Post) do
       keywords 'test' do
         highlight :merge_contiguous_fragments => true
@@ -122,7 +154,18 @@ describe 'highlighted fulltext queries', :type => :query do
     )
   end
 
-  it 'enables use of phrase highlighter' do #TODO figure out what the hell this means
+  it 'enables merging of contiguous fragments for specific fields' do
+    session.search(Post) 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
     session.search(Post) do
       keywords 'test' do
         highlight :phrase_highlighter => true
@@ -133,6 +176,17 @@ describe 'highlighted fulltext queries', :type => :query do
     )
   end
 
+  it 'enables use of phrase highlighter for specific fields' do
+    session.search(Post) 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
     session.search(Post) do
       keywords 'test' do
@@ -144,4 +198,28 @@ describe 'highlighted fulltext queries', :type => :query do
     )
   end
 
+  it 'requires field match for specified field if requested' do
+    session.search(Post) 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
+    session.search(Post) 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_texts),
+      :"f.title_text.hl.snippets" => 2,
+      :"f.body_texts.hl.snippets" => 1
+    )
+  end
 end

data/spec/api/search/faceting_spec.rb

@@ -81,6 +81,26 @@ describe 'faceting', :type => :search do
     facet_values(result, :class).should == [Post, Namespaced::Comment]
   end
 
+  it 'should return special :any facet' do
+    stub_query_facet(
+      'category_ids_im:[* TO *]' => 3
+    )
+    search = session.search(Post) { facet(:category_ids, :extra => :any) }
+    row = search.facet(:category_ids).rows.first
+    row.value.should == :any
+    row.count.should == 3
+  end
+
+  it 'should return special :none facet' do
+    stub_query_facet(
+      '-category_ids_im:[* TO *]' => 3
+    )
+    search = session.search(Post) { facet(:category_ids, :extra => :none) }
+    row = search.facet(:category_ids).rows.first
+    row.value.should == :none
+    row.count.should == 3
+  end
+
   it 'should return date range facet' do
     stub_date_facet(:published_at_d, 60*60*24, '2009-07-08T04:00:00Z' => 2, '2009-07-07T04:00:00Z' => 1)
     start_time = Time.utc(2009, 7, 7, 4)
@@ -91,6 +111,16 @@ describe 'faceting', :type => :search do
     facet.rows.last.value.should == ((start_time+24*60*60)..end_time)
   end
 
+  it 'should return date range facet sorted by count' do
+    stub_date_facet(:published_at_d, 60*60*24, '2009-07-08T04:00:00Z' => 2, '2009-07-07T04:00:00Z' => 1)
+    start_time = Time.utc(2009, 7, 7, 4)
+    end_time = start_time + 2*24*60*60
+    result = session.search(Post) { facet(:published_at, :time_range => start_time..end_time, :sort => :count) }
+    facet = result.facet(:published_at)
+    facet.rows.first.value.should == ((start_time+24*60*60)..end_time)
+    facet.rows.last.value.should == (start_time..(start_time+24*60*60))
+  end
+
   it 'returns query facet' do
     stub_query_facet(
       'average_rating_f:[3\.0 TO 5\.0]' => 3,
@@ -118,22 +148,28 @@ describe 'faceting', :type => :search do
       session.search(Post) do
         facet :average_rating, options do
           row(1) { with(:average_rating, 1.0..2.0) }
-          row(2) { with(:average_rating, 2.0..3.0) }
           row(3) { with(:average_rating, 3.0..4.0) }
+          row(2) { with(:average_rating, 2.0..3.0) }
+          row(4) { with(:average_rating, 4.0..5.0) }
         end
       end.facet(:average_rating).rows.map { |row| row.value }
     end
 
     before :each do
       stub_query_facet(
-        'average_rating_f:[1\.0 TO 2\.0]' => 1,
-        'average_rating_f:[2\.0 TO 3\.0]' => 2,
-        'average_rating_f:[3\.0 TO 4\.0]' => 0
+        'average_rating_f:[1\.0 TO 2\.0]' => 2,
+        'average_rating_f:[2\.0 TO 3\.0]' => 3,
+        'average_rating_f:[3\.0 TO 4\.0]' => 1,
+        'average_rating_f:[4\.0 TO 5\.0]' => 0
       )
     end
 
-    it 'sorts lexically by default if no limit is given' do
-      facet_values_from_options.should == [1, 2]
+    it 'sorts in order of specification if no limit is given' do
+      facet_values_from_options.should == [1, 3, 2]
+    end
+
+    it 'sorts lexically if lexical option is specified' do
+      facet_values_from_options(:sort => :index).should == [1, 2, 3]
     end
 
     it 'sorts by count by default if limit is given' do
@@ -141,7 +177,7 @@ describe 'faceting', :type => :search do
     end
 
     it 'sorts by count if count option is specified' do
-      facet_values_from_options(:sort => :count).should == [2, 1]
+      facet_values_from_options(:sort => :count).should == [2, 1, 3]
     end
 
     it 'sorts lexically if lexical option is specified even if limit is given' do
@@ -153,11 +189,11 @@ describe 'faceting', :type => :search do
     end
 
     it 'allows zero count if specified' do
-      facet_values_from_options(:zeros => true).should == [1, 2, 3]
+      facet_values_from_options(:zeros => true).should == [1, 3, 2, 4]
     end
 
     it 'sets minimum count' do
-      facet_values_from_options(:minimum_count => 2).should == [2]
+      facet_values_from_options(:minimum_count => 2).should == [1, 2]
     end
   end
 

data/spec/api/search/highlighting_spec.rb

@@ -21,8 +21,8 @@ describe 'search with highlighting results', :type => :search do
     @search.hits.last.should have(2).highlights(:body)
   end
 
-  it 'returns nil if a given field does not have a highlight' do
-    @search.hits.first.highlights(:body).should be_nil
+  it 'returns an empty array if a given field does not have a highlight' do
+    @search.hits.first.highlights(:body).should == []
   end
 
   it 'should format hits with <em> by default' do

data/spec/api/search/hits_spec.rb

@@ -44,6 +44,11 @@ describe 'hits', :type => :search do
     session.search(Post, Namespaced::Comment).hits.first.stored(:title).should == 'Title'
   end
 
+  it 'should return stored text fields' do
+    stub_full_results('instance' => Post.new, 'body_texts' => 'Body')
+    session.search(Post, Namespaced::Comment).hits.first.stored(:body).should == 'Body'
+  end
+
   it 'should typecast stored field values in hits' do
     time = Time.utc(2008, 7, 8, 2, 45)
     stub_full_results('instance' => Post.new, 'last_indexed_at_ds' => time.xmlschema)

data/spec/integration/faceting_spec.rb

@@ -46,6 +46,7 @@ describe 'search faceting' do
       facet_values.each_with_index do |value, i|
         i.times { Sunspot.index(Post.new(:title => value, :blog_id => 1)) }
       end
+      Sunspot.index(Post.new(:blog_id => 1))
       Sunspot.index(Post.new(:title => 'zero', :blog_id => 2))
       Sunspot.commit
     end
@@ -96,6 +97,24 @@ describe 'search faceting' do
       end
       search.facet(:title).rows.map { |row| row.value }.should == %w(four three two one)
     end
+
+    it 'should return :all facet' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :extra => :any
+      end
+      search.facet(:title).rows.first.value.should == :any
+      search.facet(:title).rows.first.count.should == 10
+    end
+
+    it 'should return :none facet' do
+      search = Sunspot.search(Post) do
+        with :blog_id, 1
+        facet :title, :extra => :none
+      end
+      search.facet(:title).rows.first.value.should == :none
+      search.facet(:title).rows.first.count.should == 1
+    end
   end
 
   context 'date facets' do