kuahyeow-sunspot_rails 0.10.5 → 0.10.6

data/History.txt

@@ -0,0 +1,13 @@
+== 0.11
+* Added Sunspot::Rails::Server class to  start/stop/run/bootstrap the solr server
+* Added log_level key to sunspot.yml, see java docs for valid values (http://java.sun.com/j2se/1.5.0/docs/api/java/util/logging/Level.html)
+* Added log_file key to sunspot.yml. This defaults to RAILS_ROOT/log/solr_<environment>.log.
+
+== 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.
+  Strongly encouraged for production environment.

data/README.rdoc

@@ -8,7 +8,7 @@ provides the following features:
 * Extend ActiveRecord for easy index configuration, search, and indexing
 * Automatically index ActiveRecord objects when they are saved, and remove them
   from the index when they are destroyed (can be disabled)
-* Automatically commit Solr changes at the end of each request
+* Automatically commit Solr changes at the end of each request (can be disabled)
 * Provide utility methods to find and fix orphaned documents and rebuild the
   Solr index for a given class
 * Provide rake tasks for starting and stopping the development Solr instance,
@@ -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
@@ -220,6 +205,35 @@ 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, add the
+following line to your spec_helper.rb
+
+require 'sunspot/spec/extension'
+
+This will disable all automatic after_save/after_destroy solr-requests generated
+via the #searchable method. This will not disable/mock explicit calls in your code.
+
+If you want to test the sunspot-solr integration with active record, you can 
+reenable the after_save/after_destroy hooks by adding 'integrate_sunspot' in your
+examples.
+
+  describe Searches do
+    integrate_sunspot
+    
+    before(:each) do
+      @movie = Factory.create :movie
+    end
+    
+    it "should find a movie" do
+      Movie.search { keywords @movie.title }.first.should == @movie
+    end
+  end
+
+
+
 == Further Reading
 
 Reading the {Sunspot documentation}[http://outoftime.github.com/sunspot/docs] is
@@ -240,6 +254,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/Rakefile

@@ -6,11 +6,14 @@ task :default => :spec
 
 desc 'Run all specs'
 Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+  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_ENV'] ||= 'test'
   require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config', 'environment.rb'))

data/TODO

@@ -0,0 +1,15 @@
+== 0.11
+  * Update sunspot.yml
+    * add log_level support
+    * add solr_home support
+  * add bootstrap method to setup a new solr instance
+  
+== 0.12
+  * add a method to disable sunspot updates for certain values, e.g. 
+    if you just touch a record, sunspot shouldn't index the 
+  
+=======
+* Fix final status output for reindex
+* Add batch-per-request option
+* Optionally yield from reindex
+* Access to all searchable classes

data/VERSION.yml

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

data/dev_tasks/gemspec.rake

@@ -7,18 +7,19 @@ 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/*',
                        'spec/*.rb',
                        'spec/mock_app/{app,lib,db,vendor,config}/**/*',
                        'spec/mock_app/{tmp,log,solr}']
-    s.add_dependency 'rails', '~> 2.1'
     s.add_dependency 'escape', '>= 0.0.4'
-    s.add_dependency 'outoftime-sunspot', '>= 0.8.2'
+    s.add_dependency 'outoftime-sunspot', '>= 0.10.0'
     s.add_development_dependency 'rspec', '~> 1.2'
     s.add_development_dependency 'rspec-rails', '~> 1.2'
     s.add_development_dependency 'ruby-debug', '~> 0.10'

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,18 @@
+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/sunspot/rails.rb

@@ -1,8 +1,14 @@
 require 'sunspot'
+require 'sunspot/rails/configuration'
+require 'sunspot/rails/adapters'
+require 'sunspot/rails/request_lifecycle'
+require 'sunspot/rails/searchable'
 
 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

@@ -13,18 +13,22 @@ module Sunspot #:nodoc:
     #     solr:
     #       hostname: localhost
     #       port: 8983
-    #
+    #       log_level: OFF
     #   production:
     #     solr:
     #       hostname: localhost
     #       port: 8983
     #       path: /solr/myindex
+    #       log_level: WARNING
+    #       solr_home: /some/path
+    #     auto_commit_after_request: true
     #
     # Sunspot::Rails uses the configuration to set up the Solr connection, as
     # well as for starting Solr with the appropriate port using the
     # <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 +37,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 +48,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 +60,154 @@ module Sunspot #:nodoc:
       # String:: path
       #
       def path
-        @path ||=
-          if user_configuration.has_key?('solr')
-            "#{user_configuration['solr']['path'] || '/solr'}"
-          end
+        @path ||= (user_configuration_from_key('solr', 'path') || '/solr')
+      end
+
+      #
+      # The host name at which to connect to the master Solr instance. Defaults
+      # to the 'hostname' configuration option.
+      #
+      # ==== Returns
+      #
+      # String:: host name
+      #
+      def master_hostname
+        @master_hostname ||= (user_configuration_from_key('solr', 'master_hostname') || hostname)
+      end
+
+      #
+      # The port at which to connect to the master Solr instance. Defaults to
+      # the 'port' configuration option.
+      #
+      # ==== Returns
+      #
+      # Integer:: port
+      #
+      def master_port
+        @master_port ||= (user_configuration_from_key('solr', 'master_port') || port).to_i
+      end
+
+      #
+      # The path to the master Solr servlet (useful if you are running multicore).
+      # Defaults to the value of the 'path' configuration option.
+      #
+      # ==== Returns
+      #
+      # String:: path
+      #
+      def master_path
+        @master_path ||= (user_configuration_from_key('solr', 'master_path') || path)
+      end
+
+      #
+      # True if there is a master Solr instance configured, otherwise false.
+      #
+      # ==== Returns
+      #
+      # Boolean:: bool
+      #
+      def master?
+        master_hostname != hostname || master_port != port || master_path != path
+      end
+
+      # 
+      # The default log_level that should be passed to solr. You can
+      # change the individual log_levels in the solr admin interface.
+      # Default 'INFO'.
+      #
+      # ==== Returns
+      #
+      # String:: log_level
+      #
+      def log_level
+        @log_level ||= (user_configuration_from_key('solr', 'log_level') || 'INFO')
+      end
+      
+      #
+      # Should the solr index receive a commit after each http-request.
+      # Default true
+      #
+      def auto_commit_after_request?
+        @auto_commit_after_request ||= 
+          user_configuration_from_key('auto_commit_after_request') != false
+      end
+      
+      #
+      # The log directory for solr logfiles
+      #
+      # ==== Returns
+      # 
+      # String:: log_dir
+      #
+      def log_file
+        @log_file ||= (user_configuration_from_key('solr', 'log_file') || default_log_file_location )
+      end
+
+      def data_path
+        @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)
+      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 solr home directory. Sunspot::Rails expects this directory
+      # to contain a config, data and pids directory. See 
+      # Sunspot::Rails::Server.bootstrap for more information.
+      #
+      # ==== Returns
+      #
+      # String:: solr_home
+      #
+      def solr_home
+        @solr_home ||=
+          if user_configuration_from_key('solr', 'solr_home')
+            user_configuration_from_key('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
+      
       private
+      
+      #
+      # Logging in rails_root/log as solr_<environment>.log as a 
+      # default.
+      #
+      # ===== Returns
+      #
+      # String:: default_log_file_location
+      #
+      def default_log_file_location
+        File.join(::Rails.root, 'log', "solr_" + ::Rails.env + ".log")
+      end
+      
+      # 
+      # return a specific key from the user configuration in config/sunspot.yml
+      #
+      # ==== Returns
+      #
+      # Mixed:: requested_key or nil
+      #
+      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 +225,8 @@ module Sunspot #:nodoc:
               File.open(path) do |file|
                 YAML.load(file)[::Rails.env]
               end
+            else
+              {}
             end
           end
       end