substantial-sunspot_rails 2.0.0.pre.111215

data/dev_tasks/todo.rake

@@ -0,0 +1,4 @@
+desc 'Show all TODO and related tags'
+task :todo do
+  FileList['lib/**/*.rb'].egrep(/#.*(TODO|FIXME|XXX)/)
+end

data/gemfiles/rails-2.3.14

@@ -0,0 +1,15 @@
+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'
+  gem 'ruby-debug19', :require => nil,  :platforms => :mri_19
+  gem 'test-unit', '1.2.3',             :platforms => :mri_19
+  gem 'ruby-debug', :require => nil,    :platforms => :mri_18
+end

data/gemfiles/rails-3.0.11

@@ -0,0 +1,15 @@
+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.0.0'
+  gem 'ruby-debug19', :require => nil,  :platforms => :mri_19
+  gem 'test-unit', '1.2.3',             :platforms => :mri_19
+  gem 'ruby-debug', :require => nil,    :platforms => :mri_18
+end

data/gemfiles/rails-3.1.3

@@ -0,0 +1,15 @@
+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.0.0'
+  gem 'ruby-debug19', :require => nil,  :platforms => :mri_19
+  gem 'test-unit', '1.2.3',             :platforms => :mri_19
+  gem 'ruby-debug', :require => nil,    :platforms => :mri_18
+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/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/generators/sunspot_rails.rb

@@ -0,0 +1,9 @@
+module SunspotRails
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      def self.source_root
+        @_sunspot_rails_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'sunspot_rails', generator_name, 'templates'))
+      end
+    end
+  end
+end

data/lib/generators/sunspot_rails/install/install_generator.rb

@@ -0,0 +1,13 @@
+module SunspotRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      def copy_config_file
+        template 'config/sunspot.yml'
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,17 @@
+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/substantial-sunspot_rails.rb

@@ -0,0 +1 @@
+require 'sunspot_rails'

data/lib/sunspot/rails.rb

@@ -0,0 +1,65 @@
+require 'sunspot'
+require File.join(File.dirname(__FILE__), 'rails', 'configuration')
+require File.join(File.dirname(__FILE__), 'rails', 'adapters')
+require File.join(File.dirname(__FILE__), 'rails', 'request_lifecycle')
+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')
+    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
+
+      def configuration
+        @configuration ||= Sunspot::Rails::Configuration.new
+      end
+
+      def reset
+        @configuration = nil
+      end
+
+      def build_session(configuration = self.configuration)
+        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))
+          )
+        else
+          SessionProxy::ThreadLocalSessionProxy.new(slave_config(configuration))
+        end
+      end
+
+      private
+
+      def master_config(sunspot_rails_configuration)
+        config = Sunspot::Configuration.build
+        config.solr.url = URI::HTTP.build(
+          :host => sunspot_rails_configuration.master_hostname,
+          :port => sunspot_rails_configuration.master_port,
+          :path => sunspot_rails_configuration.master_path
+        ).to_s
+        config
+      end
+
+      def slave_config(sunspot_rails_configuration)
+        config = Sunspot::Configuration.build
+        config.solr.url = URI::HTTP.build(
+          :host => sunspot_rails_configuration.hostname,
+          :port => sunspot_rails_configuration.port,
+          :path => sunspot_rails_configuration.path
+        ).to_s
+        config
+      end
+    end
+  end
+end

data/lib/sunspot/rails/adapters.rb

@@ -0,0 +1,83 @@
+module Sunspot #:nodoc:
+  module Rails #:nodoc:
+    # 
+    # This module provides Sunspot Adapter implementations for ActiveRecord
+    # models.
+    #
+    module Adapters
+      class ActiveRecordInstanceAdapter < Sunspot::Adapters::InstanceAdapter
+        # 
+        # Return the primary key for the adapted instance
+        #
+        # ==== Returns
+        # 
+        # Integer:: Database ID of model
+        #
+        def id
+          @instance.id
+        end
+      end
+
+      class ActiveRecordDataAccessor < Sunspot::Adapters::DataAccessor
+        # options for the find
+        attr_accessor :include, :select
+
+        #
+        # Set the fields to select from the database. This will be passed
+        # to ActiveRecord.
+        #
+        # ==== Parameters
+        #
+        # value<Mixed>:: String of comma-separated columns or array of columns
+        #
+        def select=(value)
+          value = value.join(', ') if value.respond_to?(:join)
+          @select = value
+        end
+        
+        # 
+        # Get one ActiveRecord instance out of the database by ID
+        #
+        # ==== Parameters
+        #
+        # id<String>:: Database ID of model to retreive
+        #
+        # ==== Returns
+        #
+        # ActiveRecord::Base:: ActiveRecord model
+        # 
+        def load(id)
+          @clazz.first(options_for_find.merge(
+            :conditions => { @clazz.primary_key => id}
+          ))
+        end
+
+        # 
+        # Get a collection of ActiveRecord instances out of the database by ID
+        #
+        # ==== Parameters
+        #
+        # ids<Array>:: Database IDs of models to retrieve
+        #
+        # ==== Returns
+        #
+        # Array:: Collection of ActiveRecord models
+        #
+        def load_all(ids)
+          @clazz.all(options_for_find.merge(
+            :conditions => { @clazz.primary_key => ids.map { |id| id }}
+          ))
+        end
+        
+        private
+        
+        def options_for_find
+          options = {}
+          options[:include] = @include unless @include.blank?
+          options[:select]  =  @select unless  @select.blank?
+          options
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/configuration.rb

@@ -0,0 +1,340 @@
+require 'erb'
+
+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
+    #       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
+    #   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
+        unless defined?(@hostname)
+          @hostname   = solr_url.host if solr_url
+          @hostname ||= user_configuration_from_key('solr', 'hostname')
+          @hostname ||= default_hostname
+        end
+        @hostname
+      end
+      
+      #
+      # The port at which to connect to Solr.
+      # Defaults to 8981 in test, 8982 in development and 8983 in production.
+      #
+      # ==== Returns
+      #
+      # Integer:: port
+      #
+      def port
+        unless defined?(@port)
+          @port   = solr_url.port if solr_url
+          @port ||= user_configuration_from_key('solr', 'port')
+          @port ||= default_port
+          @port   = @port.to_i
+        end
+        @port
+      end
+
+      #
+      # The url path to the Solr servlet (useful if you are running multicore).
+      # Default '/solr'.
+      #
+      # ==== Returns
+      #
+      # String:: path
+      #
+      def path
+        unless defined?(@path)
+          @path   = solr_url.path if solr_url
+          @path ||= user_configuration_from_key('solr', 'path')
+          @path ||= default_path
+        end
+        @path
+      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('master_solr', '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('master_solr', '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('master_solr', '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_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
+      # 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
+
+      # 
+      # Solr start jar
+      #
+      def solr_jar
+        @solr_jar ||= user_configuration_from_key('solr', 'solr_jar')
+      end
+
+      # 
+      # Minimum java heap size for Solr instance
+      #
+      def min_memory
+        @min_memory ||= user_configuration_from_key('solr', 'min_memory')
+      end
+
+      # 
+      # Maximum java heap size for Solr instance
+      #
+      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
+
+      #
+      # Whether or not to disable Solr.
+      # Defaults to false.
+      #
+      def disabled?
+        @disabled ||= (user_configuration_from_key('disabled') || false)
+      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|
+                processed = ERB.new(file.read).result
+                YAML.load(processed)[::Rails.env]
+              end
+            else
+              {}
+            end
+          end
+      end
+    
+    protected
+    
+      #
+      # When a specific hostname, port and path aren't provided in the
+      # sunspot.yml file, look for a key named 'url', then check the
+      # environment, then fall back to a sensible localhost default.
+      #
+      
+      def solr_url
+        if ENV['SOLR_URL'] || ENV['WEBSOLR_URL']
+          URI.parse(ENV['SOLR_URL'] || ENV['WEBSOLR_URL'])
+        end
+      end
+      
+      def default_hostname
+        'localhost'
+      end
+      
+      def default_port
+        { 'test'        => 8981,
+          'development' => 8982,
+          'production'  => 8983
+        }[::Rails.env]  || 8983
+      end
+      
+      def default_path
+        '/solr'
+      end
+      
+    end
+  end
+end