sunspot_rails 2.0.0 → 2.1.0

data/History.txt

@@ -1,3 +1,8 @@
+== 2.1.0
+* Dropped Rails 2 support in favour of supporting Rails 4
+* Passing :silence => true while invoking sunspot:reindex task will no longer show the Progress Bar
+* Model names can now also be delimited with spaces when passing them the sunspot:reindex task
+
 == 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`
@@ -67,7 +72,7 @@
 == 0.10.6
 * Added script/generate sunspot support to generate the required sunspot.yml
   file [Brandon Keepers]
-  
+
 == 0.10.5
 * Added a auto_commit_after_request option to sunspot.yml. Sunspot will not
   automatically commit any changes in solr if you set this value to false.

data/README.rdoc

@@ -26,32 +26,6 @@ In your <code>Gemfile</code>:
     gem 'sunspot_solr'
   end
 
-== 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'
-
-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
-
-Generate the file <code>config/sunspot.yml</code>:
-
-  script/generate sunspot
-
-Rails doesn't automatically load rake tasks from plugins installed as gems
-(https://rails.lighthouseapp.com/projects/8994/tickets/59). If you installed
-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

data/dev_tasks/spec.rake

@@ -17,11 +17,13 @@ namespace :spec do
     File.join(File.dirname(__FILE__), "..", "spec", "rails_template")
   end
 
-  task :run_with_rails => [:set_gemfile, :generate_rails_app, :setup_rails_app, :run]
+  def version
+    ENV['VERSION']
+  end
 
-  task :set_gemfile do
-    version = ENV['VERSION']
+  task :run_with_rails => [:set_gemfile, :generate_rails_app, :initialize_database, :setup_rails_app, :run]
 
+  task :set_gemfile do
     ENV['BUNDLE_PATH']    = vendor_path(version)
     ENV['BUNDLE_GEMFILE'] = gemfile_path(version)
 
@@ -32,41 +34,30 @@ namespace :spec do
   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")
-        sh("#{rails_cmd} \"#{app_path}\" --force") || exit(1)
-      elsif version.start_with?("3")
-        sh("#{rails_cmd} new \"#{app_path}\" --force --skip-git --skip-javascript --skip-gemfile --skip-sprockets") || exit(1)
-      end
+      sh("bundle exec rails _#{version}_ new \"#{app_path}\" --force --skip-git --skip-javascript --skip-gemfile --skip-sprockets") || exit(1)
     end
   end
 
-  task :setup_rails_app do
-    version = ENV['VERSION']
-    app_path = rails_app_path(version)
+  task :initialize_database do
+    if ENV['DB'] == 'postgres'
+      sh "psql -c 'DROP DATABASE IF EXISTS sunspot_test;' -d template1"
+      sh "psql -c 'create database sunspot_test;' -d template1"
+    end
+  end
 
-    FileUtils.cp_r File.join(rails_template_path, "."), app_path
+  task :setup_rails_app do
+    FileUtils.cp_r File.join(rails_template_path, "."), rails_app_path(version)
   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
-
-    sh "bundle exec #{spec_command} #{ENV['SPEC'] || 'spec/*_spec.rb'} --color"
+    sh "bundle exec rspec #{ENV['SPEC'] || 'spec/*_spec.rb'} --color"
   end
 end
 

data/gemfiles/{rails-2.3.16 → rails-3.0.0}

@@ -1,13 +1,19 @@
-source :rubygems
+source 'http://rubygems.org'
 
-gem 'rails', '2.3.16'
-gem 'sqlite3', '~> 1.3.7'
+gem 'rails', '~> 3.0.0'
 
 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 'test-unit', '~> 1.2.3', :platform => :mri_19
+  gem 'rspec-rails', '~> 2.14.0'
 end
+
+group :postgres do
+	gem 'pg'
+end
+
+group :sqlite do
+	gem 'sqlite3', '~> 1.3.7'
+end

data/gemfiles/{rails-3.0.20 → rails-3.1.0}

@@ -1,12 +1,19 @@
-source :rubygems
+source 'http://rubygems.org'
 
-gem 'rails', '3.0.20'
-gem 'sqlite3', '~> 1.3.7'
+gem 'rails', '~> 3.1.0'
 
 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'
+  gem 'rspec-rails', '~> 2.14.0'
 end
+
+group :postgres do
+	gem 'pg'
+end
+
+group :sqlite do
+	gem 'sqlite3', '~> 1.3.7'
+end

data/gemfiles/{rails-3.1.10 → rails-3.2.0}

@@ -1,12 +1,19 @@
-source :rubygems
+source 'http://rubygems.org'
 
-gem 'rails', '3.1.10'
-gem 'sqlite3', '~> 1.3.7'
+gem 'rails', '~> 3.2.0'
 
 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'
+  gem 'rspec-rails', '~> 2.14.0'
 end
+
+group :postgres do
+	gem 'pg'
+end
+
+group :sqlite do
+	gem 'sqlite3', '~> 1.3.7'
+end

data/gemfiles/rails-4.0.0

@@ -0,0 +1,20 @@
+source 'http://rubygems.org'
+
+gem 'rails', '~> 4.0.0'
+
+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 'protected_attributes' # Rails 4 support for attr_accessor so specs still work
+  gem 'rspec-rails', '~> 2.14.0'
+end
+
+group :postgres do
+	gem 'pg'
+end
+
+group :sqlite do
+	gem 'sqlite3', '~> 1.3.7'
+end

data/generators/sunspot/templates/sunspot.yml

@@ -3,18 +3,21 @@ production:
     hostname: localhost
     port: 8983
     log_level: WARNING
-    # read_timeout: 2
-    # open_timeout: 0.5
+    path: /solr/production
+    read_timeout: 20
+    open_timeout: 1
 
 development:
   solr:
     hostname: localhost
-    port: 8982
+    port: 8983
     log_level: INFO
+    path: /solr/development
 
 test:
   solr:
     hostname: localhost
-    port: 8981
+    port: 8983
     log_level: WARNING
+    path: /solr/test
     

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

@@ -3,6 +3,7 @@ production:
     hostname: localhost
     port: 8983
     log_level: WARNING
+    path: /solr/production
     # read_timeout: 2
     # open_timeout: 0.5
 
@@ -11,9 +12,12 @@ development:
     hostname: localhost
     port: 8982
     log_level: INFO
+    path: /solr/development
 
 test:
   solr:
     hostname: localhost
     port: 8981
     log_level: WARNING
+    path: /solr/test
+    

data/lib/sunspot/rails/adapters.rb

@@ -53,9 +53,7 @@ module Sunspot #:nodoc:
         # ActiveRecord::Base:: ActiveRecord model
         # 
         def load(id)
-          @clazz.first(options_for_find.merge(
-            :conditions => { @clazz.primary_key => id}
-          ))
+          @clazz.where(@clazz.primary_key => id).merge(scope_for_load).first
         end
 
         # 
@@ -70,18 +68,21 @@ module Sunspot #:nodoc:
         # Array:: Collection of ActiveRecord models
         #
         def load_all(ids)
-          @clazz.all(options_for_find.merge(
-            :conditions => { @clazz.primary_key => ids.map { |id| id }}
-          ))
+          @clazz.where(@clazz.primary_key => ids).merge(scope_for_load)
         end
         
         private
         
-        def options_for_find
-          options = {}
-          options[:include] = @include unless !defined?(@include) || @include.blank?
-          options[:select]  =  @select unless !defined?(@select)  || @select.blank?
-          options
+        def scope_for_load
+          scope = relation
+          scope = scope.includes(@include) if @include.present?
+          scope = scope.select(@select)    if @select.present?
+          scope 
+        end
+
+        # COMPATIBILITY: Rails 4 has deprecated the 'scoped' method in favour of 'all'
+        def relation
+          ::Rails.version >= '4' ? @clazz.all : @clazz.scoped
         end
       end
     end

data/lib/sunspot/rails/configuration.rb

@@ -88,7 +88,7 @@ module Sunspot #:nodoc:
 
       #
       # The url path to the Solr servlet (useful if you are running multicore).
-      # Default '/solr'.
+      # Default '/solr/default'.
       #
       # ==== Returns
       #
@@ -352,7 +352,7 @@ module Sunspot #:nodoc:
       end
       
       def default_path
-        '/solr'
+        '/solr/default'
       end
       
     end

data/lib/sunspot/rails/log_subscriber.rb

@@ -13,15 +13,15 @@ module Sunspot
         rt, self.runtime = runtime, 0
         rt
       end
-      
+
       def self.logger=(logger)
         @logger = logger
       end
-      
+
       def self.logger
         @logger if defined?(@logger)
       end
-      
+
       def logger
         self.class.logger || ::Rails.logger
       end
@@ -32,9 +32,14 @@ module Sunspot
 
         name = '%s (%.1fms)' % ["SOLR Request", event.duration]
 
-        # produces: path=/select parameters={fq: ["type:Tag"], q: rossi, fl: * score, qf: tag_name_text, defType: dismax, start: 0, rows: 20}
-        parameters = event.payload[:parameters].map { |k, v| "#{k}: #{color(v, BOLD, true)}" }.join(', ')
-        request = "path=#{event.payload[:path]} parameters={#{parameters}}"
+        # produces: path=select parameters={fq: ["type:Tag"], q: "rossi", fl: "* score", qf: "tag_name_text", defType: "edismax", start: 0, rows: 20}
+        path = color(event.payload[:path], BOLD, true)
+        parameters = event.payload[:parameters].map { |k, v|
+          v = "\"#{v}\"" if v.is_a? String
+          v = v.to_s.gsub(/\\/,'') # unescape
+          "#{k}: #{color(v, BOLD, true)}"
+        }.join(', ')
+        request = "path=#{path} parameters={#{parameters}}"
 
         debug "  #{color(name, GREEN, true)}  [ #{request} ]"
       end

data/lib/sunspot/rails/railtie.rb

@@ -12,7 +12,7 @@ module Sunspot
           include(Sunspot::Rails::RequestLifecycle)
         end
         require 'sunspot/rails/log_subscriber'
-        RSolr::Connection.module_eval{ include Sunspot::Rails::SolrInstrumentation }
+        RSolr::Client.class_eval{ include Sunspot::Rails::SolrInstrumentation }
       end
 
       # Expose database runtime to controller for logging.

data/lib/sunspot/rails/searchable.rb

@@ -246,29 +246,24 @@ module Sunspot #:nodoc:
             :batch_size => Sunspot.config.indexing.default_batch_size,
             :batch_commit => true,
             :include => self.sunspot_options[:include],
-            :start => opts.delete(:first_id) || 0
+            :start => opts.delete(:first_id)
           }.merge(opts)
-          find_in_batch_options = {
-            :include => options[:include],
-            :batch_size => options[:batch_size],
-            :start => options[:start]
-          }
-          progress_bar = options[:progress_bar]
-          if options[:batch_size]
+
+          if options[:batch_size].to_i > 0
             batch_counter = 0
-            find_in_batches(find_in_batch_options) do |records|
-              solr_benchmark options[:batch_size], batch_counter do
+            self.includes(options[:include]).find_in_batches(options.slice(:batch_size, :start)) do |records|
+              
+              solr_benchmark(options[:batch_size], batch_counter += 1) do
                 Sunspot.index(records.select { |model| model.indexable? })
                 Sunspot.commit if options[:batch_commit]
               end
-              # track progress
-              progress_bar.increment!(records.length) if progress_bar
-              batch_counter += 1
+
+              options[:progress_bar].increment!(records.length) if options[:progress_bar]
             end
           else
-            records = all(:include => options[:include]).select { |model| model.indexable? }
-            Sunspot.index!(records)
+            Sunspot.index! self.includes(options[:include]).select(&:indexable?)
           end
+
           # perform a final commit if not committing in batches
           Sunspot.commit unless options[:batch_commit]
         end

data/lib/sunspot/rails/solr_instrumentation.rb

@@ -4,14 +4,16 @@ module Sunspot
       extend ActiveSupport::Concern
 
       included do
-        alias_method_chain :execute, :as_instrumentation
+        alias_method_chain :send_and_receive, :as_instrumentation
       end
 
 
-      def execute_with_as_instrumentation(path, params={}, *extra)
-        ActiveSupport::Notifications.instrument("request.rsolr",
-                                                {:path => path, :parameters => params}) do
-          execute_without_as_instrumentation(path, params, *extra)
+      def send_and_receive_with_as_instrumentation(path, opts)
+        parameters = (opts[:params] || {})
+        parameters.merge!(opts[:data]) if opts[:data].is_a? Hash
+        payload = {:path => path, :parameters => parameters}
+        ActiveSupport::Notifications.instrument("request.rsolr", payload) do
+          send_and_receive_without_as_instrumentation(path, opts)
         end
       end
     end

data/lib/sunspot/rails/solr_logging.rb

@@ -39,11 +39,8 @@ module Sunspot
       private
 
       def format_log_entry(message, dump = nil)
-        @colorize_logging ||= begin
-          ::Rails.application.config.colorize_logging # Rails 3
-        rescue NoMethodError
-          ActiveRecord::Base.colorize_logging # Rails 2
-        end
+        @colorize_logging ||= ::Rails.application.config.colorize_logging
+          
         if @colorize_logging
           message_color, dump_color = "4;32;1", "0;1"
           log_entry = "  \e[#{message_color}m#{message}\e[0m   "