hero 0.0.6 → 0.0.7

data/README.md

@@ -87,7 +87,7 @@ This looks surprising similar to the requirements.
 In fact we can publish the specification directly from Hero.
 
 ```ruby
-puts Hero::Formula[:gather_news].publish
+puts Hero::Formula[:gather_news].to_s
 
 # => gather_news
 #      1. hacker_news
@@ -163,10 +163,10 @@ We also need an initializer to set the formula up.
 
 ```ruby
 # app/initializer.rb
-Hero::Formula[:gather_news].add_step GatherNews::HackerNews.new
-Hero::Formula[:gather_news].add_step GatherNews::Reddit.new
-Hero::Formula[:gather_news].add_step GatherNews::Google.new
-Hero::Formula[:gather_news].add_step GatherNews::Email.new
+Hero::Formula[:gather_news].add_step :hacker_news, GatherNews::HackerNews.new
+Hero::Formula[:gather_news].add_step :reddit, GatherNews::Reddit.new
+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.
@@ -177,4 +177,31 @@ This is an important point and a powerful concept.
 
 ## Deep Cuts
 
-Advanced usage coming soon...
+Logging comes for free if you register a logger with Hero. Here's an example.
+
+```ruby
+Hero.logger = Logger.new(STDOUT)
+
+Hero::Formula[:log_example].add_step :first_step do |context, options|
+  context << 1
+end
+
+Hero::Formula[:log_example].add_step :second_step do |context, options|
+  context << 2
+end
+
+Hero::Formula[:log_example].add_step :third_step do |context, options|
+  context << 3
+end
+
+Hero::Formula[:log_example].run([])
+
+# The log will now contain the following lines.
+#
+# I, [2012-08-26T11:37:22.267072 #76676]  INFO -- : HERO before log_example -> first_step Context: [] Options: {}
+# I, [2012-08-26T11:37:22.267166 #76676]  INFO -- : HERO after  log_example -> first_step Context: [1] Options: {}
+# I, [2012-08-26T11:37:22.267211 #76676]  INFO -- : HERO before log_example -> second_step Context: [1] Options: {}
+# I, [2012-08-26T11:37:22.267248 #76676]  INFO -- : HERO after  log_example -> second_step Context: [1, 2] Options: {}
+# I, [2012-08-26T11:37:22.267282 #76676]  INFO -- : HERO before log_example -> third_step Context: [1, 2] Options: {}
+# I, [2012-08-26T11:37:22.267333 #76676]  INFO -- : HERO after  log_example -> third_step Context: [1, 2, 3] Options: {}
+```

data/lib/hero/observer.rb

@@ -59,13 +59,25 @@ module Hero
     # @param optional [Hash] options An option Hash to be passed to each step.
     def update(context=nil, options={})
       steps.each do |step|
-        if Hero.logger
-          Hero.logger.info "HERO Formula: #{formula_name}, Step: #{step.first}, Context: #{context.inspect}, Options: #{options.inspect}"
-        end
+        log_step(:before, step, context, options)
         step.last.call(context, options)
+        log_step(:after, step, context, options)
       end
     end
 
+    private 
+
+    # Logs a step to the registered Hero.logger.
+    # @note Users info for the log level.
+    # @param [Symbol, String] id The identifier for the step. [:before, :after]
+    # @param [Object] step
+    # @param [Object] context
+    # @param [Object] options
+    def log_step(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}"
+    end
+
   end
 end
 

data/spec/formula_spec.rb

@@ -124,12 +124,16 @@ describe Hero::Formula do
         end
       end
       Hero.logger = TestLogger.new
-      Hero::Formula[:test_formula].add_step(:one) {}
-      Hero::Formula[:test_formula].add_step(:two) {}
-      Hero::Formula[:test_formula].run(:example, :logging => true)
-      assert_equal Hero.logger.buffer.length, 2
-      assert_equal "HERO Formula: test_formula, Step: one, Context: :example, Options: {:logging=>true}", Hero.logger.buffer.first
-      assert_equal "HERO Formula: test_formula, Step: two, Context: :example, Options: {:logging=>true}", Hero.logger.buffer.last
+
+      Hero::Formula[:test_formula].add_step(:one) { |list, opts| list << 1; opts[:step] = 1 }
+      Hero::Formula[:test_formula].add_step(:two) { |list, opts| list << 2; opts[:step] = 2 }
+      list = []
+      Hero::Formula[:test_formula].run(list, {})
+      assert_equal Hero.logger.buffer.length, 4
+      assert_equal "HERO before test_formula -> one Context: [] Options: {}", Hero.logger.buffer[0]
+      assert_equal "HERO after  test_formula -> one Context: [1] Options: {:step=>1}", Hero.logger.buffer[1]
+      assert_equal "HERO before test_formula -> two Context: [1] Options: {:step=>1}", Hero.logger.buffer[2]
+      assert_equal "HERO after  test_formula -> two Context: [1, 2] Options: {:step=>2}", Hero.logger.buffer[3]
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hero
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors: