sunspot 0.10.3 → 0.10.4

data/History.txt

@@ -1,3 +1,8 @@
+== 0.10.4 2009-10-20
+* Add adjust_params method, allowing experts to manually edit Solr params
+* Track adds and deletes separately in session, and expose delete_dirty? method
+* Allow clients to inject a singleton session proxy
+
 == 0.10.3 2009-10-15
 * Contiguous, not continuous
 * Fail fast if less-than-1 radius passed for local search

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 10
-:patch: 3
+:patch: 4
 :major: 0

data/lib/sunspot.rb

@@ -38,7 +38,16 @@ module Sunspot
   NoSetupError = Class.new(Exception)
   IllegalSearchError = Class.new(Exception)
 
+
   class <<self
+    # 
+    # Clients can inject a session proxy, allowing them to implement custom
+    # session-management logic while retaining the Sunspot singleton API as
+    # an available interface. The object assigned to this attribute must
+    # respond to all of the public methods of the Sunspot::Session class.
+    #
+    attr_writer :session
+
     # Configures indexing and search for a given class.
     #
     # ==== Parameters
@@ -413,6 +422,24 @@ module Sunspot
       session.commit_if_dirty
     end
     
+    #
+    # True if documents have been removed since the last commit.
+    #
+    # ==== Returns
+    #
+    # Boolean:: Whether there have been any deletes since the last commit
+    #
+    def delete_dirty?
+      session.delete_dirty?
+    end
+
+    # 
+    # Sends a commit if the session has deletes since the last commit (see #delete_dirty?).
+    #
+    def commit_if_delete_dirty
+      session.commit_if_delete_dirty
+    end
+    
     # Returns the configuration associated with the singleton session. See
     # Sunspot::Configuration for details.
     #

data/lib/sunspot/dsl/query.rb

@@ -97,6 +97,30 @@ module Sunspot
         @query.paginate(page, per_page)
       end
 
+      # <strong>Expert:</strong> Adjust or reset the parameters passed to Solr.
+      # The adjustment will take place just before sending the params to solr,
+      # after Sunspot builds the Solr params based on the methods called in the
+      # DSL.
+      #
+      # Under normal circumstances, using this method should not be necessary;
+      # if you find that it is, please consider submitting a feature request.
+      # Using this method requires knowledge of Sunspot's internal Solr schema
+      # and Solr query representations, which are not part of Sunspot's public
+      # API; they could change at any time. <strong>This method is unsupported
+      # and your mileage may vary.</strong>
+      #
+      # ==== Example
+      #
+      #   Sunspot.search(Post) do
+      #     adjust_solr_params do |params|
+      #       params[:q] += ' AND something_s:more'
+      #     end
+      #   end
+      # 
+      def adjust_solr_params( &block )
+        @query.set_solr_parameter_adjustment( block )
+      end
+
       # 
       # Scope the search by geographical distance from a given point.
       # +coordinates+ should either respond to #first and #last (e.g. a

data/lib/sunspot/query/query.rb

@@ -1,8 +1,7 @@
 module Sunspot
   module Query
     class Query
-      attr_accessor :scope
-      attr_accessor :fulltext
+      attr_accessor :scope, :fulltext, :parameter_adjustment
 
       def initialize(types)
         @scope = Scope.new
@@ -19,6 +18,10 @@ module Sunspot
       def set_fulltext(keywords)
         @fulltext = Dismax.new(keywords)
       end
+      
+      def set_solr_parameter_adjustment( block )
+        @parameter_adjustment = block
+      end
 
       def add_location_restriction(coordinates, radius)
         @local = Local.new(coordinates, radius)
@@ -73,6 +76,7 @@ module Sunspot
         Sunspot::Util.deep_merge!(params, @sort.to_params)
         Sunspot::Util.deep_merge!(params, @pagination.to_params) if @pagination
         Sunspot::Util.deep_merge!(params, @local.to_params) if @local
+        @parameter_adjustment.call(params) if @parameter_adjustment
         params[:q] ||= '*:*'
         params
       end

data/lib/sunspot/session.rb

@@ -34,7 +34,7 @@ module Sunspot
       yield(@config) if block_given?
       @connection = connection
       @master_connection = master_connection
-      @updates = 0
+      @deletes = @adds = 0
     end
 
     # 
@@ -68,7 +68,7 @@ module Sunspot
     #
     def index(*objects)
       objects.flatten!
-      @updates += objects.length
+      @adds += objects.length
       indexer.add(objects)
     end
 
@@ -84,7 +84,7 @@ module Sunspot
     # See Sunspot.commit
     #
     def commit
-      @updates = 0
+      @adds = @deletes = 0
       master_connection.commit
     end
 
@@ -93,7 +93,7 @@ module Sunspot
     #
     def remove(*objects)
       objects.flatten!
-      @updates += objects.length
+      @deletes += objects.length
       for object in objects
         indexer.remove(object)
       end
@@ -134,10 +134,10 @@ module Sunspot
     def remove_all(*classes)
       classes.flatten!
       if classes.empty?
-        @updates += 1
+        @deletes += 1
         Indexer.remove_all(master_connection)
       else
-        @updates += classes.length
+        @deletes += classes.length
         for clazz in classes
           indexer.remove_all(clazz)
         end
@@ -156,7 +156,7 @@ module Sunspot
     # See Sunspot.dirty?
     #
     def dirty?
-      @updates > 0
+      (@deletes + @adds) > 0
     end
 
     # 
@@ -165,7 +165,21 @@ module Sunspot
     def commit_if_dirty
       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?
+    end
+    
     # 
     # See Sunspot.batch
     #

data/spec/api/query/adjust_params_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe 'typed query' do
+  it "should send query to solr with adjusted parameters (keyword example)" do
+    session.search Post do
+      keywords 'keyword search'
+      adjust_solr_params do |params|
+        params[:q]    = 'new search'
+        params[:some] = 'param'
+      end
+    end
+    connection.should have_last_search_with(:q    => 'new search')
+    connection.should have_last_search_with(:some => 'param')
+  end
+  
+  it "should work, even without another dsl command" do
+    session.search Post do
+      adjust_solr_params do |params|
+        params[:q]    = 'napoleon dynamite'
+        params[:qt]   = 'complicated'
+      end
+    end
+    connection.should have_last_search_with(:q  => 'napoleon dynamite')
+    connection.should have_last_search_with(:qt => 'complicated')
+  end
+  
+  it "should be able to extend parameters" do
+    session.search Post do
+      keywords 'keyword search'
+      adjust_solr_params do |params|
+        params[:q]    += ' AND something_s:more'
+      end
+    end
+    connection.should have_last_search_with(:q => 'keyword search AND something_s:more')
+  end
+  
+end

data/spec/api/session_spec.rb

@@ -118,43 +118,95 @@ describe 'Session' do
     it 'should start out not dirty' do
       @session.dirty?.should be_false
     end
+    
+    it 'should start out not delete_dirty' do
+      @session.delete_dirty?.should be_false
+    end
 
     it 'should be dirty after adding an item' do
       @session.index(Post.new)
       @session.dirty?.should be_true
     end
+    
+    it 'should be not be delete_dirty after adding an item' do
+      @session.index(Post.new)
+      @session.delete_dirty?.should be_false
+    end
 
     it 'should be dirty after deleting an item' do
       @session.remove(Post.new)
       @session.dirty?.should be_true
     end
 
+    it 'should be delete_dirty after deleting an item' do
+      @session.remove(Post.new)
+      @session.delete_dirty?.should be_true
+    end
+
     it 'should be dirty after a remove_all for a class' do
       @session.remove_all(Post)
       @session.dirty?.should be_true
     end
 
+    it 'should be delete_dirty after a remove_all for a class' do
+      @session.remove_all(Post)
+      @session.delete_dirty?.should be_true
+    end
+
     it 'should be dirty after a global remove_all' do
       @session.remove_all
       @session.dirty?.should be_true
     end
-
+    
+    it 'should be delete_dirty after a global remove_all' do
+      @session.remove_all
+      @session.delete_dirty?.should be_true
+    end
+    
     it 'should not be dirty after a commit' do
       @session.index(Post.new)
       @session.commit
       @session.dirty?.should be_false
     end
 
+    it 'should not be delete_dirty after a commit' do
+      @session.remove(Post.new)
+      @session.commit
+      @session.delete_dirty?.should be_false
+    end
+
     it 'should not commit when commit_if_dirty called on clean session' do
       @session.commit_if_dirty
       connection.should have(0).commits
     end
 
+    it 'should not commit when commit_if_delete_dirty called on clean session' do
+      @session.commit_if_delete_dirty
+      connection.should have(0).commits
+    end
+
     it 'should commit when commit_if_dirty called on dirty session' do
       @session.index(Post.new)
       @session.commit_if_dirty
       connection.should have(1).commits
     end
+    
+    it 'should commit when commit_if_delete_dirty called on delete_dirty session' do
+      @session.remove(Post.new)
+      @session.commit_if_delete_dirty
+      connection.should have(1).commits
+    end
+  end
+
+  context 'session proxy' do
+    it 'should send messages to manually assigned session proxy' do
+      stub_session = stub!('session')
+      Sunspot.session = stub_session
+      post = Post.new
+      stub_session.should_receive(:index).with(post)
+      Sunspot.index(post)
+      Sunspot.reset!
+    end
   end
 
   def connection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sunspot
 version: !ruby/object:Gem::Version 
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors: 
 - Mat Brown
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 -04:00
+date: 2009-10-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -171,6 +171,7 @@ files:
 - spec/api/indexer/removal_spec.rb
 - spec/api/indexer/spec_helper.rb
 - spec/api/indexer_spec.rb
+- spec/api/query/adjust_params_spec.rb
 - spec/api/query/connectives_spec.rb
 - spec/api/query/dsl_spec.rb
 - spec/api/query/dynamic_fields_spec.rb
@@ -301,6 +302,7 @@ test_files:
 - spec/api/query/spec_helper.rb
 - spec/api/query/faceting_spec.rb
 - spec/api/query/connectives_spec.rb
+- spec/api/query/adjust_params_spec.rb
 - spec/api/query/local_spec.rb
 - spec/api/query/highlighting_spec.rb
 - spec/api/query/ordering_pagination_spec.rb