sunspot_rails 2.0.0 → 2.1.0

data/lib/sunspot/rails/stub_session_proxy.rb

@@ -82,10 +82,16 @@ module Sunspot
           0
         end
 
+        def facets
+          []
+        end
+
         def facet(name)
+          FacetStub.new
         end
 
         def dynamic_facet(name)
+          FacetStub.new
         end
 
         def execute
@@ -140,6 +146,14 @@ module Sunspot
         end
         
       end
+
+      class FacetStub
+
+        def rows
+          []
+        end
+
+      end
       
     end
   end

data/lib/sunspot/rails/tasks.rb

@@ -14,55 +14,60 @@ 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] => [:environment] do |t, args|
-    puts "*Note: the reindex task will remove your current indexes and start from scratch."
-    puts "If you have a large dataset, reindexing can take a very long time, possibly weeks."
-    puts "This is not encouraged if you have anywhere near or over 1 million rows."
-    puts "Are you sure you want to drop your indexes and completely reindex? (y/n)"
-    answer = STDIN.gets.chomp
-    return false if answer == "n"
-
+  task :reindex, [:batch_size, :models, :silence] => [:environment] do |t, args|
     # Retry once or gracefully fail for a 5xx error so we don't break reindexing
-    Sunspot.session = Sunspot::SessionProxy::Retry5xxSessionProxy.new(Sunspot.session)
-
-    # Set up general options for reindexing
-    reindex_options = { :batch_commit => false }
+    with_session(Sunspot::SessionProxy::Retry5xxSessionProxy.new(Sunspot.session)) do
 
-    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
+      # Set up general options for reindexing
+      reindex_options = { :batch_commit => false }
 
-    # 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
+      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
 
-    # 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
+      # Load all the application's models. Models which invoke 'searchable' will register themselves
+      # in Sunspot.searchable.
+      Rails.application.eager_load!
+
+      if args[:models].present?
+        # Choose a specific subset of models, if requested
+        model_names = args[:models].split(/[+ ]/)
+        sunspot_models = model_names.map{ |m| m.constantize }
+      else
+        # By default, reindex all searchable models
+        sunspot_models = Sunspot.searchable
+      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
-      $stdout.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}"
+      # Set up progress_bar to, ah, report progress unless the user has chosen to silence output
+      begin
+        require 'progress_bar'
+        total_documents = sunspot_models.map { | m | m.count }.sum
+        reindex_options[:progress_bar] = ProgressBar.new(total_documents)
+      rescue LoadError => e
+        $stdout.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 unless args[:silence]
+
+      # Finally, invoke the class-level solr_reindex on each model
+      sunspot_models.each do |model|
+        model.solr_reindex(reindex_options)
+      end
     end
+  end
 
-    # Finally, invoke the class-level solr_reindex on each model
-    sunspot_models.each do |model|
-      model.solr_reindex(reindex_options)
-    end
+  # Swaps sunspot sessions for the duration of the block
+  # Ensures the session is returned to normal in case this task is called from within the rails app
+  # and not just a one-off from the command line
+  def with_session(new_session)
+    original_session = Sunspot.session
+    Sunspot.session = new_session
+    yield
+  ensure
+    Sunspot.session = original_session
   end
 
   def sunspot_solr_in_load_path?

data/lib/sunspot_rails.rb

@@ -1,12 +1,7 @@
 # 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 >= '3'
+require 'active_support/core_ext/object/to_json'
 
 require 'sunspot/rails'
-
-if ::Rails.version >= '3'
-  require 'sunspot/rails/railtie'
-else
-  require 'sunspot/rails/init'
-end
+require 'sunspot/rails/railtie'

data/spec/configuration_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" do
   before(:each) do
-    File.stub!(:exist?).and_return(false) # simulate sunspot.yml not existing
+    File.stub(:exist?).and_return(false) # simulate sunspot.yml not existing
     @config = Sunspot::Rails::Configuration.new
   end
   
@@ -11,27 +11,27 @@ describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" d
   end  
   
   it "should handle the 'path' property when not set" do
-    @config.path.should == '/solr'
+    @config.path.should == '/solr/default'
   end
 
   describe "port" do
     it "should default to port 8981 in test" do
-      ::Rails.stub!(:env => 'test')
+      ::Rails.stub(:env => 'test')
       @config = Sunspot::Rails::Configuration.new
       @config.port.should == 8981
     end
     it "should default to port 8982 in development" do
-      ::Rails.stub!(:env => 'development')
+      ::Rails.stub(:env => 'development')
       @config = Sunspot::Rails::Configuration.new
       @config.port.should == 8982
     end
     it "should default to 8983 in production" do
-      ::Rails.stub!(:env => 'production')
+      ::Rails.stub(:env => 'production')
       @config = Sunspot::Rails::Configuration.new
       @config.port.should == 8983
     end
     it "should generally default to 8983" do
-      ::Rails.stub!(:env => 'staging')
+      ::Rails.stub(:env => 'staging')
       @config = Sunspot::Rails::Configuration.new
       @config.port.should == 8983
     end
@@ -88,7 +88,7 @@ end
 
 describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
   before(:each) do
-    ::Rails.stub!(:env => 'config_test')
+    ::Rails.stub(:env => 'config_test')
     @config = Sunspot::Rails::Configuration.new
   end
 
@@ -145,7 +145,7 @@ end
 
 describe Sunspot::Rails::Configuration, "with disabled: true in sunspot.yml" do
   before(:each) do
-    ::Rails.stub!(:env => 'config_disabled_test')
+    ::Rails.stub(:env => 'config_disabled_test')
     @config = Sunspot::Rails::Configuration.new
   end
 
@@ -160,7 +160,7 @@ describe Sunspot::Rails::Configuration, "with ENV['SOLR_URL'] overriding sunspot
   end
 
   before(:each) do
-    ::Rails.stub!(:env => 'config_test')
+    ::Rails.stub(:env => 'config_test')
     @config = Sunspot::Rails::Configuration.new
   end
   
@@ -187,7 +187,7 @@ describe Sunspot::Rails::Configuration, "with ENV['WEBSOLR_URL'] overriding suns
   end
 
   before(:each) do
-    ::Rails.stub!(:env => 'config_test')
+    ::Rails.stub(:env => 'config_test')
     @config = Sunspot::Rails::Configuration.new
   end
   

data/spec/model_spec.rb

@@ -119,46 +119,50 @@ describe 'ActiveRecord mixin' do
         with :title, 'Bogus Post'
       end.results.should be_empty
     end
-    
-    it 'should use the include option on the data accessor when specified' do
-      Post.should_receive(:all).with(hash_including(:include => [:blog])).and_return([@post])
-      Post.search do
-        with :title, 'Test Post'
-        data_accessor_for(Post).include = [:blog]
-      end.results.should == [@post]
+
+    it 'should not allow bogus options to search' do
+      lambda { Post.search(:bogus => :option) }.should raise_error(ArgumentError)
     end
 
     it 'should pass :include option from search call to data accessor' do
-      Post.should_receive(:all).with(hash_including(:include => [:blog])).and_return([@post])
-      Post.search(:include => [:blog]) do
+      Post.search(:include => [:location]) do
         with :title, 'Test Post'
-      end.results.should == [@post]
+      end.data_accessor_for(Post).include.should == [:location]
     end
     
-    it 'should use the select option from search call to data accessor' do
-      Post.should_receive(:all).with(hash_including(:select => 'title, published_at')).and_return([@post])
-      Post.search(:select => 'title, published_at') do
+    it 'should use the include option on the data accessor when specified' do
+      @post.update_attribute(:location, Location.create)
+      post = Post.search do
         with :title, 'Test Post'
-      end.results.should == [@post]
-    end
+        data_accessor_for(Post).include = [:location]
+      end.results.first
 
-    it 'should not allow bogus options to search' do
-      lambda { Post.search(:bogus => :option) }.should raise_error(ArgumentError)
+      (Rails.version >= '3.1' ? post.association(:location).loaded? : post.loaded_location?).should be_true # Rails 3.1 removed "loaded_#{association}" method
+    end
+    
+    it 'should use the select option from search call to data accessor' do
+      Post.search(:select => 'id, title, body') do
+        with :title, 'Test Post'
+      end.data_accessor_for(Post).select.should == 'id, title, body'
     end
     
     it 'should use the select option on the data accessor when specified' do
-      Post.should_receive(:all).with(hash_including(:select => 'title, published_at')).and_return([@post])
       Post.search do
         with :title, 'Test Post'
-        data_accessor_for(Post).select = [:title, :published_at]
-      end.results.should == [@post]
+        data_accessor_for(Post).select = 'id, title, body'
+      end.results.first.attribute_names.sort.should == ['body', 'id', 'title']
     end
     
     it 'should not use the select option on the data accessor when not specified' do
-      Post.should_receive(:all).with(hash_not_including(:select)).and_return([@post])
       Post.search do
         with :title, 'Test Post'
-      end.results.should == [@post]
+      end.results.first.attribute_names.should == Post.first.attribute_names
+    end
+
+    it 'should accept an array as a select option' do
+      Post.search(:select => ['id', 'title', 'body']) do
+        with :title, 'Test Post'
+      end.results.first.attribute_names.sort.should == ['body', 'id', 'title']
     end
 
     it 'should gracefully handle nonexistent records' do
@@ -286,15 +290,20 @@ describe 'ActiveRecord mixin' do
       @posts = Array.new(2) { Post.create }
     end
 
-    describe "when not using batches" do
-      
-      it "should select all if the batch_size is nil" do
-        Post.should_receive(:all).with(:include => []).and_return([])
-        Post.reindex(:batch_size => nil)
-      end
+    it "should use batches if the batch_size is specified" do
+      relation(Post).class.any_instance.should_receive(:find_in_batches)
+      Post.reindex(:batch_size => 50)
+    end
 
+    it "should select all if the batch_size isn't greater than 0" do
+      relation(Post).class.any_instance.should_not_receive(:find_in_batches)
+      Post.reindex(:batch_size => nil)
+      Post.reindex(:batch_size => 0)
+    end
+
+    describe "when not using batches" do
       it "should search for models with includes" do
-        Post.should_receive(:all).with(:include => :author).and_return([])
+        Post.should_receive(:includes).with(:author).and_return(relation(Post))
         Post.reindex(:batch_size => nil, :include => :author)
       end
 

data/spec/rails_template/app/models/post_with_default_scope.rb

@@ -5,7 +5,9 @@ class PostWithDefaultScope < ActiveRecord::Base
 
   attr_accessible :title, :type, :location_id, :body, :blog
 
-  default_scope :order => :title
+	def self.default_scope
+		order(:title)
+  end
 
   searchable :auto_index => false, :auto_remove => false do
     string :title

data/spec/rails_template/app/models/rake_task_auto_load_test_model.rb

@@ -0,0 +1,13 @@
+# This model should not be used for any test other than the spec test that
+# checks if all models are loaded. We don't want to pre-load this model in
+# another test because we're checking to see if it will be auto-loaded by
+# the reindex task
+class RakeTaskAutoLoadTestModel < ActiveRecord::Base
+  def self.table_name
+    'posts'
+  end
+
+  searchable do
+    string :name
+  end
+end

data/spec/rails_template/config/database.yml

@@ -0,0 +1,11 @@
+<% if ENV['DB'] == 'postgres' %>
+test:
+  adapter: postgresql
+  database: sunspot_test
+<% elsif ENV['DB'] == 'sqlite' %>
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+<% end %>

data/spec/rails_template/config/routes.rb

@@ -1,9 +1,3 @@
-if Rails::VERSION::MAJOR == 2
-  ActionController::Routing::Routes.draw do |map|
-    map.resources :posts, :only => :create
-  end
-elsif Rails::VERSION::MAJOR == 3
-  Rails.application.routes.draw do
-    resources :posts, :only => :create
-  end
-end
+Rails.application.routes.draw do
+  resources :posts, :only => :create
+end

data/spec/rake_task_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'sunspot namespace rake task' do
+  before :all do
+    require "#{Rails.root}/../../lib/sunspot/rails/tasks"
+    Rake::Task.define_task(:environment)
+  end
+
+  describe 'sunspot:reindex' do
+    it "should reindex all models if none are specified" do
+      run_rake_task("sunspot:reindex", '', '', true)
+
+      # This model should not be used by any other test and therefore should only be loaded by this test
+      Sunspot.searchable.collect(&:name).should include('RakeTaskAutoLoadTestModel')
+    end
+
+    it "should accept a space delimited list of models to reindex" do
+      Post.should_receive(:solr_reindex)
+      Author.should_receive(:solr_reindex)
+      Blog.should_not_receive(:solr_reindex)
+
+      run_rake_task("sunspot:reindex", '', "Post Author", true)
+    end
+
+    it "should accept a plus delimited list of models to reindex" do
+      Post.should_receive(:solr_reindex)
+      Author.should_receive(:solr_reindex)
+      Blog.should_not_receive(:solr_reindex)
+
+      run_rake_task("sunspot:reindex", '', "Post+Author", true)
+    end
+  end
+end
+
+def run_rake_task(task_name, *task_args)
+  task = Rake::Task[task_name.to_s]
+  task.reenable
+  task.invoke(*task_args) # Invoke but skip the reindex warning
+end

data/spec/searchable_spec.rb

@@ -3,6 +3,9 @@ require File.expand_path('spec_helper', File.dirname(__FILE__))
 describe Sunspot::Rails::Searchable do
   describe '#searchable' do
     it "should register models with Sunspot.searchable (via Sunspot.setup)" do
+    	# Rspec runs tests in random order, causing this test to fail on occasion unless we ensure the models have loaded.
+    	Author; Blog; Post;
+
       Sunspot.searchable.should_not be_empty
       Sunspot.searchable.should include(Author)
       Sunspot.searchable.should include(Blog)

data/spec/session_spec.rb

@@ -31,7 +31,7 @@ describe 'Sunspot::Rails session' do
   context 'disabled' do
     before do
       Sunspot::Rails.reset
-      ::Rails.stub!(:env).and_return("config_disabled_test")
+      ::Rails.stub(:env).and_return("config_disabled_test")
     end
 
     after do

data/spec/spec_helper.rb

@@ -1,48 +1,75 @@
-ENV['RAILS_ENV'] = 'test'
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
 if rsolr_version = ENV['RSOLR_GEM_VERSION']
   STDERR.puts("Forcing RSolr version #{rsolr_version}")
   gem "rsolr", rsolr_version
 end
 
-require File.expand_path('config/environment', ENV['RAILS_ROOT'])
+# Require the Database-specific gems
+ENV['DB'] ||= 'sqlite'
+Bundler.require(ENV['DB'])
 
-begin
-  require 'rspec'
-  require 'rspec/rails'
-rescue LoadError => e
-  require 'spec'
-  require 'spec/rails'
-end
-require 'rake'
+require File.expand_path('config/environment', ENV['RAILS_ROOT'])
+require 'rspec/rails'
+require 'rspec/autorun'
 require File.join('sunspot', 'rails', 'solr_logging')
 
-def load_schema
-  stdout = $stdout
-  $stdout = StringIO.new # suppress output while building the schema
-  load File.join(ENV['RAILS_ROOT'], 'db', 'schema.rb')
-  $stdout = stdout
-end
-
-def silence_stderr(&block)
-  stderr = $stderr
-  $stderr = StringIO.new
-  yield
-  $stderr = stderr
-end
-
-rspec =
-  begin
-    RSpec
-  rescue NameError, ArgumentError
-    Spec::Runner
-  end
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
 
 # Load all shared examples
 Dir[File.expand_path("shared_examples/*.rb", File.dirname(__FILE__))].each {|f| require f}
 
-rspec.configure do |config|
+# Load the schema
+load File.join(ENV['RAILS_ROOT'], 'db', 'schema.rb')
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  # --seed 1234
+  config.order = "random"
+
   config.before(:each) do
-    load_schema
+    empty_tables
     Sunspot.remove_all!
+  end  
+end
+
+def empty_tables
+  ActiveRecord::Base.connection.tables.each do |table_name|
+    ActiveRecord::Base.connection.execute("DELETE FROM #{table_name}") unless table_name == 'schema_migrations'
   end
 end
+
+# COMPATIBILITY: Rails 4 has deprecated the 'scoped' method in favour of 'all'
+def relation(clazz)
+  ::Rails.version >= '4' ? clazz.all : clazz.scoped
+end