lib/datapipes/source.rb in datapipes-0.1.3 vs lib/datapipes/source.rb in datapipes-0.1.4

@@ -1,23 +1,39 @@
 class Datapipes
-  #
   # Build your own source logic in `run` method.
   # Use `produce` method to emitt data to pipe.
   #
   #   def run
   #     10.times {|i| produce(i) }
   #   end
   #
+  # You can use infinitie stream like:
+  #
+  #   def run
+  #     twitter_client.userstream do |event|
+  #       produce(event)
+  #     end
+  #   end
+  #
   class Source
     include Composable
 
-    attr_accessor :pipe
+    # Override in sub class.
+    def run
+    end
 
+    # For internal used.
+    #
+    # Run accumulated sources which are set by composition.
+    # Each source works in new thread.
     def run_all
       @accumulated ||= [self]
       set_pipe
       @accumulated.map {|s| Thread.new { s.run } }
     end
+
+    # For internal uses. Do not touch.
+    attr_accessor :pipe
 
     private
 
     def produce(data)
       @pipe.recieve(data)