Merge pull request sunspot#18 from crowdint/master

Define Hit#to_param to play nicely with Rails URL helpers.

sunspot/lib/sunspot/search/hit.rb

@@ -96,6 +96,20 @@ def inspect #:nodoc:
         "#<Sunspot::Search::Hit:#{@class_name} #{@primary_key}>"
       end
 
+      #
+      # Returns the instance primary key when the Hit is used to generate urls
+      # For example, using a search that stores the :name attribute:
+      #
+      #   hits = Sunspot.search(Object) do ...
+      #
+      #   hits.each do |hit|
+      #     link_to hit.stored(:name), edit_object_path(hit)
+      #   end
+      #
+      def to_param
+        self.primary_key
+      end
+
       private
 
       def setup

sunspot/spec/api/search/hits_spec.rb

@@ -32,6 +32,12 @@
     session.search(Post).hits.first.instance.should == posts.first
   end
 
+  it 'should return the instance primary key when you use it as a param' do
+    posts = Array.new(2) { Post.new }
+    stub_results(*posts)
+    session.search(Post).hits.first.to_param.should == posts.first.id.to_s
+  end
+
   it 'should provide iterator over hits with instances' do
     posts = Array.new(2) { Post.new }
     stub_results(*posts)