sunspot 2.0.0 → 2.5.0

data/lib/sunspot/search/stats_row.rb

@@ -0,0 +1,68 @@
+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=#{self.count} sum=#{sum} missing=#{missing} sum_of_squares=#{sum_of_squares}"\
+        " mean=#{mean} standard_deviation=#{standard_deviation}>"
+      end
+    end
+  end
+end

data/lib/sunspot/session.rb

@@ -1,5 +1,5 @@
 module Sunspot
-  # 
+  #
   # A Sunspot session encapsulates a connection to Solr and a set of
   # configuration choices. Though users of Sunspot may manually instantiate
   # Session objects, in the general case it's easier to use the singleton
@@ -10,8 +10,8 @@ module Sunspot
   class Session
     class <<self
       attr_writer :connection_class #:nodoc:
-      
-      # 
+
+      #
       # For testing purposes
       #
       def connection_class #:nodoc:
@@ -19,12 +19,12 @@ module Sunspot
       end
     end
 
-    # 
+    #
     # Sunspot::Configuration object for this session
     #
     attr_reader :config
 
-    # 
+    #
     # Sessions are initialized with a Sunspot configuration and a Solr
     # connection. Usually you will want to stick with the default arguments
     # when instantiating your own sessions.
@@ -36,7 +36,7 @@ module Sunspot
       @deletes = @adds = 0
     end
 
-    # 
+    #
     # See Sunspot.new_search
     #
     def new_search(*types, &block)
@@ -59,7 +59,7 @@ module Sunspot
       search.execute
     end
 
-    # 
+    #
     # See Sunspot.new_more_like_this
     #
     def new_more_like_this(object, *types, &block)
@@ -91,7 +91,7 @@ module Sunspot
       indexer.add(objects)
     end
 
-    # 
+    #
     # See Sunspot.index!
     #
     def index!(*objects)
@@ -99,12 +99,28 @@ module Sunspot
       commit
     end
 
+    #
+    # See Sunspot.atomic_update
+    #
+    def atomic_update(clazz, updates = {})
+      @adds += updates.keys.length
+      indexer.add_atomic_update(clazz, updates)
+    end
+
+    #
+    # See Sunspot.atomic_update!
+    #
+    def atomic_update!(clazz, updates = {})
+      atomic_update(clazz, updates)
+      commit
+    end
+
     #
     # See Sunspot.commit
     #
-    def commit
+    def commit(soft_commit = false)
       @adds = @deletes = 0
-      connection.commit
+      connection.commit :commit_attributes => {:softCommit => soft_commit}
     end
 
     #
@@ -115,7 +131,7 @@ module Sunspot
       connection.optimize
     end
 
-    # 
+    #
     # See Sunspot.remove
     #
     def remove(*objects, &block)
@@ -139,32 +155,32 @@ module Sunspot
       end
     end
 
-    # 
+    #
     # 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
 
@@ -182,7 +198,7 @@ module Sunspot
       end
     end
 
-    # 
+    #
     # See Sunspot.remove_all!
     #
     def remove_all!(*classes)
@@ -190,35 +206,35 @@ module Sunspot
       commit
     end
 
-    # 
+    #
     # See Sunspot.dirty?
     #
     def dirty?
       (@deletes + @adds) > 0
     end
 
-    # 
+    #
     # See Sunspot.commit_if_dirty
     #
-    def commit_if_dirty
-      commit if dirty?
+    def commit_if_dirty(soft_commit = false)
+      commit soft_commit if dirty?
     end
-    
-    # 
+
+    #
     # See Sunspot.delete_dirty?
     #
     def delete_dirty?
       @deletes > 0
     end
 
-    # 
+    #
     # See Sunspot.commit_if_delete_dirty
     #
-    def commit_if_delete_dirty
-      commit if delete_dirty?
+    def commit_if_delete_dirty(soft_commit = false)
+      commit soft_commit if delete_dirty?
     end
-    
-    # 
+
+    #
     # See Sunspot.batch
     #
     def batch
@@ -229,7 +245,7 @@ module Sunspot
 
     private
 
-    # 
+    #
     # Retrieve the Solr connection for this session, creating one if it does not
     # already exist.
     #
@@ -238,10 +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)
+      @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
@@ -258,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/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
 
       # 

data/lib/sunspot/session_proxy/id_sharding_session_proxy.rb

@@ -45,23 +45,31 @@ module Sunspot
       # 
       # See Sunspot.remove_by_id
       #
-      def remove_by_id(clazz, id)
-        session_for_index_id(
-          Adapters::InstanceAdapter.index_id_for(clazz, id)
-        ).remove_by_id(clazz, id)
+      def remove_by_id(clazz, *ids)
+        ids.flatten!
+        ids_by_session(clazz, ids).each do |session, ids|
+          session.remove_by_id(clazz, ids)
+        end
       end
 
       # 
       # See Sunspot.remove_by_id!
       #
-      def remove_by_id!(clazz, id)
-        session_for_index_id(
-          Adapters::InstanceAdapter.index_id_for(clazz, id)
-        ).remove_by_id!(clazz, id)
+      def remove_by_id!(clazz, *ids)
+        ids.flatten!
+        ids_by_session(clazz, ids).each do |session, ids|
+          session.remove_by_id!(clazz, ids)
+        end
       end
 
       private
 
+      def ids_by_session(clazz, ids)
+        ids.group_by do |id|
+          session_for_index_id(Adapters::InstanceAdapter.index_id_for(clazz, id))
+        end
+      end
+
       def session_for_index_id(index_id)
         @sessions[id_hash(index_id) % @sessions.length]
       end

data/lib/sunspot/session_proxy/master_slave_session_proxy.rb

@@ -19,8 +19,8 @@ module Sunspot
 
       delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty,
                :config, :delete_dirty?, :dirty?, :index, :index!, :optimize, :remove,
-               :remove!, :remove_all, :remove_all!, :remove_by_id,
-               :remove_by_id!, :to => :master_session
+               :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!,
+               :atomic_update, :atomic_update!, :to => :master_session
       delegate :new_search, :search, :new_more_like_this, :more_like_this, :to => :slave_session
 
       def initialize(master_session, slave_session)

data/lib/sunspot/session_proxy/retry_5xx_session_proxy.rb

@@ -59,7 +59,7 @@ module Sunspot
 
       delegate :batch, :commit, :commit_if_dirty, :commit_if_delete_dirty,
         :dirty?, :index!, :index, :optimize, :remove!, :remove, :remove_all!,
-        :remove_all, :remove_by_id!, :remove_by_id,
+        :remove_all, :remove_by_id!, :remove_by_id, :atomic_update, :atomic_update!,
         :to => :retry_handler
 
     end

data/lib/sunspot/session_proxy/sharding_session_proxy.rb

@@ -27,9 +27,11 @@ module Sunspot
     # * remove_by_id!
     # * remove_all with an argument
     # * remove_all! with an argument
+    # * atomic_update with arguments
+    # * atomic_update! with arguments
     #
     class ShardingSessionProxy < AbstractSessionProxy
-      not_supported :batch, :config, :remove_by_id, :remove_by_id!
+      not_supported :batch, :config, :remove_by_id, :remove_by_id!, :atomic_update, :atomic_update!
 
       # 
       # +search_session+ is the session that should be used for searching.
@@ -70,7 +72,7 @@ module Sunspot
         using_sharded_session(objects) { |session, group| session.index!(group) }
       end
 
-      # 
+      #
       # See Sunspot.remove
       #
       def remove(*objects)

data/lib/sunspot/session_proxy/silent_fail_session_proxy.rb

@@ -22,7 +22,7 @@ module Sunspot
       SUPPORTED_METHODS = [
         :batch, :commit, :commit_if_dirty, :commit_if_delete_dirty, :dirty?,
         :index!, :index, :optimize, :remove!, :remove, :remove_all!, :remove_all,
-        :remove_by_id!, :remove_by_id
+        :remove_by_id!, :remove_by_id, :atomic_update, :atomic_update!
       ]
 
       SUPPORTED_METHODS.each do |method|

data/lib/sunspot/session_proxy/thread_local_session_proxy.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'abstract_session_proxy')
 
 module Sunspot
   module SessionProxy
-    # 
+    #
     # This class implements a session proxy that creates a different Session
     # object for each thread. Any multithreaded application should use this
     # proxy.
@@ -17,14 +17,16 @@ module Sunspot
       attr_reader :config
       @@next_id = 0
 
-      delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty, :delete_dirty?, :dirty?, :index, :index!, :new_search, :optimize, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!, :search, :more_like_this, :new_more_like_this, :to => :session
+      delegate :batch, :commit, :commit_if_delete_dirty, :commit_if_dirty, :delete_dirty?, :dirty?, :index, :index!,
+               :new_search, :optimize, :remove, :remove!, :remove_all, :remove_all!, :remove_by_id, :remove_by_id!,
+               :search, :more_like_this, :new_more_like_this, :atomic_update, :atomic_update!, :to => :session
 
-      # 
+      #
       # Optionally pass an existing Sunspot::Configuration object. If none is
       # passed, a default configuration is used; it can then be modified using
       # the #config attribute.
       #
-      def initialize(config = Sunspot::Configuration.new)
+      def initialize(config = Sunspot::Configuration.build)
         @config = config
         ObjectSpace.define_finalizer(self, FINALIZER)
       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
 
@@ -38,6 +39,17 @@ module Sunspot
       end
     end
 
+    def add_join_field_factory(name, type, options = {}, &block)
+      field_factory = FieldFactory::Join.new(name, type, options, &block)
+      @field_factories[field_factory.signature] = field_factory
+
+      if type.is_a?(Type::TextType)
+        @text_field_factories_cache[field_factory.name] = field_factory
+      else
+        @field_factories_cache[field_factory.name] = field_factory
+      end
+    end
+
     # 
     # Add field_factories for fulltext search
     #
@@ -50,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
@@ -70,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
@@ -96,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
     #
@@ -260,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
 
     #