nxa-sunspot_rails 0.11.3

data/lib/sunspot/rails/configuration.rb

@@ -0,0 +1,248 @@
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    #
+    # Sunspot::Rails is configured via the config/sunspot.yml file, which
+    # contains properties keyed by environment name. A sample sunspot.yml file
+    # would look like:
+    #
+    #   development:
+    #     solr:
+    #       hostname: localhost
+    #       port: 8982
+    #   test:
+    #     solr:
+    #       hostname: localhost
+    #       port: 8983
+    #       log_level: OFF
+    #   production:
+    #     solr:
+    #       hostname: localhost
+    #       port: 8983
+    #       path: /solr/myindex
+    #       log_level: WARNING
+    #       solr_home: /some/path
+    #     master_solr:
+    #       hostname: localhost
+    #       port: 8982
+    #       path: /solr
+    #     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.
+    #
+    # If the <code>master_solr</code> configuration is present, Sunspot will use
+    # the Solr instance specified here for all write operations, and the Solr
+    # configured under <code>solr</code> for all read operations.
+    #
+    class Configuration
+      attr_writer :user_configuration
+      #
+      # The host name at which to connect to Solr. Default 'localhost'.
+      #
+      # ==== Returns
+      #
+      # String:: host name
+      #
+      def hostname
+        @hostname ||= (user_configuration_from_key('solr', 'hostname') || 'localhost')
+      end
+
+      #
+      # The port at which to connect to Solr. Default 8983.
+      #
+      # ==== Returns
+      #
+      # Integer:: port
+      #
+      def port
+        @port ||= (user_configuration_from_key('solr', 'port') || 8983).to_i
+      end
+
+      #
+      # The url path to the Solr servlet (useful if you are running multicore).
+      # Default '/solr'.
+      #
+      # ==== Returns
+      #
+      # String:: path
+      #
+      def path
+        @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 has_master?
+        @has_master = !!user_configuration_from_key('master_solr')
+      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
+      #
+      # ==== Returns
+      # 
+      # Boolean: auto_commit_after_request?
+      #
+      def auto_commit_after_request?
+        @auto_commit_after_request ||= 
+          user_configuration_from_key('auto_commit_after_request') != false
+      end
+      
+      #
+      # As for #auto_commit_after_request? but only for deletes
+      # Default false
+      #
+      # ==== Returns
+      # 
+      # Boolean: auto_commit_after_delete_request?
+      #
+      def auto_commit_after_delete_request?
+        @auto_commit_after_delete_request ||= 
+          (user_configuration_from_key('auto_commit_after_delete_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
+      
+      # 
+      # 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')
+          else
+            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
+      # as specified in config/sunspot.yml
+      #
+      # ==== Returns
+      #
+      # Hash:: configuration options for current environment
+      #
+      def user_configuration
+        @user_configuration ||=
+          begin
+            path = File.join(::Rails.root, 'config', 'sunspot.yml')
+            if File.exist?(path)
+              File.open(path) do |file|
+                YAML.load(file)[::Rails.env]
+              end
+            else
+              {}
+            end
+          end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/request_lifecycle.rb

@@ -0,0 +1,22 @@
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    # 
+    # This module adds an after_filter to ActionController::Base that commits
+    # the Sunspot session if any documents have been added, changed, or removed
+    # in the course of the request.
+    #
+    module RequestLifecycle
+      class <<self
+        def included(base) #:nodoc:
+          base.after_filter do
+            if Sunspot::Rails.configuration.auto_commit_after_request?
+              Sunspot.commit_if_dirty
+            elsif Sunspot::Rails.configuration.auto_commit_after_delete_request?
+              Sunspot.commit_if_delete_dirty
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/searchable.rb

@@ -0,0 +1,309 @@
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    # 
+    # This module adds Sunspot functionality to ActiveRecord models. As well as
+    # providing class and instance methods, it optionally adds lifecycle hooks
+    # to automatically add and remove models from the Solr index as they are
+    # created and destroyed.
+    #
+    module Searchable
+      class <<self
+        def included(base) #:nodoc:
+          base.module_eval { extend(ActsAsMethods) }
+        end
+      end
+
+      module ActsAsMethods
+        # 
+        # Makes a class searchable if it is not already, or adds search
+        # configuration if it is. Note that the options passed in are only used
+        # the first time this method is called for a particular class; so,
+        # search should be defined before activating any mixins that extend
+        # search configuration.
+        #
+        # The block passed into this method is evaluated by the
+        # <code>Sunspot.setup</code> method. See the Sunspot documentation for
+        # complete information on the functionality provided by that method.
+        #
+        # ==== Options (+options+)
+        # 
+        # :auto_index<Boolean>::
+        #   Automatically index models in Solr when they are saved.
+        #   Default: true
+        # :auto_remove<Boolean>::
+        #   Automatically remove models from the Solr index when they are
+        #   destroyed. <b>Setting this option to +false+ is not recommended
+        #   </b>(see the README).
+        # :ignore_attribute_changes_of<Array>::
+        #   Define attributes, that should not trigger a reindex of that
+        #   object. Usual suspects are update_at or counters.
+        #
+        # ==== Example
+        #
+        #   class Post < ActiveRecord::Base
+        #     searchable do
+        #       text :title, :body
+        #       string :sort_title do
+        #         title.downcase.sub(/^(an?|the)/, '')
+        #       end
+        #       integer :blog_id
+        #       time :updated_at
+        #     end
+        #   end
+        #
+        def searchable(options = {}, &block)
+          Sunspot.setup(self, &block)
+
+          unless searchable?
+            extend ClassMethods
+            include InstanceMethods
+            
+            Sunspot::Rails::Util.sunspot_options[self.to_s.underscore.to_sym] = options
+            
+            unless options[:auto_index] == false
+              after_save do |searchable|
+                searchable.index if Sunspot::Rails::Util.index_relevant_attribute_changed?( searchable )
+              end
+            end
+
+            unless options[:auto_remove] == false
+              after_destroy do |searchable|
+                searchable.remove_from_index
+              end
+            end
+          end
+        end
+
+        # 
+        # This method is defined on all ActiveRecord::Base subclasses. It
+        # is false for classes on which #searchable has not been called, and
+        # true for classes on which #searchable has been called.
+        #
+        # ==== Returns
+        #
+        # +false+
+        #
+        def searchable?
+          false
+        end
+      end
+
+      module ClassMethods
+        # 
+        # Search for instances of this class in Solr. The block is delegated to
+        # the Sunspot.search method - see the Sunspot documentation for the full
+        # API.
+        #
+        # ==== Example
+        #
+        #   Post.search do
+        #     keywords 'best pizza'
+        #     with :blog_id, 1
+        #     order :updated_at, :desc
+        #     facet :category_ids
+        #   end
+        #
+        #
+        # ==== Returns
+        #
+        # Sunspot::Search:: Object containing results, totals, facets, etc.
+        #
+        def search(&block)
+          Sunspot.search(self, &block)
+        end
+
+        # 
+        # Get IDs of matching results without loading the result objects from
+        # the database. This method may be useful if search is used as an
+        # intermediate step in a larger find operation. The block is the same
+        # as the block provided to the #search method.
+        #
+        # ==== Returns
+        #
+        # Array:: Array of IDs, in the order returned by the search
+        #
+        def search_ids(&block)
+          search(&block).raw_results.map { |raw_result| raw_result.primary_key.to_i }
+        end
+
+        # 
+        # Remove instances of this class from the Solr index.
+        #
+        def remove_all_from_index
+          Sunspot.remove_all(self)
+        end
+
+        # 
+        # Remove all instances of this class from the Solr index and immediately
+        # commit.
+        #
+        #---
+        # XXX Sunspot should implement remove_all!()
+        #
+        def remove_all_from_index!
+          remove_all_from_index
+          Sunspot.commit
+        end
+
+        # 
+        # Completely rebuild the index for this class. First removes all
+        # instances from the index, then loads records and save them. The
+        # +batch_size+ argument specifies how many records to load out of the
+        # database at a time. The default batch size is 500; if nil is passed,
+        # records will not be indexed in batches. By default, a commit is issued
+        # after each batch; passing +false+ for +batch_commit+ will disable
+        # this, and only issue a commit at the end of the process. If associated
+        # objects need to indexed also, you can specify +include+ in format 
+        # accepted by ActiveRecord to improve your sql select performance
+        #
+        # ==== Options (passed as a hash)
+        #
+        # batch_size<Integer>:: Batch size with which to load records. Passing
+        #                       'nil' will skip batches.  Default is 500.
+        # batch_commit<Boolean>:: Flag signalling if a commit should be done after
+        #                         after each batch is indexed, default is 'true'
+        # include<Mixed>:: include option to be passed to the ActiveRecord find,
+        #                  used for including associated objects that need to be
+        #                  indexed with the parent object, accepts all formats
+        #                  ActiveRecord::Base.find does
+        #
+        # ==== Examples
+        #   
+        #   # reindex in batches of 500, commit after each
+        #   Post.reindex 
+        #
+        #   # index all rows at once, then commit
+        #   Post.reindex(:batch_size => nil) 
+        #
+        #   # reindex in batches of 500, commit when all batches complete
+        #   Post.reindex(:batch_commit => false) 
+        #
+        #   # include the associated +author+ object when loading to index
+        #   Post.reindex(:include => :author) 
+        #
+        def reindex(opts={})
+          options = { :batch_size => 500, :batch_commit => true, :include => []}.merge(opts)
+          remove_all_from_index
+          unless options[:batch_size]
+            Sunspot.index!(all(:include => options[:include]))
+          else
+            offset = 0
+            counter = 1
+            record_count = count
+            last_id = 0
+            while(offset < record_count)
+              benchmark options[:batch_size], counter do
+                records = all(:include => options[:include], :conditions => ["#{table_name}.#{primary_key} > ?", last_id], :limit => options[:batch_size], :order => primary_key)
+                Sunspot.index(records)
+                last_id = records.last.id
+              end
+              Sunspot.commit if options[:batch_commit]
+              offset += options[:batch_size]
+              counter += 1
+            end
+            Sunspot.commit unless options[:batch_commit]
+          end
+        end
+
+        # 
+        # Return the IDs of records of this class that are indexed in Solr but
+        # do not exist in the database. Under normal circumstances, this should
+        # never happen, but this method is provided in case something goes
+        # wrong. Usually you will want to rectify the situation by calling
+        # #clean_index_orphans or #reindex
+        # 
+        # ==== Returns
+        #
+        # Array:: Collection of IDs that exist in Solr but not in the database
+        def index_orphans
+          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
+          indexed_ids.to_a
+        end
+
+        # 
+        # Find IDs of records of this class that are indexed in Solr but do not
+        # exist in the database, and remove them from Solr. Under normal
+        # circumstances, this should not be necessary; this method is provided
+        # in case something goes wrong.
+        #
+        def clean_index_orphans
+          index_orphans.each do |id|
+            new do |fake_instance|
+              fake_instance.id = id
+            end.remove_from_index
+          end
+        end
+
+        # 
+        # Classes that have been defined as searchable return +true+ for this
+        # method.
+        #
+        # ==== Returns
+        #
+        # +true+
+        #
+        def searchable?
+          true
+        end
+        
+        protected
+        
+        # 
+        # Does some logging for benchmarking indexing performance
+        #
+        def benchmark(batch_size, counter,  &block)
+          start = Time.now
+          logger.info("[#{Time.now}] Start Indexing")
+          yield
+          elapsed = Time.now-start
+          logger.info("[#{Time.now}] Completed Indexing. Rows indexed #{counter * batch_size}. Rows/sec: #{batch_size/elapsed.to_f} (Elapsed: #{elapsed} sec.)")
+        end
+        
+      end
+
+      module InstanceMethods
+        # 
+        # Index the model in Solr. If the model is already indexed, it will be
+        # updated. Using the defaults, you will usually not need to call this
+        # method, as models are indexed automatically when they are created or
+        # updated. If you have disabled automatic indexing (see
+        # ClassMethods#searchable), this method allows you to manage indexing
+        # manually.
+        #
+        def index
+          Sunspot.index(self)
+        end
+
+        # 
+        # Index the model in Solr and immediately commit. See #index
+        #
+        def index!
+          Sunspot.index!(self)
+        end
+        
+        # 
+        # Remove the model from the Solr index. Using the defaults, this should
+        # not be necessary, as models will automatically be removed from the
+        # index when they are destroyed. If you disable automatic removal
+        # (which is not recommended!), you can use this method to manage removal
+        # manually.
+        #
+        def remove_from_index
+          Sunspot.remove(self)
+        end
+
+        # 
+        # Remove the model from the Solr index and commit immediately. See
+        # #remove_from_index
+        #
+        def remove_from_index!
+          Sunspot.remove!(self)
+        end
+      end
+    end
+  end
+end