0
@@ -1,20 +1,35 @@
0
 require "ropen"
0
 
0
-# TODO: document me
0
-
0
+# A recorder/replayer for messages sent to a receiver. Allows clients to spool a
0
+# series of messages which can then be sent in order to a specified receiver.
0
+# 
0
+# ==== Examples
0
+#   
0
+#   receiver = "You "
0
+#   spool = Ropen::Spool.new
0
+#   spool << " and me."
0
+#   spool.upcase!
0
+#   spool.replay(receiver)
0
+#   receiver #=> "YOU AND ME."
0
+#   
0
 class Ropen::Spool
0
+  
0
+  # Creates a new, empty spool.
0
   def initialize
0
     @messages = []
0
   end
0
   
0
+  # Registers the method call as a message to send to the eventual receiver.
0
   def method_missing(m, *args, &block)
0
     @messages << [m, args, block]
0
   end
0
   
0
-  def replay(stream)
0
+  # Sends all spooled messages to +receiver+, in order. Once a message is sent,
0
+  # it's removed from the spool.
0
+  def replay(receiver)
0
     while message = @messages.shift
0
       m, args, block = message
0
-      stream.send(m, *args, &block)
0
+      receiver.send(m, *args, &block)
0
     end
0
   end
0
 end