stages 0.0.1

data/.autotest

@@ -0,0 +1,10 @@
+Autotest.add_hook(:initialize)  do |at|
+  %w{.git .svn .hg .swp .DS_Store ._* tmp}.each do |exception|
+    at.add_exception(exception)
+  end
+
+  at.add_mapping(%r%^dataprocessing/pipeline(/stages)?/(.*).rb$%, true) do |filename, _|
+    ['test/test_pipeline.rb', 'test/test_stages.rb']
+  end   
+
+end

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://gemcutter.org'
+
+gem 'rake', '=0.9.2'
+
+group :test do
+  gem 'jeweler'
+  gem 'minitest'
+  gem 'ZenTest'
+  gem 'turn'
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://gemcutter.org/
+  specs:
+    ZenTest (4.6.2)
+    ansi (1.4.1)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.10.0)
+    rake (0.9.2)
+    turn (0.8.2)
+      ansi (>= 1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  jeweler
+  minitest
+  rake (= 0.9.2)
+  turn

data/README

@@ -0,0 +1,37 @@
+Stages
+------
+
+A gem for creating data pipelines out of tiny, reusable objects
+
+Initial code stolen shamelessly from http://pragdave.blogs.pragprog.com/pragdave/2008/01/pipelines-using.html
+
+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:
+
+```ruby
+pipeline = Evens.new | MultiplesOf.new(3)
+loop { puts pipeline.run }
+```
+
+We have included some general purpose stages, map and select, which can accomplish many pipeline operations:
+
+```ruby
+pipeline = Evens.new | Map.new{ |x| x * 3} | Select.new{ |x| x % 7 == 0}
+(0..2).map{ |x| pipeline.run } #[0, 42, 84]}
+```
+
+Writing New Stages
+------------------
+
+If you are writing a stage that needs to process an element, you probably want to subclass Stage and implement handle_value.
+
+If you are writing a generator, you probably want to subclass Stage and implement process
+
+Stern Warnings
+--------------
+
+Returning nil from handle_value kills a pipeline.  We may change this behavior in the future, but for now, it makes life easy.
+
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = true
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "stages"
+  gem.homepage = "https://github.com/iGoDigital-LLC/stages"
+  gem.summary = "pipeline builder"
+  gem.description = "pipeline builder"
+  gem.email = "support@igodigital.com"
+  gem.authors = ["Nathan Acuff", "Justin Hill", "Matt Brown", "Kyle Prifogle"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/stage_base.rb

@@ -0,0 +1,47 @@
+module Stages
+  class Stage
+    attr_accessor :source
+    
+    def initialize(&block)
+      @block = block
+      @fiber_delegate = Fiber.new do
+        process
+        die
+      end
+    end
+    
+    def run
+        @fiber_delegate.resume    
+    end
+    
+    def die
+      loop do
+        output nil
+      end
+    end
+    
+    def process
+      while value = input
+        handle_value value
+      end
+    end
+    
+    def handle_value(value)
+      output value
+    end
+    
+    def input
+      source.run
+    end
+    
+    def output(value)
+      Fiber.yield value
+    end
+      
+    def |(other=nil)
+      other.source = self
+      other
+    end
+  end  
+end 
+ 

data/lib/stages.rb

@@ -0,0 +1,3 @@
+require 'stage_base'
+Dir["#{File.dirname(__FILE__)}/stages/*.rb"].each { |file| require file.gsub(".rb", "")}
+

data/lib/stages/each_element.rb

@@ -0,0 +1,14 @@
+module Stages
+  class EachElement < Stage
+    def initialize(things)
+      @things = things
+      super()
+    end
+    
+    def process 
+      @things.each do |thing|
+        output thing 
+      end
+    end
+  end
+end

data/lib/stages/evens.rb

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

data/lib/stages/hash_lookup.rb

@@ -0,0 +1,12 @@
+module Stages
+  class HashLookup < Stage
+    def initialize(things)
+      @things = things
+      super()
+    end
+    
+    def handle_value(value)
+      output @things[value]
+    end
+  end
+end

data/lib/stages/map.rb

@@ -0,0 +1,7 @@
+module Stages
+  class Map < Stage    
+    def handle_value(value)
+      output @block.call(value)
+    end
+  end  
+end

data/lib/stages/multiples_of.rb

@@ -0,0 +1,12 @@
+module Stages
+  class MultiplesOf < Stage
+    def initialize(factor)
+      @factor = factor
+      super()
+    end
+    
+    def handle_value(value)
+      output(value) if value % @factor == 0
+    end 
+  end 
+end

data/lib/stages/select.rb

@@ -0,0 +1,7 @@
+module Stages
+  class Select < Stage 
+    def handle_value(value)
+      output(value) if @block.call(value)
+    end
+  end
+end

data/stages.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "stages"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Acuff", "Justin Hill", "Matt Brown", "Kyle Prifogle"]
+  s.date = "2012-01-13"
+  s.description = "pipeline builder"
+  s.email = "support@igodigital.com"
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".autotest",
+    "Gemfile",
+    "Gemfile.lock",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "lib/stage_base.rb",
+    "lib/stages.rb",
+    "lib/stages/each_element.rb",
+    "lib/stages/evens.rb",
+    "lib/stages/hash_lookup.rb",
+    "lib/stages/map.rb",
+    "lib/stages/multiples_of.rb",
+    "lib/stages/select.rb",
+    "stages.gemspec",
+    "test/helper.rb",
+    "test/test_pipeline.rb",
+    "test/test_stages.rb"
+  ]
+  s.homepage = "https://github.com/iGoDigital-LLC/stages"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "pipeline builder"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, ["= 0.9.2"])
+    else
+      s.add_dependency(%q<rake>, ["= 0.9.2"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["= 0.9.2"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,88 @@
+# -*- coding: utf-8 -*-
+require 'bundler/setup'
+Bundler.require(:default, :test)
+require 'stages'
+require 'turn'
+require 'minitest/unit'
+
+class MiniTest::Unit::TestCase
+  def self.test(name, &block)
+    define_method 'test_' + name, &block
+  end
+end
+
+class MiniTest::Unit
+  alias :run_test_suites_old :run_test_suites
+  def run_test_suites(filter = /./)
+    @test_count, @assertion_count = 0, 0
+    old_sync, @@out.sync = @@out.sync, true if @@out.respond_to? :sync=
+      TestCase.test_suites.each do |suite|
+      test_cases = suite.test_methods.grep(filter)
+      if test_cases.size > 0
+        @@out.print "\n#{suite}:\n"
+      end
+      
+      test_cases.each do |test|
+        inst = suite.new test
+        inst._assertions = 0
+        
+        
+        @broken = nil
+
+        @@out.print(case run_one inst
+                    when :pass
+                      @broken = false
+                      green { "P" }
+                    when :error
+                      @broken = true
+                      @@out.puts
+                      yellow { pad_with_size "ERROR" }
+                    when :fail
+                      @broken = true
+                      @@out.puts
+                      red { pad_with_size "FAIL" }
+                    when :skip
+                      @broken = false
+                      cyan { "S" }
+                    when :timeout
+                      @broken = true
+                      @@out.puts
+                      cyan { pad_with_size "TIMEOUT" }
+                    end)
+
+        if @broken
+          @@out.print MiniTest::Unit.use_natural_language_case_names? ? 
+          " #{test.gsub("test_", "").gsub(/_/, " ")}" : " #{test}"
+          @@out.print " (%.2fs) " % @elapsed
+          @@out.puts
+
+          report = @report.last
+          @@out.puts pad(report[:message], 10)
+          trace = MiniTest::filter_backtrace(report[:exception].backtrace).first
+          @@out.print pad(trace, 10)
+
+          @@out.puts
+        end
+
+        # @@out.puts
+        @test_count += 1
+        @assertion_count += inst._assertions
+      end
+    end
+    @@out.sync = old_sync if @@out.respond_to? :sync=
+      [@test_count, @assertion_count]
+  end
+  
+  def run_one(inst)
+    t = Time.now
+    result = inst.run self
+    @elapsed = Time.now - t
+    if result == :pass && @elapsed > 5.0
+      result = :timeout
+      @report << { :message => "Test took a long time (%.2fs)" % @elapsed, 
+      :exception => Exception.new("Long test")}
+    end
+    result
+  end
+end
+

data/test/test_pipeline.rb

@@ -0,0 +1,56 @@
+require 'helper'
+include Stages
+
+class TestPipeline < MiniTest::Unit::TestCase
+  
+  test 'simple basic pipeline' do
+    evens = Evens.new
+    mx3 = MultiplesOf.new(3)
+    mx7 = MultiplesOf.new(7) 
+    mx3.source = evens 
+    mx7.source = mx3
+    
+    result = (0..2).map{ |x| mx7.run }
+    assert_equal([0, 42, 84], result)
+  end
+  
+  test 'pipeline pipe syntax works' do
+    pipeline = Evens.new | MultiplesOf.new(3) | MultiplesOf.new(7)
+    result = (0..2).map{ |x| pipeline.run }
+    assert_equal([0, 42, 84], result)
+  end
+  
+  test 'block stages work' do
+    pipeline = Evens.new | Map.new{ |x| x * 3} | Select.new{ |x| x % 7 == 0}
+    result = (0..2).map{ |x| pipeline.run }
+    assert_equal([0, 42, 84], result)
+  end
+  
+  test 'exceptions do what you expect' do
+    begin
+      pipeline = Evens.new | Map.new{ |val| throw Exception.new "exception!" } | Select.new{ |v| v > 2}
+      pipeline.run
+      assert false
+    rescue Exception => e
+    end
+  end   
+       
+  test 'nil kills it' do
+    pipeline = EachElement.new([1, 2, nil, 3])
+    result = []
+    while v = pipeline.run
+      result << v
+    end
+    assert_equal([1, 2], result)    
+  end  
+  
+  def sing
+    { :do => 'doe a deer a female deer',
+      :re => 'ray a drop of golden sun',
+      :mi => 'me a name I call myself',
+      :fa => 'far a long long way to run',
+      :so => 'A needle pulling thread',
+      :la => 'a note to follow so',
+      :ti => 'a drink with jam and bread'}
+  end
+end

data/test/test_stages.rb

@@ -0,0 +1,51 @@
+require 'helper'
+include Stages
+
+class TestStages < MiniTest::Unit::TestCase
+  
+  test 'evens' do
+    evens = Evens.new
+    result = (0..2).map{ evens.run }
+    assert_equal([0, 2, 4], result)
+  end
+    
+  test 'select' do
+    pipeline = Evens.new | Select.new{ |val| val > 6}
+    result = (0..2).map{ |x| pipeline.run }
+    assert_equal([8, 10, 12], result)
+  end
+  
+  test 'map' do
+    pipeline = Evens.new | Map.new{ |val| val * 3}
+    result = (0..2).map{ |x| pipeline.run }
+    assert_equal([0, 6, 12], result)
+  end
+  
+  test 'multiples_of' do
+    pipeline = Evens.new | MultiplesOf.new(3)
+    result = (0..3).map{ |x| pipeline.run }
+    assert_equal([0, 6, 12, 18], result)
+  end
+  
+  test 'each_element' do
+    pipeline = EachElement.new([1, 2, 3])
+    result = (0..2).map{ |x| pipeline.run }
+    assert_equal([1, 2, 3], result)
+  end
+  
+  test 'hash_lookup' do
+    pipeline = EachElement.new([:do, :re, :mi]) | HashLookup.new(sing)
+    result = (0..2).map{ |x| pipeline.run }
+    assert_equal(['doe a deer a female deer', 'ray a drop of golden sun', 'me a name I call myself'], result)
+  end   
+  
+  def sing
+    { :do => 'doe a deer a female deer',
+      :re => 'ray a drop of golden sun',
+      :mi => 'me a name I call myself',
+      :fa => 'far a long long way to run',
+      :so => 'A needle pulling thread',
+      :la => 'a note to follow so',
+      :ti => 'a drink with jam and bread'}
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: stages
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathan Acuff
+- Justin Hill
+- Matt Brown
+- Kyle Prifogle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: pipeline builder
+email: support@igodigital.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .autotest
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- VERSION
+- lib/stage_base.rb
+- lib/stages.rb
+- lib/stages/each_element.rb
+- lib/stages/evens.rb
+- lib/stages/hash_lookup.rb
+- lib/stages/map.rb
+- lib/stages/multiples_of.rb
+- lib/stages/select.rb
+- stages.gemspec
+- test/helper.rb
+- test/test_pipeline.rb
+- test/test_stages.rb
+homepage: https://github.com/iGoDigital-LLC/stages
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4101338441187827743
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: pipeline builder
+test_files: []
+