gojee-sunspot-rails 2.0.3 → 2.0.4

data/spec/rails_template/config/boot.rb

@@ -0,0 +1,127 @@
+if defined?(RAILS_GEM_VERSION) && RAILS_GEM_VERSION =~ /^2/ # Rails 2 only
+  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
+        if load_error.message =~ /Could not find RubyGem rails/
+          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
+        else
+          raise
+        end
+      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
+          min_version = '1.3.2'
+          require 'rubygems'
+          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
+
+  class Rails::Boot
+    def run
+      load_initializer
+
+      Rails::Initializer.class_eval do
+        def load_gems
+          @bundler_loaded ||= Bundler.require :default, Rails.env
+        end
+      end
+
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  # All that for this:
+  Rails.boot!
+end

data/spec/rails_template/config/preinitializer.rb

@@ -0,0 +1,22 @@
+if defined?(RAILS_GEM_VERSION) && RAILS_GEM_VERSION =~ /^2/ # Rails 2 only
+  begin
+    require "rubygems"
+    require "bundler"
+  rescue LoadError
+    raise "Could not load the bundler gem. Install it with `gem install bundler`."
+  end
+
+  if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.24")
+    raise RuntimeError, "Your bundler version is too old for Rails 2.3." +
+     "Run `gem install bundler` to upgrade."
+  end
+
+  begin
+    # Set up load paths for all bundled gems
+    ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile", __FILE__)
+    Bundler.setup
+  rescue Bundler::GemNotFound
+    raise RuntimeError, "Bundler couldn't find some gems." +
+      "Did you run `bundle install`?"
+  end
+end

data/spec/rails_template/config/routes.rb

@@ -0,0 +1,9 @@
+if Rails::VERSION::MAJOR == 2
+  ActionController::Routing::Routes.draw do |map|
+    map.resources :posts, :only => :create
+  end
+elsif Rails::VERSION::MAJOR == 3
+  Rails.application.routes.draw do
+    resources :posts, :only => :create
+  end
+end

data/spec/rails_template/config/sunspot.yml

@@ -0,0 +1,24 @@
+test:
+  solr:
+    hostname: localhost
+    port: 8983
+development:
+  solr:
+    hostname: localhost
+    port: 8981
+config_test:
+  solr:
+    hostname: some.host
+    port: 1234
+    path: /solr/idx
+    log_level: WARNING
+    data_path: /my_superior_path/data
+    pid_dir: /my_superior_path/pids
+    solr_home: /my_superior_path
+    bind_address: 127.0.0.1
+    read_timeout: 2
+    open_timeout: 0.5
+  auto_commit_after_request: false
+  auto_commit_after_delete_request: true
+config_disabled_test:
+  disabled: true

data/spec/rails_template/db/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.string :type
+    t.integer :location_id
+    t.text :body
+    t.references :blog
+    t.timestamps
+  end
+
+  create_table :locations, :force => true do |t|
+    t.float :lat
+    t.float :lng
+  end
+
+  create_table :blogs, :force => true do |t|
+    t.string :name
+    t.string :subdomain
+    t.timestamps
+  end
+
+  create_table :writers, :force => true, :primary_key => :writer_id do |t|
+    t.string :name
+    t.timestamps
+  end
+
+end

data/spec/request_lifecycle_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe PostsController, :type => :controller do
+  begin
+    include ::RSpec::Rails::ControllerExampleGroup
+  rescue NameError
+    # Silent -- rspec-rails 1.x catches the :type => :controller
+  end
+
+  before(:each) do
+    Sunspot::Rails.configuration = @configuration = Sunspot::Rails::Configuration.new
+  end
+
+  after(:each) do
+    Sunspot::Rails.configuration = nil
+  end
+
+  unless respond_to?(:describes)
+    controller_name :posts  # RSpec 1
+  end
+
+  it 'should automatically commit after each action if specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => true }
+    Sunspot.should_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  it 'should not commit, if configuration is set to false' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false }
+    Sunspot.should_not_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+
+  it 'should commit if configuration is not specified' do
+    @configuration.user_configuration = {}
+    Sunspot.should_receive(:commit_if_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  ### auto_commit_if_delete_dirty
+  
+  it 'should automatically commit after each delete if specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false,
+                                          'auto_commit_after_delete_request' => true }
+    Sunspot.should_receive(:commit_if_delete_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+  
+  it 'should not automatically commit on delete if configuration is set to false' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false,
+                                          'auto_commit_after_delete_request' => false }
+    Sunspot.should_not_receive(:commit_if_delete_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+
+  it 'should not automatically commit on delete if configuration is not specified' do
+    @configuration.user_configuration = { 'auto_commit_after_request' => false }
+    Sunspot.should_not_receive(:commit_if_delete_dirty)
+    post :create, :post => { :title => 'Test 1' }
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.string :type
+    t.integer :location_id
+    t.text :body
+    t.references :blog
+    t.timestamps
+  end
+
+  create_table :locations, :force => true do |t|
+    t.float :lat
+    t.float :lng
+  end
+
+  create_table :blogs, :force => true do |t|
+    t.string :name
+    t.string :subdomain
+    t.timestamps
+  end
+
+  create_table :writers, :force => true, :primary_key => :writer_id do |t|
+    t.string :name
+    t.timestamps
+  end
+
+end

data/spec/searchable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Rails::Searchable do
+  describe '#searchable' do
+    it "should register models with Sunspot.searchable (via Sunspot.setup)" do
+      Sunspot.searchable.should_not be_empty
+      Sunspot.searchable.should include(Author)
+      Sunspot.searchable.should include(Blog)
+      Sunspot.searchable.should include(Post)
+    end
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Sunspot::Rails::Server do
+  before :each do
+    @server = Sunspot::Rails::Server.new
+    @config = Sunspot::Rails::Configuration.new
+    @solr_home = File.join(@config.solr_home)
+  end
+
+  it "sets the correct Solr home" do
+    @server.solr_home.should == @solr_home
+  end
+
+  it "sets the correct Solr PID path" do
+    @server.pid_path.should == File.join(@server.pid_dir, 'sunspot-solr-test.pid')
+  end
+
+  it "sets the correct Solr data dir" do
+    @server.solr_data_dir.should == File.join(@solr_home, 'data', 'test')
+  end
+
+  it "sets the correct port" do
+    @server.port.should == 8983
+  end
+
+  it "sets the correct log level" do
+    @server.log_level.should == "FINE"
+  end
+
+  it "sets the correct log file" do
+    @server.log_file.should == File.join(Rails.root, 'log', 'sunspot-solr-test.log')
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,57 @@
+require 'thread'
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe 'Sunspot::Rails session' do
+  it 'is a different object for each thread' do
+    # Queue is just a convenient thread-safe container
+    sessions_queue = Queue.new
+
+    # Create some threads which dump their session into the queue
+    Array.new(2) {
+      Thread.new { sessions_queue << Sunspot.session.session }
+    }.each { |thread| thread.join }
+
+    # Collect the items from the queue
+    sessions = []
+    until sessions_queue.empty?
+      sessions << sessions_queue.pop
+    end
+
+    # There should be no items in the queue with the same object_id
+    object_ids = sessions.map(&:object_id)
+    object_ids.uniq.should == object_ids
+  end
+
+  it 'should create a separate master/slave session if configured' do
+  end
+
+  it 'should not create a separate master/slave session if no master configured' do
+  end
+
+  context 'disabled' do
+    before do
+      Sunspot::Rails.reset
+      ::Rails.stub!(:env).and_return("config_disabled_test")
+    end
+
+    after do
+      Sunspot::Rails.reset
+    end
+
+    it 'sets the session proxy as a stub' do
+      Sunspot::Rails.build_session.should be_a_kind_of(Sunspot::Rails::StubSessionProxy)
+    end
+  end
+
+  private
+
+  def with_configuration(options)
+    original_configuration = Sunspot::Rails.configuration
+    Sunspot::Rails.reset
+    Sunspot::Rails.configuration = Sunspot::Rails::Configuration.new
+    Sunspot::Rails.configuration.user_configuration = options
+    yield
+    Sunspot::Rails.reset
+    Sunspot::Rails.configuration = original_configuration
+  end
+end

data/spec/shared_examples/indexed_after_save.rb

@@ -0,0 +1,8 @@
+shared_examples_for 'indexed after save' do
+  it 'should be indexed after save' do
+    subject.save!
+    Sunspot.commit
+
+    subject.class.search.results.should include(subject)
+  end
+end

data/spec/shared_examples/not_indexed_after_save.rb

@@ -0,0 +1,8 @@
+shared_examples_for 'not indexed after save' do
+  it 'should not be indexed after save' do
+    subject.save!
+    Sunspot.commit
+
+    subject.class.search.results.should_not include(subject)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+ENV['RAILS_ENV'] = 'test'
+if rsolr_version = ENV['RSOLR_GEM_VERSION']
+  STDERR.puts("Forcing RSolr version #{rsolr_version}")
+  gem "rsolr", rsolr_version
+end
+
+require File.expand_path('config/environment', ENV['RAILS_ROOT'])
+
+begin
+  require 'rspec'
+  require 'rspec/rails'
+rescue LoadError => e
+  require 'spec'
+  require 'spec/rails'
+end
+require 'rake'
+require File.join('sunspot', 'rails', 'solr_logging')
+
+def load_schema
+  stdout = $stdout
+  $stdout = StringIO.new # suppress output while building the schema
+  load File.join(ENV['RAILS_ROOT'], 'db', 'schema.rb')
+  $stdout = stdout
+end
+
+def silence_stderr(&block)
+  stderr = $stderr
+  $stderr = StringIO.new
+  yield
+  $stderr = stderr
+end
+
+rspec =
+  begin
+    RSpec
+  rescue NameError, ArgumentError
+    Spec::Runner
+  end
+
+# Load all shared examples
+Dir[File.expand_path("shared_examples/*.rb", File.dirname(__FILE__))].each {|f| require f}
+
+rspec.configure do |config|
+  config.before(:each) do
+    load_schema
+    Sunspot.remove_all!
+  end
+end

data/spec/stub_session_proxy_spec.rb

@@ -0,0 +1,122 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+require File.expand_path('../lib/sunspot/rails/spec_helper', File.dirname(__FILE__))
+
+describe 'specs with Sunspot stubbed' do
+  disconnect_sunspot
+
+  before :each do
+    @session = Sunspot.session.original_session
+    @post = Post.create!
+  end
+
+  it 'should not send index to session' do
+    @session.should_not_receive(:index)
+    @post.index
+  end
+
+  it 'should not send index! to session' do
+    @session.should_not_receive(:index!)
+    @post.index!
+  end
+
+  it 'should not send commit to session' do
+    @session.should_not_receive(:commit)
+    Sunspot.commit
+  end
+
+  it 'should not send remove to session' do
+    @session.should_not_receive(:remove)
+    @post.remove_from_index
+  end
+
+  it 'should not send remove! to session' do
+    @session.should_not_receive(:remove)
+    @post.remove_from_index!
+  end
+
+  it 'should not send remove_by_id to session' do
+    @session.should_not_receive(:remove_by_id)
+    Sunspot.remove_by_id(Post, 1)
+  end
+
+  it 'should not send remove_by_id! to session' do
+    @session.should_not_receive(:remove_by_id!)
+    Sunspot.remove_by_id!(Post, 1)
+  end
+
+  it 'should not send remove_all to session' do
+    @session.should_not_receive(:remove_all)
+    Post.remove_all_from_index
+  end
+
+  it 'should not send remove_all! to session' do
+    @session.should_not_receive(:remove_all!)
+    Post.remove_all_from_index!
+  end
+
+  it 'should return false for dirty?' do
+    @session.should_not_receive(:dirty?)
+    Sunspot.dirty?.should == false
+  end
+
+  it 'should not send commit_if_dirty to session' do
+    @session.should_not_receive(:commit_if_dirty)
+    Sunspot.commit_if_dirty
+  end
+
+  it 'should return false for delete_dirty?' do
+    @session.should_not_receive(:delete_dirty?)
+    Sunspot.delete_dirty?.should == false
+  end
+
+  it 'should not send commit_if_delete_dirty to session' do
+    @session.should_not_receive(:commit_if_delete_dirty)
+    Sunspot.commit_if_delete_dirty
+  end
+
+  it 'should not execute a search when #search called' do
+    @session.should_not_receive(:search)
+    Post.search
+  end
+
+  it 'should not execute a search when #search called' do
+    @session.should_not_receive(:search)
+    Post.search
+  end
+
+  it 'should not execute a search when #search called with parameters' do
+    @session.should_not_receive(:search)
+    Post.search(:include => :blog, :select => 'id, title')
+  end
+
+  it 'should return a new search' do
+    @session.should_not_receive(:new_search)
+    Sunspot.new_search(Post).should respond_to(:execute)
+  end
+
+  describe 'stub search' do
+    before :each do
+      @search = Post.search
+    end
+
+    it 'should return empty results' do
+      @search.results.should == []
+    end
+
+    it 'should return empty hits' do
+      @search.hits.should == []
+    end
+
+    it 'should return zero total' do
+      @search.total.should == 0
+    end
+
+    it 'should return nil for a given facet' do
+      @search.facet(:category_id).should be_nil
+    end
+
+    it 'should return nil for a given dynamic facet' do
+      @search.dynamic_facet(:custom).should be_nil
+    end
+  end
+end

data/sunspot_rails.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../../sunspot/lib/', __FILE__)
+
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'sunspot/version'
+
+Gem::Specification.new do |s|
+  s.name        = "gojee-sunspot-rails"
+  s.version     = Sunspot::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Mat Brown', 'Peer Allan', 'Dmitriy Dzema', 'Benjamin Krause', 'Marcel de Graaf', 'Brandon Keepers', 'Peter Berkenbosch',
+                  'Brian Atkinson', 'Tom Coleman', 'Matt Mitchell', 'Nathan Beyer', 'Kieran Topping', 'Nicolas Braem', 'Jeremy Ashkenas',
+                  'Dylan Vaughn', 'Brian Durand', 'Sam Granieri', 'Nick Zadrozny', 'Jason Ronallo', 'Eric Hummel']
+  s.email       = ["mat@patch.com"]
+  s.homepage = 'http://github.com/outoftime/sunspot/tree/master/sunspot_rails'
+  s.summary     = 'Rails integration for the Sunspot Solr search library'
+  s.description = <<-TEXT
+    Sunspot::Rails is an extension to the Sunspot library for Solr search.
+    Sunspot::Rails adds integration between Sunspot and ActiveRecord, including
+    defining search and indexing related methods on ActiveRecord models themselves,
+    running a Sunspot-compatible Solr instance for development and test
+    environments, and automatically commit Solr index changes at the end of each
+    Rails request.
+  TEXT
+
+  s.rubyforge_project = "sunspot"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'gojee-sunspot', Sunspot::VERSION
+  s.add_dependency 'nokogiri'
+
+  s.add_development_dependency 'rspec', '~> 1.2'
+  s.add_development_dependency 'rspec-rails', '~> 1.2'
+
+  s.rdoc_options << '--webcvs=http://github.com/outoftime/sunspot/tree/master/%s' <<
+                  '--title' << 'Sunspot-Rails - Rails integration for the Sunspot Solr search library - API Documentation' <<
+                  '--main' << 'README.rdoc'
+end