sunspot 2.2.7 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4bdef6ed9f0c2c63ec693c6db3fe71149987c50d
-  data.tar.gz: c7451cff132715d22bff11d90bed4ba62bf516e2
+SHA256:
+  metadata.gz: 179de5f5261bdb69d21038a0b2e36fbd2812e1fc71ef4c1efd77979a03e58179
+  data.tar.gz: 1f7f40d9737400cf61c23515c61ebde70140b1c1bf9df800d7e19ce27c3cbd0d
 SHA512:
-  metadata.gz: 71b60a64a69d3397a7d81c01282f8ab80e8c7b662bdb4196e91c84b9c06787d8787a2f37ba80e163f653ac0635ecf6edf682b2fec27a0dbef8ecfb79e9fd62c0
-  data.tar.gz: bdb4c1d76331b386db7a487b3161afbf4f10c7f5c3a74f0d45e1d1876d348f84ba7fa7dfc750d45a2342f0d73d8cf51b72567dae3972ffd5ac08549cd8bf5ec6
+  metadata.gz: ad59d5868f3461648d29c77b6368d7c5145ef6247ecca38878bf4f03bb3d2ab73fea2decf629936d58282b8067345198f6bff82be1347bb0cc92cb4537722d28
+  data.tar.gz: 3c4fd67940331fbdacffd665ca624119038bf12da2aa2b041adbd8260aef3921660b83803a912cf81384c7269f6b46d3b7fad1c883c34e1a1ba2ccbade2fd6dc

data/.gitignore

@@ -11,3 +11,4 @@ pkg
 README.rdoc
 .bundle
 Gemfile.lock
+gemfiles/*.gemfile*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'rsolr-1.x' do
+  gem 'rsolr', '>= 1', '< 2'
+end
+
+appraise 'rsolr-2.x' do
+  gem 'rsolr', '>= 2', '< 3'
+end

data/Gemfile

@@ -1,11 +1,3 @@
 source "http://rubygems.org"
 
-gem 'sunspot_solr', :path => File.expand_path('../../sunspot_solr', __FILE__)
-
 gemspec
-
-group :development do
-  gem 'rake'
-end
-
-gem 'rsolr', ENV['RSOLR'] if ENV['RSOLR']

data/lib/sunspot/adapters.rb

@@ -63,7 +63,10 @@ module Sunspot
       # String:: ID for use in Solr
       #
       def index_id #:nodoc:
-        InstanceAdapter.index_id_for(@instance.class.name, id)
+        setup     = Sunspot::Setup.for(@instance.class)
+        id_prefix = setup ? setup.id_prefix_for(@instance) : nil
+
+        InstanceAdapter.index_id_for("#{id_prefix}#{@instance.class.name}", id)
       end
 
       class <<self

data/lib/sunspot/configuration.rb

@@ -26,6 +26,7 @@ module Sunspot
             read_timeout nil
             open_timeout nil
             proxy nil
+            update_format :xml
           end
           master_solr do
             url nil

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]/
+
+      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/field_query.rb

@@ -333,6 +333,17 @@ module Sunspot
         end
       end
 
+      def json_facet(*field_names)
+        options = Sunspot::Util.extract_options_from(field_names)
+
+        field_names.each do |field_name|
+          field = @setup.field(field_name)
+          facet = Sunspot::Util.parse_json_facet(field_name, options, @setup)
+          @search.add_json_facet(field, options)
+          @query.add_query_facet(facet)
+        end
+      end
+
       def stats(*field_names, &block)
         options = Sunspot::Util.extract_options_from(field_names)
 

data/lib/sunspot/dsl/field_stats.rb

@@ -13,6 +13,13 @@ module Sunspot
           @search_stats.add_facet(field)
         end
       end
+
+      def json_facet(field_name, options = {})
+        field = @setup.field(field_name)
+        facet = Sunspot::Util.parse_json_facet(field_name, options, @setup)
+        @query_stats.add_json_facet(facet)
+      end
+
     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/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

@@ -14,7 +14,12 @@ module Sunspot
 
       # Build a restriction to return only fields of the type in the results.
       def field_list(*args)
-        @query.add_field_list(Sunspot::Query::FieldList.new(args.flatten))
+        list = args.flatten.map { |field| @setup.field(field.to_sym).indexed_name.to_sym }
+        @query.add_field_list(Sunspot::Query::FieldList.new([:id] + list)) unless list.empty?
+      end
+
+      def without_stored_fields
+        @query.add_field_list(Sunspot::Query::FieldList.new([:id]))
       end
 
       #
@@ -194,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/field.rb

@@ -93,6 +93,17 @@ module Sunspot
       !!@joined
     end
 
+    #
+    # Whether the field is stored or not.
+    #
+    # ==== Returns
+    #
+    # Boolean:: True if this field is a stored field
+    #
+    def stored?
+      !!@stored
+    end
+
     def hash
       indexed_name.hash
     end

data/lib/sunspot/field_factory.rb

@@ -72,11 +72,15 @@ module Sunspot
       # into the Solr document for indexing.
       #
       def populate_document(document, model, options = {}) #:nodoc:
+        atomic_operation = options[:update] == :set
         value = extract_value(model, options)
-        unless value.nil?
-          Util.Array(@field.to_indexed(value)).each do |scalar_value|
+        if value != nil || atomic_operation
+          indexed_values = Util.Array(@field.to_indexed(value))
+          indexed_values = [nil] if indexed_values.empty? && atomic_operation
+          indexed_values.each do |scalar_value|
             field_options = {}
             field_options[:boost] = @field.boost if @field.boost
+            field_options[:null] = true if scalar_value.nil? && atomic_operation
             document.add_field(
               @field.indexed_name.to_sym,
               scalar_value,

data/lib/sunspot/query/abstract_json_field_facet.rb

@@ -0,0 +1,70 @@
+module Sunspot
+  module Query
+    class AbstractJsonFieldFacet
+
+      attr_accessor :field
+
+      DISTINCT_STRATEGIES = [:unique, :hll]
+
+      def initialize(field, options, setup)
+        @field, @options, @setup = field, options, setup
+      end
+
+      def init_params
+        params = {}
+        params[:limit] = @options[:limit] unless @options[:limit].nil?
+        params[:mincount] = @options[:minimum_count] unless @options[:minimum_count].nil?
+        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?
+
+        if !@options[:distinct].nil?
+          dist_opts = @options[:distinct]
+          raise Exception.new("Need to specify a strategy") if dist_opts[:strategy].nil?
+          raise Exception.new("The strategy must be one of #{DISTINCT_STRATEGIES}") unless DISTINCT_STRATEGIES.include?(dist_opts[:strategy])
+          @stategy = dist_opts[:strategy]
+          @group_by = dist_opts[:group_by].nil? ? @field : @setup.field(dist_opts[:group_by])
+          params[:field] = @group_by.indexed_name
+          params[:facet] = {}
+          params[:facet][:distinct] = "#{@stategy}(#{@field.indexed_name})"
+        end
+
+        params
+      end
+
+      def get_params
+        query = field_name_with_local_params
+        nested_params = recursive_nested_params(@options)
+
+        if !nested_params.nil?
+          query[@field.name][:facet] ||= {}
+          query[@field.name][:facet].merge!(nested_params)
+        end
+        query
+      end
+
+      def to_params
+        { 'json.facet' => self.get_params.to_json }
+      end
+
+      private
+
+      def recursive_nested_params(options)
+        if !options[:nested].nil? && options[:nested].is_a?(Hash)
+          opts = options[:nested]
+          field_name = opts[:field]
+
+          options = Sunspot::Util.extract_options_from([opts])
+          params = Sunspot::Util.parse_json_facet(field_name, options, @setup).field_name_with_local_params
+          if !opts.nil?
+            nested_params = recursive_nested_params(opts)
+            params[field_name][:facet] = nested_params unless nested_params.nil?
+          end
+
+          params
+        end
+      end
+
+    end
+  end
+end

data/lib/sunspot/query/bbox.rb

@@ -5,8 +5,12 @@ module Sunspot
         @field, @first_corner, @second_corner = field, first_corner, second_corner
       end
 
+      def to_solr_conditional
+        "[#{@first_corner.join(",")} TO #{@second_corner.join(",")}]"
+      end
+
       def to_params
-        filter = "#{@field.indexed_name}:[#{@first_corner.join(",")} TO #{@second_corner.join(",")}]"
+        filter = "#{@field.indexed_name}:#{to_solr_conditional}"
 
         {:fq => filter}
       end

data/lib/sunspot/query/date_field_json_facet.rb

@@ -0,0 +1,25 @@
+module Sunspot
+  module Query
+    class DateFieldJsonFacet < AbstractJsonFieldFacet
+
+      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 }
+      end
+    end
+  end
+end

data/lib/sunspot/query/field_json_facet.rb

@@ -0,0 +1,19 @@
+module Sunspot
+  module Query
+    class FieldJsonFacet < AbstractJsonFieldFacet
+
+      def initialize(field, options, setup)
+        super
+      end
+
+      def field_name_with_local_params
+        {
+          @field.name => {
+            type: 'terms',
+            field: @field.indexed_name,
+          }.merge!(init_params)
+        }
+      end
+    end
+  end
+end

data/lib/sunspot/query/field_stats.rb

@@ -10,9 +10,42 @@ module Sunspot
         @facets << field
       end
 
+      def add_json_facet(json_facet)
+        @json_facet = json_facet
+      end
+
       def to_params
-        params = { :stats => true, :"stats.field" => [@field.indexed_name]}
-        params[facet_key] = @facets.map(&:indexed_name) unless @facets.empty?
+        params = {}
+        if !@json_facet.nil?
+          params['json.facet'] = recursive_add_stats(@json_facet.get_params).to_json
+        else
+          params.merge!(:stats => true, :"stats.field" => [@field.indexed_name])
+          params[facet_key] = @facets.map(&:indexed_name) unless @facets.empty?
+        end
+        params
+      end
+
+      STATS_FUNCTIONS = [:min, :max, :sum, :avg, :sumsq]
+
+      def recursive_add_stats(query)
+        query.keys.each do |k|
+          if !query[k][:facet].nil?
+            query[k][:facet] = recursive_add_stats(query[k][:facet])
+          end
+          query[k][:facet] ||= {}
+          query[k][:sort] = { @options[:sort] => @options[:sort_type]||'desc' } unless @options[:sort].nil?
+          query[k][:facet].merge!(json_stats_params)
+        end
+        query
+      end
+
+      def json_stats_params
+        params = {}
+        STATS_FUNCTIONS.each { |s| params[s] = "#{s.to_s}(#{@field.indexed_name})" }
+        unless @options[:stats].nil?
+          to_remove = STATS_FUNCTIONS - @options[:stats]
+          to_remove.map { |s| params.delete(s)}
+        end
         params
       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,12 +42,10 @@ 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
 

data/lib/sunspot/query/range_json_facet.rb

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

data/lib/sunspot/query/restriction.rb

@@ -135,7 +135,7 @@ module Sunspot
 
         protected
 
-        # 
+        #
         # Return escaped Solr API representation of given value
         #
         # ==== Parameters
@@ -158,9 +158,13 @@ module Sunspot
       end
 
       class InRadius < Base
-        def initialize(negated, field, lat, lon, radius)
-          @lat, @lon, @radius = lat, lon, radius
-          super negated, field, [lat, lon, radius]
+        def initialize(negated, field, *value)
+          @lat, @lon, @radius = value
+          super negated, field, value
+        end
+
+        def negate
+          self.class.new(!@negated, @field, *@value)
         end
 
         private
@@ -169,6 +173,17 @@ module Sunspot
           end
       end
 
+      class InBoundingBox < Base
+        def initialize(negated, field, first_corner, second_corner)
+          @bbox = Sunspot::Query::Bbox.new(field, first_corner, second_corner)
+          super negated, field, [first_corner, second_corner]
+        end
+
+        def to_solr_conditional
+          @bbox.to_solr_conditional
+        end
+      end
+
       # 
       # Results must have field with value equal to given value. If the value
       # is nil, results must have no value for the given field.

data/lib/sunspot/query.rb

@@ -1,6 +1,6 @@
-%w(filter abstract_field_facet connective boost_query date_field_facet
-   range_facet abstract_fulltext dismax join field_list
-   field_facet highlighting pagination restriction common_query spellcheck
+%w(filter abstract_field_facet abstract_json_field_facet connective boost_query date_field_facet field_json_facet
+   range_facet range_json_facet date_field_json_facet abstract_fulltext dismax join
+   field_list field_facet highlighting pagination restriction common_query spellcheck
    standard_query more_like_this more_like_this_query geo geofilt bbox query_facet
    scope sort sort_composite text_field_boost function_query field_stats
    composite_fulltext group group_query).each do |file|

data/lib/sunspot/schema.rb

@@ -88,8 +88,16 @@ module Sunspot
     # Return an XML representation of this schema using the ERB template
     #
     def to_xml
-      template = File.join(File.dirname(__FILE__), '..', '..', 'templates', 'schema.xml.erb')
-      ERB.new(File.read(template), nil, '-').result(binding)
+      template_path = File.join(File.dirname(__FILE__), '..', '..', 'templates', 'schema.xml.erb')
+      template_text = File.read(template_path)
+
+      erb = if RUBY_VERSION >= '2.6'
+        ERB.new(template_text, trim_mode: '-')
+      else
+        ERB.new(template_text, nil, '-')
+      end
+
+      erb.result(binding)
     end
 
     private