sunspot 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 385375ab001841dcd220a07df21307f581e5ed8d4c41c6907e4d2f05783259e5
-  data.tar.gz: 0cd9f3eb2a5225b46429988a7a9d10f2ecbd488fd2c824448831a5f908a69c75
+  metadata.gz: 179de5f5261bdb69d21038a0b2e36fbd2812e1fc71ef4c1efd77979a03e58179
+  data.tar.gz: 1f7f40d9737400cf61c23515c61ebde70140b1c1bf9df800d7e19ce27c3cbd0d
 SHA512:
-  metadata.gz: 97c5760b633b1ab3cbfb8a04a3dd49e9c0bd40485151c94b5c8196104a2b0fc47f1fdd97ff2d85b738c4d225820316dc1e42cceb5a19ea8c7f084a9b82e224f0
-  data.tar.gz: 6ca3b17c3c28f89f56160ebdbaf2c924103976eb939df6832f0755d30a368c757dd912b5491b9a84caf38498e8320252ad14d59cd86ca4e8d071e3b2d95518e1
+  metadata.gz: ad59d5868f3461648d29c77b6368d7c5145ef6247ecca38878bf4f03bb3d2ab73fea2decf629936d58282b8067345198f6bff82be1347bb0cc92cb4537722d28
+  data.tar.gz: 3c4fd67940331fbdacffd665ca624119038bf12da2aa2b041adbd8260aef3921660b83803a912cf81384c7269f6b46d3b7fad1c883c34e1a1ba2ccbade2fd6dc

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

@@ -259,7 +259,7 @@ module Sunspot
         read_timeout: config.solr.read_timeout,
         open_timeout: config.solr.open_timeout,
         proxy: config.solr.proxy,
-        update_format: config.solr.update_format || :xml
+        update_format: update_format_generator
       )
     end
 
@@ -277,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/version.rb

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

data/spec/api/adapters_spec.rb

@@ -20,6 +20,19 @@ describe Sunspot::Adapters::InstanceAdapter do
     Sunspot::Adapters::InstanceAdapter::for(UnseenModel)
     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

data/spec/api/search/hits_spec.rb

@@ -12,6 +12,20 @@ describe 'hits', :type => :search do
     end).to eq([['Post', post_1.id.to_s], ['Post', post_2.id.to_s]])
   end
 
+  it "should return ID prefix when used with compositeId shard router" do
+    Sunspot.index!(ModelWithPrefixId.new)
+
+    expect(Sunspot.search(ModelWithPrefixId).
+      hits.map { |h| h.id_prefix }.uniq).to eq ["USERDATA!"]
+  end
+
+  it "should parse nested ID prefixes" do
+    Sunspot.index!(ModelWithNestedPrefixId.new)
+
+    expect(Sunspot.search(ModelWithNestedPrefixId).
+      hits.map { |h| h.id_prefix }.uniq).to eq ["USER!USERDATA!"]
+  end
+
   it 'returns search total as attribute of hits' do
     stub_results(Post.new, 4)
     expect(session.search(Post) do

data/spec/api/sunspot_spec.rb

@@ -24,6 +24,9 @@ describe Sunspot do
       config_before_reset = Sunspot.config
       Sunspot.reset!(true)
       expect(Sunspot.config).to eq(config_before_reset)
+
+      # Restore sunspot config after test
+      Sunspot.reset!(false)
     end
   end
 end

data/spec/integration/field_lists_spec.rb

@@ -31,6 +31,22 @@ describe 'fields lists' do
     end
   end
 
+  it 'does not raise Sunspot::UnrecognizedFieldError when listing existing text fields' do
+    expect do
+      Sunspot.search(Post) {
+        field_list(:body)
+      }
+    end.to_not raise_error
+  end
+
+  it 'does raise Sunspot::UnrecognizedFieldError when listing a non-existent text fields' do
+    expect do
+      Sunspot.search(Post) {
+        field_list(:bogus_body)
+      }
+    end.to raise_error(Sunspot::UnrecognizedFieldError)
+  end
+
   it 'does not load any stored fields' do
     hit = Sunspot.search(Post) { without_stored_fields }.hits.first
 

data/spec/mocks/adapters.rb

@@ -7,7 +7,40 @@ end
 class UnseenModel < AbstractModel
 end
 
+class ModelWithPrefixId < AbstractModel
+  def id
+    1
+  end
+end
+
+Sunspot.setup(ModelWithPrefixId) do
+  id_prefix { "USERDATA!" }
+end
+
+class ModelWithNestedPrefixId < AbstractModel
+  def id
+    1
+  end
+end
+
+Sunspot.setup(ModelWithNestedPrefixId) do
+  id_prefix { "USER!USERDATA!" }
+end
+
+class ModelWithoutPrefixId < AbstractModel
+  def id
+    1
+  end
+end
+
+Sunspot.setup(ModelWithoutPrefixId) do
+end
+
+
 class AbstractModelInstanceAdapter < Sunspot::Adapters::InstanceAdapter
+  def id
+    @instance.id
+  end
 end
 
 class AbstractModelDataAccessor < Sunspot::Adapters::DataAccessor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunspot
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Mat Brown
@@ -30,7 +30,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsolr