piece_pipe 0.0.1 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+v0.1.0 - 2012-06-06
+  * Some class name changes for "step" motif consistency.
+
+v0.0.1 - 2012-05-30
+  * Initial release

data/README.md

@@ -2,6 +2,21 @@
 
 PiecePipe is about breaking your problem into its smallest, most interesting pieces, solving those pieces and not spending time on the glue code between them.
 
+## Motivation
+
+Though this style of programming is similar to sequence processing using map, select and inject, PiecePipe
+gives us power to:
+
+* Improve expressiveness -- our high-level pipeline definition reads like a book and encompasses a comprehensible algorithm.
+* Address and test each of the interesting little steps.
+* Decouple ourselves from the implementation of map, select etc, which assume you're processing a collection, and have preconceptions on how they should be iterated over.
+
+For sufficiently interesting algorithms we often talk in circles about how to break the problem down such that
+no one piece is too complicated, then glue it all together.  We end up with a tree of strangely named calculator
+objects and an almost arbitrary sprinkling of looping/mapping constructs.  We got sick of trying to 
+organize the glue and decided to see if we could just boil it down to "what are the interesting operations, 
+and what are the smallest pieces we can operate on?"
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,6 +46,79 @@ class NuclearPowerPlantHealthSummaryGenerator
       collect(:plant_health_summary).
       to_enum
   end
+
+  # Custom Step, overriding #generate_sequence to produce a sequence of power plants for a given region.
+  # Each power plant is "produced" as a Hash with one key (so far) heading down the pipeline.
+  class FetchPowerPlantsByRegion < PiecePipe::Step
+    def generate_sequence(inputs)
+      # The expected interface of any Step's soure is that it supports #to_enum.  
+      source.to_enum.each do |inputs|
+        inputs[:region].power_plants.those_still_open.each do |power_plant|
+          produce power_plant: power_plant  # Each call to #produce sends another object down the pipe
+        end
+      end
+    enb
+  end
+
+  # For any given power plant, determine the worst reactor.
+  # Implemented as an AssemblyStep that analyzes inputs[:power_plant] from the prior Step,
+  # and installs a new key/val pair for :worst_reactor.  
+  class FindWorstReactor < PiecePipe::AssemblyStep
+    def receive(inputs)
+      # Figure out which reactor has the highest radiation levels.
+      # "install" works a lot like "produce", but rather than take responsibility for the totality
+      # of the produced object, we're just saying "add :worst_reactor to whatever's there and pass it on".
+      install worst_reactor: inputs[:power_plant].reactors.reject(&:offline?).max_by(:&radiation)
+    end
+  end
+
+  # Figure out which CSS class corresonds to the radiation from the worst reactor.
+  # (At this point, the inputs Hash has keys :region, :power_plant,  and :worst_reactor.)
+  class DetermineStatusClass < PiecePipe::AssemblyStep
+    def receive(inputs)
+      install highlight_css_class: StatusFormatters.determine_css_class(inputs[:worst_reactor].radiation)
+    end
+  end
+
+  # Composite our details into a line-item structure for our report.
+  # Even though we consume most of the interesting values that arrive in the inputs Hash,
+  # we're letting them ride as we simply install one more key, :plant_health_summary.
+  # (This comes in handy, as we intend to sort these structures in a later step, using values
+  # that are present in our transient input Hash, but NOT actually available in the 
+  # report structure.)
+  class BuildPlantHealthSummary < PiecePipe::AssemblyStep
+    def receive(inputs)
+      power_plant = inputs[:power_plant]
+      worst_reactor = inputs[:worst_reactor]
+      install plant_health_summary: PlantHealthSummary.new(
+        power_plant_id: power_plant.id,
+        supervisor: power_plant.supervisor,
+        reactor_name: worst_reactor.name,
+        radiation: StatusFormatters.format_radiation(worst_reactor.radiation),
+        css_class: inputs[:highlight_css_class]
+      )
+    end
+  end
+
+  # Sort all the values that come through the pipe based on the radiation of the worst reactor
+  # in each power_plant.
+  # Notice this is not an AssemblyStep, and we're overriding #generate_sequence again, this time
+  # because we're implementing a sink.  The resulting downstream objects have the same structure
+  # they arrived with.
+  class SortByRadiationLevelsDescending < PiecePipe::Step
+    def generate_sequence
+      source.to_enum.sort_by do |inputs|
+        inputs[:worst_reactor].radiation
+      end.each do |inputs|
+        produce inputs
+      end
+    end
+  end
+
+  #... and that's it. Recall that the pipeline terminates with .collect(:plant_health_summary), which
+  # is shorthand for a special Step that accepts Hashes and uses #produce to spit out only the specified
+  # objects.  Downstream of our #collect, only the PlantHealthSummary remains.
+
 end
 ```
 

data/documentation_todo.txt

@@ -0,0 +1,13 @@
+MethodStep
+MethodAssemblyStep
+TapStep
+MapStep
+HashedAggregator
+
+In-file docs and example on how to use the MapStep and Aggregator. Mention in the README.
+
+Details on the AssemblyStep concept and implementation.
+
+Testing: ezpipe.  Bring it, document it, provide examples.
+
+

data/lib/piece_pipe.rb

@@ -1,12 +1,12 @@
 require 'piece_pipe/pipeline'
-require 'piece_pipe/pipeline_element'
+require 'piece_pipe/step'
 
-require 'piece_pipe/assembly_station'
+require 'piece_pipe/assembly_step'
 require 'piece_pipe/collector'
 require 'piece_pipe/debug_step'
 require 'piece_pipe/hashed_aggregator'
 require 'piece_pipe/map_step'
-require 'piece_pipe/method_assembly_station'
-require 'piece_pipe/method_element'
+require 'piece_pipe/method_assembly_step'
+require 'piece_pipe/method_step'
 require 'piece_pipe/tap_step'
 require 'piece_pipe/version'

data/lib/piece_pipe/{assembly_station.rb → assembly_step.rb}

@@ -1,6 +1,6 @@
 
 module PiecePipe
-  class AssemblyStation < PipelineElement
+  class AssemblyStep < Step
     def process(item)
       ensure_hash_like_object item
       @assembly = item
@@ -33,7 +33,7 @@ module PiecePipe
     private
     def ensure_hash_like_object(obj)
       unless obj.respond_to?(:[]) and obj.respond_to?(:merge) and obj.respond_to?(:dup)
-        raise "AssemblyStation object #{self.class.name} requires its source to produce Hash-like elements; not acceptable: #{obj.inspect}"
+        raise "AssemblyStep object #{self.class.name} requires its source to produce Hash-like elements; not acceptable: #{obj.inspect}"
       end
     end
   end

data/lib/piece_pipe/collector.rb

@@ -1,5 +1,5 @@
 module PiecePipe
-  class Collector < PipelineElement
+  class Collector < Step
     def initialize(key)
       @key = key
     end

data/lib/piece_pipe/debug_step.rb

@@ -1,5 +1,5 @@
 module PiecePipe
-  class DebugStep < PipelineElement
+  class DebugStep < Step
     def initialize(opts={},&block)
       @opts = opts
       @block = block

data/lib/piece_pipe/hashed_aggregator.rb

@@ -1,5 +1,5 @@
 module PiecePipe
-  class HashedAggregator < PipelineElement
+  class HashedAggregator < Step
     def initialize
       @hash = {}
     end

data/lib/piece_pipe/map_step.rb

@@ -1,5 +1,5 @@
 module PiecePipe
-  class MapStep < PipelineElement
+  class MapStep < Step
     def process(item)
       map item
     end

data/lib/piece_pipe/{method_assembly_station.rb → method_assembly_step.rb}

@@ -1,5 +1,5 @@
 module PiecePipe
-  class MethodAssemblyStation < AssemblyStation
+  class MethodAssemblyStep < AssemblyStep
     def initialize(meth)
       @method = meth
     end

data/lib/piece_pipe/{method_element.rb → method_step.rb}

@@ -1,5 +1,5 @@
 module PiecePipe
-  class MethodElement < PipelineElement
+  class MethodStep < Step
     def initialize(meth)
       raise "method cannot be nil" if meth.nil?
       raise "method must accept 1 or 2 arguments; it accepts #{meth.arity}" if meth.arity != 1 and meth.arity != 2

data/lib/piece_pipe/pipeline.rb

@@ -20,7 +20,7 @@ module PiecePipe
       when Class
         step = step.new # If the arg is a Class, instantiate it
       when Method
-        step = MethodElement.new(step)
+        step = MethodStep.new(step)
       end
       add_step step
     end
@@ -30,7 +30,7 @@ module PiecePipe
       when Class
         step = step.new # If the arg is a Class, instantiate it
       when Method
-        step = MethodAssemblyStation.new(step)
+        step = MethodAssemblyStep.new(step)
       end
       add_step step
     end

data/lib/piece_pipe/{pipeline_element.rb → step.rb}

@@ -1,5 +1,5 @@
 module PiecePipe
-  class PipelineElement
+  class Step
     attr_accessor :source
 
     def to_enum
@@ -17,7 +17,7 @@ module PiecePipe
 
     def generate_sequence
       if source.nil?
-        raise "The source of PipelineElement #{self.class.name} is nil"
+        raise "The source of Step #{self.class.name} is nil"
       end
       source.to_enum.each do |item|
         process(item)

data/lib/piece_pipe/tap_step.rb

@@ -1,5 +1,5 @@
 module PiecePipe
-  class TapStep < PipelineElement
+  class TapStep < Step
     def initialize(&block)
       @block = block
     end

data/lib/piece_pipe/version.rb

@@ -1,3 +1,3 @@
 module PiecePipe
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/{assembly_station_spec.rb → assembly_step_spec.rb}

@@ -1,10 +1,10 @@
 require "spec_helper"
 
-describe PiecePipe::AssemblyStation do
+describe PiecePipe::AssemblyStep do
 
-  context "default AssemblyStation" do
+  context "default AssemblyStep" do
     it "produces unaltered items from its source" do
-      as = PiecePipe::AssemblyStation.new
+      as = PiecePipe::AssemblyStep.new
       as.source = [
         {hello: "hippo"},
         {hello: "lion"}
@@ -17,8 +17,8 @@ describe PiecePipe::AssemblyStation do
     end
   end
 
-  context "a typical AssemblyStation" do
-    class AnimalPhraser < PiecePipe::AssemblyStation
+  context "a typical AssemblyStep" do
+    class AnimalPhraser < PiecePipe::AssemblyStep
       def receive(inputs)
         install phrase: "There are #{inputs[:count]} #{inputs[:animal]}s"
       end
@@ -36,7 +36,7 @@ describe PiecePipe::AssemblyStation do
       ]
     end
 
-    class Cuber < PiecePipe::AssemblyStation
+    class Cuber < PiecePipe::AssemblyStep
       def receive(inputs)
         num = inputs[:num]
         install squared: num * num, cubed: num * num * num
@@ -56,8 +56,8 @@ describe PiecePipe::AssemblyStation do
     end
   end
 
-  context "a filtering AssemblyStation" do
-    class HippoHater < PiecePipe::AssemblyStation
+  context "a filtering AssemblyStep" do
+    class HippoHater < PiecePipe::AssemblyStep
       def receive(inputs)
         unless inputs[:animal] == "Hippo"
           install phrase: "There are #{inputs[:count]} #{inputs[:animal]}s"
@@ -80,8 +80,8 @@ describe PiecePipe::AssemblyStation do
     end
   end
 
-  context "an exploding AssemblyStation" do
-    class LionCrusher < PiecePipe::AssemblyStation
+  context "an exploding AssemblyStep" do
+    class LionCrusher < PiecePipe::AssemblyStep
       def receive(inputs)
         if inputs[:animal] == "Hippo"
           inputs[:lion_count].times do 
@@ -106,18 +106,18 @@ describe PiecePipe::AssemblyStation do
 
   context "error and oddball cases" do
     context "source produces non-Hash inputs" do
-      class MyOtherSomething < PiecePipe::AssemblyStation
+      class MyOtherSomething < PiecePipe::AssemblyStep
       end
 
       it "raises an error indicating requisite input type" do
         as = MyOtherSomething.new
         as.source = [1,2,3]
-        lambda do as.to_enum.to_a end.should raise_error(/AssemblyStation object MyOtherSomething.*Hash-like/)
+        lambda do as.to_enum.to_a end.should raise_error(/AssemblyStep object MyOtherSomething.*Hash-like/)
       end
     end
 
     context "overridden receive() installs nil" do
-      class NilInstaller < PiecePipe::AssemblyStation
+      class NilInstaller < PiecePipe::AssemblyStep
         def receive(inputs)
           install nil
         end
@@ -136,7 +136,7 @@ describe PiecePipe::AssemblyStation do
     end
 
     context "using noop()" do
-      class UseTheNoOp < PiecePipe::AssemblyStation
+      class UseTheNoOp < PiecePipe::AssemblyStep
         def receive(inputs)
           noop
         end

data/spec/{method_assembly_station_spec.rb → method_assembly_step_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe PiecePipe::MethodAssemblyStation do
+describe PiecePipe::MethodAssemblyStep do
   let(:pipeline) { PiecePipe::Pipeline.new }
 
   context "wrapping methods with single arguments" do

data/spec/{method_element_spec.rb → method_step_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe PiecePipe::MethodElement do
+describe PiecePipe::MethodStep do
   let(:pipeline) { PiecePipe::Pipeline.new }
 
   context "wrapping methods with single arguments" do

data/spec/pipeline_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe PiecePipe::Pipeline do
-  class OneTwoThree < PiecePipe::PipelineElement
+  class OneTwoThree < PiecePipe::Step
     def generate_sequence
       produce 1
       produce 2
@@ -9,7 +9,7 @@ describe PiecePipe::Pipeline do
     end
   end
 
-  class TheDoubler < PiecePipe::PipelineElement
+  class TheDoubler < PiecePipe::Step
     def process(item)
       produce item * 2
     end
@@ -32,7 +32,7 @@ describe PiecePipe::Pipeline do
     end
   end
 
-  context "using instantiated PipelineElements as steps" do
+  context "using instantiated Steps as steps" do
     it "produces transformed values by processing both steps for each item" do
       subject.
         step(OneTwoThree.new).
@@ -50,7 +50,7 @@ describe PiecePipe::Pipeline do
       subject.to_enum.to_a.should == [20, 40, 60]
     end
 
-    it "works with PipelineElements" do
+    it "works with Steps" do
       subject.
         source(OneTwoThree.new).
         step(TheDoubler)

data/spec/{pipeline_element_spec.rb → step_spec.rb}

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-describe PiecePipe::PipelineElement do
+describe PiecePipe::Step do
 
   let (:array_source) { [ "hippo", "distribution", "mechanism" ] }
 
-  context "default PipelineElement" do
+  context "default Step" do
 
     it "provides an enumeration of its source's elements" do
-      e = PiecePipe::PipelineElement.new
+      e = PiecePipe::Step.new
       e.source = array_source
       
       en = e.to_enum
@@ -19,7 +19,7 @@ describe PiecePipe::PipelineElement do
   end
 
   context "overriding #generate_sequence" do 
-    class IntegerGenerator < PiecePipe::PipelineElement
+    class IntegerGenerator < PiecePipe::Step
       def generate_sequence
         process 1
         process 2
@@ -32,7 +32,7 @@ describe PiecePipe::PipelineElement do
       en.to_a.should == [1,2,3]
     end
 
-    class NothingGenerator < PiecePipe::PipelineElement
+    class NothingGenerator < PiecePipe::Step
       def generate_sequence
         
       end
@@ -45,7 +45,7 @@ describe PiecePipe::PipelineElement do
     end
 
     context "bypassing the default #process invocation" do
-    class IntegerProducer < PiecePipe::PipelineElement
+    class IntegerProducer < PiecePipe::Step
       def generate_sequence
         produce 1
         produce 2
@@ -58,7 +58,7 @@ describe PiecePipe::PipelineElement do
         en.to_a.should == [1,2,3]
       end
 
-    class NothingProducer < PiecePipe::PipelineElement
+    class NothingProducer < PiecePipe::Step
       def generate_sequence
 
       end
@@ -72,7 +72,7 @@ describe PiecePipe::PipelineElement do
   end
 
   context "overriding #process" do
-    class StringExpander < PiecePipe::PipelineElement
+    class StringExpander < PiecePipe::Step
       def  process(item)
         produce "x" * item
       end
@@ -84,7 +84,7 @@ describe PiecePipe::PipelineElement do
       se.to_enum.to_a.should == ["xx", "xxxx"]
     end
 
-    class AllFilter < PiecePipe::PipelineElement
+    class AllFilter < PiecePipe::Step
       def process(item)
 
       end
@@ -96,7 +96,7 @@ describe PiecePipe::PipelineElement do
       al.to_enum.to_a.should == []
     end
 
-    class Exploder < PiecePipe::PipelineElement
+    class Exploder < PiecePipe::Step
       def process(item)
         item.times do
           produce "hi #{item}"
@@ -112,7 +112,7 @@ describe PiecePipe::PipelineElement do
   end
 
   context "nill source" do
-    class MySomething < PiecePipe::PipelineElement
+    class MySomething < PiecePipe::Step
     end
 
     it "raises an error" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piece_pipe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-30 00:00:00.000000000 Z
+date: 2012-06-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152338560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,15 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2152338560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152337340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,15 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2152337340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152321200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,12 +44,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2152321200
 description: ! 'PiecePipe is about breaking your problem into its smallest, most interesting
   pieces, solving those pieces and not spending time on the glue code between them. '
 email:
@@ -70,32 +55,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- documentation_todo.txt
 - lib/piece_pipe.rb
-- lib/piece_pipe/assembly_station.rb
+- lib/piece_pipe/assembly_step.rb
 - lib/piece_pipe/collector.rb
 - lib/piece_pipe/debug_step.rb
 - lib/piece_pipe/hashed_aggregator.rb
 - lib/piece_pipe/map_step.rb
-- lib/piece_pipe/method_assembly_station.rb
-- lib/piece_pipe/method_element.rb
+- lib/piece_pipe/method_assembly_step.rb
+- lib/piece_pipe/method_step.rb
 - lib/piece_pipe/pipeline.rb
-- lib/piece_pipe/pipeline_element.rb
+- lib/piece_pipe/step.rb
 - lib/piece_pipe/tap_step.rb
 - lib/piece_pipe/version.rb
 - piece_pipe.gemspec
-- spec/assembly_station_spec.rb
+- spec/assembly_step_spec.rb
 - spec/collector_spec.rb
 - spec/hashed_aggregator_spec.rb
 - spec/map_step_spec.rb
-- spec/method_assembly_station_spec.rb
-- spec/method_element_spec.rb
-- spec/pipeline_element_spec.rb
+- spec/method_assembly_step_spec.rb
+- spec/method_step_spec.rb
 - spec/pipeline_spec.rb
 - spec/spec_helper.rb
+- spec/step_spec.rb
 homepage: http://atomicobject.com
 licenses: []
 post_install_message: 
@@ -116,19 +103,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: PiecePipe helps you break your code into small interesting pieces and provides
   the glue for pipelining them together to provide elegant, readable code.
 test_files:
-- spec/assembly_station_spec.rb
+- spec/assembly_step_spec.rb
 - spec/collector_spec.rb
 - spec/hashed_aggregator_spec.rb
 - spec/map_step_spec.rb
-- spec/method_assembly_station_spec.rb
-- spec/method_element_spec.rb
-- spec/pipeline_element_spec.rb
+- spec/method_assembly_step_spec.rb
+- spec/method_step_spec.rb
 - spec/pipeline_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/step_spec.rb