sunspot 2.3.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698b438f344a3e391c87d9f755dc227869fefad88555b261ef4dcd9cc9d9c1d1
-  data.tar.gz: 2ba1b782a43a5eafd6f1bc6397ef221fe94bbbb92f1036505530719a50f07882
+  metadata.gz: c13ef43c3d9e3c45ca9d1ccc170ba55947797e788911fda1982b817d34207c5d
+  data.tar.gz: 8a2dc3da8797d0ff4945c99732c9808e1ff9d06f94d0611b932a20cc49210d08
 SHA512:
-  metadata.gz: 8f89e196fd125f6c0b2bd8eda2aecf7c288860ff14ab128d695f61252344fc07b0011ed8c10d8c5578227eae814df368fecf3332d306ae2a79e9b5da593dfc97
-  data.tar.gz: 780ca66b8d6e569a994670b2e6f990444333dc03f109bd015c7f26924673e801281f611f5d08b14b48afb35b6177099747113e0bbdc10a07aebe4cee5f93c8ea
+  metadata.gz: dbdf307d46210db9f3430a7a46d615709aa181c61c2400f6e42d23edd5dfa0c619ecb249cf148eb7215d4dd37d9907c630acf4d13ec83319cff1cbdd2652882e
+  data.tar.gz: f77be8b5ee7ea9226565214951f4af0930b994f9fe568b4c79ac7d0733d414644d32018b4bdfb0ebd23a19b30ecece2c45da5d29b8bd46e28aafaf33ff58796f

data/Appraisals

@@ -1,7 +1,7 @@
-appraise 'rsolr-1.1.x' do
-  gem 'rsolr', '~> 1.1.0'
+appraise 'rsolr-1.x' do
+  gem 'rsolr', '>= 1', '< 2'
 end
 
-appraise 'rsolr-2.1.x' do
-  gem 'rsolr', '~> 2.1.0'
+appraise 'rsolr-2.x' do
+  gem 'rsolr', '>= 2', '< 3'
 end

data/lib/sunspot/adapters.rb

@@ -55,6 +55,20 @@ module Sunspot
         @instance = instance
       end
 
+      #
+      # An ID prefix to be added to the index_id
+      #
+      # ==== Returns
+      #
+      # String:: ID prefix for use in index ID to determine
+      # the shard a document is sent to for indexing
+      #
+      def id_prefix
+        setup = Sunspot::Setup.for(@instance.class)
+
+        setup && setup.id_prefix_for(@instance)
+      end
+
       #
       # The universally-unique ID for this instance that will be stored in solr
       #
@@ -63,7 +77,7 @@ module Sunspot
       # String:: ID for use in Solr
       #
       def index_id #:nodoc:
-        InstanceAdapter.index_id_for(@instance.class.name, id)
+        InstanceAdapter.index_id_for("#{id_prefix}#{@instance.class.name}", id)
       end
 
       class <<self

data/lib/sunspot/data_extractor.rb

@@ -5,16 +5,46 @@ module Sunspot
   # method, which takes an object and returns the value extracted from it.
   #
   module DataExtractor #:nodoc: all
+    #
+    # Abstract extractor to perform common actions on extracted values
+    #
+    class AbstractExtractor
+      BLACKLIST_REGEXP = /[\x0-\x8\xB\xC\xE-\x1F\x7f\uFFFE-\uFFFF]/
+
+      def value_for(object)
+        extract_value_from(object)
+      end
+
+      private
+
+      def extract_value_from(object)
+        case object
+          when String
+            remove_blacklisted_chars(object)
+          when Array
+            object.map { |o| extract_value_from(o) }
+          when Hash
+            object.inject({}) { |h, (k, v)| h.merge(extract_value_from(k) => extract_value_from(v)) }
+          else
+            object
+        end
+      end
+
+      def remove_blacklisted_chars(object)
+        object.gsub(BLACKLIST_REGEXP, '')
+      end
+    end
+
     # 
     # AttributeExtractors extract data by simply calling a method on the block.
     #
-    class AttributeExtractor
+    class AttributeExtractor < AbstractExtractor
       def initialize(attribute_name)
         @attribute_name = attribute_name
       end
 
       def value_for(object)
-        object.send(@attribute_name)
+        super object.send(@attribute_name)
       end
     end
 
@@ -24,26 +54,26 @@ module Sunspot
     # as the argument to the block. Either way, the return value of the block is
     # the value returned by the extractor.
     #
-    class BlockExtractor
+    class BlockExtractor < AbstractExtractor
       def initialize(&block)
         @block = block
       end
 
       def value_for(object)
-        Util.instance_eval_or_call(object, &@block)
+        super Util.instance_eval_or_call(object, &@block)
       end
     end
 
     # 
     # Constant data extractors simply return the same value for every object.
     #
-    class Constant
+    class Constant < AbstractExtractor
       def initialize(value)
         @value = value
       end
 
       def value_for(object)
-        @value
+        super @value
       end
     end
   end

data/lib/sunspot/dsl/fields.rb

@@ -55,6 +55,22 @@ module Sunspot
         @setup.add_document_boost(attr_name, &block)
       end
 
+      #
+      # If you use the compositeId router for shards, you can send documents
+      # with a prefix in the document ID which will be used to calculate the
+      # hash Solr uses to determine the shard a document is sent to for indexing.
+      # The prefix can be anything you’d like it to be (it doesn’t have to be
+      # the shard name, for example), but it must be consistent so Solr
+      # behaves consistently.
+      #
+      # ==== Parameters
+      #
+      # attr_name<Symbol,String>:: Attribute name to call or a string constant
+      #
+      def id_prefix(attr_name = nil, &block)
+        @setup.add_id_prefix(attr_name, &block)
+      end
+
       # method_missing is used to provide access to typed fields, because
       # developers should be able to add new Sunspot::Type implementations
       # dynamically and have them recognized inside the Fields DSL. Like #text,

data/lib/sunspot/dsl/fulltext.rb

@@ -176,7 +176,7 @@ module Sunspot
           @query.add_additive_boost_function(factor_or_function)
         else
           Sunspot::Util.instance_eval_or_call(
-            Scope.new(@query.create_boost_query(factor_or_function), @setup),
+            Scope.new(@query.add_boost_query(factor_or_function), @setup),
             &block
           )
         end

data/lib/sunspot/dsl/group.rb

@@ -59,6 +59,16 @@ module Sunspot
         @group.truncate = true
       end
 
+      #
+      # The group.ngroups option true return the total number of groups
+      # this is expensive and sometimes you don't need it!
+      # If ngroups is false paginated_collection last_page? and total_pages wont't work.
+      # Defaults to true.
+      #
+      def ngroups(enabled)
+        @group.ngroups = enabled
+      end
+
       # Specify the order that results should be returned in. This method can
       # be called multiple times; precedence will be in the order given.
       #

data/lib/sunspot/dsl/scope.rb

@@ -199,25 +199,25 @@ module Sunspot
 
       def add_restriction(negated, *args)
         case args.first
-          when String, Symbol
-            raise ArgumentError if args.length > 2
-            field = @setup.field(args[0].to_sym)
-            if args.length > 1
-              value = args[1]
-              @scope.add_shorthand_restriction(negated, field, value)
-            else # NONE
-              DSL::Restriction.new(field, @scope, negated)
-            end
-          else # args are instances
-            @scope.add_restriction(
-              negated,
-              IdField.instance,
-              Sunspot::Query::Restriction::AnyOf,
-              args.flatten.map { |instance|
-                Sunspot::Adapters::InstanceAdapter.adapt(instance).index_id }
-            )
+        when String, Symbol
+          raise ArgumentError if args.length > 2
+          field = @setup.field(args[0].to_sym)
+          if args.length > 1
+            value = args[1]
+            @scope.add_shorthand_restriction(negated, field, value)
+          else # NONE
+            DSL::Restriction.new(field, @scope, negated)
           end
+        else # args are instances
+          @scope.add_restriction(
+            negated,
+            IdField.instance,
+            Sunspot::Query::Restriction::AnyOf,
+            args.flatten.map { |instance|
+              Sunspot::Adapters::InstanceAdapter.adapt(instance).index_id }
+          )
         end
+      end
     end
   end
 end

data/lib/sunspot/dsl/standard_query.rb

@@ -9,7 +9,7 @@ module Sunspot
     # See Sunspot.search for usage examples
     #
     class StandardQuery < FieldQuery
-      include Paginatable, Adjustable, Spellcheckable
+      include Paginatable, Adjustable, Spellcheckable, Functional
 
       # Specify a phrase that should be searched as fulltext. Only +text+
       # fields are searched - see DSL::Fields.text
@@ -123,6 +123,34 @@ module Sunspot
         end
       end
 
+      #
+      # Defines a boost query
+      #
+      # === Examples
+      #
+      #   Sunspot.search(Post) do
+      #     with(:blog_id, 1)
+      #
+      #     boost(10) do
+      #       with(:category_id, 2)
+      #     end
+      #   end
+      #
+      def boost(factor_or_function, &block)
+        if factor_or_function.is_a?(Sunspot::Query::FunctionQuery)
+          @query.add_boost_function(factor_or_function)
+        else
+          Sunspot::Util.instance_eval_or_call(
+            Scope.new(@query.add_boost_query(factor_or_function), @setup),
+            &block
+          )
+        end
+      end
+
+      def boost_multiplicative(factor_or_function)
+        @query.add_multiplicative_boost_function(factor_or_function)
+      end
+
       private
 
       def add_fulltext(keywords, field_names)

data/lib/sunspot/dsl.rb

@@ -1,5 +1,5 @@
-%w(spellcheckable fields scope paginatable adjustable field_query
-   standard_query query_facet functional fulltext restriction
+%w(spellcheckable fields functional scope paginatable adjustable field_query
+   standard_query query_facet fulltext restriction
    restriction_with_near search more_like_this_query function
    group field_stats).each do |file|
   require File.join(File.dirname(__FILE__), 'dsl', file)

data/lib/sunspot/field.rb

@@ -195,7 +195,7 @@ module Sunspot
   # Could be of any type
   #
   class JoinField < Field #:nodoc:
-    attr_reader :default_boost, :target
+    attr_reader :default_boost
 
     def initialize(name, type, options = {})
       @multiple = !!options.delete(:multiple)
@@ -213,15 +213,21 @@ module Sunspot
     end
 
     def from
-      Sunspot::Setup.for(@target).field(@join[:from]).indexed_name
+      Sunspot::Setup.for(target).field(@join[:from]).indexed_name
     end
 
     def to
       Sunspot::Setup.for(@clazz).field(@join[:to]).indexed_name
     end
 
-    def local_params
-      "{!join from=#{from} to=#{to}}"
+    def local_params(value)
+      query = ["type:\"#{target.name}\""] | Util.Array(value)
+
+      "{!join from=#{from} to=#{to} v='#{query.join(' AND ')}'}"
+    end
+
+    def to_solr_conditional(value)
+      "\"#{value}\""
     end
 
     def eql?(field)
@@ -229,6 +235,11 @@ module Sunspot
     end
 
     alias_method :==, :eql?
+
+    def target
+      @target = Util.full_const_get(@target) if @target.is_a?(String)
+      @target
+    end
   end
 
   class TypeField #:nodoc:

data/lib/sunspot/indexer.rb

@@ -54,9 +54,24 @@ module Sunspot
     # Remove the model from the Solr index by specifying the class and ID
     #
     def remove_by_id(class_name, *ids)
+      if class_name.is_a?(String) and class_name.index("!")
+        partition  = class_name.rpartition("!")
+        id_prefix  = partition[0..1].join
+        class_name = partition[2]
+      else
+        clazz_setup = setup_for_class(Util.full_const_get(class_name))
+        id_prefix = if clazz_setup.id_prefix_defined?
+                      if clazz_setup.id_prefix_requires_instance?
+                        warn(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(class_name))
+                      else
+                        clazz_setup.id_prefix_for_class
+                      end
+                    end
+      end
+
       ids.flatten!
       @connection.delete_by_id(
-        ids.map { |id| Adapters::InstanceAdapter.index_id_for(class_name, id) }
+        ids.map { |id| Adapters::InstanceAdapter.index_id_for("#{id_prefix}#{class_name}", id) }
       )
     end
 
@@ -147,13 +162,27 @@ module Sunspot
       )
     end
 
-    def document_for_atomic_update(clazz, id)
-      if Adapters::InstanceAdapter.for(clazz)
-        RSolr::Xml::Document.new(
-            id: Adapters::InstanceAdapter.index_id_for(clazz.name, id),
-            type: Util.superclasses_for(clazz).map(&:name)
-        )
-      end
+    def document_for_atomic_update(clazz, key)
+      return unless Adapters::InstanceAdapter.for(clazz)
+
+      clazz_setup = setup_for_class(clazz)
+      id_prefix = if clazz_setup.id_prefix_defined?
+                    if clazz_setup.id_prefix_requires_instance?
+                      if key.respond_to?(:id)
+                        clazz_setup.id_prefix_for(key)
+                      else
+                        warn(Sunspot::AtomicUpdateRequireInstanceForCompositeIdMessage.call(clazz.name))
+                      end
+                    else
+                      clazz_setup.id_prefix_for_class
+                    end
+                  end
+
+      instance_id = key.respond_to?(:id) ? key.id : key
+      RSolr::Xml::Document.new(
+        id: Adapters::InstanceAdapter.index_id_for("#{id_prefix}#{clazz.name}", instance_id),
+        type: Util.superclasses_for(clazz).map(&:name)
+      )
     end
     # 
     # Get the Setup object for the given object's class.

data/lib/sunspot/query/abstract_fulltext.rb

@@ -10,7 +10,7 @@ module Sunspot
       #
       # Assign a new boost query and return it.
       #
-      def create_boost_query(factor)
+      def add_boost_query(factor)
         @boost_queries << boost_query = BoostQuery.new(factor)
         boost_query
       end
@@ -19,14 +19,18 @@ module Sunspot
       # Add a boost function
       #
       def add_additive_boost_function(function_query)
-        @additive_boost_functions << function_query
+        unless @additive_boost_functions.include?(function_query)
+          @additive_boost_functions << function_query
+        end
       end
 
       #
       # Add a multiplicative boost function
       #
       def add_multiplicative_boost_function(function_query)
-        @multiplicative_boost_functions << function_query
+        unless @multiplicative_boost_functions.include?(function_query)
+          @multiplicative_boost_functions << function_query
+        end
       end
 
       #

data/lib/sunspot/query/abstract_json_field_facet.rb

@@ -17,6 +17,9 @@ module Sunspot
         params[:sort] = { @options[:sort] => @options[:sort_type]||'desc' } unless @options[:sort].nil?
         params[:prefix] = @options[:prefix] unless @options[:prefix].nil?
         params[:offset] = @options[:offset] unless @options[:offset].nil?
+        params[:allBuckets] = @options[:all_buckets] unless @options[:all_buckets].nil?
+        params[:missing] = @options[:missing] unless @options[:missing].nil?
+        params[:method] = @options[:method] unless @options[:method].nil?
 
         if !@options[:distinct].nil?
           dist_opts = @options[:distinct]

data/lib/sunspot/query/composite_fulltext.rb

@@ -3,11 +3,30 @@ module Sunspot
     class CompositeFulltext
       def initialize
         @components = []
+        @dismax = nil
       end
 
       def add_fulltext(keywords)
-        @components << dismax = Dismax.new(keywords)
-        dismax
+        @components << @dismax = Dismax.new(keywords)
+        @dismax
+      end
+
+      def add_boost_query(factor)
+        @dismax ||= Dismax.new("*:*")
+        @components << @dismax unless @components.include?(@dismax)
+        @dismax.add_boost_query(factor)
+      end
+
+      def add_boost_function(function)
+        @dismax ||= Dismax.new("*:*")
+        @components << @dismax unless @components.include?(@dismax)
+        @dismax.add_additive_boost_function(function)
+      end
+
+      def add_multiplicative_boost_function(function)
+        @dismax ||= Dismax.new("*:*")
+        @components << @dismax unless @components.include?(@dismax)
+        @dismax.add_multiplicative_boost_function(function)
       end
 
       def add_join(keywords, target, from, to)

data/lib/sunspot/query/date_field_json_facet.rb

@@ -1,24 +1,10 @@
 module Sunspot
   module Query
-    class DateFieldJsonFacet < AbstractJsonFieldFacet
+    class DateFieldJsonFacet < RangeJsonFacet
 
       def initialize(field, options, setup)
-        raise Exception.new('Need to specify a time_range') if options[:time_range].nil?
-        @start = options[:time_range].first
-        @end = options[:time_range].last
-        @gap = "+#{options[:gap] || 86400}SECONDS"
         super
-      end
-
-      def field_name_with_local_params
-        params = {}
-        params[:type] = 'range'
-        params[:field] = @field.indexed_name
-        params[:start] = @field.to_indexed(@start)
-        params[:end] = @field.to_indexed(@end)
-        params[:gap] = @gap
-        params.merge!(init_params)
-        { @field.name => params }
+        @gap = "+#{@gap}#{options[:gap_unit] || 'SECONDS'}"
       end
     end
   end

data/lib/sunspot/query/dismax.rb

@@ -28,10 +28,16 @@ module Sunspot
       # The query as Solr parameters
       #
       def to_params
-        params = { :q => @keywords }
-        params[:fl] = '* score'
-        params[:qf] = @fulltext_fields.values.map { |field| field.to_boosted_field }.join(' ')
-        params[:defType] = 'edismax'
+        params = {
+          :q => @keywords,
+          :defType => 'edismax',
+          :fl => '* score'
+        }
+
+        if @fulltext_fields.any?
+          params[:qf] = @fulltext_fields.values.map { |field| field.to_boosted_field }.join(' ')
+        end
+
         params[:mm] = @minimum_match if @minimum_match
         params[:ps] = @phrase_slop if @phrase_slop
         params[:qs] = @query_phrase_slop if @query_phrase_slop

data/lib/sunspot/query/function_query.rb

@@ -3,18 +3,25 @@ module Sunspot
     # 
     # Abstract class for function queries.
     #
-    class FunctionQuery 
+    class FunctionQuery
+      attr_reader :boost_amount
 
       def ^(y)
         @boost_amount = y
         self
       end
+
+      def ==(other)
+        @boost_amount == other.boost_amount
+      end
     end
 
     #
     # Function query which represents a constant.
     #
     class ConstantFunctionQuery < FunctionQuery
+      attr_reader :constant
+
       def initialize(constant)
         @constant = constant
       end
@@ -22,12 +29,18 @@ module Sunspot
       def to_s
         Type.to_literal(@constant) << (@boost_amount ? "^#{@boost_amount}" : "")
       end
+
+      def ==(other)
+        super and @constant == other.constant
+      end
     end
 
     #
     # Function query which represents a field.
     #
     class FieldFunctionQuery < FunctionQuery
+      attr_reader :field
+
       def initialize(field)
         @field = field
       end
@@ -35,6 +48,10 @@ module Sunspot
       def to_s
         "#{Util.escape(@field.indexed_name)}" << (@boost_amount ? "^#{@boost_amount}" : "")
       end
+
+      def ==(other)
+        super and @field == other.field
+      end
     end
 
     #
@@ -43,6 +60,8 @@ module Sunspot
     # Arguments are in turn FunctionQuery objects.
     #
     class FunctionalFunctionQuery < FunctionQuery
+      attr_reader :function_name, :function_args
+
       def initialize(function_name, function_args)
         @function_name, @function_args = function_name, function_args
       end
@@ -51,6 +70,11 @@ module Sunspot
         params = @function_args.map { |arg| arg.to_s }.join(",")
         "#{@function_name}(#{params})" << (@boost_amount ? "^#{@boost_amount}" : "")
       end
+
+      def ==(other)
+        super and
+          @function_name == other.function_name and @function_args == other.function_args
+      end
     end
   end
 end

data/lib/sunspot/query/group.rb

@@ -4,7 +4,7 @@ module Sunspot
     # A Group groups by the unique values of a given field, or by given queries.
     #
     class Group
-      attr_accessor :limit, :truncate
+      attr_accessor :limit, :truncate, :ngroups
       attr_reader :fields, :queries
 
       def initialize
@@ -30,16 +30,15 @@ module Sunspot
 
       def to_params
         params = {
-          :group            => "true",
-          :"group.ngroups"  => "true",
+          :group            => 'true',
+          :"group.ngroups"  => @ngroups.nil? ? 'true' : @ngroups.to_s
         }
 
-        params.merge!(@sort.to_params("group."))
+        params.merge!(@sort.to_params('group.'))
         params[:"group.field"] = @fields.map(&:indexed_name) if @fields.any?
         params[:"group.query"] = @queries.map(&:to_boolean_phrase) if @queries.any?
         params[:"group.limit"] = @limit if @limit
         params[:"group.truncate"] = @truncate if @truncate
-
         params
       end
     end

data/lib/sunspot/query/join.rb

@@ -42,19 +42,17 @@ module Sunspot
         keywords = escape_quotes(params.delete(:q))
         options = params.map { |key, value| escape_param(key, value) }.join(' ')
         q_name = "q#{@target.name}#{self.object_id}"
-        fq_name = "f#{q_name}"
 
         {
-          :q => "_query_:\"{!join from=#{@from} to=#{@to} v=$#{q_name} fq=$#{fq_name}}\"",
-          q_name => "_query_:\"{!edismax #{options}}#{keywords}\"",
-          fq_name => "type:#{@target.name}"
+          :q     => "_query_:\"{!join from=#{@from} to=#{@to} v=$#{q_name}}\"",
+          q_name => "_query_:\"{!field f=type}#{@target.name}\"+_query_:\"{!edismax #{options}}#{keywords}\""
         }
       end
 
       #
       # Assign a new boost query and return it.
       #
-      def create_boost_query(factor)
+      def add_boost_query(factor)
       end
 
       #

data/lib/sunspot/query/range_json_facet.rb

@@ -5,10 +5,12 @@ module Sunspot
       SECONDS_IN_DAY = 86400
 
       def initialize(field, options, setup)
-        raise Exception.new("Need to specify a range") if options[:range].nil?
+        options[:range] ||= options[:time_range]
+        raise Exception.new("Need to specify a range") if options[:range].nil? && options[:time_range].nil?
         @start = options[:range].first
         @end = options[:range].last
         @gap = options[:gap] || SECONDS_IN_DAY
+        @other = options[:other]
         super
       end
 
@@ -19,7 +21,8 @@ module Sunspot
             field: @field.indexed_name,
             start: @field.to_indexed(@start),
             end: @field.to_indexed(@end),
-            gap: @gap
+            gap: @gap,
+            other: @other
           }.merge!(init_params)
         }
       end