sunspot_rails 1.2.1 → 1.3.0.rc6

data/.gitignore

@@ -0,0 +1,7 @@
+sunspot-solr.pid
+doc
+pkg/*
+log
+.bundle
+tmp/*
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/History.txt

@@ -1,3 +1,18 @@
+== 1.3.0
+* `Model.index` correctly uses `:first_id` option (Hamza Khan-Cheema)
+* Solr request performance is instrumented in Rails (Paco Guzmán)
+* Reindexing tasks display a progress bar if `progress_bar` gem is available (Paul Carey)
+* Deprecated Rails syntax is removed from `Sunspot::Rails::Searchable` (Steve Schwartz)
+* Deprecated syntax is removed from rake tasks (Huned Botee)
+* `sunspot:reindex` rake task correctly handles namespaced models (João Gradim)
+* `bind_address` parameter can be specified in `sunspot.yml` to bind Solr to a
+  specific interface (Sylvain Utard)
+* `disabled` parameter can be specified in `sunspot.yml` to stub out the
+  connection to Solr (David B)
+
+== 1.2.1 2010-12-28
+* Decreased default reindexing batch size from 500 to 50
+
 == 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

data/README.rdoc

@@ -21,6 +21,10 @@ Sunspot::Rails has been tested with Rails versions 2.3 and 3.0
 In your <code>Gemfile</code>:
 
   gem 'sunspot_rails'
+  # This is an optional packaged Solr:
+  group :test, :development do
+    gem 'sunspot_solr'
+  end
 
 == Installation in Rails 2
 
@@ -28,7 +32,12 @@ In your project's <code>config/environment.rb</code>, add the following gem depe
 
   config.gem 'sunspot'
   config.gem 'sunspot_rails'
-    
+
+And in your project's <code>config/development.rb</code> and <code>config/test.rb</code>,
+add the following gem dependency to install the optional packaged Solr:
+
+  config.gem 'sunspot_solr'
+
 Install the gems with:
 
   rake gems:install
@@ -53,7 +62,8 @@ Sunspot::Rails will detect them and tell Solr to use your local configurations.
 Use caution when modifying <code>schema.xml</code> - Sunspot relies on the
 field naming scheme in the packaged schema file.
 
-To start up a Solr instance, issue the following:
+To start up a Solr instance, issue the following (requires sunspot_solr to be
+installed):
 
   rake sunspot:solr:start
 
@@ -148,7 +158,6 @@ without actually loading the models out of the database. For that, you can
 call +search_ids+, using the same block format as #search. This will return an
 array of IDs.
 
-
 === Searching for multiple types
 
 Sunspot is entirely agnostic about whether searches are for one or more types;
@@ -205,7 +214,6 @@ remove those documents from the index, use +clean_index_orphans+. Note that
 neither of these operations should be needed if Sunspot and Sunspot::Rails are
 used as intended.
 
-
 == Testing Solr integration using RSpec
 
 To disable the sunspot-solr integration for your active record models, require
@@ -217,7 +225,7 @@ Then, in your spec, use the #disconnect_sunspot method:
 
   describe Post do
     disconnect_sunspot
-    
+
     it 'should have some behavior'
       # ...
     end
@@ -238,8 +246,7 @@ Posts about Sunspot on my blog are available at http://outofti.me/tagged/sunspot
 
 == Bugs
 
-Please submit bug reports to
-http://outoftime.lighthouseapp.com/projects/20339-sunspot
+Please submit bug reports to https://github.com/sunspot/sunspot/issues
 
 == Contributors
 

data/Rakefile

@@ -7,12 +7,6 @@ if File.exist?(sunspot_lib = File.expand_path(File.join(File.dirname(__FILE__),
 end
 
 task :environment do
-  if ENV['SUNSPOT_LIB']
-    $: << ENV['SUNSPOT_LIB']
-  end
-  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
 
 FileList['dev_tasks/*.rake', 'lib/sunspot/rails/tasks.rb'].each { |file| load(file) }

data/TESTING.md

@@ -1,35 +1,49 @@
 # Testing `sunspot_rails`
 
-Note: All the paths mentioned in here are relative to the current directory, or `sunspot/sunspot_rails`.
+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`.
+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.
+The specs are run against Rails 2 and Rails 3 applications which are
+dynamically generated in `tmp/`
+
+**NOTE:** Because the applications are dynamically generated, the specs
+must be run with the rake task (described below) and not simply with
+`rspec spec`.
 
 ## Start Solr
 
 Specs expect to connect to Solr on `http://localhost:8980/solr`
 
-    rake sunspot:solr:start
+    sunspot-solr start -p 8980
+
+## Invoke specs
 
-## Install dependencies
+To run the specs against every Rails version defined in
+`gemfiles/rails-*`:
 
-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.
+    rake spec
 
-    pushd spec/rails2
-    bundle install
-    cd ../rails3
-    bundle install
-		popd
+### Focused on specific versions
 
-## Invoke specs
+To run the specs against a specific version or versions of Rails:
+
+    rake spec VERSIONS=2.3.14
+    rake spec VERSIONS=2.3.14,3.0.10
+
+To make a Rails the default for your shell session, export the
+environment variable:
+
+    export VERSIONS=2.3.14
 
-The project contains wrapper scripts that set up the environment to run the
-specs under Rails 2 and Rails 3 respectively:
+Though be sure to run the tests against all versions before submitting
+code!
 
-    rake spec:rails2
-    rake spec:rails3
+### Focused on specific specs
 
-Or you can run them both:
+To run a specific spec or spec file:
 
-	 	rake spec
+    rake spec SPEC=spec/model_spec.rb
+    rake spec SPEC=spec/model_spec.rb:4 # run spec(s) that start on line 4

data/dev_tasks/spec.rake

@@ -1,22 +1,107 @@
-desc 'Run spec suite in both Rails 2 and Rails 3'
-task :spec => [:"spec:rails2", :"spec:rails3"]
+require 'fileutils'
 
 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'}"
+  def rails_app_path(version)
+    File.join(File.dirname(__FILE__), "..", "tmp", "rails_#{version.gsub(".", "_")}_app")
+  end
+
+  def gemfile_path(version)
+    File.join(File.dirname(__FILE__), "..", "gemfiles", "rails-#{version}")
+  end
+
+  def vendor_path(version)
+    File.expand_path("vendor/bundle", rails_app_path(version))
+  end
+
+  def rails_template_path
+    File.join(File.dirname(__FILE__), "..", "spec", "rails_template")
+  end
+
+  task :run_with_rails => [:set_gemfile, :generate_rails_app, :setup_rails_app, :run]
+
+  task :set_gemfile do
+    version = ENV['VERSION']
+
+    ENV['BUNDLE_PATH']    = vendor_path(version)
+    ENV['BUNDLE_GEMFILE'] = gemfile_path(version)
+
+    unless File.exist?(ENV['BUNDLE_PATH'])
+      puts "Installing gems for Rails #{version} (this will only be done once)..."
+      `bundle install #{ENV['BUNDLE_ARGS']}`
+    end
+  end
+
+  task :generate_rails_app do
+    version = ENV['VERSION']
+    app_path = rails_app_path(version)
+
+    unless File.exist?(File.expand_path("config/environment.rb", app_path))
+      rails_cmd = "bundle exec rails _#{version}_"
+
+      puts "Generating Rails #{version} application..."
+      if version.start_with?("2")
+        `#{rails_cmd} \"#{app_path}\" --force`
+      elsif version.start_with?("3")
+        `#{rails_cmd} new \"#{app_path}\" --force --skip-git --skip-javascript --skip-gemfile --skip-sprockets`
+      end
+    end
+  end
+
+  task :setup_rails_app do
+    version = ENV['VERSION']
+    app_path = rails_app_path(version)
+
+    FileUtils.cp_r File.join(rails_template_path, "."), app_path
+  end
+
+  task :run do
+    version = ENV['VERSION']
+
+    ENV['BUNDLE_GEMFILE'] = gemfile_path(version)
+    ENV['RAILS_ROOT']     = rails_app_path(version)
+
+    spec_command = if version.start_with?("2")
+                     "spec"
+                   elsif version.start_with?("3")
+                     "rspec"
+                   end
+
+    system "bundle exec #{spec_command} #{ENV['SPEC'] || 'spec/*_spec.rb'} --color"
+  end
+end
+
+def rails_all_versions
+  versions = []
+  Dir.glob(File.join(File.dirname(__FILE__), "..", "gemfiles", "rails-*")).each do |gemfile|
+    if !gemfile.end_with?(".lock") && gemfile =~ /rails-([0-9.]+)/
+      versions << $1
+    end
+  end
+
+  versions
+end
+
+def reenable_spec_tasks
+  Rake::Task.tasks.each do |task|
+    if task.name =~ /spec:/
+      task.reenable
+    end
+  end
+end
+
+desc 'Run spec suite in all Rails versions'
+task :spec do
+  versions = if ENV['RAILS']
+               ENV['RAILS'].split(",")
+             else
+               rails_all_versions
+             end
+
+  versions.each do |version|
+    puts "Running specs against Rails #{version}..."
+
+    ENV['VERSION'] = version
+    reenable_spec_tasks
+    Rake::Task['spec:run_with_rails'].invoke
   end
 end

data/gemfiles/rails-2.3.14

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem 'rails', '2.3.14'
+gem 'sqlite3-ruby', '~> 1.3.1'
+
+gem 'sunspot', :path => File.expand_path('../../../sunspot', __FILE__)
+gem 'sunspot_solr', :path => File.expand_path('../../../sunspot_solr', __FILE__)
+gem 'sunspot_rails', :path => File.expand_path('../..', __FILE__)
+
+group :test do
+	gem 'rspec-rails', '~> 1.3.4'
+  gem 'ruby-debug19', :require => nil,  :platforms => :mri_19
+  gem 'test-unit', '1.2.3',             :platforms => :mri_19
+  gem 'ruby-debug', :require => nil,    :platforms => :mri_18
+end

data/gemfiles/rails-3.0.10

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem 'rails', '3.0.10'
+gem 'sqlite3-ruby', '~> 1.3.1'
+
+gem 'sunspot', :path => File.expand_path('../../../sunspot', __FILE__)
+gem 'sunspot_solr', :path => File.expand_path('../../../sunspot_solr', __FILE__)
+gem 'sunspot_rails', :path => File.expand_path('../..', __FILE__)
+
+group :test do
+  gem 'rspec-rails', '~> 2.0.0'
+  gem 'ruby-debug19', :require => nil,  :platforms => :mri_19
+  gem 'test-unit', '1.2.3',             :platforms => :mri_19
+  gem 'ruby-debug', :require => nil,    :platforms => :mri_18
+end

data/gemfiles/rails-3.1.1

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem 'rails', '3.1.1'
+gem 'sqlite3-ruby', '~> 1.3.1'
+
+gem 'sunspot', :path => File.expand_path('../../../sunspot', __FILE__)
+gem 'sunspot_solr', :path => File.expand_path('../../../sunspot_solr', __FILE__)
+gem 'sunspot_rails', :path => File.expand_path('../..', __FILE__)
+
+group :test do
+  gem 'rspec-rails', '~> 2.0.0'
+  gem 'ruby-debug19', :require => nil,  :platforms => :mri_19
+  gem 'test-unit', '1.2.3',             :platforms => :mri_19
+  gem 'ruby-debug', :require => nil,    :platforms => :mri_18
+end

data/lib/sunspot/rails.rb

@@ -6,9 +6,14 @@ require File.join(File.dirname(__FILE__), 'rails', 'searchable')
 
 module Sunspot #:nodoc:
   module Rails #:nodoc:
+    autoload :SolrInstrumentation, File.join(File.dirname(__FILE__), 'rails', 'solr_instrumentation')
     autoload :StubSessionProxy, File.join(File.dirname(__FILE__), 'rails', 'stub_session_proxy')
-    autoload :Server, File.join(File.dirname(__FILE__), 'rails', 'server')
-    autoload :VERSION, File.join(File.dirname(__FILE__), 'rails', 'version')
+    begin
+      require 'sunspot_solr'
+      autoload :Server, File.join(File.dirname(__FILE__), 'rails', 'server')
+    rescue LoadError => e
+      # We're fine
+    end
 
     class <<self
       attr_writer :configuration
@@ -22,7 +27,9 @@ module Sunspot #:nodoc:
       end
 
       def build_session(configuration = self.configuration)
-        if configuration.has_master?
+        if configuration.disabled?
+          StubSessionProxy.new(Sunspot.session)
+        elsif configuration.has_master?
           SessionProxy::MasterSlaveSessionProxy.new(
             SessionProxy::ThreadLocalSessionProxy.new(master_config(configuration)),
             SessionProxy::ThreadLocalSessionProxy.new(slave_config(configuration))
@@ -47,9 +54,9 @@ module Sunspot #:nodoc:
       def slave_config(sunspot_rails_configuration)
         config = Sunspot::Configuration.build
         config.solr.url = URI::HTTP.build(
-          :host => configuration.hostname,
-          :port => configuration.port,
-          :path => configuration.path
+          :host => sunspot_rails_configuration.hostname,
+          :port => sunspot_rails_configuration.port,
+          :path => sunspot_rails_configuration.path
         ).to_s
         config
       end

data/lib/sunspot/rails/configuration.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module Sunspot #:nodoc:
   module Rails #:nodoc:
     #
@@ -12,6 +14,8 @@ module Sunspot #:nodoc:
     #       min_memory: 512M
     #       max_memory: 1G
     #       solr_jar: /some/path/solr15/start.jar
+    #       bind_address: 0.0.0.0
+    #     disabled: false
     #   test:
     #     solr:
     #       hostname: localhost
@@ -193,9 +197,10 @@ module Sunspot #:nodoc:
         @data_path ||= user_configuration_from_key('solr', 'data_path') || File.join(::Rails.root, 'solr', 'data', ::Rails.env)
       end
       
-      def pid_path
-        @pids_path ||= user_configuration_from_key('solr', 'pid_path') || File.join(::Rails.root, 'solr', 'pids', ::Rails.env)
+      def pid_dir
+        @pid_dir ||= user_configuration_from_key('solr', 'pid_dir') || File.join(::Rails.root, 'solr', 'pids', ::Rails.env)
       end
+
       
       # 
       # The solr home directory. Sunspot::Rails expects this directory
@@ -235,7 +240,22 @@ module Sunspot #:nodoc:
       def max_memory
         @max_memory ||= user_configuration_from_key('solr', 'max_memory')
       end
-      
+
+      #
+      # Interface on which to run Solr
+      #
+      def bind_address
+        @bind_address ||= user_configuration_from_key('solr', 'bind_address')
+      end
+
+      #
+      # Whether or not to disable Solr.
+      # Defaults to false.
+      #
+      def disabled?
+        @disabled ||= (user_configuration_from_key('disabled') || false)
+      end
+
       private
       
       #
@@ -277,7 +297,8 @@ module Sunspot #:nodoc:
             path = File.join(::Rails.root, 'config', 'sunspot.yml')
             if File.exist?(path)
               File.open(path) do |file|
-                YAML.load(file)[::Rails.env]
+                processed = ERB.new(file.read).result
+                YAML.load(processed)[::Rails.env]
               end
             else
               {}