sunspot 2.2.7 → 2.5.0

data/lib/sunspot/search/abstract_search.rb

@@ -16,7 +16,7 @@ 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, :groups, :stats
+      attr_reader :facets, :groups
       attr_reader :query #:nodoc:
       attr_accessor :request_handler
 
@@ -182,6 +182,10 @@ module Sunspot
         end
       end
 
+      def json_facet_stats(name, options = {})
+        JsonFacetStats.new(name, self, options)
+      end
+
       #
       # Deprecated in favor of optional second argument to #facet
       #
@@ -193,6 +197,10 @@ module Sunspot
         @solr_result['facet_counts']
       end
 
+      def json_facet_response #:nodoc:
+        @solr_result['facets']
+      end
+
       def stats_response #:nodoc:
         @solr_result['stats']['stats_fields']
       end
@@ -255,6 +263,11 @@ module Sunspot
         add_stats(field.name, FieldStats.new(field, self))
       end
 
+      def add_json_facet(field, options = {})
+        name = (options[:name] || field.name)
+        add_facet(name, FieldJsonFacet.new(field, self, options))
+      end
+
       def highlights_for(doc) #:nodoc:
         if @solr_result['highlighting']
           @solr_result['highlighting'][doc['id']]

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/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/standard_search.rb

@@ -49,12 +49,11 @@ module Sunspot
       # the index. Otherwise return Solr's suggested collation.
       #
       # Solr's suggested collation is more liberal, replacing even terms that
-      # are present in the index. This may not be useful if only one term is
-      # misspelled and preventing useful results.
+      # 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 > 2
+        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

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

data/lib/sunspot/search/stats_row.rb

@@ -59,7 +59,9 @@ module Sunspot
       end
 
       def inspect
-        "<Sunspot::Search::StatsRow:#{value.inspect} min=#{min} max=#{max} count=#{count}>"
+        "<Sunspot::Search::StatsRow:#{value.inspect} min=#{min} max=#{max}"\
+        " count=#{self.count} sum=#{sum} missing=#{missing} sum_of_squares=#{sum_of_squares}"\
+        " mean=#{mean} standard_deviation=#{standard_deviation}>"
       end
     end
   end

data/lib/sunspot/search.rb

@@ -1,6 +1,7 @@
-%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
-   stats_row field_stats stats_facet query_group).each do |file|
+%w(abstract_search standard_search more_like_this_search query_facet
+   field_facet field_json_facet date_facet range_facet json_facet_stats
+   facet_row json_facet_row hit highlight field_group group hit_enumerable
+   stats_row stats_json_row field_stats stats_facet query_group).each do |file|
   require File.join(File.dirname(__FILE__), 'search', file)
 end
 

data/lib/sunspot/session.rb

@@ -254,11 +254,13 @@ module Sunspot
     # RSolr::Connection::Base:: The connection for this session
     #
     def connection
-      @connection ||=
-        self.class.connection_class.connect(:url          => config.solr.url,
-                                            :read_timeout => config.solr.read_timeout,
-                                            :open_timeout => config.solr.open_timeout,
-                                            :proxy        => config.solr.proxy)
+      @connection ||= self.class.connection_class.connect(
+        url: config.solr.url,
+        read_timeout: config.solr.read_timeout,
+        open_timeout: config.solr.open_timeout,
+        proxy: config.solr.proxy,
+        update_format: update_format_generator
+      )
     end
 
     def indexer
@@ -275,5 +277,11 @@ module Sunspot
         CompositeSetup.for(types)
       end
     end
+
+    def update_format_generator
+      if config.solr.update_format && RSolr.version.to_i > 1
+        config.solr.update_format.downcase.to_sym == :json ? RSolr::JSON::Generator : RSolr::Xml::Generator
+      end
+    end
   end
 end

data/lib/sunspot/setup.rb

@@ -15,6 +15,7 @@ module Sunspot
       @more_like_this_field_factories_cache = Hash.new { |h, k| h[k] = [] }
       @dsl = DSL::Fields.new(self)
       @document_boost_extractor = nil
+      @id_prefix_extractor = nil
       add_field_factory(:class, Type::ClassType.instance)
     end
 
@@ -61,6 +62,7 @@ module Sunspot
       field_factory = FieldFactory::Static.new(name, Type::TextType.instance, options, &block)
       @text_field_factories[name] = field_factory
       @text_field_factories_cache[field_factory.name] = field_factory
+      @field_factories_cache[field_factory.name] = field_factory
       if stored
         @stored_field_factories_cache[field_factory.name] << field_factory
       end
@@ -81,6 +83,7 @@ module Sunspot
       field_factory = FieldFactory::Dynamic.new(name, type, options, &block)
       @dynamic_field_factories[field_factory.signature] = field_factory
       @dynamic_field_factories_cache[field_factory.name] = field_factory
+      @field_factories_cache[field_factory.name] = field_factory
       if stored
         @stored_field_factories_cache[field_factory.name] << field_factory
       end
@@ -107,6 +110,24 @@ module Sunspot
         end
     end
 
+    #
+    # Add id prefix for compositeId router
+    #
+    def add_id_prefix(attr_name, &block)
+      @id_prefix_extractor =
+        case attr_name
+        when Symbol
+          DataExtractor::AttributeExtractor.new(attr_name)
+        when String
+          DataExtractor::Constant.new(attr_name)
+        when nil
+          DataExtractor::BlockExtractor.new(&block) if block_given?
+        else
+          raise ArgumentError,
+            "The ID prefix has to be either a Symbol, a String or a Proc"
+        end
+    end
+
     # 
     # Builder method for evaluating the setup DSL
     #
@@ -271,6 +292,16 @@ module Sunspot
       end
     end
 
+    def id_prefix_for(model)
+      if @id_prefix_extractor
+        value = @id_prefix_extractor.value_for(model)
+
+        if value.is_a?(String) and value.size > 0
+          value[-1] == "!" ? value : "#{value}!"
+        end
+      end
+    end
+
     protected
 
     # 

data/lib/sunspot/util.rb

@@ -188,6 +188,29 @@ module Sunspot
         RSolr.solr_escape(value).gsub(/([\s\.])/, '\\\\\1')
       end
 
+      def parse_json_facet(field_name, options, setup)
+        field = setup.field(field_name)
+        if options[:time_range]
+          unless field.type.is_a?(Sunspot::Type::TimeType)
+            raise(
+              ArgumentError,
+              ':time_range can only be specified for Date or Time fields'
+            )
+          end
+          Sunspot::Query::DateFieldJsonFacet.new(field, options, setup)
+        elsif options[:range]
+          unless [Sunspot::Type::TimeType, Sunspot::Type::FloatType, Sunspot::Type::IntegerType ].find{|type| field.type.is_a?(type)}
+            raise(
+              ArgumentError,
+              ':range can only be specified for date or numeric fields'
+            )
+          end
+          Sunspot::Query::RangeJsonFacet.new(field, options, setup)
+        else
+          Sunspot::Query::FieldJsonFacet.new(field, options, setup)
+        end
+      end
+
       private
 
       #

data/lib/sunspot/version.rb

@@ -1,3 +1,3 @@
 module Sunspot
-  VERSION = '2.2.7'
+  VERSION = '2.5.0'
 end

data/spec/api/adapters_spec.rb

@@ -2,45 +2,58 @@ require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 describe Sunspot::Adapters::InstanceAdapter do
   it "finds adapter by superclass" do
-    Sunspot::Adapters::InstanceAdapter::for(Model).should be(AbstractModelInstanceAdapter)
+    expect(Sunspot::Adapters::InstanceAdapter::for(Model)).to be(AbstractModelInstanceAdapter)
   end
 
   it "finds adapter by mixin" do
-    Sunspot::Adapters::InstanceAdapter::for(MixModel).should be(MixInModelInstanceAdapter)
+    expect(Sunspot::Adapters::InstanceAdapter::for(MixModel)).to be(MixInModelInstanceAdapter)
   end
 
   it 'throws NoAdapterError if anonymous module passed in' do
-    lambda do
+    expect do
       Sunspot::Adapters::InstanceAdapter::for(Module.new)
-    end.should raise_error(Sunspot::NoAdapterError)
+    end.to raise_error(Sunspot::NoAdapterError)
   end
 
   it "registers adapters found by ancestor lookup with the descendant class" do
-    Sunspot::Adapters::InstanceAdapter::registered_adapter_for(UnseenModel).should be(nil)
+    expect(Sunspot::Adapters::InstanceAdapter::registered_adapter_for(UnseenModel)).to be(nil)
     Sunspot::Adapters::InstanceAdapter::for(UnseenModel)
-    Sunspot::Adapters::InstanceAdapter::registered_adapter_for(UnseenModel).should be(AbstractModelInstanceAdapter)
+    expect(Sunspot::Adapters::InstanceAdapter::registered_adapter_for(UnseenModel)).to be(AbstractModelInstanceAdapter)
+  end
+
+  it "appends ID prefix when configured" do
+    expect(AbstractModelInstanceAdapter.new(ModelWithPrefixId.new).index_id).to eq "USERDATA!ModelWithPrefixId 1"
+  end
+
+  it "supports nested ID prefixes" do
+    expect(AbstractModelInstanceAdapter.
+      new(ModelWithNestedPrefixId.new).index_id).to eq "USER!USERDATA!ModelWithNestedPrefixId 1"
+  end
+
+  it "doesn't appends ID prefix when not configured" do
+    expect(AbstractModelInstanceAdapter.new(ModelWithoutPrefixId.new).index_id).to eq "ModelWithoutPrefixId 1"
   end
 end
 
 describe Sunspot::Adapters::DataAccessor do
   it "finds adapter by superclass" do
-    Sunspot::Adapters::DataAccessor::for(Model).should be(AbstractModelDataAccessor)
+    expect(Sunspot::Adapters::DataAccessor::for(Model)).to be(AbstractModelDataAccessor)
   end
 
   it "finds adapter by mixin" do
-    Sunspot::Adapters::DataAccessor::for(MixModel).should be(MixInModelDataAccessor)
+    expect(Sunspot::Adapters::DataAccessor::for(MixModel)).to be(MixInModelDataAccessor)
   end
 
   it 'throws NoAdapterError if anonymous module passed in' do
-    lambda do
+    expect do
       Sunspot::Adapters::DataAccessor::for(Module.new)
-    end.should raise_error(Sunspot::NoAdapterError)
+    end.to raise_error(Sunspot::NoAdapterError)
   end
 
   it "registers adapters found by ancestor lookup with the descendant class" do
-    Sunspot::Adapters::DataAccessor::registered_accessor_for(UnseenModel).should be(nil)
+    expect(Sunspot::Adapters::DataAccessor::registered_accessor_for(UnseenModel)).to be(nil)
     Sunspot::Adapters::DataAccessor::for(UnseenModel)
-    Sunspot::Adapters::DataAccessor::registered_accessor_for(UnseenModel).should be(AbstractModelDataAccessor)
+    expect(Sunspot::Adapters::DataAccessor::registered_accessor_for(UnseenModel)).to be(AbstractModelDataAccessor)
   end
 end
 
@@ -51,30 +64,30 @@ describe Sunspot::Adapters::Registry do
   let(:mixin_accessor){ Sunspot::Adapters::DataAccessor::for(MixModel) }
 
   it "registers and retrieves a data accessor for abstractclass" do
-      registry.retrieve(AbstractModel).should be_a(abstractclass_accessor)
+      expect(registry.retrieve(AbstractModel)).to be_a(abstractclass_accessor)
   end
 
   it "registers and retrieves a data accessor for superclass" do
-      registry.retrieve(Model).should be_a(superclass_accessor)
+      expect(registry.retrieve(Model)).to be_a(superclass_accessor)
   end
 
   it "registers and retrieves a data accessor for mixin" do
-      registry.retrieve(MixModel).should be_a(mixin_accessor)
+      expect(registry.retrieve(MixModel)).to be_a(mixin_accessor)
   end
 
   it "injects inherited attributes" do
-    AbstractModelDataAccessor.any_instance.stub(:inherited_attributes).and_return([:to_be_injected])
+    allow_any_instance_of(AbstractModelDataAccessor).to receive(:inherited_attributes).and_return([:to_be_injected])
     in_registry_data_accessor = registry.retrieve(AbstractModel)
     in_registry_data_accessor.to_be_injected = "value"
-    registry.retrieve(Model).to_be_injected.should == "value"
+    expect(registry.retrieve(Model).to_be_injected).to eq("value")
   end
 
   it "not overrides inherited attributes" do
-    AbstractModelDataAccessor.any_instance.stub(:inherited_attributes).and_return([:to_be_injected])
+    allow_any_instance_of(AbstractModelDataAccessor).to receive(:inherited_attributes).and_return([:to_be_injected])
     parent_data_accessor = registry.retrieve(AbstractModel)
     current_data_accessor = registry.retrieve(Model)
     parent_data_accessor.to_be_injected = "value"
     current_data_accessor.to_be_injected = "safe-value"
-    registry.retrieve(Model).to_be_injected.should == "safe-value"
+    expect(registry.retrieve(Model).to_be_injected).to eq("safe-value")
   end
 end

data/spec/api/batcher_spec.rb

@@ -2,12 +2,12 @@ require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 describe Sunspot::Batcher do
   it "includes Enumerable" do
-    described_class.should include Enumerable
+    expect(described_class).to include Enumerable
   end
 
   describe "#each" do
     let(:current) { [:foo, :bar] }
-    before { subject.stub(:current).and_return current }
+    before { allow(subject).to receive(:current).and_return current }
 
     it "iterates over current" do
       yielded_values = []
@@ -16,25 +16,25 @@ describe Sunspot::Batcher do
         yielded_values << value
       end
 
-      yielded_values.should eq current
+      expect(yielded_values).to eq current
     end
   end
 
   describe "adding to current batch" do
     it "#push pushes to current" do
       subject.push :foo
-      subject.current.should include :foo
+      expect(subject.current).to include :foo
     end
 
     it "#<< pushes to current" do
       subject.push :foo
-      subject.current.should include :foo
+      expect(subject.current).to include :foo
     end
 
     it "#concat concatinates on current batch" do
       subject << :foo
       subject.concat [:bar, :mix]
-      should include :foo, :bar, :mix
+      is_expected.to include :foo, :bar, :mix
     end
   end
 
@@ -46,7 +46,7 @@ describe Sunspot::Batcher do
       end
 
       it "is empty by default" do
-        subject.current.should be_empty
+        expect(subject.current).to be_empty
       end
     end
 
@@ -58,7 +58,7 @@ describe Sunspot::Batcher do
       end
 
       it "returns the same as last time" do
-        subject.current.should eq subject.current
+        expect(subject.current).to eq subject.current
       end
     end
   end
@@ -71,7 +71,7 @@ describe Sunspot::Batcher do
     it "changes current" do
       subject << :foo
       subject.start_new
-      should_not include :foo
+      is_expected.not_to include :foo
     end
   end
 
@@ -88,25 +88,25 @@ describe Sunspot::Batcher do
       it "changes current" do
         subject << :foo
         subject.end_current
-        should_not include :foo
+        is_expected.not_to include :foo
       end
 
       it "returns current" do
         subject << :foo
-        subject.end_current.should include :foo
+        expect(subject.end_current).to include :foo
       end
     end
   end
 
   describe "#batching?" do
     it "is false when depth is 0" do
-      subject.should_receive(:depth).and_return 0
-      should_not be_batching
+      expect(subject).to receive(:depth).and_return 0
+      is_expected.not_to be_batching
     end
 
     it "is true when depth is more than 0" do
-      subject.should_receive(:depth).and_return 1
-      should be_batching
+      expect(subject).to receive(:depth).and_return 1
+      is_expected.to be_batching
     end
   end
 end

data/spec/api/binding_spec.rb

@@ -6,7 +6,7 @@ describe "DSL bindings" do
     session.search(Post) do
       value = test_method
     end
-    value.should == 'value'
+    expect(value).to eq('value')
   end
 
   it 'should give access to calling context\'s id method in search DSL' do
@@ -14,7 +14,7 @@ describe "DSL bindings" do
     session.search(Post) do
       value = id
     end
-    value.should == 16
+    expect(value).to eq(16)
   end
 
   it 'should give access to calling context\'s methods in nested DSL block' do
@@ -24,7 +24,7 @@ describe "DSL bindings" do
         value = test_method
       end
     end
-    value.should == 'value'
+    expect(value).to eq('value')
   end
 
   it 'should give access to calling context\'s methods in double-nested DSL block' do