sunspot_rails 1.2.1 → 1.3.0.rc6

data/lib/sunspot/rails/stub_session_proxy.rb

@@ -55,18 +55,23 @@ module Sunspot
       def new_search(*types)
         Search.new
       end
+      
+      def new_more_like_this(*args)
+        Search.new
+      end
 
       class Search
+        
         def build
           self
         end
 
         def results
-          []
+          PaginatedCollection.new
         end
 
         def hits(options = {})
-          []
+          PaginatedCollection.new
         end
 
         def total
@@ -83,6 +88,55 @@ module Sunspot
           self
         end
       end
+      
+      
+      class PaginatedCollection < Array
+        
+        def total_count
+          0
+        end
+        alias :total_entries :total_count
+        
+        def current_page
+          1
+        end
+        
+        def per_page
+          30
+        end
+        alias :limit_value :per_page
+        
+        def total_pages
+          1
+        end
+        alias :num_pages :total_pages
+
+        def first_page?
+          true
+        end
+
+        def last_page?
+          true
+        end
+
+        def previous_page
+          nil
+        end
+
+        def next_page
+          nil
+        end
+
+        def out_of_bounds?
+          false
+        end
+
+        def offset
+          0
+        end
+        
+      end
+      
     end
   end
 end

data/lib/sunspot/rails/tasks.rb

@@ -1,28 +1,4 @@
 namespace :sunspot do
-  namespace :solr do
-    desc 'Start the Solr instance'
-    task :start => :environment do
-      if RUBY_PLATFORM =~ /w(in)?32$/
-        abort('This command does not work on Windows. Please use rake sunspot:solr:run to run Solr in the foreground.')
-      end
-      Sunspot::Rails::Server.new.start
-    end
-
-    desc 'Run the Solr instance in the foreground'
-    task :run => :environment do
-      Sunspot::Rails::Server.new.run
-    end
-
-    desc 'Stop the Solr instance'
-    task :stop => :environment do
-      if RUBY_PLATFORM =~ /w(in)?32$/
-        abort('This command does not work on Windows.')
-      end
-      Sunspot::Rails::Server.new.stop
-    end
-
-    task :reindex => :"sunspot:reindex"
-  end
 
   desc "Reindex all solr models that are located in your application's models directory."
   # This task depends on the standard Rails file naming \
@@ -38,23 +14,70 @@ namespace :sunspot do
   # $ rake sunspot:reindex[1000,Post]     # reindex only the Post model in
   #                                       # batchs of 1000
   # $ rake sunspot:reindex[,Post+Author]  # reindex Post and Author model
-  task :reindex, :batch_size, :models, :needs => :environment do |t, args|
-    reindex_options = {:batch_commit => false}
+  task :reindex, [:batch_size, :models] => [:environment] do |t, args|
+    # Set up general options for reindexing
+    reindex_options = { :batch_commit => false }
+    
     case args[:batch_size]
     when 'false'
       reindex_options[:batch_size] = nil
     when /^\d+$/ 
       reindex_options[:batch_size] = args[:batch_size].to_i if args[:batch_size].to_i > 0
     end
-    unless args[:models]
-      all_files = Dir.glob(Rails.root.join('app', 'models', '*.rb'))
-      all_models = all_files.map { |path| File.basename(path, '.rb').camelize.constantize }
-      sunspot_models = all_models.select { |m| m < ActiveRecord::Base and m.searchable? }
-    else
-      sunspot_models = args[:models].split('+').map{|m| m.constantize}
+
+    # Load all the application's models. Models which invoke 'searchable' will register themselves
+    # in Sunspot.searchable.
+    Dir.glob(Rails.root.join('app/models/**/*.rb')).each { |path| require path }
+
+    # By default, reindex all searchable models
+    sunspot_models = Sunspot.searchable
+
+    # Choose a specific subset of models, if requested
+    if args[:models]
+      model_names = args[:models].split('+')
+      sunspot_models = model_names.map{ |m| m.constantize }
+    end
+    
+    # Set up progress_bar to, ah, report progress
+    begin
+      require 'progress_bar'
+      total_documents = sunspot_models.map { | m | m.count }.sum
+      reindex_options[:progress_bar] = ProgressBar.new(total_documents)
+    rescue LoadError => e
+      $stderr.puts "Skipping progress bar: for progress reporting, add gem 'progress_bar' to your Gemfile"
+    rescue Exception => e
+      $stderr.puts "Error using progress bar: #{e.message}"
     end
+    
+    # Finally, invoke the class-level solr_reindex on each model
     sunspot_models.each do |model|
-      model.solr_reindex reindex_options
+      model.solr_reindex(reindex_options)
+    end
+  end
+
+
+  unless defined?(Sunspot::Solr)
+    namespace :solr do
+  		task :moved_to_sunspot_solr do
+  	    abort %(
+  Note: This task has been moved to the sunspot_solr gem. To install, start and
+  stop a local Solr instance, please add sunspot_solr to your Gemfile:
+
+  group :development do
+    gem 'sunspot_solr'
+  end
+
+)
+  		end
+  		
+      desc 'Start the Solr instance'
+      task :start => :moved_to_sunspot_solr
+      desc 'Run the Solr instance in the foreground'
+      task :run => :moved_to_sunspot_solr
+      desc 'Stop the Solr instance'
+      task :stop => :moved_to_sunspot_solr
+  		# for backwards compatibility
+      task :reindex => :"sunspot:reindex"
     end
   end
   

data/lib/sunspot_rails.rb

@@ -1,3 +1,8 @@
+# This needs to be loaded before sunspot/search/paginated_collection
+# or #to_json gets defined in Object breaking delegation to Array via
+# method_missing
+require 'active_support/core_ext/object/to_json' if Rails::VERSION::MAJOR == 3
+
 require 'sunspot/rails'
 
 if Rails::VERSION::MAJOR == 3

data/spec/configuration_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" do
   before(:each) do
@@ -55,9 +55,9 @@ describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" d
     @config.data_path.should == '/some/path/solr/data/test'
   end
 
-  it "should handle the 'pid_path' property when not set" do
+  it "should handle the 'pid_dir' property when not set" do
     Rails.should_receive(:root).at_least(1).and_return('/some/path')
-    @config.pid_path.should == '/some/path/solr/pids/test'
+    @config.pid_dir.should == '/some/path/solr/pids/test'
   end
   
   it "should handle the 'auto_commit_after_request' propery when not set" do
@@ -67,6 +67,14 @@ describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" d
   it "should handle the 'auto_commit_after_delete_request' propery when not set" do
     @config.auto_commit_after_delete_request?.should == false
   end
+
+  it "should handle the 'bind_address' property when not set" do
+    @config.bind_address.should be_nil
+  end
+
+  it "should handle the 'disabled' property when not set" do
+    @config.disabled?.should be_false
+  end
 end
 
 describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
@@ -99,8 +107,8 @@ describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
     @config.data_path.should == '/my_superior_path/data'
   end
 
-  it "should handle the 'pid_path' property when set" do
-    @config.pid_path.should == '/my_superior_path/pids'
+  it "should handle the 'pid_dir' property when set" do
+    @config.pid_dir.should == '/my_superior_path/pids'
   end
   
   it "should handle the 'solr_home' property when set" do
@@ -114,8 +122,22 @@ describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
   it "should handle the 'auto_commit_after_delete_request' propery when set" do
     @config.auto_commit_after_delete_request?.should == true
   end
+
+  it "should handle the 'bind_address' property when set" do
+    @config.bind_address.should == "127.0.0.1"
+  end
 end
 
+describe Sunspot::Rails::Configuration, "with disabled: true in sunspot.yml" do
+  before(:each) do
+    ::Rails.stub!(:env => 'config_disabled_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+
+  it "should handle the 'disabled' property when set" do
+    @config.disabled?.should be_true
+  end
+end
 
 describe Sunspot::Rails::Configuration, "with ENV['SOLR_URL'] overriding sunspot.yml" do
   before(:all) do

data/spec/model_lifecycle_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 describe 'searchable with lifecycle' do
   describe 'on create' do

data/spec/model_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 describe 'ActiveRecord mixin' do
   describe 'index()' do
@@ -297,6 +297,22 @@ describe 'ActiveRecord mixin' do
         Post.should_receive(:all).with(:include => :author).and_return([])
         Post.reindex(:batch_size => nil, :include => :author)
       end
+
+      describe ':if constraints' do
+        before do
+          Post.sunspot_options[:if] = proc { |model| model.id != @posts.first.id }
+        end
+
+        after do
+          Post.sunspot_options[:if] = nil
+        end
+
+        it 'should only index those models where :if constraints pass' do
+          Post.reindex(:batch_size => nil)
+
+          Post.search.results.should_not include(@posts.first)
+        end
+      end
     
     end
 
@@ -310,6 +326,22 @@ describe 'ActiveRecord mixin' do
         Sunspot.should_receive(:commit).once
         Post.reindex(:batch_commit => false)
       end
+
+      describe ':if constraints' do
+        before do
+          Post.sunspot_options[:if] = proc { |model| model.id != @posts.first.id }
+        end
+
+        after do
+          Post.sunspot_options[:if] = nil
+        end
+
+        it 'should only index those models where :if constraints pass' do
+          Post.reindex(:batch_size => 50)
+
+          Post.search.results.should_not include(@posts.first)
+        end
+      end
     end
   end
   
@@ -353,4 +385,211 @@ describe 'ActiveRecord mixin' do
       @posts.first.more_like_this_ids.to_set.should == [@posts[3], @posts[1]].map { |post| post.id }.to_set
     end
   end
+
+  describe ':if constraint' do
+    subject do
+      PostWithAuto.new(:title => 'Post123')
+    end
+
+    after do
+      subject.class.sunspot_options[:if] = nil
+    end
+
+    context 'Symbol' do
+      context 'constraint returns true' do
+        # searchable :if => :returns_true
+        before do
+          subject.should_receive(:returns_true).and_return(true)
+          subject.class.sunspot_options[:if] = :returns_true
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+
+      context 'constraint returns false' do
+        # searchable :if => :returns_false
+        before do
+          subject.should_receive(:returns_false).and_return(false)
+          subject.class.sunspot_options[:if] = :returns_false
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+    end
+
+    context 'String' do
+      context 'constraint returns true' do
+        # searchable :if => 'returns_true'
+        before do
+          subject.should_receive(:returns_true).and_return(true)
+          subject.class.sunspot_options[:if] = 'returns_true'
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+
+      context 'constraint returns false' do
+        # searchable :if => 'returns_false'
+        before do
+          subject.should_receive(:returns_false).and_return(false)
+          subject.class.sunspot_options[:if] = 'returns_false'
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+    end
+
+    context 'Proc' do
+      context 'constraint returns true' do
+        # searchable :if => proc { true }
+        before do
+          subject.class.sunspot_options[:if] = proc { true }
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+
+      context 'constraint returns false' do
+        # searchable :if => proc { false }
+        before do
+          subject.class.sunspot_options[:if] = proc { false }
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+    end
+
+    context 'Array' do
+      context 'all constraints returns true' do
+        # searchable :if => [:returns_true_1, :returns_true_2]
+        before do
+          subject.should_receive(:returns_true_1).and_return(true)
+          subject.should_receive(:returns_true_2).and_return(true)
+          subject.class.sunspot_options[:if] = [:returns_true_1, 'returns_true_2']
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+
+      context 'one constraint returns false' do
+        # searchable :if => [:returns_true, :returns_false]
+        before do
+          subject.should_receive(:returns_true).and_return(true)
+          subject.should_receive(:returns_false).and_return(false)
+          subject.class.sunspot_options[:if] = [:returns_true, 'returns_false']
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+    end
+
+    it 'removes the model from the index if the constraint does not match' do
+      subject.save!
+      Sunspot.commit
+      subject.class.search.results.should include(subject)
+
+      subject.class.sunspot_options[:if] = proc { false }
+      subject.save!
+      Sunspot.commit
+      subject.class.search.results.should_not include(subject)
+    end
+  end
+
+  describe ':unless constraint' do
+    subject do
+      PostWithAuto.new(:title => 'Post123')
+    end
+
+    after do
+      subject.class.sunspot_options[:unless] = nil
+    end
+
+    context 'Symbol' do
+      context 'constraint returns true' do
+        # searchable :unless => :returns_true
+        before do
+          subject.should_receive(:returns_true).and_return(true)
+          subject.class.sunspot_options[:unless] = :returns_true
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+
+      context 'constraint returns false' do
+        # searchable :unless => :returns_false
+        before do
+          subject.should_receive(:returns_false).and_return(false)
+          subject.class.sunspot_options[:unless] = :returns_false
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+    end
+
+    context 'String' do
+      context 'constraint returns true' do
+        # searchable :unless => 'returns_true'
+        before do
+          subject.should_receive(:returns_true).and_return(true)
+          subject.class.sunspot_options[:unless] = 'returns_true'
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+
+      context 'constraint returns false' do
+        # searchable :unless => 'returns_false'
+        before do
+          subject.should_receive(:returns_false).and_return(false)
+          subject.class.sunspot_options[:unless] = 'returns_false'
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+    end
+
+    context 'Proc' do
+      context 'constraint returns true' do
+        # searchable :unless => proc { true }
+        before do
+          subject.class.sunspot_options[:unless] = proc { |model| model == subject } # true
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+
+      context 'constraint returns false' do
+        # searchable :unless => proc { false }
+        before do
+          subject.class.sunspot_options[:unless] = proc { false }
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+    end
+
+    context 'Array' do
+      context 'all constraints returns true' do
+        # searchable :unless => [:returns_true_1, :returns_true_2]
+        before do
+          subject.should_receive(:returns_true_1).and_return(true)
+          subject.should_receive(:returns_true_2).and_return(true)
+          subject.class.sunspot_options[:unless] = [:returns_true_1, 'returns_true_2']
+        end
+
+        it_should_behave_like 'not indexed after save'
+      end
+
+      context 'one constraint returns false' do
+        # searchable :unless => [:returns_true, :returns_false]
+        before do
+          subject.should_receive(:returns_true).and_return(true)
+          subject.should_receive(:returns_false).and_return(false)
+          subject.class.sunspot_options[:unless] = [:returns_true, 'returns_false']
+        end
+
+        it_should_behave_like 'indexed after save'
+      end
+    end
+  end
 end