linepipe 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36c4f7e0578480dee9f8ce08b6c40acbc9f819ad
+  data.tar.gz: 6d66b0016c88478fe5d20b836eb1d584eebc8bec
+SHA512:
+  metadata.gz: bb827c6e9d00fb5d573694c9ebe1e325f92aa2219b28bdd420ab7474da5869ca01d335a8c318e0c2efecf7f6eea0c4198f11e920904c9d1ecc2b59249db4c8a6
+  data.tar.gz: 15cfbada1229d2f5f8c0f6a4ff06872e587e3b584c87fa13db2ff5e531b8565c9511768017868b8b48186389cb32cc8b62226ebd214549fe2a807e76a7a9d2c3

data/README.md

@@ -26,7 +26,8 @@ Linepipe's DSL consists of 4 different parts:
 * `setup`: Optional setup that will be run at the beginning.
 * `data`: The input data.
 * `step`: As many of these as you want will conform the steps of your
-  algorithm.
+  algorithm. You can optionally provide an `expect` block that will test the
+  output right after than particular step.
 * `expect`: In development mode, each of these will be run against your final
   output data to ensure its conformity with your expectations.
 
@@ -42,12 +43,16 @@ linepipe = Linepipe.develop do
 
   step("Upcasing") { |data|
     data.map(&:upcase)
-  }
+  }.expect('is upcased') { |data|
+    data.first == 'FOO'
+  } # as you see, each step can have its own expectations that will be tested
+    # when the data leaves that particular step of the pipeline
 
   step("Reversing") { |data|
     data.reverse
   }
 
+  # now the final expectation on the result
   expect { |data|
     data == %w(BAZ BAR FOO)
   }
@@ -88,11 +93,11 @@ linepipe = Linepipe.benchmark(10_000) do
     %w(foo bar baz)
   }
 
-  process("Upcasing") { |data|
+  step("Upcasing") { |data|
     data.map(&:upcase)
   }
 
-  process("Reversing") { |data|
+  step("Reversing") { |data|
     data.reverse
   }
 

data/examples/develop.rb

@@ -10,6 +10,8 @@ class DevelopTest < MiniTest::Unit::TestCase
 
       step("Upcasing") { |data|
         data.map(&:upcase)
+      }.expect('is upcased') { |data|
+        data.first.upcase == data.first
       }
 
       step("Reversing") { |data|

data/lib/linepipe/dsl.rb

@@ -12,7 +12,8 @@ module Linepipe
     end
 
     def step(name=nil, &block)
-      @steps << Step.new(name, &block)
+      @steps << step = Step.new(name, &block)
+      step
     end
 
     def expect(msg=nil, &block)

data/lib/linepipe/process.rb

@@ -27,9 +27,12 @@ module Linepipe
       run_setup
       @output = steps.to_enum.with_index.reduce(initial_data) { |d, (step, idx)|
         log "Stage #{idx}", step.name
-        log "Input", d
-        step.apply(d).tap do |r|
-          log "Output", r
+        log "\tInput", d
+        step.apply(d).tap do |result|
+          log "\tOutput", result
+          step.verify_expectations(result).each do |expectation|
+            log "\t\t#{expectation.name}: #{expectation.status}"
+          end
         end
       }
 

data/lib/linepipe/step.rb

@@ -5,14 +5,37 @@ module Linepipe
     def initialize(name=nil, &block)
       @name  = name
       @block = block
+      @expectations = []
     end
 
     def apply(data)
       block.call(data)
     end
 
+    def verify_expectations(result)
+      @expectations.each { |exp| exp.verify(result) }
+    end
+
+    def expect(name=nil, &block)
+      @expectations << StepExpectation.new(name, &block)
+    end
+
     private
     attr_reader :block
+
+    class StepExpectation
+      attr_reader :name, :status
+
+      def initialize(name=nil, &test)
+        @name   = name
+        @test   = test
+        @status = 'not run'
+      end
+
+      def verify(data)
+        @status = @test.call(data) ? 'pass' : 'fail'
+      end
+    end
   end
 end
 

data/lib/linepipe/version.rb

@@ -1,3 +1,3 @@
 module Linepipe
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/pipeline/process_spec.rb

@@ -10,8 +10,8 @@ module Linepipe
       Process.new(io).tap do |process|
         process.setup { process.taint }
         process.data { %w(foo bar baz) }
-        process.step('Upcasing') { |data| data.map(&:upcase) }
-        process.step('Reversing', &:reverse)
+        process.step('Upcasing') { |data| data.map(&:upcase) }.expect('is upcased') { |data| data.first == data.first.upcase }
+        process.step('Reversing', &:reverse).expect('is not reversed') { |data| data.first == 'foo' } # will fail
         process.expect { |data| data.first == 'BAZ' }
       end
     end
@@ -54,6 +54,12 @@ module Linepipe
         expect(io.string).to match(/Stage 1 Reversing/)
       end
 
+      it 'outputs step expectation info to the io stream' do
+        process.develop
+        expect(io.string).to match(/is upcased: pass/)
+        expect(io.string).to match(/is not reversed: fail/)
+      end
+
       describe 'when the expectations pass' do
         it 'outputs SUCCESS' do
           process.develop

data/spec/pipeline/step_spec.rb

@@ -9,8 +9,26 @@ module Linepipe
       expect(step.name).to eq('upcase')
     end
 
-    it 'calls the block with the data' do
-      expect(step.apply('data')).to eq('DATA')
+    describe '#apply' do
+      it 'calls the block with the data' do
+        expect(step.apply('data')).to eq('DATA')
+      end
+    end
+
+    describe '#verify_expectations' do
+      context 'when there are no expectations' do
+        it 'returns an empty array' do
+          expect(step.verify_expectations('DATA')).to eq([])
+        end
+      end
+
+      it 'returns the expectations with their status' do
+        step.expect('is upcased') { |data| data.upcase == data }
+        step.expect('is downcased') { |data| data.downcase == data }
+        expectations = step.verify_expectations('DATA')
+        expect(expectations.first.status).to eq('pass')
+        expect(expectations.last.status).to eq('fail')
+      end
     end
   end
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: linepipe
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Josep M. Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Process data one step at a time.
@@ -71,33 +66,26 @@ files:
 - spec/pipeline_spec.rb
 homepage: http://wimdu.github.com/linepipe
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3429959400891049712
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3429959400891049712
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Process data one step at a time.
 test_files:
 - spec/pipeline/expectation_spec.rb