sunspot_solr 2.0.0.pre.120720 → 2.0.0.pre.120924

data/sunspot_rails/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+if File.exist?(sunspot_lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'sunspot', 'lib')))
+  STDERR.puts("Using sunspot lib at #{sunspot_lib}")
+  $: << sunspot_lib
+end
+
+task :environment do
+end
+
+FileList['dev_tasks/*.rake', 'lib/sunspot/rails/tasks.rb'].each { |file| load(file) }

data/sunspot_rails/TODO

@@ -0,0 +1,8 @@
+* Delegate new_search method
+=======
+* Fix final status output for reindex
+* Add batch-per-request option
+* Optionally yield from reindex
+* Access to all searchable classes
+* Add a method to disable sunspot updates for certain values, e.g. 
+  if you just touch a record, sunspot shouldn't index the 

data/sunspot_rails/dev_tasks/rdoc.rake

@@ -0,0 +1,24 @@
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  if require 'rubygems'
+    retry
+  end
+  # It's OK if hanna isn't installed.
+end
+
+Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/sunspot/rails/**/*.rb', 'lib/sunspot/rails.rb')
+  rdoc.rdoc_dir = 'doc'
+end
+
+namespace :doc do
+  desc 'Generate rdoc and move into pages directory'
+  task :publish => :redoc do
+    doc_dir = File.join(File.dirname(__FILE__), '..', 'doc')
+    publish_dir = File.join(File.dirname(__FILE__), '..', '..', 'pages', 'rails', 'docs')
+    FileUtils.rm_rf(publish_dir) if File.exist?(publish_dir)
+    FileUtils.cp_r(doc_dir, publish_dir)
+  end
+end

data/sunspot_rails/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/sunspot_rails/dev_tasks/spec.rake

@@ -0,0 +1,107 @@
+require 'fileutils'
+
+namespace :spec do
+  def rails_app_path(version)
+    File.join(File.dirname(__FILE__), "..", "tmp", "rails_#{version.gsub(".", "_")}_app")
+  end
+
+  def gemfile_path(version)
+    File.join(File.dirname(__FILE__), "..", "gemfiles", "rails-#{version}")
+  end
+
+  def vendor_path(version)
+    File.expand_path("vendor/bundle", rails_app_path(version))
+  end
+
+  def rails_template_path
+    File.join(File.dirname(__FILE__), "..", "spec", "rails_template")
+  end
+
+  task :run_with_rails => [:set_gemfile, :generate_rails_app, :setup_rails_app, :run]
+
+  task :set_gemfile do
+    version = ENV['VERSION']
+
+    ENV['BUNDLE_PATH']    = vendor_path(version)
+    ENV['BUNDLE_GEMFILE'] = gemfile_path(version)
+
+    unless File.exist?(ENV['BUNDLE_PATH'])
+      puts "Installing gems for Rails #{version} (this will only be done once)..."
+      system("bundle install #{ENV['BUNDLE_ARGS']}") || exit(1)
+    end
+  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")
+        system("#{rails_cmd} \"#{app_path}\" --force") || exit(1)
+      elsif version.start_with?("3")
+        system("#{rails_cmd} new \"#{app_path}\" --force --skip-git --skip-javascript --skip-gemfile --skip-sprockets") || exit(1)
+      end
+    end
+  end
+
+  task :setup_rails_app do
+    version = ENV['VERSION']
+    app_path = rails_app_path(version)
+
+    FileUtils.cp_r File.join(rails_template_path, "."), app_path
+  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
+
+    system "bundle exec #{spec_command} #{ENV['SPEC'] || 'spec/*_spec.rb'} --color"
+  end
+end
+
+def rails_all_versions
+  versions = []
+  Dir.glob(File.join(File.dirname(__FILE__), "..", "gemfiles", "rails-*")).each do |gemfile|
+    if !gemfile.end_with?(".lock") && gemfile =~ /rails-([0-9.]+)/
+      versions << $1
+    end
+  end
+
+  versions
+end
+
+def reenable_spec_tasks
+  Rake::Task.tasks.each do |task|
+    if task.name =~ /spec:/
+      task.reenable
+    end
+  end
+end
+
+desc 'Run spec suite in all Rails versions'
+task :spec do
+  versions = if ENV['RAILS']
+               ENV['RAILS'].split(",")
+             else
+               rails_all_versions
+             end
+
+  versions.each do |version|
+    puts "Running specs against Rails #{version}..."
+
+    ENV['VERSION'] = version
+    reenable_spec_tasks
+    Rake::Task['spec:run_with_rails'].invoke
+  end
+end

data/sunspot_rails/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/sunspot_rails/gemfiles/rails-2.3.14

@@ -0,0 +1,12 @@
+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'
+end

data/sunspot_rails/gemfiles/rails-3.0.15

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails', '3.0.15'
+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.8.1'
+end

data/sunspot_rails/gemfiles/rails-3.1.6

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails', '3.1.6'
+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.8.1'
+end

data/sunspot_rails/gemfiles/rails-3.2.6

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'rails', '3.2.6'
+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.8.1'
+end

data/sunspot_rails/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/sunspot_rails/generators/sunspot/templates/sunspot.yml

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

data/sunspot_rails/install.rb

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

data/sunspot_rails/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/sunspot_rails/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/sunspot_rails/lib/generators/sunspot_rails/install/templates/config/sunspot.yml

@@ -0,0 +1,19 @@
+production:
+  solr:
+    hostname: localhost
+    port: 8983
+    log_level: WARNING
+    # read_timeout: 2
+    # open_timeout: 0.5
+
+development:
+  solr:
+    hostname: localhost
+    port: 8982
+    log_level: INFO
+
+test:
+  solr:
+    hostname: localhost
+    port: 8981
+    log_level: WARNING

data/sunspot_rails/lib/sunspot/rails.rb

@@ -0,0 +1,69 @@
+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.solr.read_timeout = sunspot_rails_configuration.read_timeout
+        config.solr.open_timeout = sunspot_rails_configuration.open_timeout
+        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.solr.read_timeout = sunspot_rails_configuration.read_timeout
+        config.solr.open_timeout = sunspot_rails_configuration.open_timeout
+        config
+      end
+    end
+  end
+end

data/sunspot_rails/lib/sunspot/rails/adapters.rb

@@ -0,0 +1,88 @@
+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
+
+        def initialize(clazz)
+          super(clazz)
+          @inherited_attributes = [:include, :select]
+        end
+
+        #
+        # 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