sunspot 0.10.5 → 0.10.6

data/lib/sunspot/query/field_facet.rb

@@ -1,128 +1,8 @@
-require 'set'
-
 module Sunspot
   module Query
-    #
-    # Encapsulates a query component representing a field facet. Users create
-    # instances using DSL::Query#facet
-    #
-    class FieldFacet #:nodoc:
-      class <<self
-        protected :new
-
-        # 
-        # Return the appropriate FieldFacet instance for the field and options.
-        # If a :time_range option is specified, and the field type is TimeType,
-        # build a DateFieldFacet. Otherwise, build a normal FieldFacet.
-        #
-        # ==== Returns
-        #
-        # FieldFacet:: FieldFacet instance of appropriate class.
-        #
-        def build(field, options)
-          if options.has_key?(:time_range)
-            unless field.type == Type::TimeType
-              raise(
-                ArgumentError,
-                ":time_range key can only be specified for time fields"
-              )
-            end
-            DateFieldFacet.new(field, options)
-          elsif options.has_key?(:only)
-            QueryFieldFacet.new(field, options.delete(:only), options)
-          else
-            FieldFacet.new(field, options)
-          end
-        end
-      end
-
-      def initialize(field, options)
-        @field, @options = field, options
-      end
-
-      # ==== Returns
-      #
-      # Hash:: solr-ruby params for this field facet
-      #
+    class FieldFacet < AbstractFieldFacet
       def to_params
-        params = { :"facet.field" => [@field.indexed_name], :facet => 'true' }
-        params[param_key(:sort)] = 
-          case @options[:sort]
-          when :count then 'true'
-          when :index then 'false'
-          when nil
-          else raise(ArgumentError, 'Allowed facet sort options are :count and :index')
-          end
-        params[param_key(:limit)] = @options[:limit]
-        params[param_key(:mincount)] =
-          if @options[:minimum_count] then @options[:minimum_count]
-          elsif @options[:zeros] then 0
-          else 1
-          end
-        params
-      end
-
-      private
-
-      # 
-      # Given a facet parameter name, return the appropriate Solr parameter for
-      # this facet.
-      #
-      # ==== Returns
-      #
-      # Symbol:: Solr query parameter key
-      #
-      def param_key(name)
-        :"f.#{@field.indexed_name}.facet.#{name}"
-      end
-    end
-
-    class DateFieldFacet < FieldFacet #:nodoc:
-      # 
-      # Convert the facet to date params.
-      #
-      def to_params
-        super.merge(
-          :"facet.date" => [@field.indexed_name],
-          param_key('date.start') => start_time.utc.xmlschema,
-          param_key('date.end') => end_time.utc.xmlschema,
-          param_key('date.gap') => "+#{interval}SECONDS"
-        )
-      end
-
-      private
-
-      # 
-      # Start time for facet range
-      #
-      # ==== Returns
-      #
-      # Time:: Start time
-      #
-      def start_time
-        @options[:time_range].first
-      end
-
-      # 
-      # End time for facet range
-      #
-      # ==== Returns
-      #
-      # Time:: End time
-      #
-      def end_time
-        @options[:time_range].last
-      end
-
-      # 
-      # Time interval that each facet row should cover. Default is 1 day.
-      #
-      # ===== Returns
-      #
-      # Integer:: Time interval in seconds
-      #
-      def interval
-        @options[:time_interval] || 86400
+        super.merge(:"facet.field" => [@field.indexed_name])
       end
     end
   end

data/lib/sunspot/query/highlighting.rb

@@ -22,22 +22,34 @@ module Sunspot
           params[:"hl.fl"] = @fields.map { |field| field.indexed_name }
         end
         if max_snippets = @options[:max_snippets]
-          params[:"hl.snippets"] = max_snippets
+          params.merge!(make_params('snippets', max_snippets))
         end
         if fragment_size = @options[:fragment_size]
-          params[:"hl.fragsize"] = fragment_size
+          params.merge!(make_params('fragsize', fragment_size))
         end
         if @options[:merge_contiguous_fragments]
-          params[:"hl.mergeContiguous"] = 'true'
+          params.merge!(make_params('mergeContiguous', 'true'))
         end
         if @options[:phrase_highlighter]
-          params[:"hl.usePhraseHighlighter"] = 'true'
+          params.merge!(make_params('usePhraseHighlighter', 'true'))
           if @options[:require_field_match]
-            params[:"hl.requireFieldMatch"] = 'true'
+            params.merge!(make_params('requireFieldMatch', 'true'))
           end
         end
         params
       end
+
+      private
+
+      def make_params(name, value)
+        if @fields.empty?
+          { :"hl.#{name}" => value }
+        else
+          @fields.inject({}) do |hash, field|
+            hash.merge!(:"f.#{field.indexed_name}.hl.#{name}" => value)
+          end
+        end
+      end
     end
   end
 end

data/lib/sunspot/query/query.rb

@@ -5,9 +5,8 @@ module Sunspot
 
       def initialize(types)
         @scope = Scope.new
-        @field_facets = []
-        @query_facets = {}
         @sort = SortComposite.new
+        @components = []
         if types.length == 1
           @scope.add_restriction(TypeField.instance, Restriction::EqualTo, types.first)
         else
@@ -27,21 +26,18 @@ module Sunspot
         @local = Local.new(coordinates, radius)
       end
 
-      def add_field_facet(field, options = {})
-        facet = FieldFacet.build(field, options)
-        if facet.is_a?(QueryFacet)
-          @query_facets[field.name.to_sym] = facet
-        else
-          @field_facets << facet
-        end
+      def add_sort(sort)
+        @sort << sort
       end
 
-      def add_query_facet(name, options = {})
-        @query_facets[name.to_sym] = QueryFacet.new(name, options)
+      def add_field_facet(facet)
+        @components << facet
+        facet
       end
 
-      def add_sort(sort)
-        @sort << sort
+      def add_query_facet(facet)
+        @components << facet
+        facet
       end
 
       def paginate(page, per_page)
@@ -67,15 +63,12 @@ module Sunspot
             @scope.to_params
           end
         Sunspot::Util.deep_merge!(params, @fulltext.to_params) if @fulltext
-        @field_facets.each do |facet|
-          Sunspot::Util.deep_merge!(params, facet.to_params)
-        end
-        @query_facets.values.each do |facet|
-          Sunspot::Util.deep_merge!(params, facet.to_params)
-        end
         Sunspot::Util.deep_merge!(params, @sort.to_params)
         Sunspot::Util.deep_merge!(params, @pagination.to_params) if @pagination
         Sunspot::Util.deep_merge!(params, @local.to_params) if @local
+        @components.each do |component|
+          Sunspot::Util.deep_merge!(params, component.to_params)
+        end
         @parameter_adjustment.call(params) if @parameter_adjustment
         params[:q] ||= '*:*'
         params
@@ -88,10 +81,6 @@ module Sunspot
       def per_page
         @pagination.per_page if @pagination
       end
-
-      def query_facet(name)
-        @query_facets[name] if @query_facets
-      end
     end
   end
 end

data/lib/sunspot/query/query_facet.rb

@@ -1,78 +1,16 @@
 module Sunspot
   module Query
-    # 
-    # QueryFacets encapsulate requests for Sunspot's query faceting capability.
-    # They are created by the FieldQuery#add_query_facet method.
-    #
-    #--
-    #
-    # The actual concept of a QueryFacet is somewhat artificial - it provides a
-    # grouping for the facet at the Sunspot level, which provides a nicer and
-    # more consistent API in Sunspot; Solr does not provide any grouping for
-    # query facet rows, instead returning each requested row individually, keyed
-    # by the boolean phrase used in the facet query.
-    #
-    class QueryFacet #:nodoc:
-      attr_reader :name #:nodoc:
-      attr_reader :field #:nodoc:
-      attr_reader :options #:nodoc:
-
-      def initialize(name, options, setup = nil) #:nodoc:
-        @name, @options, @setup = name, options, setup
-        @components = []
-      end
-
-      #
-      # Add a QueryFacetRow to this facet. The label argument becomes the value
-      # of the Sunspot::QueryFacetRow object corresponding to this query facet
-      # row.
-      #
-      # ==== Parameters
-      #
-      # label<Object>::
-      #   An object that will become the value of the result row. Use whatever
-      #   type is most intuitive.
-      #
-      # ==== Returns
-      #
-      # QueryFacetRow:: QueryFacetRow object containing scope for this row
-      #
-      def add_row(label)
-        @components << row = QueryFacetRow.new(label, @setup)
-        row
-      end
-
-      # 
-      # Express this query facet as Solr parameters
-      #
-      # ==== Returns
-      #
-      # Hash:: Solr params hash
-      #
-      def to_params #:nodoc:
-        components = @components.map { |component| component.to_boolean_phrase }
-        components.compact!
-        if components.empty?
+    class QueryFacet < Connective::Conjunction
+      def to_params
+        if @components.empty?
           {}
         else
-          components = components.first if components.length == 1
           {
             :facet => 'true',
-            :"facet.query" => components
+            :"facet.query" => to_boolean_phrase
           }
         end
       end
-
-      # 
-      # Get query facet rows (used when constructing results)
-      #
-      # ==== Returns
-      #
-      # Array:: Array of QueryFacetRow objects.
-      #
-      def rows #:nodoc:
-        @components
-      end
     end
   end
 end

data/lib/sunspot/query.rb

@@ -1,4 +1,8 @@
-%w(connective boost_query dismax field_facet highlighting local pagination restriction query query_facet query_field_facet query_facet_row scope sort sort_composite text_field_boost).each { |file| require(File.join(File.dirname(__FILE__), 'query', file)) }
+%w(abstract_field_facet connective boost_query date_field_facet dismax
+   field_facet highlighting local pagination restriction query query_facet
+   scope sort sort_composite text_field_boost).each do |file|
+  require(File.join(File.dirname(__FILE__), 'query', file))
+end
 module Sunspot
   module Query #:nodoc:all
   end

data/lib/sunspot/search/date_facet.rb

@@ -0,0 +1,35 @@
+module Sunspot
+  class Search
+    class DateFacet
+      def initialize(field, search, options)
+        @field, @search, @options = field, search, options
+      end
+
+      def field_name
+        @field.name
+      end
+
+      def rows
+        @rows ||=
+          begin
+            data = @search.facet_response['facet_dates'][@field.indexed_name]
+            gap = (@options[:time_interval] || 86400).to_i
+            rows = []
+            data.each_pair do |value, count|
+              if value =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/
+                start_time = @field.cast(value)
+                end_time = start_time + gap
+                rows << FacetRow.new(start_time..end_time, count, self)
+              end
+            end
+            if @options[:sort] == :count
+              rows.sort! { |lrow, rrow| rrow.count <=> lrow.count }
+            else
+              rows.sort! { |lrow, rrow| lrow.value.first <=> rrow.value.first }
+            end
+            rows
+          end
+      end
+    end
+  end
+end

data/lib/sunspot/search/facet_row.rb

@@ -0,0 +1,27 @@
+module Sunspot
+  class Search
+    class FacetRow
+      attr_reader :value, :count
+      attr_writer :instance #:nodoc:
+
+      def initialize(value, count, facet) #:nodoc:
+        @value, @count, @facet = value, count, facet
+      end
+
+      # 
+      # Return the instance referenced by this facet row. Only valid for field
+      # facets whose fields are defined with the :references key.
+      #
+      def instance
+        if !defined?(@instance)
+          @facet.populate_instances
+        end
+        @instance
+      end
+
+      def inspect
+        "<Sunspot::Search::FacetRow:#{value.inspect} (#{count})>"
+      end
+    end
+  end
+end

data/lib/sunspot/search/field_facet.rb

@@ -0,0 +1,44 @@
+module Sunspot
+  class Search
+    class FieldFacet < QueryFacet
+      alias_method :field_name, :name
+
+      def initialize(field, search, options) #:nodoc:
+        super(field.name, search, options)
+        @field = field
+      end
+
+      def rows
+        @rows ||=
+          begin
+            rows = super
+            has_query_facets = !rows.empty?
+            if @search.facet_response['facet_fields']
+              if data = @search.facet_response['facet_fields'][@field.indexed_name]
+                data.each_slice(2) do |value, count|
+                  rows << FacetRow.new(@field.cast(value), count, self)
+                end
+              end
+            end
+            sort_rows!(rows) if has_query_facets
+            rows
+          end
+      end
+
+      def populate_instances #:nodoc:
+        if reference = @field.reference
+          values_hash = rows.inject({}) do |hash, row|
+            hash[row.value] = row
+            hash
+          end
+          instances = Adapters::DataAccessor.create(Sunspot::Util.full_const_get(reference)).load_all(
+            values_hash.keys
+          )
+          instances.each do |instance|
+            values_hash[Adapters::InstanceAdapter.adapt(instance).id].instance = instance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/search/hit.rb

@@ -49,7 +49,7 @@ module Sunspot
           highlights_cache.values.flatten 
         else
           highlights_cache[field_name.to_sym]
-        end
+        end || []
       end
 
       # 
@@ -64,11 +64,7 @@ module Sunspot
       #   The name of the field for which to retrieve the stored value.
       #
       def stored(field_name)
-        @stored_cache[field_name.to_sym] ||=
-          begin
-            field = setup.field(field_name)
-            field.cast(@stored_values[field.indexed_name])
-          end
+        @stored_cache[field_name.to_sym] ||= stored_value(field_name)
       end
 
       # 
@@ -108,6 +104,14 @@ module Sunspot
             cache
           end
       end
+
+      def stored_value(field_name)
+        setup.stored_fields(field_name).each do |field|
+          if value = @stored_values[field.indexed_name]
+            return field.cast(value)
+          end
+        end
+      end
     end
   end
 end

data/lib/sunspot/search/query_facet.rb

@@ -0,0 +1,62 @@
+module Sunspot
+  class Search
+    class QueryFacet
+      RequestedFacet = Struct.new(:label, :boolean_phrase) #:nodoc:
+
+      attr_reader :name
+
+      def initialize(name, search, options) #:nodoc:
+        @name, @search, @options = name, search, options
+        @requested_facets = []
+      end
+
+      def rows
+        @rows ||=
+          begin
+            data = @search.facet_response['facet_queries']
+            rows = []
+            minimum_count =
+              case
+              when @options[:minimum_count] then @options[:minimum_count]
+              when @options[:zeros] then 0
+              else 1
+              end
+            @requested_facets.each do |requested_facet|
+              count = data[requested_facet.boolean_phrase] || 0
+              if count >= minimum_count
+                rows << FacetRow.new(requested_facet.label, count, self)
+              end
+            end
+            sort_rows!(rows)
+          end
+      end
+
+      def add_row(label, boolean_phrase) #:nodoc:
+        @requested_facets << RequestedFacet.new(label, boolean_phrase)
+      end
+
+      private
+
+      def sort_rows!(rows)
+        case @options[:sort] || (:count if @options[:limit])
+        when :count
+          rows.sort! { |lrow, rrow| rrow.count <=> lrow.count }
+        when :index
+          rows.sort! do |lrow, rrow|
+            if lrow.respond_to?(:<=>)
+              lrow.value <=> rrow.value
+            elsif lrow.respond_to?(:first) && rrow.respond_to?(:first) && lrow.first.respond_to?(:<=>)
+              lrow.first.value <=> rrow.first.value
+            else
+              lrow.value.to_s <=> rrow.value.to_s
+            end
+          end
+        end
+        if @options[:limit]
+          rows.slice!(@options[:limit], rows.length)
+        end
+        rows
+      end
+    end
+  end
+end

data/lib/sunspot/search.rb

@@ -1,4 +1,5 @@
-%w(hit highlight).each do |file|
+%w(query_facet field_facet date_facet facet_row hit
+   highlight).each do |file|
   require File.join(File.dirname(__FILE__), 'search', file)
 end
 
@@ -19,6 +20,7 @@ module Sunspot
     def initialize(connection, setup, query, configuration) #:nodoc:
       @connection, @setup, @query = connection, setup, query
       @query.paginate(1, configuration.pagination.default_per_page)
+      @facets = {}
     end
 
     #
@@ -86,17 +88,7 @@ module Sunspot
     # Sunspot::Facet object.
     #
     def facet(name)
-      (@facets_cache ||= {})[name.to_sym] ||=
-        begin
-          facet_data = query_facet_data(name) ||
-            begin
-              field = field(name)
-              date_facet_data(field) ||
-                FacetData::FieldFacetData.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field)
-            end
-          facet_class = facet_data.reference ? InstantiatedFacet : Facet
-          facet_class.new(facet_data)
-        end
+      @facets[name]
     end
 
     # 
@@ -126,11 +118,7 @@ module Sunspot
     #     #=> Facet for the dynamic field :cuisine in the :custom field definition
     # 
     def dynamic_facet(base_name, dynamic_name)
-      (@dynamic_facets_cache ||= {})[[base_name.to_sym, dynamic_name.to_sym]] ||=
-        begin
-          field = @setup.dynamic_field_factory(base_name).build(dynamic_name)
-          Facet.new(FacetData::FieldFacetData.new(@solr_result['facet_counts']['facet_fields'][field.indexed_name], field))
-        end
+      facet(:"#{base_name}:#{dynamic_name}")
     end
 
     # 
@@ -188,6 +176,22 @@ module Sunspot
       "<Sunspot::Search:#{query.to_params.inspect}>"
     end
 
+    def add_field_facet(field, options = {}) #:nodoc:
+      @facets[field.name] = FieldFacet.new(field, self, options)
+    end
+
+    def add_date_facet(field, options) #:nodoc:
+      @facets[field.name] = DateFacet.new(field, self, options)
+    end
+
+    def add_query_facet(name, options) #:nodoc:
+      @facets[name] = QueryFacet.new(name, self, options)
+    end
+
+    def facet_response #:nodoc:
+      @solr_result['facet_counts']
+    end
+
     private
 
     def solr_response
@@ -198,41 +202,15 @@ module Sunspot
       DSL::Search.new(self, @setup)
     end
 
-    def date_facet_data(field)
-      if field.type == Type::TimeType
-        if @solr_result['facet_counts'].has_key?('facet_dates')
-          if facet_result = @solr_result['facet_counts']['facet_dates'][field.indexed_name]
-            FacetData::DateFacetData.new(facet_result, field)
-          end
-        end
-      end
-    end
-
-    def query_facet_data(name)
-      if query_facet = @query.query_facet(name.to_sym)
-        if @solr_result['facet_counts'].has_key?('facet_queries')
-            FacetData::QueryFacetData.new(
-              query_facet,
-              @solr_result['facet_counts']['facet_queries']
-            )
-        end
-      end
-    end
-
     def highlights_for(doc)
       if @solr_result['highlighting']
         @solr_result['highlighting'][doc['id']]
       end
     end
-
-    def field(name)
-      @setup.field(name)
-    end
     
     # Clear out all the cached ivars so the search can be called again.
     def reset
-      @results = @hits = @total = @facets_cache = 
-        @dynamic_facets_cache = @solr_response = @doc_ids = nil
+      @results = @hits = @total = @solr_response = @doc_ids = nil
     end
   end
 end