outoftime-sunspot_rails 0.10.4 → 0.10.5

data/README.rdoc

@@ -18,41 +18,26 @@ Sunspot::Rails has been tested with Rails versions 2.1, 2.2, and 2.3
 
 == Installation
 
-First, install the Sunspot and Sunspot::Rails gems:
+For recent versions of Rails, In your project's <code>config/environment.rb</code>, add the following gem dependencies:
 
-  sudo gem install outoftime-sunspot outoftime-sunspot_rails --source=http://gems.github.com
-
-In your project's <code>config/environment.rb</code>, add the following gem dependencies:
+  config.gem 'outoftime-sunspot', :lib => 'sunspot',
+    :source => 'http://gems.github.com'
+  config.gem 'outoftime-sunspot_rails', :lib => 'sunspot/rails',
+    :source => 'http://gems.github.com'
+    
+Install the gems with:
 
-  config.gem 'outoftime-sunspot', :lib => 'sunspot'
-  config.gem 'outoftime-sunspot_rails', :lib => 'sunspot/rails'
+  rake gems:install
 
-If you are using an older version of Rails that doesn't support plugins-as-gems,
-use:
+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 outoftime-sunspot outoftime-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>:
 
-Create the file <code>config/sunspot.yml</code> and set it up for your environments. Here is a sample:
-
-  common: &common
-    solr:
-      hostname: localhost
-      port: 8983
-
-  production:
-    <<: *common
-    solr:
-      path: /solr/myindex
-
-  development:
-    <<: *common
-    solr:
-      port: 8982
-
-  test:
-    <<: *common
-    solr:
-      port: 8981
+  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
@@ -240,6 +225,8 @@ http://outoftime.lighthouseapp.com/projects/20339-sunspot
 - Peer Allan (peer.allan@gmail.com)
 - Michael Moen (michael@underpantsgnome.com)
 - Benjamin Krause (bk@benjaminkrause.com)
+- Adam Salter (adam@codebright.net)
+- Brandon Keepers (brandon@opensoul.org)
 
 == License
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 10
-:patch: 4
+:patch: 5
 :major: 0

data/dev_tasks/gemspec.rake

@@ -7,9 +7,11 @@ begin
     s.email = 'mat@patch.com'
     s.homepage = 'http://github.com/outoftime/sunspot_rails'
     s.description = 'Rails integration for the Sunspot Solr search library'
-    s.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause']
+    s.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause', 'Adam Salter', 'Brandon Keepers']
+    s.rubyforge_project = 'sunspot'
     s.files = FileList['[A-Z]*',
                        '{lib,tasks,dev_tasks}/**/*',
+                       'generators/**/*',
                        'install.rb',
                        'MIT-LICENSE',
                        'rails/*',

data/dev_tasks/release.rake

@@ -0,0 +1,4 @@
+namespace :release do
+  desc 'Release gem on RubyForge and GitHub'
+  task :all => [:release, :"rubyforge:release:gem"]
+end

data/generators/sunspot/sunspot_generator.rb

@@ -0,0 +1,9 @@
+class SunspotGenerator < Rails::Generator::Base
+  
+  def manifest
+    record do |m|
+      m.template 'sunspot.yml', 'config/sunspot.yml'
+    end
+  end
+  
+end

data/generators/sunspot/templates/sunspot.yml

@@ -0,0 +1,19 @@
+common: &common
+  solr:
+    hostname: localhost
+    port: 8983
+
+production:
+  <<: *common
+  solr:
+    path: /solr/myindex
+
+development:
+  <<: *common
+  solr:
+    port: 8982
+
+test:
+  <<: *common
+  solr:
+    port: 8981

data/lib/sunspot/rails.rb

@@ -3,6 +3,8 @@ require 'sunspot'
 module Sunspot #:nodoc:
   module Rails #:nodoc:
     class <<self
+      attr_writer :configuration
+
       def configuration
         @configuration ||= Sunspot::Rails::Configuration.new
       end

data/lib/sunspot/rails/configuration.rb

@@ -25,6 +25,7 @@ module Sunspot #:nodoc:
     # <code>rake sunspot:solr:start</code> task.
     #
     class Configuration
+      attr_writer :user_configuration
       #
       # The host name at which to connect to Solr. Default 'localhost'.
       #
@@ -33,10 +34,7 @@ module Sunspot #:nodoc:
       # String:: host name
       #
       def hostname
-        @hostname ||=
-          if user_configuration.has_key?('solr')
-            user_configuration['solr']['hostname']
-          end || 'localhost'
+        @hostname ||= (user_configuration_from_key('solr', 'hostname') || 'localhost')
       end
 
       #
@@ -47,14 +45,11 @@ module Sunspot #:nodoc:
       # Integer:: port
       #
       def port
-        @port ||=
-          if user_configuration.has_key?('solr')
-            user_configuration['solr']['port']
-          end || 8983
+        @port ||= (user_configuration_from_key('solr', 'port') || 8983).to_i
       end
 
       #
-      # The path to the Solr servlet (useful if you are running multicore).
+      # The url path to the Solr servlet (useful if you are running multicore).
       # Default '/solr'.
       #
       # ==== Returns
@@ -62,13 +57,91 @@ module Sunspot #:nodoc:
       # String:: path
       #
       def path
-        @path ||=
+        @path ||= (user_configuration_from_key('solr', 'path') || '/solr')
+      end
+      
+      #
+      # Should the solr index receive a commit after each http-request.
+      # Default true
+      #
+      # ==== Returns
+      #
+      # Boolean:: bool
+      #
+      
+      def auto_commit_after_request?
+        @auto_commit_after_request ||= 
+          user_configuration_from_key('auto_commit_after_request') != false
+      end
+
+      #
+      # The path to the Solr indexes. (Used by the rake tasks).
+      # Default RAILS_ROOT + '/solr/data/' + ENVIRONMENT
+      #
+      # ==== Returns
+      #
+      # String:: path
+      #
+      def data_path
+        @data_path ||=
           if user_configuration.has_key?('solr')
-            "#{user_configuration['solr']['path'] || '/solr'}"
+            "#{user_configuration['solr']['data_path'] || File.join(::Rails.root, 'solr', 'data', ::Rails.env)}"
+          end
+      end
+
+      #
+      # The path to the Solr pids
+      # Default RAILS_ROOT + '/solr/pids/' + ENVIRONMENT
+      #
+      # ==== Returns
+      #
+      # String:: path
+      #
+      def pid_path
+        @pids_path ||=
+          if user_configuration.has_key?('solr')
+            "#{user_configuration['solr']['pid_path'] || File.join(::Rails.root, 'solr', 'pids', ::Rails.env)}"
+          end
+      end
+
+      #
+      # The path to the Solr home directory
+      # Default nil (runs the solr with sunspot default settings).
+      #
+      # If you have a custom solr conf directory,
+      # change this to the directory above your solr conf files
+      #
+      # e.g. conf files in RAILS_ROOT/solr/conf
+      #   solr_home: RAILS_ROOT/solr
+      #
+      # ==== Returns
+      #
+      # String:: path
+      #
+      def solr_home
+        @solr_home ||=
+          if user_configuration.has_key?('solr')
+            if user_configuration['solr']['solr_home'].present?
+              user_configuration['solr']['solr_home']
+            elsif %w(solrconfig schema).all? { |file| File.exist?(File.join(::Rails.root, 'solr', 'conf', "#{file}.xml")) }
+              File.join(::Rails.root, 'solr')
+            end
           end
       end
 
       private
+      
+      # 
+      # return a specific key from the user configuration in config/sunspot.yml
+      #
+      # ==== Returns
+      #
+      # 
+      def user_configuration_from_key( *keys )
+        keys.inject(user_configuration) do |hash, key|
+          hash[key] if hash
+        end
+      end
 
       #
       # Memoized hash of configuration options for the current Rails environment
@@ -86,6 +159,8 @@ module Sunspot #:nodoc:
               File.open(path) do |file|
                 YAML.load(file)[::Rails.env]
               end
+            else
+              {}
             end
           end
       end

data/lib/sunspot/rails/request_lifecycle.rb

@@ -9,7 +9,7 @@ module Sunspot #:nodoc:
       class <<self
         def included(base) #:nodoc:
           base.after_filter do
-            Sunspot.commit_if_dirty
+            Sunspot.commit_if_dirty if Sunspot::Rails.configuration.auto_commit_after_request?
           end
         end
       end

data/lib/sunspot/rails/searchable.rb

@@ -208,7 +208,8 @@ module Sunspot #:nodoc:
         #
         # Array:: Collection of IDs that exist in Solr but not in the database
         def index_orphans
-          indexed_ids = search_ids.to_set
+          count = self.count
+          indexed_ids = search_ids { paginate(:page => 1, :per_page => count) }.to_set
           all(:select => 'id').each do |object|
             indexed_ids.delete(object.id)
           end

data/lib/sunspot/rails/tasks.rb

@@ -7,12 +7,9 @@ namespace :sunspot do
       if RUBY_PLATFORM =~ /w(in)?32$/
         abort('This command does not work on Windows. Please use rake sunspot:solr:run to run Solr in the foreground.')
       end
-      data_path = File.join(::Rails.root, 'solr', 'data', ::Rails.env)
-      pid_path = File.join(::Rails.root, 'solr', 'pids', ::Rails.env)
-      solr_home =
-        if %w(solrconfig schema).all? { |file| File.exist?(File.join(::Rails.root, 'solr', 'conf', "#{file}.xml")) }
-          File.join(::Rails.root, 'solr')
-        end
+      data_path = Sunspot::Rails.configuration.data_path
+      pid_path = Sunspot::Rails.configuration.pid_path
+      solr_home = Sunspot::Rails.configuration.solr_home
       [data_path, pid_path].each { |path| FileUtils.mkdir_p(path) }
       port = Sunspot::Rails.configuration.port
       FileUtils.cd(File.join(pid_path)) do
@@ -26,11 +23,8 @@ namespace :sunspot do
 
     desc 'Run the Solr instance in the foreground'
     task :run => :environment do
-      data_path = File.join(::Rails.root, 'solr', 'data', ::Rails.env)
-      solr_home =
-        if %w(solrconfig schema).all? { |file| File.exist?(File.join(::Rails.root, 'solr', 'conf', "#{file}.xml")) }
-          File.join(::Rails.root, 'solr')
-        end
+      data_path = Sunspot::Rails.configuration.data_path
+      solr_home = Sunspot::Rails.configuration.solr_home
       FileUtils.mkdir_p(data_path)
       port = Sunspot::Rails.configuration.port
       command = ['sunspot-solr', 'run', '--', '-p', port.to_s, '-d', data_path]
@@ -45,7 +39,7 @@ namespace :sunspot do
 
     desc 'Stop the Solr instance'
     task :stop => :environment do
-      FileUtils.cd(File.join(::Rails.root, 'solr', 'pids', ::Rails.env)) do
+      FileUtils.cd(Sunspot::Rails.configuration.pid_path) do
         system(Escape.shell_command(['sunspot-solr', 'stop']))
       end
     end

data/spec/configuration_spec.rb

@@ -1,16 +1,53 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
-describe "Configuration" do
+describe Sunspot::Rails::Configuration, "default values" do
+  before(:each) do
+    File.should_receive(:exist?).and_return(false)
+  end
+  
+  it "should handle the 'hostname' property when not set" do
+    config = Sunspot::Rails::Configuration.new
+    config.hostname.should == 'localhost'
+  end  
+  
   it "should handle the 'path' property when not set" do
     config = Sunspot::Rails::Configuration.new
     config.path.should == '/solr'
   end
 
+  it "should handle the 'port' property when not set" do
+    config = Sunspot::Rails::Configuration.new
+    config.port.should == 8983
+  end
+
+  it "should handle the 'auto_commit_after_request' propery when not set" do
+    config = Sunspot::Rails::Configuration.new
+    config.auto_commit_after_request?.should == true
+  end
+end
+
+describe Sunspot::Rails::Configuration, "user settings" do
+  before(:each) do
+    Rails.stub!(:env => 'config_test')
+  end
+
+  it "should handle the 'hostname' property when not set" do
+    config = Sunspot::Rails::Configuration.new
+    config.hostname.should == 'some.host'
+  end
+
+  it "should handle the 'port' property when not set" do
+    config = Sunspot::Rails::Configuration.new
+    config.port.should == 1234
+  end
+  
   it "should handle the 'path' property when set" do
-    silence_stderr do
-      Rails.stub!(:env => 'path_test')
-      config = Sunspot::Rails::Configuration.new
-      config.path.should == '/solr/path_test'
-    end
+    config = Sunspot::Rails::Configuration.new
+    config.path.should == '/solr/idx'
+  end
+
+  it "should handle the 'auto_commit_after_request' propery when set" do
+    config = Sunspot::Rails::Configuration.new
+    config.auto_commit_after_request?.should == false
   end
 end

data/spec/mock_app/config/sunspot.yml

@@ -6,8 +6,9 @@ development:
   solr:
     hostname: localhost
     port: 8981
-path_test:
+config_test:
   solr:
-    hostname: localhost
-    port: 8981
-    path: /solr/path_test
+    hostname: some.host
+    port: 1234
+    path: /solr/idx
+  auto_commit_after_request: false

data/spec/request_lifecycle_spec.rb

@@ -1,10 +1,30 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe 'request lifecycle', :type => :controller do
+  before(:each) do
+    Sunspot::Rails.configuration = @configuration = Sunspot::Rails::Configuration.new
+  end
+
+  after(:each) do
+    Sunspot::Rails.configuration = nil
+  end
   controller_name :posts
 
-  it 'should automatically commit after each action' do
+  it 'should automatically commit after each action if specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => true }
+    Sunspot.should_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  it 'should not commit, if configuration is set to false' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false }
+    Sunspot.should_not_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+
+  it 'should commit if configuration is not specified' do
+    @configuration.user_configuration = {}
+    Sunspot.should_receive(:commit_if_dirty)
     post :create, :post => { :title => 'Test 1' }
-    PostWithAuto.search { with :title, 'Test 1' }.results.should_not be_empty
   end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,9 @@ require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'
 
 require 'spec'
 require 'spec/rails'
-require 'ruby-debug'
+require 'rake'
+require 'ruby-debug' unless RUBY_VERSION =~ /1\.9/
+require 'sunspot/rails/tasks'
 
 def load_schema
   stdout = $stdout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: outoftime-sunspot_rails
 version: !ruby/object:Gem::Version 
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors: 
 - Mat Brown
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 -07:00
+date: 2009-09-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,7 +102,10 @@ files:
 - VERSION.yml
 - dev_tasks/gemspec.rake
 - dev_tasks/rdoc.rake
+- dev_tasks/release.rake
 - dev_tasks/todo.rake
+- generators/sunspot/sunspot_generator.rb
+- generators/sunspot/templates/sunspot.yml
 - install.rb
 - lib/sunspot/rails.rb
 - lib/sunspot/rails/adapters.rb
@@ -132,7 +135,7 @@ files:
 - spec/request_lifecycle_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/outoftime/sunspot_rails
 post_install_message: 
 rdoc_options: 
@@ -153,28 +156,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: sunspot
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Rails integration for the Sunspot Solr search library
 test_files: 
-- spec/spec_helper.rb
 - spec/configuration_spec.rb
-- spec/model_lifecycle_spec.rb
-- spec/schema.rb
-- spec/model_spec.rb
-- spec/mock_app/app/controllers/posts_controller.rb
-- spec/mock_app/app/controllers/application_controller.rb
 - spec/mock_app/app/controllers/application.rb
+- spec/mock_app/app/controllers/application_controller.rb
+- spec/mock_app/app/controllers/posts_controller.rb
 - spec/mock_app/app/models/blog.rb
-- spec/mock_app/app/models/post_with_auto.rb
 - spec/mock_app/app/models/post.rb
+- spec/mock_app/app/models/post_with_auto.rb
+- spec/mock_app/config/boot.rb
 - spec/mock_app/config/environment.rb
-- spec/mock_app/config/initializers/session_store.rb
-- spec/mock_app/config/initializers/new_rails_defaults.rb
 - spec/mock_app/config/environments/development.rb
 - spec/mock_app/config/environments/test.rb
+- spec/mock_app/config/initializers/new_rails_defaults.rb
+- spec/mock_app/config/initializers/session_store.rb
 - spec/mock_app/config/routes.rb
-- spec/mock_app/config/boot.rb
+- spec/model_lifecycle_spec.rb
+- spec/model_spec.rb
 - spec/request_lifecycle_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb