stages 0.1.2 → 0.2.0

data/README.md

@@ -8,10 +8,15 @@ Initial code stolen shamelessly from http://pragdave.blogs.pragprog.com/pragdave
 Usage
 -----
 
-You knit your stages together with '|'.  The leftmost pipeline stage will be contain a generator, which usually is an infinite loop.  For ean example, look at evens.rb in our sample stages collection.  If you wanted to output, for example, every even number divisible by 3, you might do:
+You knit your stages together with '|'.  The leftmost pipeline stage will contain a generator, which usually is an infinite loop.  
+
+Example
+-------
+
+Image you wanted to output every even number divisible by 3.  First you would need a class that would output even numbers.  Then you would want to select the ones that are divisible by 3.  A simple implementation using stages would like this
 
 ```ruby
-pipeline = Evens.new | MultiplesOf.new(3)
+pipeline = Evens.new | Select.new{ |x| x % 3 == 0}
 loop { puts pipeline.run }
 ```
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'bundler'
 begin
-  Bundler.setup(:default, :development)
+  Bundler.setup(:default, :test)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/examples/sing_custom_stages.rb

@@ -38,11 +38,12 @@ def setup_pipeline
   
   each_character = Each.new{ |x| x.chars }
   trim_whitespace = Select.new{ |x| x != ' '}
-  letters_in_each_line = SubStage.new(get_lyric | each_character | trim_whitespace)
+  letters_in_each_line = Wrap.new(get_lyric | each_character | trim_whitespace)
+  each_letter = Each.new
   each_note = Generator.new(@lyrics.keys)
   count_everything = Count.new
   
-  each_note | letters_in_each_line | count_everything
+  each_note | letters_in_each_line | each_letter | count_everything
 end
 
 puts setup_pipeline.run.inspect

data/examples/sing_subpipes.rb

@@ -18,14 +18,24 @@ def setup_pipeline
   
   each_character = Each.new{ |x| x.chars }
   trim_whitespace = Select.new{ |x| x != ' '}
-  letters_in_each_line = SubStage.new(get_lyric | each_character | trim_whitespace)
+  letters_in_each_line = Wrap.new(get_lyric | each_character | trim_whitespace)
   each_note = Each.new @lyrics.keys
   count_everything = Count.new
+  each_letter = Each.new
   
-  each_note | letters_in_each_line | count_everything
+  
+  each_note | letters_in_each_line | each_letter | count_everything
 end
 
 puts setup_pipeline.run.inspect
 
+puts "one line at a time"
+lyrics = Each.new(@lyrics.keys)
+letters_in_chunks = Wrap.new(Map.new{ |x| @lyrics[x]} | Each.new{ |x| x.chars}).with_hash
+each_letter = Each.new{ |x| x.values.first }
+count = Count.new
+
+p2 = lyrics | letters_in_chunks | each_letter | count
 
+puts p2.run.inspect
 

data/lib/stages/wrap.rb

@@ -0,0 +1,34 @@
+module Stages
+  class Wrap < Stage    
+    def initialize(pipeline)
+      @pipeline = pipeline
+      @cache = []
+      @output_style = :hash
+      super()
+    end
+    
+    def array
+      @output_style = :array
+      self
+    end
+    
+    def each
+      @output_style = :each
+      self
+    end
+    
+    def process
+      while value = input
+        subpipe = Emit.new(value) | @pipeline
+        results = []
+        while v = subpipe.run
+          @output_style == :each ? output(v) : results << v
+        end        
+        output results if @output_style == :array
+        output({ value => results}) if @output_style == :hash
+        @pipeline.drop_leftmost!
+        @pipeline.continue
+      end
+    end
+  end  
+end

data/stages.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "stages"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["The Justice Eight"]
-  s.date = "2012-01-14"
+  s.date = "2012-01-16"
   s.description = "pipeline builder"
   s.email = "support@igodigital.com"
   s.extra_rdoc_files = [
@@ -30,13 +30,12 @@ Gem::Specification.new do |s|
     "lib/stages/count.rb",
     "lib/stages/each.rb",
     "lib/stages/emit.rb",
-    "lib/stages/evens.rb",
     "lib/stages/map.rb",
     "lib/stages/restrict.rb",
     "lib/stages/resume.rb",
     "lib/stages/resume_count.rb",
     "lib/stages/select.rb",
-    "lib/stages/sub_stage.rb",
+    "lib/stages/wrap.rb",
     "stages.gemspec",
     "test/helper.rb",
     "test/test_pipeline.rb",

data/test/helper.rb

@@ -5,6 +5,18 @@ require 'stages'
 require 'turn'
 require 'minitest/unit'
 
+module Stages
+  class Evens < Stage
+    def process 
+      value = 0
+      loop do
+        output(value)
+        value += 2
+      end
+    end
+  end
+end
+
 class MiniTest::Unit::TestCase
   def self.test(name, &block)
     define_method 'test_' + name, &block

data/test/test_pipeline.rb

@@ -42,6 +42,20 @@ class TestPipeline < MiniTest::Unit::TestCase
       result << v
     end
     assert_equal([1, 2], result)    
-  end  
+  end    
+  
+  test 'complex substage hash example' do
+    sub = Each.new{ |x| x.chars } | Map.new{ |x| x.to_sym} | Count.new
+    pipeline = Each.new(%w(foo bar)) | Wrap.new(sub) | Map.new{ |x| { x.keys.first => x.values.first.first}}
+    result = pipeline.run
+    assert_equal({'foo' => { :f => 1, :o => 2}}, result)
+    result = pipeline.run
+    assert_equal({ 'bar' => { :b => 1, :a => 1, :r => 1}}, result)
+  end
+  
+  test 'reset! resets everything' do
+    assert false
+    #todo
+  end
 
 end

data/test/test_stages.rb

@@ -69,22 +69,28 @@ class TestStages < MiniTest::Unit::TestCase
     assert_equal({ 'foo' => { :f => 1, :o => 2}}, result)
   end
   
-  test 'substage instead of resume' do
-    sub = Each.new{ |x| x.chars } | Map.new{ |x| x.to_sym} | Count.new
-    pipeline = Each.new(%w(foo bar)) | SubStage.new(sub).with_hash | Map.new{ |x| x.values.first}
+  test 'hash mode wrap' do
+    pipeline = Each.new(%w(foo bar)) | Wrap.new(Each.new{ |x| x.chars})
     result = pipeline.run
-    assert_equal({ :f => 1, :o => 2}, result)
+    assert_equal(%w(f o o), result['foo'])
     result = pipeline.run
-    assert_equal({ :b => 1, :a => 1, :r => 1}, result)
+    assert_equal(%w(b a r), result['bar'])
   end
   
-  test 'substage with key and result' do
-    sub = Each.new{ |x| x.chars } | Map.new{ |x| x.to_sym} | Count.new
-    pipeline = Each.new(%w(foo bar)) | SubStage.new(sub).with_hash
+  test 'array mode wrap' do
+    pipeline = Each.new(%w(foo bar)) | Wrap.new(Each.new{ |x| x.chars}).array
     result = pipeline.run
-    assert_equal({'foo' => { :f => 1, :o => 2}}, result)
+    assert_equal(%w(f o o), result)
     result = pipeline.run
-    assert_equal({ 'bar' => { :b => 1, :a => 1, :r => 1}}, result)
+    assert_equal(%w(b a r), result)
+  end
+  
+  test 'each mode wrap' do
+    pipeline = Each.new(%w(foo bar)) | Wrap.new(Each.new{ |x| x.chars}).each
+    expected = %w(r a b o o f)
+    while r = pipeline.run
+      assert_equal(expected.pop, r)
+    end    
   end
   
   def sing

metadata

@@ -2,7 +2,7 @@
 name: stages
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - The Justice Eight
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-14 00:00:00 Z
+date: 2012-01-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -46,13 +46,12 @@ files:
 - lib/stages/count.rb
 - lib/stages/each.rb
 - lib/stages/emit.rb
-- lib/stages/evens.rb
 - lib/stages/map.rb
 - lib/stages/restrict.rb
 - lib/stages/resume.rb
 - lib/stages/resume_count.rb
 - lib/stages/select.rb
-- lib/stages/sub_stage.rb
+- lib/stages/wrap.rb
 - stages.gemspec
 - test/helper.rb
 - test/test_pipeline.rb
@@ -70,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1777887051892301360
+      hash: 1341798131382787657
       segments: 
       - 0
       version: "0"

data/lib/stages/evens.rb

@@ -1,11 +0,0 @@
-module Stages
-  class Evens < Stage
-    def process 
-      value = 0
-      loop do
-        output(value)
-        value += 2
-      end
-    end
-  end
-end

data/lib/stages/sub_stage.rb

@@ -1,27 +0,0 @@
-module Stages
-  class SubStage < Stage    
-    def initialize(pipeline)
-      @pipeline = pipeline
-      @cache = []
-      @with_hash = false
-      super()
-    end
-    
-    def with_hash
-      @with_hash = true
-      self
-    end
-    
-    def process
-      while value = input
-        subpipe = Emit.new(value) | @pipeline
-        while v = subpipe.run
-          v = { value => v} if @with_hash
-          output v
-        end
-        @pipeline.drop_leftmost!
-        @pipeline.continue
-      end
-    end
-  end  
-end