sunspot_activerecord 0.0.2 → 0.0.3

data/lib/sunspot_activerecord/searchable.rb

@@ -126,7 +126,7 @@ module SunspotActiveRecord #:nodoc:
       #
       # ==== Options
       #
-      # :include:: Specify associations to eager load
+      # :include :: Specify associations to eager load
       # :select:: Specify columns to select from database when loading results
       #
       # ==== Returns
@@ -231,9 +231,9 @@ module SunspotActiveRecord #:nodoc:
         if options[:batch_size]
           counter = 0
           find_in_batches(:include => options[:include], :batch_size => options[:batch_size]) do |records|
-            solr_benchmark options[:batch_size], counter do
+            #solr_benchmark options[:batch_size], counter do
               Sunspot.index(records)
-            end
+            #end
             Sunspot.commit if options[:batch_commit]
             counter += 1
           end
@@ -316,10 +316,10 @@ module SunspotActiveRecord #:nodoc:
       #
       def solr_benchmark(batch_size, counter,  &block)
         start = Time.now
-        logger.info("[#{Time.now}] Start Indexing")
+        #logger.info("[#{Time.now}] Start Indexing")
         yield
         elapsed = Time.now-start
-        logger.info("[#{Time.now}] Completed Indexing. Rows indexed #{counter * batch_size}. Rows/sec: #{batch_size/elapsed.to_f} (Elapsed: #{elapsed} sec.)")
+        #logger.info("[#{Time.now}] Completed Indexing. Rows indexed #{counter * batch_size}. Rows/sec: #{batch_size/elapsed.to_f} (Elapsed: #{elapsed} sec.)")
       end
 
     end

data/lib/sunspot_activerecord/version.rb

@@ -1,3 +1,3 @@
 module SunspotActiverecord
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/app/boot.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'active_record'
+require 'sunspot'
+require 'sunspot_activerecord'
+
+ENV['APP_ROOT'] ||= File.dirname(__FILE__)
+env = ENV['APP_ENV'] || 'development'
+
+db = YAML.load_file(File.join(ENV['APP_ROOT'], 'db', 'database.yml'))
+db[env][:database] = ENV['APP_ROOT'] + '/' + db[env][:database]
+ActiveRecord::Base.establish_connection(db[env])
+
+
+$LOAD_PATH.unshift("#{ENV['APP_ROOT']}/models")
+Dir.glob("#{ENV['APP_ROOT']}/models/*.rb") { |model| require File.basename(model, '.*') }

data/spec/app/db/database.yml

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

data/spec/app/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/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/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/app/models/location.rb

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

data/spec/app/models/photo_post.rb

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

data/spec/app/models/post.rb

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

data/spec/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/app/models/post_with_default_scope.rb

@@ -0,0 +1,11 @@
+class PostWithDefaultScope < ActiveRecord::Base
+  def self.table_name
+    'posts'
+  end
+
+  default_scope :order => :title
+
+  searchable :auto_index => false, :auto_remove => false do
+    string :title
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,357 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'ActiveRecord mixin' do
+  describe 'index()' do
+    before :each do
+      @post = Post.create!
+      #@post = Post.create!(:title => 'title', :body => 'body')
+      @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
+
+    it "should not blow up if there's a default scope specifying order" do
+      posts = Array.new(2) { |j| PostWithDefaultScope.create! :title => (10-j).to_s }
+      lambda { PostWithDefaultScope.index(:batch_size => 1) }.should_not raise_error
+    end
+  end
+
+  describe 'single table inheritence' do
+    before :each do
+      @post = PhotoPost.create!
+    end
+
+    it 'should not break auto-indexing' do
+      @post.title = 'Title'
+      lambda { @post.save! }.should_not raise_error
+    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(2) { 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(2) { 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 use the include option on the data accessor when specified' do
+      Post.should_receive(:all).with(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 pass :include option from search call to data accessor' do
+      Post.should_receive(:all).with(hash_including(:include => [:blog])).and_return([@post])
+      Post.search(:include => [:blog]) do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should use the select option from search call to data accessor' do
+      Post.should_receive(:all).with(hash_including(:select => 'title, published_at')).and_return([@post])
+      Post.search(:select => 'title, published_at') do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should not allow bogus options to search' do
+      lambda { Post.search(:bogus => :option) }.should raise_error(ArgumentError)
+    end
+
+    it 'should use the select option on the data accessor when specified' do
+      Post.should_receive(:all).with(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(:all).with(hash_not_including(:select)).and_return([@post])
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should gracefully handle nonexistent records' do
+      post2 = Post.create!(:title => 'Test Post')
+      post2.index!
+      post2.destroy
+      Post.search do
+        with :title, 'Test Post'
+      end.results.should == [@post]
+    end
+
+    it 'should use an ActiveRecord object for coordinates' do
+      post = Post.new(:title => 'Test Post')
+      post.location = Location.create!(:lat => 40.0, :lng => -70.0)
+      post.save
+      post.index!
+      Post.search { with(:location).near(40.0, -70.0) }.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
+      Location.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(2) { 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 commit after indexing each batch" do
+        Sunspot.should_receive(:commit).twice
+        Post.reindex(:batch_size => 1)
+      end
+
+      it "should commit after indexing everything" do
+        Sunspot.should_receive(:commit).once
+        Post.reindex(:batch_commit => false)
+      end
+    end
+  end
+
+  describe "more_like_this()" do
+    before(:each) do
+      @posts = [
+        Post.create!(:title => 'Post123', :body => "one two three"),
+        Post.create!(:title => 'Post345', :body => "three four five"),
+        Post.create!(:title => 'Post456', :body => "four five six"),
+        Post.create!(:title => 'Post234', :body => "two three four"),
+      ]
+      @posts_with_auto = [
+        PostWithAuto.create!(:body => "one two three"),
+        PostWithAuto.create!(:body => "four five six")
+      ]
+      @posts.each { |p| p.index! }
+    end
+
+    it "should return results" do
+      @posts.first.more_like_this.results.should == [@posts[3], @posts[1]]
+    end
+
+    it "should return results for specified classes" do
+      @posts.first.more_like_this(Post, PostWithAuto).results.to_set.should ==
+        Set[@posts_with_auto[0], @posts[1], @posts[3]]
+    end
+  end
+
+  describe 'more_like_this_ids()' do
+    before :each do
+      @posts = [
+        Post.create!(:title => 'Post123', :body => "one two three"),
+        Post.create!(:title => 'Post345', :body => "three four five"),
+        Post.create!(:title => 'Post456', :body => "four five six"),
+        Post.create!(:title => 'Post234', :body => "two three four"),
+      ]
+      @posts.each { |p| p.index! }
+    end
+
+    it 'should return IDs' do
+      @posts.first.more_like_this_ids.to_set.should == [@posts[3], @posts[1]].map { |post| post.id }.to_set
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+ENV['APP_ROOT'] ||= File.join(File.dirname(__FILE__), 'app')
+ENV['APP_ENV'] ||= 'test'
+
+if rsolr_version = ENV['RSOLR_GEM_VERSION']
+  STDERR.puts("Forcing RSolr version #{rsolr_version}")
+  gem "rsolr", rsolr_version
+end
+
+begin
+  require 'rspec'
+#  require 'rspec/rails'
+rescue LoadError => e
+  require 'spec'
+#  require 'spec/rails'
+end
+require 'rake'
+require 'rubygems'
+require 'sqlite3'
+
+#`sunspot-solr start`
+require File.join(ENV['APP_ROOT'], 'boot.rb')
+#require File.join('sunspot', 'rails', 'solr_logging')
+
+def load_db
+#  stdout = $stdout
+#  $stdout = StringIO.new # suppress output while building the schema
+#  db = YAML.load_file(File.join(ENV['APP_ROOT'], 'db', 'database.yml'))
+#  ActiveRecord::Base.establish_connection(db['test'])
+
+  #load File.join(ENV['APP_ROOT'], '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
+
+rspec.configure do |config|
+  config.before(:each) do
+    load_db
+    Sunspot.remove_all!
+    Location.delete_all
+    Author.delete_all
+    Blog.delete_all
+    Post.delete_all
+  end
+end

data/sunspot_activerecord.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_dependency 'sunspot'
   s.add_dependency 'activerecord', "~> 2.3.8"
+  s.add_development_dependency 'rspec', '~> 1.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sunspot_activerecord
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Olga Gorun
@@ -48,6 +48,21 @@ dependencies:
         version: 2.3.8
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :development
+  version_requirements: *id003
 description: Simplified version of sunspot_rails gem to enable usage of sunspot+active_record -based models in not Rails projects
 email: 
 - ogorun@gmail.com
@@ -66,6 +81,19 @@ files:
 - lib/sunspot_activerecord/adapters.rb
 - lib/sunspot_activerecord/searchable.rb
 - lib/sunspot_activerecord/version.rb
+- spec/app/boot.rb
+- spec/app/db/database.yml
+- spec/app/db/schema.rb
+- spec/app/db/test.sqlite3
+- spec/app/models/author.rb
+- spec/app/models/blog.rb
+- spec/app/models/location.rb
+- spec/app/models/photo_post.rb
+- spec/app/models/post.rb
+- spec/app/models/post_with_auto.rb
+- spec/app/models/post_with_default_scope.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
 - sunspot_activerecord.gemspec
 has_rdoc: true
 homepage: ""