erichummel-sunspot 1.2.1 → 2.0.0.pre.111215

data/lib/sunspot/dsl/scope.rb

@@ -3,9 +3,9 @@ module Sunspot
     # 
     # This DSL presents methods for constructing restrictions and other query
     # elements that are specific to fields. As well as being a superclass of
-    # Sunspot::DSL::Query, which presents the main query block, this DSL class
-    # is also used directly inside the #dynamic() block, which only allows
-    # operations on specific fields.
+    # Sunspot::DSL::StandardQuery, which presents the main query block, this
+    # DSL class is also used directly inside the #dynamic() block, which only
+    # allows operations on specific fields.
     #
     class Scope
       NONE = Object.new
@@ -41,7 +41,7 @@ module Sunspot
       #
       # ==== Returns
       #
-      # Sunspot::DSL::Query::Restriction::
+      # Sunspot::DSL::Restriction::
       #   Restriction DSL object (if only one argument is passed which is a
       #   field name)
       #

data/lib/sunspot/dsl/search.rb

@@ -2,8 +2,8 @@ module Sunspot
   module DSL
     # 
     # This top-level DSL class is the context in which the block passed to
-    # Sunspot.query. See Sunspot::DSL::Query, Sunspot::DSL::FieldQuery, and
-    # Sunspot::DSL::Scope for the full API presented.
+    # Sunspot.query. See Sunspot::DSL::StandardQuery, Sunspot::DSL::FieldQuery,
+    # and Sunspot::DSL::Scope for the full API presented.
     #
     class Search < StandardQuery
       def initialize(search, setup) #:nodoc:

data/lib/sunspot/dsl/standard_query.rb

@@ -35,6 +35,8 @@ module Sunspot
       # :highlight<Boolean,Array>::
       #   If true, perform keyword highlighting on all searched fields. If an
       #   array of field names, perform highlighting on the specified fields.
+      #   Note that for highlighting to work, the desired fields have to be set
+      #   up with :stored => true.
       #   This can also be called from within the fulltext block.
       # :minimum_match<Integer>::
       #   The minimum number of search terms that a result must match. By

data/lib/sunspot/indexer.rb

@@ -1,3 +1,5 @@
+require 'sunspot/batcher'
+
 module Sunspot
   # 
   # This class presents a service for adding, updating, and removing data
@@ -22,10 +24,10 @@ module Sunspot
     #
     def add(model)
       documents = Util.Array(model).map { |m| prepare(m) }
-      if @batch.nil?
-        add_documents(documents)
+      if batcher.batching?
+        batcher.concat(documents)
       else
-        @batch.concat(documents)
+        add_documents(documents)
       end
     end
 
@@ -69,19 +71,22 @@ module Sunspot
     # Start batch processing
     #
     def start_batch
-      @batch = []
+      batcher.start_new
     end
 
     #
     # Write batch out to Solr and clear it
     #
     def flush_batch
-      add_documents(@batch)
-      @batch = nil
+      add_documents(batcher.end_current)
     end
 
     private
 
+    def batcher
+      @batcher ||= Batcher.new
+    end
+
     # 
     # Convert documents into hash of indexed properties
     #
@@ -107,7 +112,7 @@ module Sunspot
     # pairs.
     #
     def document_for(model)
-      RSolr::Message::Document.new(
+      RSolr::Xml::Document.new(
         :id => Adapters::InstanceAdapter.adapt(model).index_id,
         :type => Util.superclasses_for(model.class).map { |clazz| clazz.name }
       )

data/lib/sunspot/query.rb

@@ -1,8 +1,8 @@
 %w(filter abstract_field_facet connective boost_query date_field_facet dismax
    field_facet highlighting pagination restriction common_query
-   standard_query more_like_this more_like_this_query geo query_facet scope
-   sort sort_composite text_field_boost function_query
-   composite_fulltext).each do |file|
+   standard_query more_like_this more_like_this_query geo geofilt bbox query_facet
+   scope sort sort_composite text_field_boost function_query
+   composite_fulltext field_group).each do |file|
   require(File.join(File.dirname(__FILE__), 'query', file))
 end
 module Sunspot

data/lib/sunspot/query/bbox.rb

@@ -0,0 +1,15 @@
+module Sunspot
+  module Query
+    class Bbox
+      def initialize(field, first_corner, second_corner)
+        @field, @first_corner, @second_corner = field, first_corner, second_corner
+      end
+
+      def to_params
+        filter = "#{@field.indexed_name}:[#{@first_corner.join(",")} TO #{@second_corner.join(",")}]"
+
+        {:fq => filter}
+      end
+    end
+  end
+end

data/lib/sunspot/query/common_query.rb

@@ -20,6 +20,11 @@ module Sunspot
         @sort << sort
       end
 
+      def add_group(group)
+        @components << group
+        group
+      end
+
       def add_field_facet(facet)
         @components << facet
         facet
@@ -35,12 +40,18 @@ module Sunspot
         function
       end
 
-      def paginate(page, per_page)
+      def add_geo(geo)
+        @components << geo
+        geo
+      end
+
+      def paginate(page, per_page, offset = nil)
         if @pagination
+          @pagination.offset = offset
           @pagination.page = page
           @pagination.per_page = per_page
         else
-          @components << @pagination = Pagination.new(page, per_page)
+          @components << @pagination = Pagination.new(page, per_page, offset)
         end
       end
 

data/lib/sunspot/query/dismax.rb

@@ -64,7 +64,7 @@ module Sunspot
         params.delete :defType
         params.delete :fl
         keywords = params.delete(:q)
-        options = params.map { |key, value| "#{key}='#{escape_quotes(value)}'"}.join(' ')
+        options = params.map { |key, value| escape_param(key, value) }.join(' ')
         "_query_:\"{!dismax #{options}}#{escape_quotes(keywords)}\""
       end
 
@@ -117,6 +117,10 @@ module Sunspot
 
 
       private
+      
+      def escape_param(key, value)
+        "#{key}='#{escape_quotes(Array(value).join(" "))}'"
+      end
 
       def escape_quotes(value)
         return value unless value.is_a? String

data/lib/sunspot/query/field_group.rb

@@ -0,0 +1,36 @@
+module Sunspot
+  module Query
+    #
+    # A FieldGroup groups by the unique values of a given field.
+    #
+    class FieldGroup
+      attr_accessor :limit, :truncate
+
+      def initialize(field)
+        if field.multiple?
+          raise(ArgumentError, "#{field.name} cannot be used for grouping because it is a multiple-value field")
+        end
+        @field = field
+
+        @sort = SortComposite.new
+      end
+
+      def add_sort(sort)
+        @sort << sort
+      end
+
+      def to_params
+        params = {
+          :group         => "true",
+          :"group.field" => @field.indexed_name,
+        }
+
+        params.merge!(@sort.to_params("group."))
+        params[:"group.limit"] = @limit if @limit
+        params[:"group.truncate"] = @truncate if @truncate
+
+        params
+      end
+    end
+  end
+end

data/lib/sunspot/query/geofilt.rb

@@ -0,0 +1,16 @@
+module Sunspot
+  module Query
+    class Geofilt
+      def initialize(field, lat, lon, radius, options = {})
+        @field, @lat, @lon, @radius, @options = field, lat, lon, radius, options
+      end
+
+      def to_params
+        func = @options[:bbox] ? "bbox" : "geofilt"
+
+        filter = "{!#{func} sfield=#{@field.indexed_name} pt=#{@lat},#{@lon} d=#{@radius}}"
+        {:fq => filter}
+      end
+    end
+  end
+end

data/lib/sunspot/query/highlighting.rb

@@ -9,7 +9,7 @@ module Sunspot
         @options = options
       end
 
-      # 
+      #
       # Return Solr highlighting params
       #
       def to_params
@@ -36,6 +36,13 @@ module Sunspot
             params.merge!(make_params('requireFieldMatch', 'true'))
           end
         end
+        if formatter = @options[:formatter]
+          params.merge!(make_params('formatter', formatter))
+        end
+        if fragmenter = @options[:fragmenter]
+          params.merge!(make_params('fragmenter', fragmenter))
+        end
+
         params
       end
 

data/lib/sunspot/query/pagination.rb

@@ -6,10 +6,10 @@ module Sunspot
     # reference to it and updates it if pagination is changed.
     #
     class Pagination #:nodoc:
-      attr_reader :page, :per_page
+      attr_reader :page, :per_page, :offset
 
-      def initialize(page = nil, per_page = nil)
-        self.page, self.per_page = page, per_page
+      def initialize(page = nil, per_page = nil, offset = nil)
+        self.offset, self.page, self.per_page = offset, page, per_page
       end
 
       def to_params
@@ -24,10 +24,14 @@ module Sunspot
         @per_page = per_page.to_i if per_page
       end
 
+      def offset=(offset)
+        @offset = offset.to_i
+      end
+
       private
 
       def start
-        (@page - 1) * @per_page
+        (@page - 1) * @per_page + @offset
       end
 
       def rows

data/lib/sunspot/query/sort.rb

@@ -90,6 +90,20 @@ module Sunspot
           "score #{direction_for_solr}"
         end
       end
+
+      #
+      # A GeodistSort sorts by distance from a given point.
+      #
+      class GeodistSort < FieldSort
+        def initialize(field, lat, lon, direction)
+          @lat, @lon = lat, lon
+          super(field, direction)
+        end
+
+        def to_param
+          "geodist(#{@field.indexed_name.to_sym},#{@lat},#{@lon}) #{direction_for_solr}"
+        end
+      end
     end
   end
 end

data/lib/sunspot/query/sort_composite.rb

@@ -21,9 +21,10 @@ module Sunspot
       # 
       # Combine the sorts into a single param by joining them
       #
-      def to_params
+      def to_params(prefix = "")
         unless @sorts.empty?
-          { :sort => @sorts.map { |sort| sort.to_param } * ', ' }
+          key = "#{prefix}sort".to_sym
+          { key => @sorts.map { |sort| sort.to_param } * ', ' }
         else
           {}
         end

data/lib/sunspot/search.rb

@@ -1,5 +1,5 @@
 %w(abstract_search standard_search more_like_this_search query_facet field_facet
-   date_facet facet_row hit highlight).each do |file|
+   date_facet facet_row hit highlight field_group group hit_enumerable).each do |file|
   require File.join(File.dirname(__FILE__), 'search', file)
 end
 

data/lib/sunspot/search/abstract_search.rb

@@ -1,4 +1,5 @@
 require 'sunspot/search/paginated_collection'
+require 'sunspot/search/hit_enumerable'
 
 module Sunspot
   module Search #:nodoc:
@@ -14,15 +15,21 @@ module Sunspot
       # Retrieve all facet objects defined for this search, in order they were
       # defined. To retrieve an individual facet by name, use #facet()
       #
-      attr_reader :facets
+      attr_reader :facets, :groups
       attr_reader :query #:nodoc:
       attr_accessor :request_handler
+
+      include HitEnumerable
   
       def initialize(connection, setup, query, configuration) #:nodoc:
         @connection, @setup, @query = connection, setup, query
         @query.paginate(1, configuration.pagination.default_per_page)
+
         @facets = []
         @facets_by_name = {}
+
+        @groups_by_name = {}
+        @groups = []
       end
   
       #
@@ -35,7 +42,7 @@ module Sunspot
       def execute
         reset
         params = @query.to_params
-        @solr_result = @connection.request("/#{request_handler}", params, {:header => {'Content-Type' => 'application/x-www-form-urlencoded'}})
+        @solr_result = @connection.post "#{request_handler}", :data => params
         self
       end
 
@@ -78,44 +85,33 @@ module Sunspot
       #
       def hits(options = {})
         if options[:verify]
-          verified_hits
+          super
         else
-          @hits ||=
-            begin
-              hits = if solr_response && solr_response['docs']
-                solr_response['docs'].map do |doc|
-                  Hit.new(doc, highlights_for(doc), self)
-                end
-              end
-              paginate_collection(hits || [])
-            end
+          @hits ||= paginate_collection(super)
         end
       end
       alias_method :raw_results, :hits
-  
+
+      # 
+      # The total number of documents matching the query parameters
       #
-      # Convenience method to iterate over hit and result objects. Block is
-      # yielded a Sunspot::Server::Hit instance and a Sunspot::Server::Result
-      # instance.
+      # ==== Returns
       #
-      # Note that this method iterates over verified hits (see #hits method
-      # for more information).
+      # Integer:: Total matching documents
       #
-      def each_hit_with_result
-        verified_hits.each do |hit|
-          yield(hit, hit.result)
-        end
+      def total
+        @total ||= solr_response['numFound'] || 0
       end
   
       # 
-      # The total number of documents matching the query parameters
+      # The time elapsed to generate the Solr response
       #
       # ==== Returns
       #
-      # Integer:: Total matching documents
+      # Integer:: Query runtime in milliseconds
       #
-      def total
-        @total ||= solr_response['numFound'] || 0
+      def query_time
+        @query_time ||= solr_response_header['QTime']
       end
   
       # 
@@ -167,6 +163,12 @@ module Sunspot
           end
         end
       end
+
+      def group(name)
+        if name
+          @groups_by_name[name.to_sym]
+        end
+      end
   
       # 
       # Deprecated in favor of optional second argument to #facet
@@ -178,19 +180,9 @@ module Sunspot
       def facet_response #:nodoc:
         @solr_result['facet_counts']
       end
-  
-      # 
-      # Get the data accessor that will be used to load a particular class out of
-      # persistent storage. Data accessors can implement any methods that may be
-      # useful for refining how data is loaded out of storage. When building a
-      # search manually (e.g., using the Sunspot#new_search method), this should
-      # be used before calling #execute(). Use the
-      # Sunspot::DSL::Search#data_accessor_for method when building searches using
-      # the block DSL.
-      #
-      def data_accessor_for(clazz) #:nodoc:
-        (@data_accessors ||= {})[clazz.name.to_sym] ||=
-          Adapters::DataAccessor.create(clazz)
+
+      def group_response #:nodoc:
+        @solr_result['grouped']
       end
   
       # 
@@ -211,31 +203,14 @@ module Sunspot
         self
       end
   
-      # 
-      # Populate the Hit objects with their instances. This is invoked the first
-      # time any hit has its instance requested, and all hits are loaded as a
-      # batch.
-      #
-      def populate_hits #:nodoc:
-        id_hit_hash = Hash.new { |h, k| h[k] = {} }
-        hits.each do |hit|
-          id_hit_hash[hit.class_name][hit.primary_key] = hit
-        end
-        id_hit_hash.each_pair do |class_name, hits|
-          ids = hits.map { |id, hit| hit.primary_key }
-          data_accessor = data_accessor_for(Util.full_const_get(class_name))
-          hits_for_class = id_hit_hash[class_name]
-          data_accessor.load_all(ids).each do |result|
-            hit = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
-            hit.result = result
-          end
-          hits_for_class.values.each { |hit| hit.result = nil }
-        end
-      end
   
       def inspect #:nodoc:
         "<Sunspot::Search:#{query.to_params.inspect}>"
       end
+
+      def add_field_group(field, options = {}) #:nodoc:
+        add_group(field.name, FieldGroup.new(field, self, options))
+      end
   
       def add_field_facet(field, options = {}) #:nodoc:
         name = (options[:name] || field.name)
@@ -250,6 +225,12 @@ module Sunspot
         name = (options[:name] || field.name)
         add_facet(name, DateFacet.new(field, self, options))
       end
+
+      def highlights_for(doc) #:nodoc:
+        if @solr_result['highlighting']
+          @solr_result['highlighting'][doc['id']]
+        end
+      end
   
       private
   
@@ -265,14 +246,16 @@ module Sunspot
         @solr_response ||= @solr_result['response'] || {}
       end
   
-      def highlights_for(doc)
-        if @solr_result['highlighting']
-          @solr_result['highlighting'][doc['id']]
-        end
+      def solr_response_header
+        @solr_response_header ||= @solr_result['responseHeader'] || {}
+      end
+
+      def solr_docs
+        solr_response['docs']
       end
   
       def verified_hits
-        @verified_hits ||= paginate_collection(hits.select { |hit| hit.instance })
+        @verified_hits ||= paginate_collection(super)
       end
   
       def paginate_collection(collection)
@@ -283,6 +266,11 @@ module Sunspot
         @facets << facet
         @facets_by_name[name.to_sym] = facet
       end
+
+      def add_group(name, group)
+        @groups << group
+        @groups_by_name[name.to_sym] = group
+      end
       
       # Clear out all the cached ivars so the search can be called again.
       def reset