sunspot 2.0.0 → 2.5.0

data/lib/sunspot/search/cursor_paginated_collection.rb

@@ -0,0 +1,32 @@
+module Sunspot
+  module Search
+
+    class CursorPaginatedCollection < Array
+      attr_reader :per_page, :total_count, :current_cursor, :next_page_cursor
+      alias :total_entries :total_count
+      alias :limit_value :per_page
+
+      def initialize(collection, per_page, total, current_cursor, next_page_cursor)
+        @per_page         = per_page
+        @total_count      = total
+        @current_cursor   = current_cursor
+        @next_page_cursor = next_page_cursor
+
+        replace collection
+      end
+
+      def total_pages
+        (total_count.to_f / per_page).ceil
+      end
+      alias :num_pages :total_pages
+
+      def first_page?
+        current_cursor == '*'
+      end
+
+      def last_page?
+        count < per_page
+      end
+    end
+  end
+end

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_json_facet.rb

@@ -0,0 +1,33 @@
+module Sunspot
+  module Search
+    class FieldJsonFacet
+
+      attr_reader :name
+
+      def initialize(field, search, options)
+        @name, @search, @options = name, search, options
+        @field = field
+      end
+
+      def rows
+        @rows ||=
+          begin
+            json_facet_response = @search.json_facet_response[@field.name.to_s]
+            data = json_facet_response.nil? ? [] : json_facet_response['buckets']
+            rows = []
+            data.each do |d|
+              rows << JsonFacetRow.new(d, self)
+            end
+
+            if @options[:sort] == :count
+              rows.sort! { |lrow, rrow| rrow.count <=> lrow.count }
+            else
+              rows.sort! { |lrow, rrow| lrow.value <=> rrow.value }
+            end
+            rows
+          end
+
+      end
+    end
+  end
+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/hit.rb

@@ -17,6 +17,10 @@ module Sunspot
       # Class name of object associated with this hit, as string.
       #
       attr_reader :class_name
+      #
+      # ID prefix used for compositeId shard router
+      #
+      attr_reader :id_prefix
       # 
       # Keyword relevance score associated with this result. Nil if this hit
       # is not from a keyword search.
@@ -27,7 +31,8 @@ module Sunspot
       attr_writer :result #:nodoc:
 
       def initialize(raw_hit, highlights, search) #:nodoc:
-        @class_name, @primary_key = *raw_hit['id'].match(/([^ ]+) (.+)/)[1..2]
+        @id_prefix, @class_name, @primary_key =
+          *raw_hit['id'].match(/((?:[^!]+!)+)*([^\s]+)\s(.+)/)[1..3]
         @score = raw_hit['score']
         @search = search
         @stored_values = raw_hit

data/lib/sunspot/search/hit_enumerable.rb

@@ -11,6 +11,9 @@ module Sunspot
         end
       end
 
+      #
+      # Returns all of the hits that have a result
+      #
       def verified_hits
         hits.select { |h| h.result }
       end
@@ -31,7 +34,7 @@ module Sunspot
           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
+            hit.result = result if hit
           end
           hits_for_class.values.each { |hit| hit.result = nil }
         end

data/lib/sunspot/search/json_facet_row.rb

@@ -0,0 +1,40 @@
+module Sunspot
+  module Search
+    class JsonFacetRow
+      attr_reader :value, :count, :nested
+      attr_writer :instance #:nodoc:
+
+      def initialize(data, facet) #:nodoc:
+        @value = data['val']
+        @count = data['distinct'] || data['count']
+        @facet = facet
+        @nested_key = data.keys.select { |k| data[k].is_a?(Hash) }.first
+        @nested = recursive_nested_initialization(data) unless @nested_key.nil?
+      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}) #{nested.nil? ? '' : " nested_count=#{nested.size}"}>"
+      end
+
+      private
+
+      def recursive_nested_initialization(data)
+        data[@nested_key]['buckets'].map do |d|
+          JsonFacetRow.new(d, @facet)
+        end
+      end
+
+    end
+  end
+end

data/lib/sunspot/search/json_facet_stats.rb

@@ -0,0 +1,23 @@
+module Sunspot
+  module Search
+    class JsonFacetStats
+      def initialize(field, search, options)
+        @field, @search, @options = field, search, options
+      end
+
+      def rows
+        @rows ||=
+          begin
+            json_facet_response = @search.json_facet_response[@field.to_s]
+            data = json_facet_response.nil? ? [] : json_facet_response['buckets']
+            rows = []
+            data.each do |d|
+              rows << StatsJsonRow.new(d, nil, d['val'])
+            end
+            rows
+          end
+
+      end
+    end
+  end
+end

data/lib/sunspot/search/paginated_collection.rb

@@ -32,6 +32,7 @@ module Sunspot
       def previous_page
         current_page > 1 ? (current_page - 1) : nil
       end
+      alias :prev_page :previous_page
 
       def next_page
         current_page < total_pages ? (current_page + 1) : nil

data/lib/sunspot/search/query_group.rb

@@ -0,0 +1,74 @@
+require 'sunspot/search/paginated_collection'
+
+module Sunspot
+  module Search
+    class QueryGroup
+      def initialize(queries, search) #:nodoc:
+        @queries, @search = queries, search
+      end
+
+      def groups
+        @groups ||=
+          if solr_response_for_first
+            groups = @queries.map { |query| Group.new(query.label, doclist_for(query), @search) }
+
+            paginate_collection(groups)
+          end
+      end
+
+      def matches
+        if solr_response_for_first
+          solr_response_for_first['matches'].to_i
+        end
+      end
+
+      def total
+        @queries.count
+      end
+
+      #
+      # It populates all grouped hits at once.
+      # Useful for eager loading fall grouped results at once.
+      #
+      def populate_all_hits
+        # Init a 2 dimension Hash that contains an array per key
+        id_hit_hash = Hash.new { |hash, key| hash[key] = Hash.new{ |h, k| h[k] = [] } }
+        groups.each do |g|
+          # Take all hits to being populated later on
+          g.hits.each do |hit|
+            id_hit_hash[hit.class_name][hit.primary_key] |= [hit]
+          end
+        end
+        # Go for each class and load the results' objects into each of the hits
+        id_hit_hash.each_pair do |class_name, many_hits|
+          ids = many_hits.keys
+          data_accessor = @search.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|
+            hits = hits_for_class.delete(Adapters::InstanceAdapter.adapt(result).id.to_s)
+            hits.each{ |hit| hit.result = result }
+          end
+          hits_for_class.values.each { |hits| hits.each{|hit| hit.result = nil } }
+        end
+      end
+
+      private
+
+      def doclist_for(query)
+        solr_response_for(query.to_boolean_phrase)['doclist']
+      end
+
+      def solr_response_for(query_string)
+        @search.group_response[query_string]
+      end
+
+      def solr_response_for_first
+        solr_response_for(@queries[0].to_boolean_phrase)
+      end
+
+      def paginate_collection(collection)
+        PaginatedCollection.new(collection, @search.query.page, @search.query.per_page, total)
+      end
+    end
+  end
+end

data/lib/sunspot/search/standard_search.rb

@@ -1,6 +1,6 @@
 module Sunspot
   module Search
-    # 
+    #
     # 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
@@ -10,9 +10,76 @@ module Sunspot
       def request_handler
         super || :select
       end
-  
+
+      # Return the raw spellcheck block from the Solr response
+      def solr_spellcheck
+        @solr_spellcheck ||= @solr_result['spellcheck'] || {}
+      end
+
+      # Reformat the oddly-formatted spellcheck suggestion array into a
+      # more useful hash.
+      #
+      # Original: [term, suggestion, term, suggestion, ..., "correctlySpelled", bool, "collation", str]
+      #           "collation" is only included if spellcheck.collation was set to true
+      # Returns: { term => suggestion, term => suggestion }
+      def spellcheck_suggestions
+        unless defined?(@spellcheck_suggestions)
+          @spellcheck_suggestions = {}
+          count = ((solr_spellcheck['suggestions'] || []).length) / 2
+          (0..(count - 1)).each do |i|
+            break if ["correctlySpelled", "collation"].include? solr_spellcheck[i]
+            term = solr_spellcheck['suggestions'][i * 2]
+            suggestion = solr_spellcheck['suggestions'][(i * 2) + 1]
+            @spellcheck_suggestions[term] = suggestion
+          end
+        end
+        @spellcheck_suggestions
+      end
+
+      # Return the suggestion with the single highest frequency.
+      # Requires the extended results format.
+      def spellcheck_suggestion_for(term)
+        spellcheck_suggestions[term]['suggestion'].sort_by do |suggestion|
+          suggestion['freq']
+        end.last['word']
+      end
+
+      # Provide a collated query. If the user provides a query string,
+      # tokenize it on whitespace and replace terms strictly not present in
+      # the index. Otherwise return Solr's suggested collation.
+      #
+      # Solr's suggested collation is more liberal, replacing even terms that
+      # are present in the index.
+      #
+      # Mix and match in your views for a blend of strict and liberal collations.
+      def spellcheck_collation(*terms)
+        if solr_spellcheck['suggestions'] && solr_spellcheck['suggestions'].length > 0
+          collation = terms.join(" ").dup if terms
+
+          # If we are given a query string, tokenize it and strictly replace
+          # the terms that aren't present in the index
+          if terms.length > 0
+            terms.each do |term|
+              if (spellcheck_suggestions[term]||{})['origFreq'] == 0
+                collation[term] = spellcheck_suggestion_for(term)
+              end
+            end
+          end
+
+          # If no query was given, or all terms are present in the index,
+          # return Solr's suggested collation.
+          if terms.length == 0
+            collation = solr_spellcheck['collations'][-1]
+          end
+
+          collation
+        else
+          nil
+        end
+      end
+
       private
-  
+
       def dsl
         DSL::Search.new(self, @setup)
       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_json_row.rb

@@ -0,0 +1,82 @@
+module Sunspot
+  module Search
+    class StatsJsonRow
+      attr_reader :data, :value, :nested
+      attr_writer :instance #:nodoc:
+
+      def initialize(data, facet = nil, value = nil) #:nodoc:
+        @data, @facet, @value = data, facet, value
+        @facet_fields = []
+        @nested_key = data.keys.select { |k| data[k].is_a?(Hash) }.first
+        @nested = recursive_nested_initialization(data) unless @nested_key.nil?
+      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['sumsq']
+      end
+      alias :sumsq :sum_of_squares
+
+      def mean
+        data['avg']
+      end
+      alias :avg :mean
+
+      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::StatsJsonRow:#{value.inspect} min=#{min} max=#{max}"\
+        " count=#{count} sum=#{sum} missing=#{missing} sum_of_squares=#{sum_of_squares}"\
+        " mean=#{mean} standard_deviation=#{standard_deviation}"\
+        " #{nested.nil? ? '' : "nested_count=#{nested.size}"}>"
+      end
+
+      private
+
+      def recursive_nested_initialization(data)
+        data[@nested_key]['buckets'].map do |d|
+          StatsJsonRow.new(d, @facet, d['val'])
+        end
+      end
+
+    end
+  end
+end