erichummel-sunspot_rails 1.2.1g → 2.0.0.pre.111215

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,26 @@
+== 2.0.0
+* Finds orphaned objects in batches to avoid excessive memory use (Peer Allan)
+* Default batch size can be specified by setting `Sunspot.config.indexing.default_batch_size`
+  (Peer Allan)
+* Explanation of `progress_bar` is written to stdout instead of stderr (Matt Gornick)
+* Fixes deprecated behavior of using InstanceMethods module with
+  ActiveSupport::Concern (Everton J. Carpes)
+
+== 1.3.0 2011-11-26
+* `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

@@ -1,5 +1,10 @@
 require 'rake'
-require 'rake/rdoctask'
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rake/rdoctask'
+end
 
 if File.exist?(sunspot_lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'sunspot', 'lib')))
   STDERR.puts("Using sunspot lib at #{sunspot_lib}")
@@ -7,12 +12,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/dev_tasks/rdoc.rake

@@ -8,8 +8,8 @@ rescue LoadError
 end
 
 Rake::RDocTask.new(:doc) do |rdoc|
-  rdoc.main = 'README.rdoc'
-  rdoc.rdoc_files.include('README.rdoc', 'lib/sunspot/rails/**/*.rb', 'lib/sunspot/rails.rb')
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/sunspot/rails/**/*.rb', 'lib/sunspot/rails.rb')
   rdoc.rdoc_dir = 'doc'
 end
 

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)..."
+      system("bundle install #{ENV['BUNDLE_ARGS']}") || exit(1)
+    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")
+        system("#{rails_cmd} \"#{app_path}\" --force") || exit(1)
+      elsif version.start_with?("3")
+        system("#{rails_cmd} new \"#{app_path}\" --force --skip-git --skip-javascript --skip-gemfile --skip-sprockets") || exit(1)
+      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,12 @@
+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'
+end

data/gemfiles/rails-3.0.11

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails', '3.0.11'
+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.8.1'
+end

data/gemfiles/rails-3.1.3

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails', '3.1.3'
+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.8.1'
+end

data/gemfiles/rails-3.2.1

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails', '3.2.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.8.1'
+end

data/generators/sunspot/templates/sunspot.yml

@@ -3,6 +3,8 @@ production:
     hostname: localhost
     port: 8983
     log_level: WARNING
+    # read_timeout: 2
+    # open_timeout: 0.5
 
 development:
   solr:
@@ -15,4 +17,4 @@ test:
     hostname: localhost
     port: 8981
     log_level: WARNING
-    
+    

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

@@ -3,6 +3,8 @@ production:
     hostname: localhost
     port: 8983
     log_level: WARNING
+    # read_timeout: 2
+    # open_timeout: 0.5
 
 development:
   solr:
@@ -14,4 +16,4 @@ test:
   solr:
     hostname: localhost
     port: 8981
-    log_level: WARNING
+    log_level: WARNING

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))
@@ -41,6 +48,8 @@ module Sunspot #:nodoc:
           :port => sunspot_rails_configuration.master_port,
           :path => sunspot_rails_configuration.master_path
         ).to_s
+        config.solr.read_timeout = sunspot_rails_configuration.read_timeout
+        config.solr.open_timeout = sunspot_rails_configuration.open_timeout
         config
       end
 
@@ -51,6 +60,8 @@ module Sunspot #:nodoc:
           :port => sunspot_rails_configuration.port,
           :path => sunspot_rails_configuration.path
         ).to_s
+        config.solr.read_timeout = sunspot_rails_configuration.read_timeout
+        config.solr.open_timeout = sunspot_rails_configuration.open_timeout
         config
       end
     end

data/lib/sunspot/rails/configuration.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 module Sunspot #:nodoc:
   module Rails #:nodoc:
     #
@@ -12,11 +14,15 @@ 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
     #       port: 8983
     #       log_level: OFF
+    #       open_timeout: 0.5
+    #       read_timeout: 2
     #   production:
     #     solr:
     #       hostname: localhost
@@ -24,6 +30,8 @@ module Sunspot #:nodoc:
     #       path: /solr/myindex
     #       log_level: WARNING
     #       solr_home: /some/path
+    #       open_timeout: 0.5
+    #       read_timeout: 2
     #     master_solr:
     #       hostname: localhost
     #       port: 8982
@@ -193,9 +201,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,11 +244,34 @@ 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
       
       def multicore
         @multicore ||= !!user_configuration_from_key('solr', 'multicore')
       end
       
+      def read_timeout
+        @read_timeout ||= user_configuration_from_key('solr', 'read_timeout')
+      end
+
+      def open_timeout
+        @open_timeout ||= user_configuration_from_key('solr', 'open_timeout')
+      end
+
+      #
+      # Whether or not to disable Solr.
+      # Defaults to false.
+      #
+      def disabled?
+        @disabled ||= (user_configuration_from_key('disabled') || false)
+      end
+
       private
       
       #
@@ -281,7 +313,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
               {}