hero 0.0.7 → 0.0.8

data/README.md

@@ -36,7 +36,7 @@ you have a lump of spaghetti that's difficult to maintain and even harder to imp
 
 Hero provides a simple pattern that encourages you to 
 <a href="http://en.wikipedia.org/wiki/Decomposition_(computer_science)">decompose</a>
-these processes into managable chunks. And the best part... the components can be easily tested.
+these processes into managable chunks.
 
 ---
 
@@ -48,6 +48,8 @@ gem install hero
 
 Lets model a business process for collecting the top news stories from Hacker News, Reddit, & Google and then emailing the results to someone.
 
+---
+
 Gather News
 
 - Get news from Hacker News
@@ -55,28 +57,30 @@ Gather News
 - Get news from Google
 - Email Results
 
+---
+
 Now that we have the basic requirements, lets model it with Hero.
 
 ```ruby
-Hero::Formula[:gather_news].add_step :hacker_news do |context|
+Hero::Formula[:gather_news].add_step :hacker_news do |context, options|
   # make api call
   # parse results
   # append results to context
 end
 
-Hero::Formula[:gather_news].add_step :reddit do |context|
+Hero::Formula[:gather_news].add_step :reddit do |context, options|
   # make api call
   # parse results
   # append results to context
 end
 
-Hero::Formula[:gather_news].add_step :google do |context|
+Hero::Formula[:gather_news].add_step :google do |context, options|
   # make api call
   # parse results
   # append results to context
 end
 
-Hero::Formula[:gather_news].add_step :email do |context|
+Hero::Formula[:gather_news].add_step :email do |context, options|
   # format news for email
   # compose the email
   # send the email
@@ -108,14 +112,16 @@ And we're done.
 
 ### Key take aways
 
-- **The implementation aligns perfectly with the requirements.**
-  *This means that developers and business folks can talk the same lingo.*
+- The implementation aligns perfectly with the requirements.
+  *Developers and business folks can talk the same lingo.*
+
+- The formula is composed of smaller steps that are interchangable.
+  *We are poised for changing requirements.*
+
+- Steps can be tested independently.
 
-- **The formula is composed of smaller steps that are interchangable.**
-  *This means we are poised for changing requirements.*
+- Each step implements the interface: `def call(context, options)`
 
-- **Each step implements the interface `def call(context)`**
-  *This means we can create step classes to simplify the app structure.*
 
 ## Next Steps
 
@@ -124,7 +130,7 @@ Here's an example.
 
 ```ruby
 # this
-Hero::Formula[:gather_news].add_step :hacker_news do |context|
+Hero::Formula[:gather_news].add_step :hacker_news do |context, options|
   # make api call
   # parse results
   # append results to context
@@ -134,7 +140,7 @@ end
 module GatherNews
   class HackerNews
 
-    def call(context)
+    def call(context, options)
       # make api call
       # parse results
       # append results to context
@@ -169,7 +175,7 @@ Hero::Formula[:gather_news].add_step :google, GatherNews::Google.new
 Hero::Formula[:gather_news].add_step :email, GatherNews::Email.new
 ```
 
-Now we have a well structured application that is ready to grow.
+Now we have a well structured application thats ready to grow.
 Notice how well organized everything is.
 
 Also note that we can write tests for each step independent of anything else.

data/lib/hero/observer.rb

@@ -59,13 +59,18 @@ module Hero
     # @param optional [Hash] options An option Hash to be passed to each step.
     def update(context=nil, options={})
       steps.each do |step|
-        log_step(:before, step, context, options)
-        step.last.call(context, options)
-        log_step(:after, step, context, options)
+        log_step(:info, :before, step, context, options)
+        begin
+          step.last.call(context, options)
+        rescue Exception => ex
+          log_step(:error, :after, step, context, options)
+          raise ex
+        end
+        log_step(:info, :after, step, context, options)
       end
     end
 
-    private 
+    private
 
     # Logs a step to the registered Hero.logger.
     # @note Users info for the log level.
@@ -73,9 +78,9 @@ module Hero
     # @param [Object] step
     # @param [Object] context
     # @param [Object] options
-    def log_step(id, step, context, options)
+    def log_step(level, id, step, context, options)
       return unless Hero.logger
-      Hero.logger.info "HERO #{id.to_s.ljust(6)} #{formula_name} -> #{step.first} Context: #{context.inspect} Options: #{options.inspect}"
+      Hero.logger.send level, "HERO #{id.to_s.ljust(6)} #{formula_name} -> #{step.first} Context: #{context.inspect} Options: #{options.inspect}"
     end
 
   end

data/spec/formula_spec.rb

@@ -118,10 +118,9 @@ describe Hero::Formula do
     it "should support logging" do
       class TestLogger
         attr_reader :buffer
-        def info(value)
-          @buffer ||= []
-          @buffer << value
-        end
+        def initialize; @buffer = []; end
+        def info(value); @buffer << value; end
+        alias :error :info
       end
       Hero.logger = TestLogger.new
 
@@ -136,6 +135,21 @@ describe Hero::Formula do
       assert_equal "HERO after  test_formula -> two Context: [1, 2] Options: {:step=>2}", Hero.logger.buffer[3]
     end
 
+    it "should support logging errors" do
+      class TestLogger
+        attr_reader :info_count, :error_count, :buffer
+        def initialize; @info_count = 0; @error_count = 0; @buffer = []; end
+        def info(value); @info_count += 1; @buffer << value; end
+        def error(value); @error_count += 1; @buffer << value; end
+      end
+      Hero.logger = TestLogger.new
+      Hero::Formula[:test_formula].add_step(:one) { |list, opts| raise Exception.new("fubar") }
+      assert_raise(Exception) { Hero::Formula[:test_formula].run }
+      assert_equal Hero.logger.buffer.length, 2
+      assert_equal Hero.logger.info_count, 1
+      assert_equal Hero.logger.error_count, 1
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hero
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-26 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies: []
 description: ! '    Simplify your apps with Hero.