outoftime-sunspot 0.7.2 → 0.7.3

data/README.rdoc

@@ -10,9 +10,7 @@ features for indexing objects and searching against them.
 Sunspot is designed to be easily plugged in to any ORM, or even non-database-backed
 objects such as the filesystem.
 
-Sunspot is currently under active development and is not feature-complete.
-
-=== Sunspot already has these features:
+=== Features:
 
 * Define indexing strategy for each searchable class using intuitive block-based API
 * Clean separation between keyword-searchable fields and fields for scoping/ordering
@@ -24,13 +22,6 @@ Sunspot is currently under active development and is not feature-complete.
 * Full compatibility with will_paginate
 * Ordering
 
-=== Sunspot will have these features:
-
-* Adapters for DataMapper, ActiveRecord, and File objects
-* High-power integration with ORM features for maximum efficiency (e.g., specify AR :include argument for eager loading associations when hydrating search results)
-* Define association facets, which return model objects as row values
-* Plugins for drop-in integration with Merb and Rails
-
 == Installation
 
   gem sources -a http://gems.github.com
@@ -47,6 +38,11 @@ You can change the URL at which Sunspot accesses Solr with:
 
   Sunspot.config.solr.url = 'http://solr.my.host:9818/solr'
 
+== Rails Integration
+
+The {Sunspot::Rails}[http://github.com/outoftime/sunspot_rails] plugin makes
+integrating Sunspot into Rails drop-in easy.
+
 == Using Sunspot
 
 === Define an index:
@@ -109,15 +105,24 @@ me so I can rectify the situation!
 1. solr-ruby
 2. Java
 
+== Bugs
+
+Please submit bug reports to
+http://outoftime.lighthouseapp.com/projects/20339-sunspot
+
 == Further Reading
 
 Posts about Sunspot from my tumblog: http://outofti.me/tagged/sunspot
 
+== Contributors
+
+Mat Brown <mat@patch.com>
+
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2008 Mat Brown
+Copyright (c) 2008-2009 Mat Brown
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/TODO

@@ -1,4 +1,5 @@
 === 0.8 ===
+* Expose Query as part of public API
 * Facet by type
 * Dynamic fields
 * ActiveRecord, DataMapper, File adapters

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 2
+:patch: 3
 :major: 0
 :minor: 7

data/lib/sunspot/adapters.rb

@@ -94,13 +94,19 @@ module Sunspot
         #
         # Class:: Subclass of InstanceAdapter, or nil if none found
         #
+        # ==== Raises
+        #
+        # Sunspot::NoAdapterError:: If no adapter is registered for this class
+        #
         def for(clazz) #:nodoc:
+          original_class_name = clazz.name
           while clazz != Object
             class_name = clazz.name.to_sym
             return instance_adapters[class_name] if instance_adapters[class_name]
             clazz = clazz.superclass
           end
-          nil
+          raise(Sunspot::NoAdapterError,
+                "No adapter is configured for #{original_class_name} or its superclasses. See the documentation for Sunspot::Adapters")
         end
 
         protected

data/lib/sunspot/session.rb

@@ -68,6 +68,14 @@ module Sunspot
       end
     end
 
+    # 
+    # See Sunspot.remove!
+    #
+    def remove!(*objects)
+      remove(*objects)
+      commit
+    end
+
     #
     # See Sunspot.remove_all
     #
@@ -84,6 +92,14 @@ module Sunspot
       end
     end
 
+    # 
+    # See Sunspot.remove_all!
+    #
+    def remove_all!(*classes)
+      remove_all(*classes)
+      commit
+    end
+
     # 
     # See Sunspot.dirty?
     #
@@ -112,7 +128,7 @@ module Sunspot
     # Sunspot::Setup:: The setup for the object's class
     #
     def setup_for(object)
-      Setup.for(object.class) || raise(ArgumentError, "Sunspot is not configured for #{object.class.inspect}")
+      Setup.for(object.class) || raise(NoSetupError, "Sunspot is not configured for #{object.class.inspect}")
     end
 
     # 

data/lib/sunspot.rb

@@ -24,6 +24,8 @@ end
 module Sunspot
   UnrecognizedFieldError = Class.new(Exception)
   UnrecognizedRestrictionError = Class.new(Exception)
+  NoAdapterError = Class.new(Exception)
+  NoSetupError = Class.new(Exception)
 
   class <<self
     # Configures indexing and search for a given class.
@@ -225,9 +227,21 @@ module Sunspot
       session.remove(*objects)
     end
 
+    # 
+    # Remove objects from the index and immediately commit. See Sunspot.remove
+    #
+    # ==== Parameters
+    #
+    # objects...<Object>:: Objects to remove from the index
+    #
+    def remove!
+      session.remove!(*objects)
+    end
+
     # Remove all objects of the given classes from the index. There isn't much
     # use for this in general operations but it can be useful for maintenance,
-    # testing, etc.
+    # testing, etc. If no arguments are passed, remove everything from the
+    # index.
     #
     # ==== Parameters
     #
@@ -243,6 +257,18 @@ module Sunspot
       session.remove_all(*classes)
     end
 
+    # 
+    # Remove all objects of the given classes from the index and immediately
+    # commit. See Sunspot.remove_all
+    #
+    # ==== Parameters
+    #
+    # classes...<Class>::
+    #   classes for which to remove all instances from the index
+    def remove_all!(*classes)
+      session.remove_all(*classes)
+    end
+
     #
     # True if documents have been added, updated, or removed since the last
     # commit.

data/spec/api/indexer_spec.rb

@@ -92,11 +92,23 @@ describe 'indexer' do
       session.remove(post)
     end
 
-    it 'should be able to remove everything from the index' do
+    it 'should remove an object from the index and immediately commit' do
+      connection.should_receive(:delete).with("Post #{post.id}").ordered
+      connection.should_receive(:commit).ordered
+      session.remove!(post)
+    end
+
+    it 'should remove everything from the index' do
       connection.should_receive(:delete_by_query).with("type:[* TO *]")
       session.remove_all
     end
 
+    it 'should remove everything from the index and immediately commit' do
+      connection.should_receive(:delete_by_query).with("type:[* TO *]").ordered
+      connection.should_receive(:commit).ordered
+      session.remove_all!
+    end
+
     it 'should be able to remove everything of a given class from the index' do
       connection.should_receive(:delete_by_query).with("type:Post")
       session.remove_all(Post)
@@ -113,7 +125,7 @@ describe 'indexer' do
   end
 
   it 'should throw an ArgumentError if an attempt is made to index an object that has no configuration' do
-    lambda { session.index(Time.now) }.should raise_error(ArgumentError)
+    lambda { session.index(Time.now) }.should raise_error(Sunspot::NoSetupError)
   end
 
   it 'should throw an ArgumentError if single-value field tries to index multiple values' do
@@ -123,6 +135,10 @@ describe 'indexer' do
     end.should raise_error(ArgumentError)
   end
 
+  it 'should throw a NoAdapterError if class without adapter is indexed' do
+    lambda { session.index(User.new) }.should raise_error(Sunspot::NoAdapterError)
+  end
+
   private
 
   def config

data/spec/mocks/user.rb

@@ -0,0 +1,8 @@
+class User
+  attr_accessor :name
+end
+
+Sunspot.setup(User) do
+  text :name
+  string :name
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: outoftime-sunspot
 version: !ruby/object:Gem::Version 
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors: 
 - Mat Brown
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-29 00:00:00 -07:00
+date: 2009-05-06 00:00:00 -07:00
 default_executable: sunspot-solr
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ files:
 - spec/mocks
 - spec/mocks/base_class.rb
 - spec/mocks/mock_adapter.rb
+- spec/mocks/user.rb
 - spec/mocks/post.rb
 - spec/mocks/comment.rb
 - spec/api