nuatt_sunspot_rails 1.1.0.3

data/lib/sunspot/rails/solr_logging.rb

@@ -0,0 +1,58 @@
+module Sunspot
+  module Rails
+    module SolrLogging
+      class <<self
+        def included(base)
+          base.module_eval { alias_method_chain(:request, :rails_logging) }
+        end
+      end
+
+      def request_with_rails_logging(path, params={}, *extra)
+
+        # Set up logging text.
+        body = (params.nil? || params.empty?) ? extra.first : params.inspect
+        action = path[1..-1].capitalize
+        if body == "<commit/>"
+          action = 'Commit'
+          body = ''
+        end
+        body = body[0, 800] + '...' if body.length > 800
+
+        # Make request and log.
+        response = nil
+        begin
+          ms = Benchmark.ms do
+            response = request_without_rails_logging(path, params, *extra)
+          end
+          log_name = 'Solr %s (%.1fms)' % [action, ms]
+          ::Rails.logger.debug(format_log_entry(log_name, body))
+        rescue Exception => e
+          log_name = 'Solr %s (Error)' % [action]
+          ::Rails.logger.error(format_log_entry(log_name, body))
+          raise e
+        end
+
+        response
+      end
+
+      private
+
+      def format_log_entry(message, dump = nil)
+        if ActiveRecord::Base.colorize_logging
+          message_color, dump_color = "4;32;1", "0;1"
+          log_entry = "  \e[#{message_color}m#{message}\e[0m   "
+          log_entry << "\e[#{dump_color}m%#{String === dump ? 's' : 'p'}\e[0m" % dump if dump
+          log_entry
+        else
+          "%s  %s" % [message, dump]
+        end
+      end
+    end
+  end
+end
+
+begin
+  RSolr::Client.module_eval { include(Sunspot::Rails::SolrLogging) }
+rescue NameError # RSolr 0.9.6
+  RSolr::Connection::Base.module_eval { include(Sunspot::Rails::SolrLogging) }
+end

data/lib/sunspot/rails/spec_helper.rb

@@ -0,0 +1,19 @@
+module Sunspot
+  module Rails
+    module SpecHelper
+      def disconnect_sunspot
+        before(:each) do
+          Sunspot.session = StubSessionProxy.new(Sunspot.session)
+        end
+
+        after(:each) do
+          Sunspot.session = Sunspot.session.original_session
+        end
+      end
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.extend(Sunspot::Rails::SpecHelper)
+end

data/lib/sunspot/rails/stub_session_proxy.rb

@@ -0,0 +1,88 @@
+module Sunspot
+  module Rails
+    class StubSessionProxy
+      attr_reader :original_session
+
+      def initialize(original_session)
+        @original_session = original_session
+      end
+
+      def index(*objects)
+      end
+
+      def index!(*objects)
+      end
+
+      def remove(*objects)
+      end
+
+      def remove!(*objects)
+      end
+
+      def remove_by_id(clazz, id)
+      end
+
+      def remove_by_id!(clazz, id)
+      end
+
+      def remove_all(clazz = nil)
+      end
+
+      def remove_all!(clazz = nil)
+      end
+
+      def dirty?
+        false
+      end
+
+      def delete_dirty?
+        false
+      end
+
+      def commit_if_dirty
+      end
+
+      def commit_if_delete_dirty
+      end
+
+      def commit
+      end
+
+      def search(*types)
+        Search.new
+      end
+
+      def new_search(*types)
+        Search.new
+      end
+
+      class Search
+        def build
+          self
+        end
+
+        def results
+          []
+        end
+
+        def hits(options = {})
+          []
+        end
+
+        def total
+          0
+        end
+
+        def facet(name)
+        end
+
+        def dynamic_facet(name)
+        end
+
+        def execute
+          self
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/rails/tasks.rb

@@ -0,0 +1,61 @@
+namespace :sunspot do
+  namespace :solr do
+    desc 'Start the Solr instance'
+    task :start => :environment 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
+      Sunspot::Rails::Server.new.start
+    end
+
+    desc 'Run the Solr instance in the foreground'
+    task :run => :environment do
+      Sunspot::Rails::Server.new.run
+    end
+
+    desc 'Stop the Solr instance'
+    task :stop => :environment do
+      if RUBY_PLATFORM =~ /w(in)?32$/
+        abort('This command does not work on Windows.')
+      end
+      Sunspot::Rails::Server.new.stop
+    end
+
+    task :reindex => :"sunspot:reindex"
+  end
+
+  desc "Reindex all solr models that are located in your application's models directory."
+  # This task depends on the standard Rails file naming \
+  # conventions, in that the file name matches the defined class name. \
+  # By default the indexing system works in batches of 500 records, you can \
+  # set your own value for this by using the batch_size argument. You can \
+  # also optionally define a list of models to separated by a forward slash '/'
+  # 
+  # $ rake sunspot:reindex                # reindex all models
+  # $ rake sunspot:reindex[1000]          # reindex in batches of 1000
+  # $ rake sunspot:reindex[false]         # reindex without batching
+  # $ rake sunspot:reindex[,Post]         # reindex only the Post model
+  # $ rake sunspot:reindex[1000,Post]     # reindex only the Post model in
+  #                                       # batchs of 1000
+  # $ rake sunspot:reindex[,Post+Author]  # reindex Post and Author model
+  task :reindex, :batch_size, :models, :needs => :environment do |t, args|
+    reindex_options = {:batch_commit => false}
+    case args[:batch_size]
+    when 'false'
+      reindex_options[:batch_size] = nil
+    when /^\d+$/ 
+      reindex_options[:batch_size] = args[:batch_size].to_i if args[:batch_size].to_i > 0
+    end
+    unless args[:models]
+      all_files = Dir.glob(File.join(RAILS_ROOT, 'app', 'models', '*.rb'))
+      all_models = all_files.map { |path| File.basename(path, '.rb').camelize.constantize }
+      sunspot_models = all_models.select { |m| m < ActiveRecord::Base and m.searchable? }
+    else
+      sunspot_models = args[:models].split('+').map{|m| m.constantize}
+    end
+    sunspot_models.each do |model|
+      model.solr_reindex reindex_options
+    end
+  end
+  
+end

data/lib/sunspot/rails/version.rb

@@ -0,0 +1,5 @@
+module Sunspot
+  module Rails
+    VERSION = '1.1.0.3'
+  end
+end

data/rails/init.rb

@@ -0,0 +1,7 @@
+require 'sunspot'
+
+Sunspot.session = Sunspot::Rails.build_session
+Sunspot::Adapters::InstanceAdapter.register(Sunspot::Rails::Adapters::ActiveRecordInstanceAdapter, ActiveRecord::Base)
+Sunspot::Adapters::DataAccessor.register(Sunspot::Rails::Adapters::ActiveRecordDataAccessor, ActiveRecord::Base)
+ActiveRecord::Base.module_eval { include(Sunspot::Rails::Searchable) }
+ActionController::Base.module_eval { include(Sunspot::Rails::RequestLifecycle) }

data/spec/configuration_spec.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Sunspot::Rails::Configuration, "default values" do
+  before(:each) do
+    File.should_receive(:exist?).at_least(:once).and_return(false)
+    @config = Sunspot::Rails::Configuration.new
+  end
+  
+  it "should handle the 'hostname' property when not set" do
+    @config.hostname.should == 'localhost'
+  end  
+  
+  it "should handle the 'path' property when not set" do
+    @config.path.should == '/solr'
+  end
+
+  it "should handle the 'port' property when not set" do
+    @config.port.should == 8983
+  end
+
+  it "should handle the 'log_level' property when not set" do
+    @config.log_level.should == 'INFO'
+  end
+  
+  it "should handle the 'log_file' property" do
+    @config.log_file.should =~ /log\/solr_test.log/
+  end
+  
+  it "should handle the 'solr_home' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.solr_home.should == '/some/path/solr'
+  end
+
+  it "should handle the 'data_path' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.data_path.should == '/some/path/solr/data/test'
+  end
+
+  it "should handle the 'pid_path' property when not set" do
+    Rails.should_receive(:root).at_least(1).and_return('/some/path')
+    @config.pid_path.should == '/some/path/solr/pids/test'
+  end
+  
+  it "should handle the 'solr_home' property when not set" do
+    @config.solr_home.should_not == nil
+  end
+
+  it "should handle the 'auto_commit_after_request' propery when not set" do
+    @config.auto_commit_after_request?.should == true
+  end
+  
+  it "should handle the 'auto_commit_after_delete_request' propery when not set" do
+    @config.auto_commit_after_delete_request?.should == false
+  end
+end
+
+describe Sunspot::Rails::Configuration, "user settings" do
+  before(:each) do
+    ::Rails.stub!(:env => 'config_test')
+    @config = Sunspot::Rails::Configuration.new
+  end
+
+  it "should handle the 'hostname' property when set" do
+    @config.hostname.should == 'some.host'
+  end
+
+  it "should handle the 'port' property when set" do
+    @config.port.should == 1234
+  end
+  
+  it "should handle the 'path' property when set" do
+    @config.path.should == '/solr/idx'
+  end
+  
+  it "should handle the 'log_level' propery when set" do
+    @config.log_level.should == 'WARNING'
+  end
+  
+  it "should handle the 'solr_home' propery when set" do
+    @config.solr_home.should == '/my_superior_path'
+  end
+
+  it "should handle the 'data_path' property when set" do
+    @config.data_path.should == '/my_superior_path/data'
+  end
+
+  it "should handle the 'pid_path' property when set" do
+    @config.pid_path.should == '/my_superior_path/pids'
+  end
+  
+  it "should handle the 'solr_home' property when set" do
+    @config.solr_home.should == '/my_superior_path'
+  end
+
+  it "should handle the 'auto_commit_after_request' propery when set" do
+    @config.auto_commit_after_request?.should == false
+  end
+  
+  it "should handle the 'auto_commit_after_delete_request' propery when set" do
+    @config.auto_commit_after_delete_request?.should == true
+  end
+end

data/spec/mock_app/app/controllers/application.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/spec/mock_app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/spec/mock_app/app/controllers/posts_controller.rb

@@ -0,0 +1,6 @@
+class PostsController < ApplicationController
+  def create
+    PostWithAuto.create(params[:post])
+    render :nothing => true
+  end
+end

data/spec/mock_app/app/models/author.rb

@@ -0,0 +1,8 @@
+class Author < ActiveRecord::Base
+  set_table_name :writers
+  set_primary_key :writer_id
+
+  searchable do
+    string :name
+  end
+end

data/spec/mock_app/app/models/blog.rb

@@ -0,0 +1,12 @@
+class Blog < ActiveRecord::Base
+  has_many :posts
+  has_many :comments, :through => :posts
+
+  searchable :include => { :posts => :author } do
+    string :subdomain
+    text :name
+  end
+
+  # Make sure that includes are added to with multiple searchable calls
+  searchable(:include => :comments) {}
+end

data/spec/mock_app/app/models/location.rb

@@ -0,0 +1,2 @@
+class Location < ActiveRecord::Base
+end

data/spec/mock_app/app/models/photo_post.rb

@@ -0,0 +1,2 @@
+class PhotoPost < PostWithAuto
+end

data/spec/mock_app/app/models/post.rb

@@ -0,0 +1,10 @@
+class Post < ActiveRecord::Base
+  belongs_to :location
+  belongs_to :author
+
+  searchable :auto_index => false, :auto_remove => false do
+    string :title
+    text :body, :more_like_this => true
+    coordinates :location
+  end
+end

data/spec/mock_app/app/models/post_with_auto.rb

@@ -0,0 +1,10 @@
+class PostWithAuto < ActiveRecord::Base
+  def self.table_name
+    'posts'
+  end
+
+  searchable :ignore_attribute_changes_of => [ :updated_at ] do
+    string :title
+    text :body, :more_like_this => true
+  end
+end

data/spec/mock_app/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!