sunspot 2.5.0 → 2.7.1

data/lib/sunspot/util.rb

@@ -190,22 +190,15 @@ module Sunspot
 
       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]
+        if options[:range] || options[:time_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'
+              ':range can only be specified for date, time, or numeric fields'
             )
           end
-          Sunspot::Query::RangeJsonFacet.new(field, options, setup)
+          facet_klass = field.type.is_a?(Sunspot::Type::TimeType) ? Sunspot::Query::DateFieldJsonFacet : Sunspot::Query::RangeJsonFacet
+          facet_klass.new(field, options, setup)
         else
           Sunspot::Query::FieldJsonFacet.new(field, options, setup)
         end
@@ -255,7 +248,7 @@ module Sunspot
     Coordinates = Struct.new(:lat, :lng)
 
     class ContextBoundDelegate
-      class <<self
+      class << self
         def instance_eval_with_context(receiver, &block)
           calling_context = eval('self', block.binding)
           if parent_calling_context = calling_context.instance_eval{@__calling_context__ if defined?(@__calling_context__)}
@@ -296,21 +289,31 @@ module Sunspot
         __proxy_method__(:sub, *args, &block)
       end
 
-      def method_missing(method, *args, &block)
-        __proxy_method__(method, *args, &block)
+      def method_missing(method, *args, **kwargs, &block)
+        __proxy_method__(method, *args, **kwargs, &block)
       end
 
-      def __proxy_method__(method, *args, &block)
-        begin
+      def respond_to_missing?(method, _)
+        @__receiver__.respond_to?(method, true) || super
+      end
+
+      def __proxy_method__(method, *args, **kwargs, &block)
+        if kwargs.empty?
           @__receiver__.__send__(method.to_sym, *args, &block)
-        rescue ::NoMethodError => e
-          begin
+        else
+          @__receiver__.__send__(method.to_sym, *args, **kwargs, &block)
+        end
+      rescue ::NoMethodError => e
+        begin
+          if kwargs.empty?
             @__calling_context__.__send__(method.to_sym, *args, &block)
-          rescue ::NoMethodError
-            raise(e)
+          else
+            @__calling_context__.__send__(method.to_sym, *args, **kwargs, &block)
           end
+        rescue ::NoMethodError
+          raise(e)
         end
-      end
+      end      
     end
   end
 end

data/lib/sunspot/version.rb

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

data/lib/sunspot.rb

@@ -40,6 +40,12 @@ module Sunspot
   NoSetupError = Class.new(StandardError)
   IllegalSearchError = Class.new(StandardError)
   NotImplementedError = Class.new(StandardError)
+  AtomicUpdateRequireInstanceForCompositeIdMessage = lambda do |class_name|
+    "WARNING: `id_prefix` is defined for #{class_name}. Use instance as key for `atomic_update` instead of ID."
+  end
+  RemoveByIdNotSupportCompositeIdMessage = lambda do |class_name|
+    "WARNING: `id_prefix` is defined for #{class_name}. `remove_by_id` does not support it. Use `remove` instead."
+  end
 
   autoload :Installer, File.join(File.dirname(__FILE__), 'sunspot', 'installer')
 
@@ -208,6 +214,8 @@ module Sunspot
     #
     #   post1, post2 = new Array(2) { Post.create }
     #   Sunspot.atomic_update(Post, post1.id => {title: 'New Title'}, post2.id => {description: 'new description'})
+    #   Or
+    #   Sunspot.atomic_update(Post, post1 => {title: 'New Title'}, post2 => {description: 'new description'})
     #
     # Note that indexed objects won't be reflected in search until a commit is
     # sent - see Sunspot.index! and Sunspot.commit
@@ -223,7 +231,7 @@ module Sunspot
     # ==== Parameters
     #
     # clazz<Class>:: the class of the objects to be updated
-    # updates<Hash>:: hash of updates where keys are model ids
+    # updates<Hash>:: hash of updates where keys are models or model ids
     #                 and values are hash with property name/values to be updated
     #
     def atomic_update!(clazz, updates = {})

data/spec/api/binding_spec.rb

@@ -36,6 +36,17 @@ describe "DSL bindings" do
         end
       end
     end
+    expect(value).to eq('value')
+  end
+
+  it 'should give access to calling context\'s methods with keyword arguments' do
+    value = nil
+    session.search(Post) do
+      any_of do
+        value = kwargs_method(a: 10, b: 20)
+      end
+    end
+    expect(value).to eq({ a: 10, b: 20 })
   end
 
   private
@@ -47,4 +58,8 @@ describe "DSL bindings" do
   def id
     16
   end
+
+  def kwargs_method(a:, b:)
+    { a: a, b: b }
+  end
 end

data/spec/api/indexer/attributes_spec.rb

@@ -98,7 +98,7 @@ describe 'indexing attribute fields', :type => :indexer do
 
   it 'should index latitude and longitude passed as non-Floats' do
     coordinates = Sunspot::Util::Coordinates.new(
-      BigDecimal.new('40.7'), BigDecimal.new('-73.5'))
+      BigDecimal('40.7'), BigDecimal('-73.5'))
     session.index(post(:coordinates => coordinates))
     expect(connection).to have_add_with(:coordinates_s => 'dr5xx3nytvgs')
   end

data/spec/api/indexer/removal_spec.rb

@@ -60,4 +60,91 @@ describe 'document removal', :type => :indexer do
     end
     expect(connection).to have_delete_by_query("(type:Post AND title_ss:monkeys)")
   end
+
+  context 'when call #remove_by_id' do
+    let(:post) { clazz.new(title: 'A Title') }
+    before(:each) { index_post(post) }
+
+    context 'and `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+        let(:id_prefix) { lambda { |post| "USERDATA-#{post.id}!" } }
+
+        it 'prints warning' do
+          expect do
+            session.remove_by_id(clazz, post.id)
+          end.to output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'does not remove record' do
+          session.remove_by_id(clazz, post.id)
+          expect(connection).to have_no_delete(post_solr_id)
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+        let(:id_prefix) { lambda { |post| "#{post.title}!" } }
+
+        it 'prints warning' do
+          expect do
+            session.remove_by_id(clazz, post.id)
+          end.to output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'does not remove record' do
+          session.remove_by_id(clazz, post.id)
+          expect(connection).to have_no_delete(post_solr_id)
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+        let(:id_prefix) { 'USERDATA!' }
+
+        it 'does not print warning' do
+          expect do
+            session.remove_by_id(clazz, post.id)
+          end.to_not output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+        end
+
+        it 'removes record' do
+          session.remove_by_id(clazz, post.id)
+          expect(connection).to have_delete(post_solr_id)
+        end
+      end
+    end
+
+    context 'and `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+      let(:id_prefix) { nil }
+
+      it 'does not print warning' do
+        expect do
+          session.remove_by_id(clazz, post.id)
+        end.to_not output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+      end
+
+      it 'removes record' do
+        session.remove_by_id(clazz, post.id)
+        expect(connection).to have_delete(post_solr_id)
+      end
+    end
+
+    context 'and `id_prefix` is passed along with `class_name`' do
+      let(:clazz) { PostWithProcPrefixId }
+      let(:id_prefix) { lambda { |post| "USERDATA-#{post.id}!" } }
+
+      it 'does not print warning' do
+        expect do
+          session.remove_by_id("USERDATA-#{post.id}!#{clazz.name}", post.id)
+        end.to_not output(Sunspot::RemoveByIdNotSupportCompositeIdMessage.call(clazz) + "\n").to_stderr
+      end
+
+      it 'removes record' do
+        session.remove_by_id("USERDATA-#{post.id}!#{clazz.name}", post.id)
+        expect(connection).to have_delete(post_solr_id)
+      end
+    end
+  end
 end

data/spec/api/query/connective_boost_examples.rb

@@ -0,0 +1,85 @@
+shared_examples_for "query with connective scope and boost" do
+  it 'creates a boost query' do
+    search do
+      boost(10) do
+        any_of do
+          with(:coordinates_new).in_bounding_box([23, -46], [25, -44])
+          with(:coordinates_new).in_bounding_box([42, 56], [43, 58])
+        end
+      end
+    end
+
+    expect(connection).to have_last_search_including(
+      :bq, '(coordinates_new_ll:[23,-46 TO 25,-44] OR coordinates_new_ll:[42,56 TO 43,58])^10'
+    )
+
+    expect(connection).to have_last_search_including(
+      :defType, 'edismax'
+    )
+  end
+
+  it 'creates a boost function' do
+    search do
+      boost(function() { field(:average_rating) })
+    end
+
+    expect(connection).to have_last_search_including(
+      :bf, 'field(average_rating_ft)'
+    )
+
+    expect(connection).to have_last_search_including(
+      :defType, 'edismax'
+    )
+  end
+
+  it 'creates a multiplicative boost function' do
+    search do
+      boost_multiplicative(function() { field(:average_rating) })
+    end
+
+    expect(connection).to have_last_search_including(
+      :boost, 'field(average_rating_ft)'
+    )
+
+    expect(connection).to have_last_search_including(
+      :defType, 'edismax'
+    )
+  end
+
+  it 'creates combined boost search' do
+    search do
+      boost(10) do
+        any_of do
+          with(:coordinates_new).in_bounding_box([23, -46], [25, -44])
+          with(:coordinates_new).in_bounding_box([42, 56], [43, 58])
+        end
+      end
+
+      boost(function() { field(:average_rating) })
+      boost_multiplicative(function() { field(:average_rating) })
+    end
+
+    expect(connection).to have_last_search_including(
+      :bq, '(coordinates_new_ll:[23,-46 TO 25,-44] OR coordinates_new_ll:[42,56 TO 43,58])^10'
+    )
+
+    expect(connection).to have_last_search_including(
+      :bf, 'field(average_rating_ft)'
+    )
+
+    expect(connection).to have_last_search_including(
+      :boost, 'field(average_rating_ft)'
+    )
+  end
+
+  it 'avoids duplicate boost functions' do
+    search do
+      boost(function() { field(:average_rating) })
+      boost(function() { field(:average_rating) })
+      boost_multiplicative(function() { field(:average_rating) })
+    end
+
+    expect(connection.searches.last[:bf]).to eq ['field(average_rating_ft)']
+    expect(connection.searches.last[:boost]).to eq ['field(average_rating_ft)']
+  end
+end

data/spec/api/query/geo_examples.rb

@@ -10,7 +10,7 @@ shared_examples_for 'geohash query' do
 
   it 'searches for nearby points with non-Float arguments' do
     search do
-      with(:coordinates).near(BigDecimal.new('40.7'), BigDecimal.new('-73.5'))
+      with(:coordinates).near(BigDecimal('40.7'), BigDecimal('-73.5'))
     end
     expect(connection).to have_last_search_including(:q, build_geo_query)
   end

data/spec/api/query/join_spec.rb

@@ -6,7 +6,7 @@ describe 'join' do
       with(:caption, 'blah')
     end
     expect(connection).to have_last_search_including(
-      :fq, "{!join from=photo_container_id_i to=id_i}caption_s:blah")
+      :fq, "{!join from=photo_container_id_i to=id_i v='type:\"Photo\" AND caption_s:\"blah\"'}")
   end
 
   it 'should greater_than search by join' do
@@ -14,6 +14,6 @@ describe 'join' do
       with(:photo_rating).greater_than(3)
     end
     expect(connection).to have_last_search_including(
-      :fq, "{!join from=photo_container_id_i to=id_i}average_rating_ft:{3\\.0 TO *}")
+      :fq, "{!join from=photo_container_id_i to=id_i v='type:\"Photo\" AND average_rating_ft:{3\\.0 TO *}'}")
   end
 end

data/spec/api/query/standard_spec.rb

@@ -4,6 +4,7 @@ describe 'standard query', :type => :query do
   it_should_behave_like "scoped query"
   it_should_behave_like "query with advanced manipulation"
   it_should_behave_like "query with connective scope"
+  it_should_behave_like "query with connective scope and boost"
   it_should_behave_like "query with dynamic field support"
   it_should_behave_like "facetable query"
   it_should_behave_like "fulltext query"
@@ -22,6 +23,15 @@ describe 'standard query', :type => :query do
     expect(connection).to have_last_search_with(:q => '*:*')
   end
 
+  it 'adds a no-op query to :q parameter when only a boost query provided' do
+    session.search Post do
+      boost(2) do
+        with :title, 'My Pet Post'
+      end
+    end
+    expect(connection).to have_last_search_with(:q => '*:*')
+  end
+
   private
 
   def search(*classes, &block)

data/spec/api/query/types_spec.rb

@@ -1,12 +1,12 @@
 describe 'typed query' do
   it 'properly escapes namespaced type names' do
     session.search(Namespaced::Comment)
-    expect(connection).to have_last_search_with(:fq => ['type:Namespaced\:\:Comment'])
+    expect(connection).to have_last_search_with(:fq => ['type:"Namespaced\:\:Comment"'])
   end
 
   it 'builds search for multiple types' do
     session.search(Post, Namespaced::Comment)
-    expect(connection).to have_last_search_with(:fq => ['type:(Post OR Namespaced\:\:Comment)'])
+    expect(connection).to have_last_search_with(:fq => ['type:(Post OR "Namespaced\:\:Comment")'])
   end
 
   it 'searches type of subclass when superclass is configured' do

data/spec/api/session_proxy/master_slave_session_proxy_spec.rb

@@ -38,7 +38,7 @@ describe Sunspot::SessionProxy::MasterSlaveSessionProxy do
   end
 
   it 'should raise ArgumentError when bogus config specified' do
-    expect { @proxy.config(:bogus) }.to raise_error
+    expect { @proxy.config(:bogus) }.to raise_error(ArgumentError)
   end
 
   it_should_behave_like 'session proxy'

data/spec/api/session_proxy/retry_5xx_session_proxy_spec.rb

@@ -1,7 +1,8 @@
 require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'uri'
 
 describe Sunspot::SessionProxy::Retry5xxSessionProxy do
-  
+
   before :each do
     Sunspot::Session.connection_class = Mock::ConnectionFactory.new
     @sunspot_session = Sunspot.session
@@ -21,11 +22,14 @@ describe Sunspot::SessionProxy::Retry5xxSessionProxy do
   end
 
   let :fake_rsolr_request do
-    {:uri => 'http://solr.test/uri'}
+    {:uri => URI('http://solr.test/uri')}
   end
 
   def fake_rsolr_response(status)
-    {:status => status.to_s}
+    {
+      :status => status.to_s,
+      :body => ''
+    }
   end
 
   let :post do
@@ -67,12 +71,12 @@ describe Sunspot::SessionProxy::Retry5xxSessionProxy do
   it "should not retry a 4xx" do
     e = FakeRSolrErrorHttp.new(fake_rsolr_request, fake_rsolr_response(400))
     expect(@sunspot_session).to receive(:index).and_raise(e)
-    expect { Sunspot.index(post) }.to raise_error
+    expect { Sunspot.index(post) }.to raise_error(FakeRSolrErrorHttp)
   end
 
   # TODO: try against more than just Sunspot.index? but that's just testing the
   # invocation of delegate, so probably not important. -nz 11Apr12
 
   it_should_behave_like 'session proxy'
-  
+
 end

data/spec/api/session_spec.rb

@@ -109,7 +109,7 @@ describe 'Session' do
     it 'should open a connection with custom read timeout' do
       Sunspot.config.solr.read_timeout = 0.5
       Sunspot.commit
-      expect(connection.opts[:read_timeout]).to eq(0.5)
+      expect(connection.opts[:timeout]).to eq(0.5)
     end
 
     it 'should open a connection with custom open timeout' do

data/spec/api/setup_spec.rb

@@ -0,0 +1,99 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Setup do
+  context '#id_prefix_for_class' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_for_class }
+
+    context 'when `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+
+        it 'returns `id_prefix` value' do
+          is_expected.to eq('USERDATA!')
+        end
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns nil' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  context '#id_prefix_defined?' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_defined? }
+
+    context 'when `id_prefix` is defined on model' do
+      let(:clazz) { PostWithProcPrefixId }
+
+      it 'returns true' do
+        is_expected.to be_truthy
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns false' do
+        is_expected.to be_falsey
+      end
+    end
+  end
+
+  context '#id_prefix_requires_instance?' do
+    subject { Sunspot::Setup.for(clazz).id_prefix_requires_instance? }
+
+    context 'when `id_prefix` is defined on model' do
+      context 'as Proc' do
+        let(:clazz) { PostWithProcPrefixId }
+
+        it 'returns true' do
+          is_expected.to be_truthy
+        end
+      end
+
+      context 'as Symbol' do
+        let(:clazz) { PostWithSymbolPrefixId }
+
+        it 'returns true' do
+          is_expected.to be_truthy
+        end
+      end
+
+      context 'as String' do
+        let(:clazz) { PostWithStringPrefixId }
+
+        it 'returns false' do
+          is_expected.to be_falsey
+        end
+      end
+    end
+
+    context 'when `id_prefix` is not defined on model' do
+      let(:clazz) { PostWithoutPrefixId }
+
+      it 'returns false' do
+        is_expected.to be_falsey
+      end
+    end
+  end
+end

data/spec/helpers/indexer_helper.rb

@@ -14,4 +14,26 @@ module IndexerHelper
   def values_in_last_document_for(field_name)
     @connection.adds.last.last.fields_by_name(field_name).map { |field| field.value }
   end
+
+  def index_post(post)
+    Sunspot.index!(post)
+    hit = find_post(post)
+    expect(hit).not_to be_nil
+    hit
+  end
+
+  def find_post(post)
+    Sunspot.search(clazz).hits.find { |h| h.primary_key.to_i == post.id && h.id_prefix == id_prefix_value(post, id_prefix) }
+  end
+
+  def id_prefix_value(post, id_prefix)
+    return unless id_prefix
+    return id_prefix if id_prefix.is_a?(String)
+
+    id_prefix.call(post)
+  end
+
+  def post_solr_id
+    "#{id_prefix_value(post, id_prefix)}#{clazz} #{post.id}"
+  end
 end