nxa-sunspot_rails 0.11.3

data/spec/mock_app/config/database.yml

@@ -0,0 +1,4 @@
+test: &test
+  :adapter: sqlite3
+  :database: db/test.db
+development: *test

data/spec/mock_app/config/environment.rb

@@ -0,0 +1,42 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+# RAILS_GEM_VERSION = ENV['RAILS_GEM_VERSION'] || '2.3.3' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+  config.gem "qoobaa-sqlite3-ruby", :lib => 'sqlite3', :source => "http://gems.github.com" if RUBY_VERSION > '1.9'
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end

data/spec/mock_app/config/environments/development.rb

@@ -0,0 +1,27 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/spec/mock_app/config/environments/test.rb

@@ -0,0 +1,27 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/spec/mock_app/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,19 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/spec/mock_app/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_mock_app_session',
+  :secret      => 'a2ddf56c7d642f2075a5d466eff55556c20d13415aff5156740ac82848c3c586711fde0e52f4834727816d08b2d13f3da7b6c7587d789cebe6081ee1a7fec943'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/spec/mock_app/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  
+  map.resources :posts, :only => :create
+end

data/spec/mock_app/config/sunspot.yml

@@ -0,0 +1,19 @@
+test:
+  solr:
+    hostname: localhost
+    port: 8980
+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_path: /my_superior_path/pids
+    solr_home: /my_superior_path
+  auto_commit_after_request: false
+  auto_commit_after_delete_request: true

data/spec/mock_app/db/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.text :body
+    t.references :blog
+    t.timestamps
+  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/model_lifecycle_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'searchable with lifecycle' do
+  integrate_sunspot
+  
+  describe 'on create' do
+    before :each do
+      @post = PostWithAuto.create
+      Sunspot.commit
+    end
+
+    it 'should automatically index' do
+      PostWithAuto.search.results.should == [@post]
+    end
+  end
+
+  describe 'on update' do
+    before :each do
+      @post = PostWithAuto.create
+      @post.update_attributes(:title => 'Test 1')
+      Sunspot.commit
+    end
+
+    it 'should automatically update index' do
+      PostWithAuto.search { with :title, 'Test 1' }.results.should == [@post]
+    end
+  end
+  
+  describe 'on destroy' do
+    before :each do
+      @post = PostWithAuto.create
+      @post.destroy
+      Sunspot.commit
+    end
+
+    it 'should automatically remove it from the index' do
+      PostWithAuto.search_ids.should be_empty
+    end
+  end
+end
+
+describe 'searchable with lifecycle - ignoring specific attributes' do
+  integrate_sunspot
+  
+  before(:each) do
+    @post = PostWithAuto.create
+  end
+  
+  it "should not reindex the object on an update_at change, because it is marked as to-ignore" do
+    Sunspot.should_not_receive(:index).with(@post)
+    @post.update_attribute :updated_at, 123.seconds.from_now
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,314 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'ActiveRecord mixin' do
+  integrate_sunspot
+  
+  describe 'index()' do
+    before :each do
+      @post = Post.create!
+      @post.index
+    end
+
+    it 'should not commit the model' do
+      Post.search.results.should be_empty
+    end
+
+    it 'should index the model' do
+      Sunspot.commit
+      Post.search.results.should == [@post]
+    end
+  end
+
+  describe 'index!()' do
+    before :each do
+      @post = Post.create!
+      @post.index!
+    end
+
+    it 'should immediately index and commit' do
+      Post.search.results.should == [@post]
+    end
+  end
+
+  describe 'remove_from_index()' do
+    before :each do
+      @post = Post.create!
+      @post.index!
+      @post.remove_from_index
+    end
+
+    it 'should not commit immediately' do
+      Post.search.results.should == [@post]
+    end
+
+    it 'should remove the model from the index' do
+      Sunspot.commit
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'remove_from_index!()' do
+    before :each do
+      @post = Post.create!
+      @post.index!
+      @post.remove_from_index!
+    end
+
+    it 'should immediately remove the model and commit' do
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'remove_all_from_index' do
+    before :each do
+      @posts = Array.new(10) { Post.create! }.each { |post| Sunspot.index(post) }
+      Sunspot.commit
+      Post.remove_all_from_index
+    end
+
+    it 'should not commit immediately' do
+      Post.search.results.to_set.should == @posts.to_set
+    end
+
+    it 'should remove all instances from the index' do
+      Sunspot.commit
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'remove_all_from_index!' do
+    before :each do
+      Array.new(10) { Post.create! }.each { |post| Sunspot.index(post) }
+      Sunspot.commit
+      Post.remove_all_from_index!
+    end
+
+    it 'should remove all instances from the index and commit immediately' do
+      Post.search.results.should be_empty
+    end
+  end
+
+  describe 'search()' do
+    before :each do
+      @post = Post.create!(:title => 'Test Post')
+      @post.index!
+    end
+
+    it 'should return results specified by search' do
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should not return results excluded by search' do
+      Post.search do
+        with :title, 'Bogus Post'
+      end.results.should be_empty
+    end
+    
+    it 'should find ActiveRecord objects with an integer, not a string' do
+      Post.should_receive(:find).with([@post.id.to_i], anything()).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+    
+    it 'should use the include option on the data accessor when specified' do
+      Post.should_receive(:find).with(anything(), hash_including(:include => [:blog])).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+        data_accessor_for(Post).include = [:blog]
+      end.results.should == [@post]
+    end
+    
+    it 'should use the select option on the data accessor when specified' do
+      Post.should_receive(:find).with(anything(), hash_including(:select => 'title, published_at')).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+        data_accessor_for(Post).select = [:title, :published_at]
+      end.results.should == [@post]
+    end
+    
+    it 'should not use the select option on the data accessor when not specified' do
+      Post.should_receive(:find).with(anything(), hash_not_including(:select)).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+  end
+
+  describe 'search_ids()' do
+    before :each do
+      @posts = Array.new(2) { Post.create! }.each { |post| post.index }
+      Sunspot.commit
+    end
+
+    it 'should return IDs' do
+      Post.search_ids.to_set.should == @posts.map { |post| post.id }.to_set
+    end
+  end
+  
+  describe 'searchable?()' do
+    it 'should not be true for models that have not been configured for search' do
+      Blog.should_not be_searchable
+    end
+
+    it 'should be true for models that have been configured for search' do
+      Post.should be_searchable
+    end
+  end
+
+  describe 'index_orphans()' do
+    before :each do
+      @posts = Array.new(2) { Post.create }.each { |post| post.index }
+      Sunspot.commit
+      @posts.first.destroy
+    end
+
+    it 'should return IDs of objects that are in the index but not the database' do
+      Post.index_orphans.should == [@posts.first.id]
+    end
+  end
+
+  describe 'clean_index_orphans()' do
+    before :each do
+      @posts = Array.new(2) { Post.create }.each { |post| post.index }
+      Sunspot.commit
+      @posts.first.destroy
+    end
+
+    it 'should remove orphans from the index' do
+      Post.clean_index_orphans
+      Sunspot.commit
+      Post.search.results.should == [@posts.last]
+    end
+  end
+
+  describe 'reindex()' do
+    before :each do
+      @posts = Array.new(2) { Post.create }
+    end
+
+    it 'should index all instances' do
+      Post.reindex(:batch_size => nil)
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
+
+    it 'should remove all currently indexed instances' do
+      old_post = Post.create!
+      old_post.index!
+      old_post.destroy
+      Post.reindex
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
+    
+  end
+
+  describe 'reindex() with real data' do
+    before :each do
+      @posts = Array.new(2) { Post.create }
+    end
+
+    it 'should index all instances' do
+      Post.reindex(:batch_size => nil)
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
+
+    it 'should remove all currently indexed instances' do
+      old_post = Post.create!
+      old_post.index!
+      old_post.destroy
+      Post.reindex
+      Sunspot.commit
+      Post.search.results.to_set.should == @posts.to_set
+    end
+    
+    describe "using batch sizes" do
+      it 'should index with a specified batch size' do
+        Post.reindex(:batch_size => 1)
+        Sunspot.commit
+        Post.search.results.to_set.should == @posts.to_set
+      end
+    end
+    
+  end
+  
+  describe "reindex()" do
+  
+    before(:each) do
+      @posts = Array.new(10) { Post.create }
+    end
+
+    describe "when not using batches" do
+      
+      it "should select all if the batch_size is nil" do
+        Post.should_receive(:all).with(:include => []).and_return([])
+        Post.reindex(:batch_size => nil)
+      end
+
+      it "should search for models with includes" do
+        Post.should_receive(:all).with(:include => :author).and_return([])
+        Post.reindex(:batch_size => nil, :include => :author)
+      end
+    
+    end
+
+    describe "when using batches" do
+      
+      it "should use the default options" do
+        Post.should_receive(:all).with do |params|
+          params[:limit].should == 500
+          params[:include].should == []
+          params[:conditions].should == ['posts.id > ?', 0]
+          params[:order].should == 'id'
+        end.and_return(@posts)
+        Post.reindex
+      end
+
+      it "should set the conditions using the overridden table attributes" do
+        @posts = Array.new(10) { Author.create }
+        Author.should_receive(:all).with do |params|
+          params[:conditions].should == ['writers.writer_id > ?', 0]
+          params[:order].should == 'writer_id'
+        end.and_return(@posts)
+        Author.reindex
+      end
+
+      it "should count the number of records to index" do
+        Post.should_receive(:count).and_return(10)
+        Post.reindex
+      end
+
+      it "should override the batch_size" do
+        Post.should_receive(:all).with do |params|
+          params[:limit].should == 20
+          @posts
+        end.and_return(@posts)
+        Post.reindex(:batch_size => 20)
+      end
+
+      it "should set the include option" do
+        Post.should_receive(:all).with do |params|
+          params[:include].should == [{:author => :address}]
+          @posts
+        end.and_return(@posts)
+        Post.reindex(:include => [{:author => :address}])
+      end
+
+      it "should commit after indexing each batch" do
+        Sunspot.should_receive(:commit).twice
+        Post.reindex(:batch_size => 5)
+      end
+
+      it "should commit after indexing everything" do
+        Sunspot.should_receive(:commit).once
+        Post.reindex(:batch_commit => false)
+      end
+      
+    end
+  end
+  
+end

data/spec/request_lifecycle_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'request lifecycle', :type => :controller do
+  before(:each) do
+    Sunspot::Rails.configuration = @configuration = Sunspot::Rails::Configuration.new
+  end
+
+  after(:each) do
+    Sunspot::Rails.configuration = nil
+  end
+  controller_name :posts
+
+  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,20 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.text :body
+    t.references :blog
+    t.timestamps
+  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