sunspot 2.1.0 → 2.1.1

data/lib/sunspot/search.rb

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

data/lib/sunspot/search/abstract_search.rb

@@ -3,24 +3,24 @@ require 'sunspot/search/hit_enumerable'
 
 module Sunspot
   module Search #:nodoc:
-    
-    # 
+
+    #
     # This class encapsulates the results of a Solr search. It provides access
     # to search results, total result count, facets, and pagination information.
     # Instances of Search are returned by the Sunspot.search and
     # Sunspot.new_search methods.
     #
     class AbstractSearch
-      # 
+      #
       # 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, :groups
+      attr_reader :facets, :groups, :stats
       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)
@@ -30,8 +30,11 @@ module Sunspot
 
         @groups_by_name = {}
         @groups = []
+
+        @stats_by_name = {}
+        @stats = []
       end
-  
+
       #
       # Execute the search on the Solr instance and store the results. If you
       # use Sunspot#search() to construct your searches, there is no need to call
@@ -49,8 +52,8 @@ module Sunspot
       def execute! #:nodoc: deprecated
         execute
       end
-  
-      # 
+
+      #
       # Get the collection of results as instantiated objects. If WillPaginate is
       # available, the results will be a WillPaginate::Collection instance; if
       # not, it will be a vanilla Array.
@@ -65,8 +68,8 @@ module Sunspot
       def results
         @results ||= paginate_collection(verified_hits.map { |hit| hit.instance })
       end
-  
-      # 
+
+      #
       # Access raw Solr result information. Returns a collection of Hit objects
       # that contain the class name, primary key, keyword relevance score (if
       # applicable), and any stored fields.
@@ -92,7 +95,7 @@ module Sunspot
       end
       alias_method :raw_results, :hits
 
-      # 
+      #
       # The total number of documents matching the query parameters
       #
       # ==== Returns
@@ -102,8 +105,8 @@ module Sunspot
       def total
         @total ||= solr_response['numFound'] || 0
       end
-  
-      # 
+
+      #
       # The time elapsed to generate the Solr response
       #
       # ==== Returns
@@ -113,8 +116,8 @@ module Sunspot
       def query_time
         @query_time ||= solr_response_header['QTime']
       end
-  
-      # 
+
+      #
       # Get the facet object for the given name. `name` can either be the name
       # given to a query facet, or the field name of a field facet. Returns a
       # Sunspot::Facet object.
@@ -164,28 +167,38 @@ module Sunspot
         end
       end
 
+      def stats(name)
+        if name
+          @stats_by_name[name.to_sym]
+        end
+      end
+
       def group(name)
         if name
           @groups_by_name[name.to_sym]
         end
       end
-  
-      # 
+
+      #
       # Deprecated in favor of optional second argument to #facet
       #
       def dynamic_facet(base_name, dynamic_name) #:nodoc:
         facet(base_name, dynamic_name)
       end
-  
+
       def facet_response #:nodoc:
         @solr_result['facet_counts']
       end
 
+      def stats_response #:nodoc:
+        @solr_result['stats']['stats_fields']
+      end
+
       def group_response #:nodoc:
         @solr_result['grouped']
       end
-  
-      # 
+
+      #
       # Build this search using a DSL block. This method can be called more than
       # once on an unexecuted search (e.g., Sunspot.new_search) in order to build
       # a search incrementally.
@@ -202,8 +215,8 @@ module Sunspot
         Util.instance_eval_or_call(dsl, &block)
         self
       end
-  
-  
+
+
       def inspect #:nodoc:
         "<Sunspot::Search:#{query.to_params.inspect}>"
       end
@@ -211,16 +224,16 @@ module Sunspot
       def add_field_group(field) #:nodoc:
         add_group(field.name, FieldGroup.new(field, self))
       end
-  
+
       def add_field_facet(field, options = {}) #:nodoc:
         name = (options[:name] || field.name)
         add_facet(name, FieldFacet.new(field, self, options))
       end
-  
+
       def add_query_facet(name, options) #:nodoc:
         add_facet(name, QueryFacet.new(name, self, options))
       end
-  
+
       def add_date_facet(field, options) #:nodoc:
         name = (options[:name] || field.name)
         add_facet(name, DateFacet.new(field, self, options))
@@ -231,26 +244,30 @@ module Sunspot
         add_facet(name, RangeFacet.new(field, self, options))
       end
 
+      def add_field_stats(field) #:nodoc:
+        add_stats(field.name, FieldStats.new(field, self))
+      end
+
       def highlights_for(doc) #:nodoc:
         if @solr_result['highlighting']
           @solr_result['highlighting'][doc['id']]
         end
       end
-  
+
       private
-  
+
       def dsl
-        raise NotImplementedError 
+        raise NotImplementedError
       end
-  
+
       def execute_request(params)
         raise NotImplementedError
       end
-  
+
       def solr_response
         @solr_response ||= @solr_result['response'] || {}
       end
-  
+
       def solr_response_header
         @solr_response_header ||= @solr_result['responseHeader'] || {}
       end
@@ -258,25 +275,30 @@ module Sunspot
       def solr_docs
         solr_response['docs']
       end
-  
+
       def verified_hits
         @verified_hits ||= paginate_collection(super)
       end
-  
+
       def paginate_collection(collection)
         PaginatedCollection.new(collection, @query.page, @query.per_page, total)
       end
-  
+
       def add_facet(name, facet)
         @facets << facet
         @facets_by_name[name.to_sym] = facet
       end
 
+      def add_stats(name, stats)
+        @stats << stats
+        @stats_by_name[name.to_sym] = stats
+      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
         @results = @hits = @verified_hits = @total = @solr_response = @doc_ids = nil

data/lib/sunspot/search/field_facet.rb

@@ -1,6 +1,6 @@
 module Sunspot
   module Search
-    # 
+    #
     # A FieldFacet is a facet whose rows are all values for a certain field, in
     # contrast to a QueryFacet, whose rows represent arbitrary queries.
     #
@@ -14,7 +14,7 @@ module Sunspot
         @field.name
       end
 
-      # 
+      #
       # Get the rows returned for this facet.
       #
       # ==== Options (options)
@@ -50,7 +50,7 @@ module Sunspot
         end
       end
 
-      # 
+      #
       # If this facet references a model class, populate the rows with instances
       # of the model class by loading them out of the appropriate adapter.
       #
@@ -79,7 +79,7 @@ module Sunspot
           rows
         end
       end
-      
+
       def key
         @key ||= (@options[:name] || @field.indexed_name).to_s
       end

data/lib/sunspot/search/field_stats.rb

@@ -0,0 +1,21 @@
+module Sunspot
+  module Search
+    class FieldStats < StatsRow
+      def initialize(field, search) #:nodoc:
+        @field, @search, @facet_fields = field, search, []
+      end
+
+      def add_facet field
+        @facet_fields << field
+      end
+
+      def field_name
+        @field.name
+      end
+
+      def data
+        @search.stats_response[@field.indexed_name]
+      end
+    end
+  end
+end

data/lib/sunspot/search/stats_facet.rb

@@ -0,0 +1,25 @@
+module Sunspot
+  module Search
+    class StatsFacet < FieldFacet
+      attr_reader :field
+
+      def initialize(field, data) #:nodoc:
+        @field, @data = field, data
+      end
+
+      def rows(options = {})
+        if options[:verified]
+          verified_rows
+        else
+          @rows ||= @data.map do |value, data|
+            StatsRow.new(data, self, @field.type.cast(value))
+          end.sort_by { |row| row.value.to_s }
+        end
+      end
+
+      def inspect
+        "<Sunspot::Search::StatsFacet:#{@field}>"
+      end
+    end
+  end
+end

data/lib/sunspot/search/stats_row.rb

@@ -0,0 +1,66 @@
+module Sunspot
+  module Search
+    class StatsRow
+      attr_reader :data, :value
+      attr_writer :instance #:nodoc:
+
+      def initialize(data, facet = nil, value = nil) #:nodoc:
+        @data, @facet, @value = data, facet, value
+        @facet_fields = []
+      end
+
+      def min
+        data['min']
+      end
+
+      def max
+        data['max']
+      end
+
+      def count
+        data['count']
+      end
+
+      def sum
+        data['sum']
+      end
+
+      def missing
+        data['missing']
+      end
+
+      def sum_of_squares
+        data['sumOfSquares']
+      end
+
+      def mean
+        data['mean']
+      end
+
+      def standard_deviation
+        data['stddev']
+      end
+
+      def facet name
+        facets.find { |facet| facet.field.name == name.to_sym }
+      end
+
+      def facets
+        @facets ||= @facet_fields.map do |field|
+          StatsFacet.new(field, data['facets'][field.indexed_name])
+        end
+      end
+
+      def instance
+        if !defined?(@instance)
+          @facet.populate_instances
+        end
+        @instance
+      end
+
+      def inspect
+        "<Sunspot::Search::StatsRow:#{value.inspect} min=#{min} max=#{max} count=#{count}>"
+      end
+    end
+  end
+end

data/lib/sunspot/session.rb

@@ -142,29 +142,29 @@ module Sunspot
     # 
     # See Sunspot.remove!
     #
-    def remove!(*objects)
-      remove(*objects)
+    def remove!(*objects, &block)
+      remove(*objects, &block)
       commit
     end
 
     # 
     # See Sunspot.remove_by_id
     #
-    def remove_by_id(clazz, id)
+    def remove_by_id(clazz, *ids)
       class_name =
         if clazz.is_a?(Class)
           clazz.name
         else
           clazz.to_s
         end
-      indexer.remove_by_id(class_name, id)
+      indexer.remove_by_id(class_name, ids)
     end
 
     # 
     # See Sunspot.remove_by_id!
     #
-    def remove_by_id!(clazz, id)
-      remove_by_id(clazz, id)
+    def remove_by_id!(clazz, *ids)
+      remove_by_id(clazz, ids)
       commit
     end
 

data/lib/sunspot/session_proxy/class_sharding_session_proxy.rb

@@ -23,15 +23,17 @@ module Sunspot
       # 
       # See Sunspot.remove_by_id
       #
-      def remove_by_id(clazz, id)
-        session_for_class(clazz).remove_by_id(clazz, id)
+      def remove_by_id(clazz, *ids)
+        ids.flatten!
+        session_for_class(clazz).remove_by_id(clazz, ids)
       end
 
       # 
       # See Sunspot.remove_by_id!
       #
-      def remove_by_id!(clazz, id)
-        session_for_class(clazz).remove_by_id!(clazz, id)
+      def remove_by_id!(clazz, *ids)
+        ids.flatten!
+        session_for_class(clazz).remove_by_id!(clazz, ids)
       end
 
       #