sunspot_rails 1.1.0 → 1.2.0

data/History.txt

@@ -1,3 +1,14 @@
+== 1.2.0 2010-12-28
+* Compatible with both Rails 2 and Rails 3
+* Configure Sunspot with a SOLR_URL or WEBSOLR_URL environment variable, also
+  provide a default port based on Rails.env.
+* Fix the 'Anonymous modules' ArgumentError for Ruby 1.9.2 and Rails 2.3
+* Fix SQL's ambiguous ID issue when tables are joined
+
+== 1.1.0 2010-04-01
+* Added include option to searchable options to allow definition of eager
+  loading associations when indexing
+
 == 1.0.4 2010-03-19
 * Fix StubSessionProxy to match new internal API
 

data/README.rdoc

@@ -14,25 +14,25 @@ provides the following features:
 * Provide rake tasks for starting and stopping the development Solr instance,
   using the configuration in sunspot.yml
 
-Sunspot::Rails has been tested with Rails versions 2.1, 2.2, and 2.3
+Sunspot::Rails has been tested with Rails versions 2.3 and 3.0
 
-== Installation
+== Installation in Rails 3
 
-For recent versions of Rails, In your project's <code>config/environment.rb</code>, add the following gem dependencies:
+In your <code>Gemfile</code>:
 
-  config.gem 'sunspot', :lib => 'sunspot'
-  config.gem 'sunspot_rails', :lib => 'sunspot/rails'
+  gem 'sunspot_rails'
+
+== Installation in Rails 2
+
+In your project's <code>config/environment.rb</code>, add the following gem dependencies:
+
+  config.gem 'sunspot'
+  config.gem 'sunspot_rails'
     
 Install the gems with:
 
   rake gems:install
 
-If you are using an older version of Rails that doesn't support plugins-as-gems, install the gems manually and install the plugin:
-
-  sudo gem install sunspot sunspot_rails --source=http://gems.github.com
-  
-  script/plugin install git://github.com/outoftime/sunspot_rails.git
-  
 Generate the file <code>config/sunspot.yml</code>:
 
   script/generate sunspot
@@ -43,6 +43,8 @@ Sunspot::Rails as a gem, add the following line to your project's Rakefile:
 
   require 'sunspot/rails/tasks'
 
+== Using Sunspot::Rails
+
 If you wish to make modifications to the Solr schema, you can create a custom
 Solr home in your project directory. In order to do so, create the directory
 <code>RAILS_ROOT/solr/conf</code>, and copy in the contents of the Solr gem's

data/Rakefile

@@ -1,25 +1,16 @@
 require 'rake'
-require 'spec/rake/spectask'
 require 'rake/rdoctask'
 
-task :default => :spec
-
 if File.exist?(sunspot_lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'sunspot', 'lib')))
   STDERR.puts("Using sunspot lib at #{sunspot_lib}")
   $: << sunspot_lib
 end
 
-desc 'Run all specs'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = FileList['spec/*_spec.rb']
-  t.spec_opts << '--color'
-end
-
 task :environment do
   if ENV['SUNSPOT_LIB']
     $: << ENV['SUNSPOT_LIB']
   end
-  ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), 'spec', 'mock_app')
+  ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), 'spec', 'rails3')
   ENV['RAILS_ENV'] ||= 'test'
   require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))
 end

data/TESTING.md

@@ -0,0 +1,35 @@
+# Testing `sunspot_rails`
+
+Note: All the paths mentioned in here are relative to the current directory, or `sunspot/sunspot_rails`.
+
+The `sunspot_rails` gem is tested with RSpec, and its spec suite is located in `spec`.
+
+These specs are to be run against up to date Rails 2 and Rails 3 applications, included at `spec/rails2` and `spec/rails3`, respectively. The `spec_helper.rb` file loads the environment for these applications based on the `RAILS_ROOT` provided when invoking tests, outlined below.
+
+## Start Solr
+
+Specs expect to connect to Solr on `http://localhost:8980/solr`
+
+    rake sunspot:solr:start
+
+## Install dependencies
+
+Each application uses Bundler to manage its dependencies. The `Gemfile` also installs the `sunspot` and `sunspot_rails` gems from your copies checked out locally. Because Bundler expands the full path to `sunspot` and `sunspot_rails`, we're excluding its generated `Gemfile.lock` file from version control.
+
+    pushd spec/rails2
+    bundle install
+    cd ../rails3
+    bundle install
+		popd
+
+## Invoke specs
+
+The project contains wrapper scripts that set up the environment to run the
+specs under Rails 2 and Rails 3 respectively:
+
+    rake spec:rails2
+    rake spec:rails3
+
+Or you can run them both:
+
+	 	rake spec

data/dev_tasks/spec.rake

@@ -0,0 +1,22 @@
+desc 'Run spec suite in both Rails 2 and Rails 3'
+task :spec => [:"spec:rails2", :"spec:rails3"]
+
+namespace :spec do
+  desc 'Run spec suite in Rails 2 application'
+  task :rails2 do
+    ENV['BUNDLE_GEMFILE'] = 'spec/rails2/Gemfile'
+    ENV['RAILS_ROOT'] = 'spec/rails2'
+    require 'bundler'
+    Bundler.setup(:default, :test)
+    system "spec --color #{ENV['SPEC'] || 'spec'}"
+  end
+
+  desc 'Run spec suite in Rails 3 application'
+  task :rails3 do
+    ENV['BUNDLE_GEMFILE'] = 'spec/rails3/Gemfile'
+    ENV['RAILS_ROOT'] = 'spec/rails3'
+    require 'bundler'
+    Bundler.setup(:default, :test)
+    system "rspec --color #{ENV['SPEC'] || 'spec'}"
+  end
+end

data/lib/generators/sunspot_rails/install/install_generator.rb

@@ -0,0 +1,13 @@
+module SunspotRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      def copy_config_file
+        template 'config/sunspot.yml'
+      end
+    end
+  end
+end
+

data/lib/generators/sunspot_rails/install/templates/config/sunspot.yml

@@ -0,0 +1,17 @@
+production:
+  solr:
+    hostname: localhost
+    port: 8983
+    log_level: WARNING
+
+development:
+  solr:
+    hostname: localhost
+    port: 8982
+    log_level: INFO
+
+test:
+  solr:
+    hostname: localhost
+    port: 8981
+    log_level: WARNING

data/lib/generators/sunspot_rails.rb

@@ -0,0 +1,9 @@
+module SunspotRails
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      def self.source_root
+        @_sunspot_rails_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'sunspot_rails', generator_name, 'templates'))
+      end
+    end
+  end
+end

data/lib/sunspot/rails/adapters.rb

@@ -48,7 +48,7 @@ module Sunspot #:nodoc:
         # 
         def load(id)
           @clazz.first(options_for_find.merge(
-            :conditions => { @clazz.primary_key => id.to_i}
+            :conditions => { @clazz.primary_key => id}
           ))
         end
 
@@ -65,17 +65,17 @@ module Sunspot #:nodoc:
         #
         def load_all(ids)
           @clazz.all(options_for_find.merge(
-            :conditions => { @clazz.primary_key => ids.map { |id| id.to_i }}
+            :conditions => { @clazz.primary_key => ids.map { |id| id }}
           ))
         end
         
         private
         
         def options_for_find
-          returning({}) do |options|
-            options[:include] = @include unless @include.blank?
-            options[:select]  =  @select unless  @select.blank?
-          end
+          options = {}
+          options[:include] = @include unless @include.blank?
+          options[:select]  =  @select unless  @select.blank?
+          options
         end
       end
     end

data/lib/sunspot/rails/configuration.rb

@@ -48,18 +48,30 @@ module Sunspot #:nodoc:
       # String:: host name
       #
       def hostname
-        @hostname ||= (user_configuration_from_key('solr', 'hostname') || 'localhost')
+        unless defined?(@hostname)
+          @hostname   = solr_url.host if solr_url
+          @hostname ||= user_configuration_from_key('solr', 'hostname')
+          @hostname ||= default_hostname
+        end
+        @hostname
       end
-
+      
       #
-      # The port at which to connect to Solr. Default 8983.
+      # The port at which to connect to Solr.
+      # Defaults to 8981 in test, 8982 in development and 8983 in production.
       #
       # ==== Returns
       #
       # Integer:: port
       #
       def port
-        @port ||= (user_configuration_from_key('solr', 'port') || 8983).to_i
+        unless defined?(@port)
+          @port   = solr_url.port if solr_url
+          @port ||= user_configuration_from_key('solr', 'port')
+          @port ||= default_port
+          @port   = @port.to_i
+        end
+        @port
       end
 
       #
@@ -71,7 +83,12 @@ module Sunspot #:nodoc:
       # String:: path
       #
       def path
-        @path ||= (user_configuration_from_key('solr', 'path') || '/solr')
+        unless defined?(@path)
+          @path   = solr_url.path if solr_url
+          @path ||= user_configuration_from_key('solr', 'path')
+          @path ||= default_path
+        end
+        @path
       end
 
       #
@@ -245,7 +262,7 @@ module Sunspot #:nodoc:
           hash[key] if hash
         end
       end
-
+      
       #
       # Memoized hash of configuration options for the current Rails environment
       # as specified in config/sunspot.yml
@@ -267,6 +284,36 @@ module Sunspot #:nodoc:
             end
           end
       end
+    
+    protected
+    
+      #
+      # When a specific hostname, port and path aren't provided in the
+      # sunspot.yml file, look for a key named 'url', then check the
+      # environment, then fall back to a sensible localhost default.
+      #
+      
+      def solr_url
+        if ENV['SOLR_URL'] || ENV['WEBSOLR_URL']
+          URI.parse(ENV['SOLR_URL'] || ENV['WEBSOLR_URL'])
+        end
+      end
+      
+      def default_hostname
+        'localhost'
+      end
+      
+      def default_port
+        { 'test'        => 8981,
+          'development' => 8982,
+          'production'  => 8983
+        }[::Rails.env]  || 8983
+      end
+      
+      def default_path
+        '/solr'
+      end
+      
     end
   end
 end

data/{rails → lib/sunspot/rails}/init.rb

@@ -1,5 +1,3 @@
-require 'sunspot'
-
 Sunspot.session = Sunspot::Rails.build_session
 Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveRecordInstanceAdapter, ActiveRecord::Base)
 Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveRecordDataAccessor, ActiveRecord::Base)

data/lib/sunspot/rails/railtie.rb

@@ -0,0 +1,26 @@
+module Sunspot
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'sunspot_rails.init' do
+        Sunspot.session = Sunspot::Rails.build_session
+        ActiveSupport.on_load(:active_record) do
+          Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveRecordInstanceAdapter, ActiveRecord::Base)
+          Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveRecordDataAccessor, ActiveRecord::Base)
+          include(Sunspot::Rails::Searchable)
+        end
+        ActiveSupport.on_load(:action_controller) do
+          include(Sunspot::Rails::RequestLifecycle)
+        end
+      end
+
+      rake_tasks do
+        load 'sunspot/rails/tasks.rb'
+      end
+      
+      generators do
+        load "generators/sunspot_rails.rb"
+      end
+
+    end
+  end
+end

data/lib/sunspot/rails/request_lifecycle.rb

@@ -8,8 +8,13 @@ module Sunspot #:nodoc:
     module RequestLifecycle
       class <<self
         def included(base) #:nodoc:
-          loaded_controllers =
-            [base].concat(base.subclasses.map { |subclass| subclass.constantize })
+          subclasses = base.subclasses.map do |subclass|
+            begin
+              subclass.constantize
+            rescue NameError
+            end
+          end.compact
+          loaded_controllers = [base].concat(subclasses)
           # Depending on how Sunspot::Rails is loaded, there may already be
           # controllers loaded into memory that subclass this controller. In
           # this case, since after_filter uses the inheritable_attribute

data/lib/sunspot/rails/searchable.rb

@@ -223,25 +223,23 @@ module Sunspot #:nodoc:
         #   Post.index(:include => :author) 
         #
         def solr_index(opts={})
-          options = { :batch_size => 500, :batch_commit => true, :include => self.sunspot_options[:include], :first_id => 0}.merge(opts)
-          unless options[:batch_size]
-            Sunspot.index!(all(:include => options[:include]))
-          else
-            offset = 0
-            counter = 1
-            record_count = count
-            last_id = options[:first_id]
-            while(offset < record_count)
+          options = {
+            :batch_size => 500,
+            :batch_commit => true,
+            :include => self.sunspot_options[:include],
+            :first_id => 0
+          }.merge(opts)
+
+          if options[:batch_size]
+            find_in_batches(:include => options[:include], :batch_size => options[:batch_size]) do |records|
               solr_benchmark options[:batch_size], counter do
-                records = all(:include => options[:include], :conditions => ["#{table_name}.#{primary_key} > ?", last_id], :limit => options[:batch_size], :order => primary_key)
                 Sunspot.index(records)
-                last_id = records.last.id
               end
               Sunspot.commit if options[:batch_commit]
-              offset += options[:batch_size]
-              counter += 1
             end
             Sunspot.commit unless options[:batch_commit]
+          else
+            Sunspot.index!(all(:include => options[:include]))
           end
         end
 

data/lib/sunspot/rails/server.rb

@@ -66,7 +66,7 @@ module Sunspot
       # Directory to use for Solr home.
       #
       def solr_home
-        File.join(::Rails.root, 'solr')
+        File.join(configuration.solr_home)
       end
 
       #

data/lib/sunspot/rails/solr_logging.rb

@@ -38,7 +38,12 @@ module Sunspot
       private
 
       def format_log_entry(message, dump = nil)
-        if ActiveRecord::Base.colorize_logging
+        @colorize_logging ||= begin
+            ::Rails.application.config.colorize_logging # Rails 3
+          rescue NoMethodError
+            ActiveRecord::Base.colorize_logging # Rails 2
+          end
+        if @colorize_logging
           message_color, dump_color = "4;32;1", "0;1"
           log_entry = "  \e[#{message_color}m#{message}\e[0m   "
           log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump

data/lib/sunspot/rails/spec_helper.rb

@@ -14,6 +14,13 @@ module Sunspot
   end
 end
 
-Spec::Runner.configure do |config|
+rspec =
+  begin
+    RSpec
+  rescue NameError, ArgumentError
+    Spec::Runner
+  end
+
+rspec.configure do |config|
   config.extend(Sunspot::Rails::SpecHelper)
 end

data/lib/sunspot/rails/tasks.rb

@@ -47,7 +47,7 @@ namespace :sunspot do
       reindex_options[:batch_size] = args[:batch_size].to_i if args[:batch_size].to_i > 0
     end
     unless args[:models]
-      all_files = Dir.glob(File.join(RAILS_ROOT, 'app', 'models', '*.rb'))
+      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

data/lib/sunspot/rails/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Rails
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/lib/sunspot_rails.rb

@@ -0,0 +1,7 @@
+require 'sunspot/rails'
+
+if Rails::VERSION::MAJOR == 3
+  require 'sunspot/rails/railtie'
+else
+  require 'sunspot/rails/init'
+end

data/spec/configuration_spec.rb

@@ -1,8 +1,8 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe Sunspot::Rails::Configuration, "default values" do
+describe Sunspot::Rails::Configuration, "default values without a sunspot.yml" do
   before(:each) do
-    File.should_receive(:exist?).at_least(:once).and_return(false)
+    File.stub!(:exist?).and_return(false) # simulate sunspot.yml not existing
     @config = Sunspot::Rails::Configuration.new
   end
   
@@ -14,8 +14,27 @@ describe Sunspot::Rails::Configuration, "default values" do
     @config.path.should == '/solr'
   end
 
-  it "should handle the 'port' property when not set" do
-    @config.port.should == 8983
+  describe "port" do
+    it "should default to port 8981 in test" do
+      ::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')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8982
+    end
+    it "should default to 8983 in production" do
+      ::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')
+      @config = Sunspot::Rails::Configuration.new
+      @config.port.should == 8983
+    end
   end
 
   it "should handle the 'log_level' property when not set" do
@@ -41,10 +60,6 @@ describe Sunspot::Rails::Configuration, "default values" do
     @config.pid_path.should == '/some/path/solr/pids/test'
   end
   
-  it "should handle the 'solr_home' property when not set" do
-    @config.solr_home.should_not == nil
-  end
-
   it "should handle the 'auto_commit_after_request' propery when not set" do
     @config.auto_commit_after_request?.should == true
   end
@@ -54,7 +69,7 @@ describe Sunspot::Rails::Configuration, "default values" do
   end
 end
 
-describe Sunspot::Rails::Configuration, "user settings" do
+describe Sunspot::Rails::Configuration, "user provided sunspot.yml" do
   before(:each) do
     ::Rails.stub!(:env => 'config_test')
     @config = Sunspot::Rails::Configuration.new
@@ -100,3 +115,59 @@ describe Sunspot::Rails::Configuration, "user settings" do
     @config.auto_commit_after_delete_request?.should == true
   end
 end
+
+
+describe Sunspot::Rails::Configuration, "with ENV['SOLR_URL'] overriding sunspot.yml" do
+  before(:all) do
+    ENV['SOLR_URL'] = 'http://environment.host:5432/solr/env'
+  end
+
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  after(:all) do
+    ENV.delete('SOLR_URL')
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'environment.host'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 5432
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/env'
+  end
+end
+
+describe Sunspot::Rails::Configuration, "with ENV['WEBSOLR_URL'] overriding sunspot.yml" do
+  before(:all) do
+    ENV['WEBSOLR_URL'] = 'http://index.websolr.test/solr/a1b2c3d4e5f'
+  end
+
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  after(:all) do
+    ENV.delete('WEBSOLR_URL')
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'index.websolr.test'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 80
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/a1b2c3d4e5f'
+  end
+end
+