sunspot_rails 1.0.1 → 1.0.2

data/History.txt

@@ -1,7 +1,14 @@
-== 1.0.1
+== 1.0.2 2010-03-11
+* Allow use of ActiveRecord object for coordinates extraction
+* Works with non-standard primary keys
+* Add :include, :select options to Searchable::search()
+* Allow specification of min_memory and max_memory in config/sunspot.yml
+* Searchable now more considerate of model namespaces
+
+== 1.0.1 2010-03-05
 * Fix Solr logging compatibility with RSolr 0.12.1
 
-== 1.0.0
+== 1.0.0 2010-03-03
 * Sunspot::Rails::Server subclasses Sunspot::Server; no longer needs to shell out
 * Use Sunspot built-in session proxies in Sunspot::Rails
 * Sunspot::Rails adapter compatible with assumed inconsistency

data/README.rdoc

@@ -248,6 +248,8 @@ http://outoftime.lighthouseapp.com/projects/20339-sunspot
 - Adam Salter (adam@codebright.net)
 - Brandon Keepers (brandon@opensoul.org)
 - Paul Canavese (paul@canavese.org)
+- John Eberly (jeberly@elctech.com)
+- Gert Thiel (gertthiel@gmail.com)
 
 == License
 

data/dev_tasks/gemspec.rake

@@ -16,7 +16,7 @@ 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.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause', 'Adam Salter', 'Brandon Keepers', 'Paul Canavese']
+  s.authors = ['Mat Brown', 'Peer Allan', 'Michael Moen', 'Benjamin Krause', 'Adam Salter', 'Brandon Keepers', 'Paul Canavese', 'John Eberly', 'Gert Thiel']
   s.rubyforge_project = 'sunspot'
   s.files = FileList['[A-Z]*',
     '{lib,tasks,dev_tasks}/**/*',

data/dev_tasks/rdoc.rake

@@ -1,7 +1,24 @@
-require 'rake/rdoctask'
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  if require 'rubygems'
+    retry
+  end
+  # It's OK if hanna isn't installed.
+end
 
 Rake::RDocTask.new(:doc) do |rdoc|
   rdoc.main = 'README.rdoc'
-  rdoc.rdoc_files.include('README.rdoc', 'lib/sunspot/rails/**/*.rb')
+  rdoc.rdoc_files.include('README.rdoc', 'lib/sunspot/rails/**/*.rb', 'lib/sunspot/rails.rb')
   rdoc.rdoc_dir = 'doc'
 end
+
+namespace :doc do
+  desc 'Generate rdoc and move into pages directory'
+  task :publish => :redoc do
+    doc_dir = File.join(File.dirname(__FILE__), '..', 'doc')
+    publish_dir = File.join(File.dirname(__FILE__), '..', '..', 'pages', 'rails', 'docs')
+    FileUtils.rm_rf(publish_dir) if File.exist?(publish_dir)
+    FileUtils.cp_r(doc_dir, publish_dir)
+  end
+end

data/lib/sunspot/rails/adapters.rb

@@ -47,7 +47,9 @@ module Sunspot #:nodoc:
         # ActiveRecord::Base:: ActiveRecord model
         # 
         def load(id)
-          @clazz.find_by_id(id.to_i, options_for_find)
+          @clazz.first(options_for_find.merge(
+            :conditions => { @clazz.primary_key => id.to_i}
+          ))
         end
 
         # 
@@ -62,7 +64,9 @@ module Sunspot #:nodoc:
         # Array:: Collection of ActiveRecord models
         #
         def load_all(ids)
-          @clazz.find_all_by_id(ids.map { |id| id.to_i }, options_for_find)
+          @clazz.all(options_for_find.merge(
+            :conditions => { @clazz.primary_key => ids.map { |id| id.to_i }}
+          ))
         end
         
         private

data/lib/sunspot/rails/configuration.rb

@@ -9,6 +9,8 @@ module Sunspot #:nodoc:
     #     solr:
     #       hostname: localhost
     #       port: 8982
+    #       min_memory: 512M
+    #       max_memory: 1G
     #   test:
     #     solr:
     #       hostname: localhost
@@ -194,6 +196,20 @@ module Sunspot #:nodoc:
             File.join(::Rails.root, 'solr')
           end
       end
+
+      # 
+      # Minimum java heap size for Solr instance
+      #
+      def min_memory
+        @min_memory ||= user_configuration_from_key('solr', 'min_memory')
+      end
+
+      # 
+      # Maximum java heap size for Solr instance
+      #
+      def max_memory
+        @max_memory ||= user_configuration_from_key('solr', 'max_memory')
+      end
       
       private
       

data/lib/sunspot/rails/searchable.rb

@@ -9,7 +9,9 @@ module Sunspot #:nodoc:
     module Searchable
       class <<self
         def included(base) #:nodoc:
-          base.module_eval { extend(ActsAsMethods) }
+          base.module_eval do
+            extend(ActsAsMethods)
+          end
         end
       end
 
@@ -89,6 +91,18 @@ module Sunspot #:nodoc:
       end
 
       module ClassMethods
+        def self.extended(base) #:nodoc:
+          class <<base
+            alias_method :search, :solr_search unless method_defined? :search
+            alias_method :search_ids, :solr_search_ids unless method_defined? :search_ids
+            alias_method :remove_all_from_index, :solr_remove_all_from_index unless method_defined? :remove_all_from_index
+            alias_method :remove_all_from_index!, :solr_remove_all_from_index! unless method_defined? :remove_all_from_index!
+            alias_method :reindex, :solr_reindex unless method_defined? :reindex
+            alias_method :index, :solr_index unless method_defined? :index
+            alias_method :index_orphans, :solr_index_orphans unless method_defined? :index_orphans
+            alias_method :clean_index_orphans, :solr_clean_index_orphans unless method_defined? :clean_index_orphans
+          end
+        end
         # 
         # Search for instances of this class in Solr. The block is delegated to
         # the Sunspot.search method - see the Sunspot documentation for the full
@@ -96,20 +110,36 @@ module Sunspot #:nodoc:
         #
         # ==== Example
         #
-        #   Post.search do
+        #   Post.search(:include => [:blog]) do
         #     keywords 'best pizza'
         #     with :blog_id, 1
         #     order :updated_at, :desc
         #     facet :category_ids
         #   end
         #
+        # ==== Options
+        #
+        # :include:: Specify associations to eager load
+        # :select:: Specify columns to select from database when loading results
         #
         # ==== Returns
         #
         # Sunspot::Search:: Object containing results, totals, facets, etc.
         #
-        def search(&block)
-          Sunspot.search(self, &block)
+        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
+          end
+          search.execute
         end
 
         # 
@@ -122,14 +152,14 @@ module Sunspot #:nodoc:
         #
         # Array:: Array of IDs, in the order returned by the search
         #
-        def search_ids(&block)
-          search(&block).raw_results.map { |raw_result| raw_result.primary_key.to_i }
+        def solr_search_ids(&block)
+          solr_search(&block).raw_results.map { |raw_result| raw_result.primary_key.to_i }
         end
 
         # 
         # Remove instances of this class from the Solr index.
         #
-        def remove_all_from_index
+        def solr_remove_all_from_index
           Sunspot.remove_all(self)
         end
 
@@ -138,7 +168,7 @@ module Sunspot #:nodoc:
         # commit.
         #
         #
-        def remove_all_from_index!
+        def solr_remove_all_from_index!
           Sunspot.remove_all!(self)
         end
 
@@ -148,9 +178,9 @@ module Sunspot #:nodoc:
         #
         # See #index for information on options, etc.
         #
-        def reindex(options = {})
-          remove_all_from_index
-          index(options)
+        def solr_reindex(options = {})
+          solr_remove_all_from_index
+          solr_index(options)
         end
 
         #
@@ -191,7 +221,7 @@ module Sunspot #:nodoc:
         #   # include the associated +author+ object when loading to index
         #   Post.index(:include => :author) 
         #
-        def index(opts={})
+        def solr_index(opts={})
           options = { :batch_size => 500, :batch_commit => true, :include => [], :first_id => 0}.merge(opts)
           unless options[:batch_size]
             Sunspot.index!(all(:include => options[:include]))
@@ -201,7 +231,7 @@ module Sunspot #:nodoc:
             record_count = count
             last_id = options[:first_id]
             while(offset < record_count)
-              benchmark options[:batch_size], counter do
+              solr_benchmark options[:batch_size], counter do
                 records = all(:include => options[:include], :conditions => ["#{table_name}.#{primary_key} > ?", last_id], :limit => options[:batch_size], :order => primary_key)
                 Sunspot.index(records)
                 last_id = records.last.id
@@ -224,9 +254,9 @@ module Sunspot #:nodoc:
         # ==== Returns
         #
         # Array:: Collection of IDs that exist in Solr but not in the database
-        def index_orphans
+        def solr_index_orphans
           count = self.count
-          indexed_ids = search_ids { paginate(:page => 1, :per_page => count) }.to_set
+          indexed_ids = solr_search_ids { paginate(:page => 1, :per_page => count) }.to_set
           all(:select => 'id').each do |object|
             indexed_ids.delete(object.id)
           end
@@ -239,11 +269,11 @@ module Sunspot #:nodoc:
         # circumstances, this should not be necessary; this method is provided
         # in case something goes wrong.
         #
-        def clean_index_orphans
-          index_orphans.each do |id|
+        def solr_clean_index_orphans
+          solr_index_orphans.each do |id|
             new do |fake_instance|
               fake_instance.id = id
-            end.remove_from_index
+            end.solr_remove_from_index
           end
         end
 
@@ -264,7 +294,7 @@ module Sunspot #:nodoc:
         # 
         # Does some logging for benchmarking indexing performance
         #
-        def benchmark(batch_size, counter,  &block)
+        def solr_benchmark(batch_size, counter,  &block)
           start = Time.now
           logger.info("[#{Time.now}] Start Indexing")
           yield
@@ -275,6 +305,14 @@ module Sunspot #:nodoc:
       end
 
       module InstanceMethods
+        def self.included(base) #:nodoc:
+          base.module_eval do
+            alias_method :index, :solr_index unless method_defined? :index
+            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!
+          end
+        end
         # 
         # Index the model in Solr. If the model is already indexed, it will be
         # updated. Using the defaults, you will usually not need to call this
@@ -283,14 +321,14 @@ module Sunspot #:nodoc:
         # ClassMethods#searchable), this method allows you to manage indexing
         # manually.
         #
-        def index
+        def solr_index
           Sunspot.index(self)
         end
 
         # 
         # Index the model in Solr and immediately commit. See #index
         #
-        def index!
+        def solr_index!
           Sunspot.index!(self)
         end
         
@@ -301,7 +339,7 @@ module Sunspot #:nodoc:
         # (which is not recommended!), you can use this method to manage removal
         # manually.
         #
-        def remove_from_index
+        def solr_remove_from_index
           Sunspot.remove(self)
         end
 
@@ -309,7 +347,7 @@ module Sunspot #:nodoc:
         # Remove the model from the Solr index and commit immediately. See
         # #remove_from_index
         #
-        def remove_from_index!
+        def solr_remove_from_index!
           Sunspot.remove!(self)
         end
 
@@ -327,7 +365,7 @@ module Sunspot #:nodoc:
 
         def maybe_auto_index
           if @marked_for_auto_indexing
-            index
+            solr_index
             remove_instance_variable(:@marked_for_auto_indexing)
           end
         end

data/lib/sunspot/rails/server.rb

@@ -91,6 +91,20 @@ module Sunspot
         File.join(::Rails.root, 'log', "sunspot-solr-#{::Rails.env}.log")
       end
 
+      # 
+      # Minimum Java heap size for Solr
+      #
+      def min_memory
+        configuration.min_memory
+      end
+
+      # 
+      # Maximum Java heap size for Solr
+      #
+      def max_memory
+        configuration.max_memory
+      end
+
       private
 
       #

data/lib/sunspot/rails/tasks.rb

@@ -28,10 +28,10 @@ namespace :sunspot do
   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? }
+    sunspot_models = all_models.select { |m| m < ActiveRecord::Base and m.solr_searchable? }
 
     sunspot_models.each do |model|
-      model.reindex :batch_commit => false
+      model.solr_reindex :batch_commit => false
     end
   end
 end

data/lib/sunspot/rails/version.rb

@@ -1,5 +1,5 @@
 module Sunspot
   module Rails
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

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

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

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

@@ -1,5 +1,8 @@
 class Post < ActiveRecord::Base
+  belongs_to :location
+
   searchable :auto_index => false, :auto_remove => false do
     string :title
+    coordinates :location
   end
 end

data/spec/mock_app/config/sunspot.yml

@@ -16,4 +16,4 @@ config_test:
     pid_path: /my_superior_path/pids
     solr_home: /my_superior_path
   auto_commit_after_request: false
-  auto_commit_after_delete_request: true
+  auto_commit_after_delete_request: true

data/spec/mock_app/db/schema.rb

@@ -2,11 +2,17 @@ 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

data/spec/model_lifecycle_spec.rb

@@ -26,14 +26,14 @@ describe 'searchable with lifecycle' do
     it "should index model if relevant attribute changed" do
       @post = PostWithAuto.create!
       @post.title = 'new title'
-      @post.should_receive :index
+      @post.should_receive :solr_index
       @post.save!
     end
 
     it "should not index model if relevant attribute not changed" do
       @post = PostWithAuto.create!
       @post.updated_at = Date.tomorrow
-      @post.should_not_receive :index
+      @post.should_not_receive :solr_index
       @post.save!
     end
   end

data/spec/model_spec.rb

@@ -116,7 +116,7 @@ describe 'ActiveRecord mixin' do
     end
     
     it 'should find ActiveRecord objects with an integer, not a string' do
-      Post.should_receive(:find_all_by_id).with([@post.id.to_i], anything).and_return([@post])
+      Post.should_receive(:all).with(hash_including(:conditions => { "id" => [@post.id.to_i] })).and_return([@post])
       Post.search do
         with :title, 'Test Post'
       end.results.should == [@post]
@@ -129,6 +129,24 @@ describe 'ActiveRecord mixin' do
         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(:find).with(anything(), 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(:find).with(anything(), 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(:find).with(anything(), hash_including(:select => 'title, published_at')).and_return([@post])
@@ -154,6 +172,14 @@ describe 'ActiveRecord mixin' do
       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 { near([40.0, -70.0], :distance => 1) }.results.should == [post]
+    end
+
   end
 
   describe 'search_ids()' do

data/spec/schema.rb

@@ -2,11 +2,17 @@ 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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Mat Brown
@@ -16,11 +16,13 @@ authors:
 - Adam Salter
 - Brandon Keepers
 - Paul Canavese
+- John Eberly
+- Gert Thiel
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 -05:00
+date: 2010-03-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,8 +35,8 @@ dependencies:
         segments: 
         - 1
         - 0
-        - 1
-        version: 1.0.1
+        - 2
+        version: 1.0.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -117,6 +119,7 @@ files:
 - spec/mock_app/app/controllers/posts_controller.rb
 - spec/mock_app/app/controllers/application_controller.rb
 - spec/mock_app/app/controllers/application.rb
+- spec/mock_app/app/models/location.rb
 - spec/mock_app/app/models/photo_post.rb
 - spec/mock_app/app/models/blog.rb
 - spec/mock_app/app/models/post_with_auto.rb