datapipes 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82f3fba797ae0fadf73b45ab5ac99cba0ba46e6c
-  data.tar.gz: 84f76e38c7fa6db3b3abfc50b4bbed1ece5a8ac0
+  metadata.gz: b69f0bd0a67b11610394bb01fe5d5e3dccb5da8b
+  data.tar.gz: 1f171ea4c6f63989795bfb1cb22da5cbbb732cc5
 SHA512:
-  metadata.gz: cc97e582f356284a454d697efb5bf12407b74bf25e6c388201cd1a76a66b46f87aad85ba6980ca3fc4738c4a45407b260716264ce4b8b37c1fd0de3a9243f37f
-  data.tar.gz: c92abd412d2d980ac9f4362940524c88424108acb9bd20a4187dd74f5fda5097ac8649afaba498c8490022ab4957870780e6023c293343a4fe40130a39d1920e
+  metadata.gz: b283617335d62edffd27f34c69deca578481788e381766f9dc54adbc7742495bffa7f132c0b769f79c922d660b4e775744e6c8b14e87cc619deefc96e34a51e5
+  data.tar.gz: a1cfdeadae7ba85c47cc2c2cbbdb1ff2b594e186bd0391913a546ec0b0e8ceadf175d632856b7bce74403050088dc7b3e52707a127f58df3481d719ae38d6e12

data/README.md

@@ -1,6 +1,49 @@
 datapipes [![Build Status](https://travis-ci.org/taiki45/datapipes.svg?branch=master)](https://travis-ci.org/taiki45/datapipes)
 =========
-datapipes is multi-streaming library.
+datapipes is an asynchronous multi streaming library.
+
+## About
+datapipes encourages to handle multi streamings asynchronously. datapipes has
+a few objects sparated by its responsibility.
+
+- __Source__ Produces resources and emits the resource to pipe.
+- __Tube__ Effector for resources. Processes resource in the middle of pipe.
+- __Sink__ Consumer for resources. Do something with processed resources.
+- __Pipe__ Resources pass through the pipe. Handles resources asynchronously.
+
+```
+ Source
+   |   ↓ data flow
+   |
+  Tube
+   |    pipe is '|'
+   |
+Consumer
+```
+
+To handle multi streamings, datapipes offers composabiliy. Source, Tube and Sink
+are composable individually. So the diagram above will be:
+
+```
+ Composed Source works asynchronously
+
+  [Source Source Source]
+            |
+            |  pipe handles asynchronous
+            |
+           Tube
+           Tube  Composed Tube has individual tube in series
+           Tube
+           Tube
+            |
+            |
+            |
+           Sink
+           Sink
+           Sink
+
+ Composed Sink works synchronously
+```
 
 ## Installation
 
@@ -17,8 +60,85 @@ Or install it yourself as:
     $ gem install datapipes
 
 ## Usage
+You have to define your own Source, Tube and Sink.
+
+A basic source is list type. it produces a value in several times.
+Use `produce` method to emit data to pipe.
+
+```ruby
+class List < Datapipes::Source
+  def run
+    (1..10).each {|i| produce(i) }
+  end
+end
+```
+
+Next is tube. Tube processes piped data. A example tube recieve
+Integer value then increase amount of the value.
+
+Define `accept?` to recieve the data or skip this.
+
+```ruby
+class Triple < Datapipes::Tube
+  def run(data)
+    [data, data, data]
+  end
+
+  def accept?(data)
+    data.is_a? Integer and data > 3
+  end
+end
+```
+
+Sink consumes piped data. A typical sink is printing data.
+
+```ruby
+class Print < Datapipes::Sink
+  def run(data)
+    puts data
+  end
+
+  def accept?(data)
+    data.is_a? Array and data[0] < 7
+  end
+end
+```
+
+You can make your own datapipe with your objects.
+
+```ruby
+datapipe = Datapipes.new(
+  List.new,           # A source
+  Triple.new,         # A tube
+  Print.new,          # A sink
+  Datapipes::Pipe.new # A pipe
+)
+```
+
+Then just run everything with `run_resource`.
+
+```ruby
+datapipe.run_resource
+```
+
+The output will be:
+
+```
+4
+4
+4
+5
+5
+5
+6
+6
+6
+```
+
+Congratulation!!
 
-TODO: Write usage instructions here
+### Composing objects
+TODO...
 
 ## Contributing
 

data/datapipes.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Datapipes::VERSION
   spec.authors       = ['Taiki ONO']
   spec.email         = ['taiks.4559@gmail.com']
-  spec.summary       = %q{A library for processing steamings.}
-  spec.description   = %q{A library for processing steamings.}
+  spec.summary       = %q{An asynchronous multi steamings library.}
+  spec.description   = %q{To handle multi steamings easily.}
   spec.homepage      = 'https://github.com/taiki45/datapipes'
   spec.license       = 'MIT'
 

data/examples/basics.rb

@@ -0,0 +1,36 @@
+require 'datapipes'
+
+class List < Datapipes::Source
+  def run
+    (1..10).each {|i| produce(i) }
+  end
+end
+
+class Triple < Datapipes::Tube
+  def run(data)
+    [data, data, data]
+  end
+
+  def accept?(data)
+    data.is_a? Integer and data > 3
+  end
+end
+
+class Print < Datapipes::Sink
+  def run(data)
+    puts data
+  end
+
+  def accept?(data)
+    data.is_a? Array and data[0] < 7
+  end
+end
+
+datapipe = Datapipes.new(
+  List.new,           # A source
+  Triple.new,         # A tube
+  Print.new,          # A sink
+  Datapipes::Pipe.new # A pipe
+)
+
+datapipe.run_resource

data/lib/datapipes/version.rb

@@ -1,3 +1,3 @@
 class Datapipes
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/datapipes.rb

@@ -24,7 +24,7 @@ class Datapipes
     runners.each(&:join)
 
     notify_resource_ending
-    consumer.join if consumer.status == "run"
+    graceful_down(consumer)
   end
 
   private
@@ -37,14 +37,22 @@ class Datapipes
         data = @tube.run_all(@pipe.pull)
         @sink.run_all(data)
       end
+      Thread.current.kill
     end
   end
 
   def notify_resource_ending
     @flag.enq true
+    Thread.pass
   end
 
   def resource_ended?
     !@flag.empty?
   end
+
+  def graceful_down(consumer)
+    sleep 0.1
+    consumer.kill if consumer.status == 'sleep'
+    consumer.join
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datapipes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Taiki ONO
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A library for processing steamings.
+description: To handle multi steamings easily.
 email:
 - taiks.4559@gmail.com
 executables: []
@@ -80,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - datapipes.gemspec
+- examples/basics.rb
 - lib/datapipes.rb
 - lib/datapipes/basics.rb
 - lib/datapipes/basics/list.rb
@@ -117,7 +118,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A library for processing steamings.
+summary: An asynchronous multi steamings library.
 test_files:
 - spec/basics_spec.rb
 - spec/composable_spec.rb