sunspot_rails 1.0.5 → 1.1.0

data/lib/sunspot/rails/configuration.rb

@@ -11,6 +11,7 @@ module Sunspot #:nodoc:
     #       port: 8982
     #       min_memory: 512M
     #       max_memory: 1G
+    #       solr_jar: /some/path/solr15/start.jar
     #   test:
     #     solr:
     #       hostname: localhost
@@ -82,7 +83,7 @@ module Sunspot #:nodoc:
       # String:: host name
       #
       def master_hostname
-        @master_hostname ||= (user_configuration_from_key('solr', 'master_hostname') || hostname)
+        @master_hostname ||= (user_configuration_from_key('master_solr', 'hostname') || hostname)
       end
 
       #
@@ -94,7 +95,7 @@ module Sunspot #:nodoc:
       # Integer:: port
       #
       def master_port
-        @master_port ||= (user_configuration_from_key('solr', 'master_port') || port).to_i
+        @master_port ||= (user_configuration_from_key('master_solr', 'port') || port).to_i
       end
 
       #
@@ -106,7 +107,7 @@ module Sunspot #:nodoc:
       # String:: path
       #
       def master_path
-        @master_path ||= (user_configuration_from_key('solr', 'master_path') || path)
+        @master_path ||= (user_configuration_from_key('master_solr', 'path') || path)
       end
 
       #
@@ -197,6 +198,13 @@ module Sunspot #:nodoc:
           end
       end
 
+      # 
+      # Solr start jar
+      #
+      def solr_jar
+        @solr_jar ||= user_configuration_from_key('solr', 'solr_jar')
+      end
+
       # 
       # Minimum java heap size for Solr instance
       #

data/lib/sunspot/rails/searchable.rb

@@ -39,6 +39,11 @@ module Sunspot #:nodoc:
         # :ignore_attribute_changes_of<Array>::
         #   Define attributes, that should not trigger a reindex of that
         #   object. Usual suspects are updated_at or counters.
+        # :include<Mixed>::
+        #   Define default ActiveRecord includes, set this to allow ActiveRecord
+        #   to load required associations when indexing. See ActiveRecord's 
+        #   documentation on eager-loading for examples on how to set this
+        #   Default: [] 
         #
         # ==== Example
         #
@@ -56,7 +61,9 @@ module Sunspot #:nodoc:
         def searchable(options = {}, &block)
           Sunspot.setup(self, &block)
 
-          unless searchable?
+          if searchable?
+            sunspot_options[:include].concat(Util::Array(options[:include]))
+          else
             extend ClassMethods
             include InstanceMethods
 
@@ -72,8 +79,10 @@ module Sunspot #:nodoc:
                 searchable.remove_from_index
               end
             end
+            options[:include] = Util::Array(options[:include])
+            
+            self.sunspot_options = options
           end
-          self.sunspot_options = options
         end
 
         # 
@@ -127,19 +136,9 @@ module Sunspot #:nodoc:
         # Sunspot::Search:: Object containing results, totals, facets, etc.
         #
         def solr_search(options = {}, &block)
-          options.assert_valid_keys(:include, :select)
-          search = Sunspot.new_search(self, &block)
-          unless options.empty?
-            search.build do |query|
-              if options[:include]
-                query.data_accessor_for(self).include = options[:include]
-              end
-              if options[:select]
-                query.data_accessor_for(self).select = options[:select]
-              end
-            end
+          solr_execute_search(options) do
+            Sunspot.new_search(self, &block)
           end
-          search.execute
         end
 
         # 
@@ -153,7 +152,9 @@ module Sunspot #:nodoc:
         # Array:: Array of IDs, in the order returned by the search
         #
         def solr_search_ids(&block)
-          solr_search(&block).raw_results.map { |raw_result| raw_result.primary_key.to_i }
+          solr_execute_search_ids do
+            solr_search(&block)
+          end
         end
 
         # 
@@ -222,7 +223,7 @@ module Sunspot #:nodoc:
         #   Post.index(:include => :author) 
         #
         def solr_index(opts={})
-          options = { :batch_size => 500, :batch_commit => true, :include => [], :first_id => 0}.merge(opts)
+          options = { :batch_size => 500, :batch_commit => true, :include => self.sunspot_options[:include], :first_id => 0}.merge(opts)
           unless options[:batch_size]
             Sunspot.index!(all(:include => options[:include]))
           else
@@ -289,6 +290,27 @@ module Sunspot #:nodoc:
           true
         end
         
+        def solr_execute_search(options = {})
+          options.assert_valid_keys(:include, :select)
+          search = yield
+          unless options.empty?
+            search.build do |query|
+              if options[:include]
+                query.data_accessor_for(self).include = options[:include]
+              end
+              if options[:select]
+                query.data_accessor_for(self).select = options[:select]
+              end
+            end
+          end
+          search.execute
+        end
+
+        def solr_execute_search_ids(options = {})
+          search = yield
+          search.raw_results.map { |raw_result| raw_result.primary_key.to_i }
+        end
+        
         protected
         
         # 
@@ -301,7 +323,7 @@ module Sunspot #:nodoc:
           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.)")
         end
-        
+
       end
 
       module InstanceMethods
@@ -311,6 +333,8 @@ module Sunspot #:nodoc:
             alias_method :index!, :solr_index! unless method_defined? :index!
             alias_method :remove_from_index, :solr_remove_from_index unless method_defined? :remove_from_index
             alias_method :remove_from_index!, :solr_remove_from_index! unless method_defined? :remove_from_index!
+            alias_method :more_like_this, :solr_more_like_this unless method_defined? :more_like_this
+            alias_method :more_like_this_ids, :solr_more_like_this_ids unless method_defined? :more_like_this_ids
           end
         end
         # 
@@ -351,6 +375,19 @@ module Sunspot #:nodoc:
           Sunspot.remove!(self)
         end
 
+        def solr_more_like_this(*args, &block)
+          options = args.extract_options!
+          self.class.solr_execute_search(options) do
+            Sunspot.new_more_like_this(self, *args, &block)
+          end
+        end
+
+        def solr_more_like_this_ids(&block)
+          self.class.solr_execute_search_ids do
+            solr_more_like_this(&block)
+          end
+        end
+
         private
 
         def maybe_mark_for_auto_indexing

data/lib/sunspot/rails/server.rb

@@ -69,6 +69,13 @@ module Sunspot
         File.join(::Rails.root, 'solr')
       end
 
+      #
+      # Solr start jar
+      #
+      def solr_jar
+        configuration.solr_jar || super
+      end
+
       # 
       # Port on which to run Solr
       #

data/lib/sunspot/rails/tasks.rb

@@ -24,14 +24,38 @@ namespace :sunspot do
     task :reindex => :"sunspot:reindex"
   end
 
-  desc 'Reindex all solr models'
-  task :reindex => :environment do
-    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? }
-
+  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 :batch_commit => false
+      model.solr_reindex reindex_options
     end
   end
+  
 end

data/lib/sunspot/rails/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Rails
-    VERSION = '1.0.5'
+    VERSION = '1.1.0'
   end
 end

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

@@ -1,2 +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/post.rb

@@ -1,8 +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

@@ -5,5 +5,6 @@ class PostWithAuto < ActiveRecord::Base
 
   searchable :ignore_attribute_changes_of => [ :updated_at ] do
     string :title
+    text :body, :more_like_this => true
   end
 end

data/spec/model_spec.rb

@@ -195,7 +195,7 @@ describe 'ActiveRecord mixin' do
   
   describe 'searchable?()' do
     it 'should not be true for models that have not been configured for search' do
-      Blog.should_not be_searchable
+      Location.should_not be_searchable
     end
 
     it 'should be true for models that have been configured for search' do
@@ -343,6 +343,15 @@ describe 'ActiveRecord mixin' do
         end.and_return(@posts)
         Post.reindex(:include => [{:author => :address}])
       end
+      
+      it "should set the include option from the searchable options" do
+        @blogs = Array.new(10) { Blog.create }
+        Blog.should_receive(:all).with do |params|
+          params[:include].should == [{ :posts => :author }, :comments]
+          @blogs
+        end.and_return(@blogs)
+        Blog.reindex
+      end
 
       it "should commit after indexing each batch" do
         Sunspot.should_receive(:commit).twice
@@ -357,4 +366,44 @@ describe 'ActiveRecord mixin' do
     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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 5
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors: 
 - Mat Brown
@@ -22,7 +22,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-22 00:00:00 -04:00
+date: 2010-04-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,9 +34,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 1
         - 0
-        - 5
-        version: 1.0.5
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency