datapipes 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8abb0451500188b58038dbb2731ff2fcb8977f4b
-  data.tar.gz: 7f6348febf36db66e7939bca687b820f5a029fe4
+  metadata.gz: 1863bd8ffe4af8833093199f29b332f3911067c9
+  data.tar.gz: df0e6af9d83caa8fdb684d32c16bcd314d35fa51
 SHA512:
-  metadata.gz: 43ba18b6df1af0b1118ac7c39c719d0f7d63160cd90247e1e2a0b4dd8baf3992a888fede632491d7f276b949b07910f327f761758f719e4ff36604626e3db385
-  data.tar.gz: 413545e4c611a78e48f98ce0cfb791003b7ae9512b16adee0535159e49cd30368c81b6a2671e7bc62179cd1ae52984de6ebd1846a31a2b9f1973aa90faeb4a6f
+  metadata.gz: 62eb3d70c73d90635e49100cd2153803dc8642419a8c94f32b87e6c59eb994c04b1bce2a0d96312900f103945db36364740a6128498541a71d32b84d6231b600
+  data.tar.gz: 14f92a41066e77e14087378e53c62834540383bfebef660d69bd53491210f1112e2b02e8e6a62a7c33e1218a40c5b0dcb2e886860d6ad4e6b10d07fde5795085

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 2.1
   - 2.0
+  - 1.9.3
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.5
+- Change Pipe API name: recieve -> pour_in, pull -> pour_out
+- Change Datapipes.new API: all arguments must be given as a Hash.
+- Revival Ruby 1.9.3 supports.
+
 ## 0.1.4
 - Add documents.
 

data/README.md

@@ -23,7 +23,7 @@ a few objects sparated by its responsibility.
   Sink
 ```
 
-To handle multi streamings, datapipes offers composabiliy. Source, Tube and Sink
+To handle multi streamings, datapipes offers composability. Source, Tube and Sink
 are composable individually. So the diagram above will be:
 
 ```
@@ -45,6 +45,8 @@ are composable individually. So the diagram above will be:
  Composed Sink works concurrently.
 ```
 
+You can see how to compose objects in `examples/composing.rb`.
+
 ## Installation
 __datapipes requires Ruby >= 2.0.__
 

data/examples/basics.rb

@@ -10,8 +10,8 @@ require 'print'
 # Then you can make your own datapipe with your objects.
 #
 datapipe = Datapipes.new(
-  List.new,        # A source
-  Print.new,       # A sink
+  source: List.new,
+  sink: Print.new,
   tube: Triple.new,
 )
 

data/examples/composing.rb

@@ -16,8 +16,8 @@ tube = Mul.new >> Triple.new
 sink = acc + rev_acc
 
 datapipe = Datapipes.new(
-  source,
-  sink,
+  source: source,
+  sink: sink,
   tube: tube
 )
 

data/lib/datapipes.rb

@@ -12,13 +12,23 @@ class Datapipes
   # Pass datapipes components instances.
   # Each component can be composed. See detail in examples.
   #
-  # tube and pipe are optional.
-  # If not given tube, a default tube which takes no effect is used.
-  def initialize(source, sink, tube: Tube.new, pipe: Pipe.new)
-    @source = source
-    @tube = tube
-    @sink = sink
-    @pipe = pipe
+  # Pass parameters as a hash:
+  #
+  #   datapipe = Datapipes.new(source: my_source, sink: my_sink)
+  #
+  # Or pass all:
+  #
+  #   datapipe = Datapipes.new(
+  #     source: my_source,
+  #     sink: my_sink,
+  #     tube: my_tube,
+  #     pipe: my_pipe
+  #   )
+  #
+  # All arguments are  optional. But in most case, you specify
+  # source and sink.
+  def initialize(args = {})
+    @source, @sink, @tube, @pipe = *ArgParser.extract(args)
   end
 
   # Run sources, data flow via pipe, tubes and sinks work.
@@ -30,19 +40,19 @@ class Datapipes
     @source.pipe = @pipe
     runners = @source.run_all
 
-    consumer = run_comsumer
+    sink = run_sink
     runners.each(&:join)
 
     notify_resource_ending
-    consumer.join
+    sink.join
   end
 
   private
 
-  def run_comsumer
+  def run_sink
     Thread.new do
       loop do
-        data = @pipe.pull
+        data = @pipe.pour_out
         break if resource_ended?(data)
 
         @sink.run_all(@tube.run(data))
@@ -51,7 +61,7 @@ class Datapipes
   end
 
   def notify_resource_ending
-    @pipe.recieve Notification.new
+    @pipe.pour_in Notification.new
   end
 
   def resource_ended?(data)
@@ -59,4 +69,14 @@ class Datapipes
   end
 
   Notification = Class.new
+
+  module ArgParser
+    def self.extract(args)
+      source = args[:source] || Source.new
+      sink = args[:sink] || Sink.new
+      tube = args[:tube] || Tube.new
+      pipe = args[:pipe] || Pipe.new
+      [source, sink, tube, pipe]
+    end
+  end
 end

data/lib/datapipes/pipe.rb

@@ -7,8 +7,8 @@ class Datapipes
   # If you make your own, you can override _initialize_, because
   # this is not used in internal.
   #
-  # Then supply _recieve_ and _pull_. _pull_ must cause thread blocking
-  # when it is empty.
+  # Then supply _pour_in_ and _pour_out_. _pour_out_ must occur
+  # thread blocking when it is empty.
   class Pipe
     # You can override and don't need to call super in sub class.
     def initialize
@@ -16,12 +16,12 @@ class Datapipes
     end
 
     # Emit data to pipe.
-    def recieve(data)
+    def pour_in(data)
       @queue.enq data
     end
 
-    # _pull_ must cause thread blocking when it is empty.
-    def pull
+    # _pour_out_ must cause thread blocking when it is empty.
+    def pour_out
       @queue.deq
     end
   end

data/lib/datapipes/source.rb

@@ -37,7 +37,7 @@ class Datapipes
     private
 
     def produce(data)
-      @pipe.recieve(data)
+      @pipe.pour_in(data)
     end
 
     def set_pipe

data/lib/datapipes/version.rb

@@ -1,3 +1,3 @@
 class Datapipes
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/basics_spec.rb

@@ -11,8 +11,8 @@ describe 'basic function' do
 
   let(:datapipe) do
     Datapipes.new(
-      List.new,
-      Print.new,
+      source: List.new,
+      sink: Print.new,
       tube: Triple.new
     )
   end

data/spec/composing_spec.rb

@@ -18,8 +18,8 @@ describe 'composability' do
 
   let(:datapipe) do
     Datapipes.new(
-      source,
-      sink,
+      source: source,
+      sink: sink,
       tube: tube
     )
   end

data/spec/intact_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'intact objects' do
+  let(:datapipe) do
+    Datapipes.new
+  end
+
+  it 'runs but occurs nothing' do
+    expect { datapipe.run_resource }.not_to raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -4,9 +4,13 @@ require 'stringio'
 require 'coveralls'
 require 'simplecov'
 Coveralls.wear!
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start do
   add_filter 'spec'
+  add_filter 'examples'
 end
 
 $: << File.expand_path('../../lib', __FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datapipes
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Taiki ONO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -143,6 +143,7 @@ files:
 - lib/datapipes/version.rb
 - spec/basics_spec.rb
 - spec/composing_spec.rb
+- spec/intact_spec.rb
 - spec/sink_spec.rb
 - spec/spec_helper.rb
 - spec/tube_spec.rb
@@ -173,6 +174,7 @@ summary: An asynchronous multi steamings library.
 test_files:
 - spec/basics_spec.rb
 - spec/composing_spec.rb
+- spec/intact_spec.rb
 - spec/sink_spec.rb
 - spec/spec_helper.rb
 - spec/tube_spec.rb