ismasan-proto_processor 0.2.0 → 0.3.0

data/README.markdown

@@ -1,15 +1,19 @@
-= proto_processor
+## proto_processor
 
 A couple of modules to ease the creation of background processors or any kind of delegated task or tasks for which you want flow control and error reporting.
 
-== Example
+## Install
 
-=== Strategies
+    sudo gem install ismasan-proto_processor
+
+## Examples
+
+### Strategies
 
 You start by defining a *strategy*. A strategy defines the sequence of tasks your program will carry out.
 
-require 'rubygems'
-require 'proto_processor'
+    require 'rubygems'
+    require 'proto_processor'
 
     class ImageStrategy
       include ProtoProcessor::Strategy
@@ -44,7 +48,7 @@ Strategy#run captures the output of tasks and gives you a Report object, with in
 
 Apart from the *process* method, Strategies are normal Ruby classes so you can go ahead and add whatever functionality you want to them, including, for example, an *initialize* method, or a factory.
 
-=== Tasks
+### Tasks
 
 Tasks do the real work. They also implement a *process* method where you can put you image resizing, file storing, email sending or whatever code you want.
 
@@ -65,7 +69,7 @@ That's pretty much it. Any exceptions raised within *process* will be captured,
 
 Every task has an *options* hash available.
 
-=== Validating task options
+### Validating task options
 
 The previous example shows a simple way of checking that a task was passed required parameters as part of the options hash.
 
@@ -75,9 +79,9 @@ If parameters declared in this way are not present in the options, a ProtoProces
 
 You can also raise manually in the process method.
 
-   def process
-    raise ArgumentError, ":width option must be > 0" if options[:width] < 1
-   end
+    def process
+      raise ArgumentError, ":width option must be > 0" if options[:width] < 1
+    end
 
 Tasks also have *before_process* and *after_process* callbacks that will run if defined. You can guess what they do :)
 
@@ -87,7 +91,7 @@ Lastly, you can define your own *validate* method which will be run before proce
       (1..500).include? options[:width]
     end
 
-=== Chaining tasks in strategies
+### Chaining tasks in strategies
 
     run_task [CropTask, ResizeTask, ZipTask, EmailTask], options
 
@@ -111,7 +115,7 @@ You can use task chains to process elements in a collection:
 
 If any task in the chain fails the error will be logged. The following tasks will not be processed.
 
-== Stand alone tasks
+### Stand alone tasks
 
 Tasks are quite simple objects. They expect an array with an input, an options hash and a report hash as an argument and return the same.
 
@@ -129,14 +133,18 @@ If a task expects a certain key in the report passed from a previous task in a c
 
 If :some_key doesn't exist in the passed report, the task will not process and halt any chain it is in.
 
-=== Logging
+### Logging
 
 Default to STDOUT. Just add your own logger and logger level.
 
-ProtoProcessor.logger = Logger.new('my_processor.log')
-ProtoProcessor.logger.level = Logger::ERROR
+    ProtoProcessor.logger = Logger.new('my_processor.log')
+    ProtoProcessor.logger.level = Logger::ERROR
+
+## TODO
 
+* Improve DSL in strategies
+* Better log formatting?
 
-== Copyright
+## Copyright
 
 Copyright (c) 2009 Ismael Celis. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 2
+:minor: 3
 :patch: 0

data/lib/proto_processor.rb

@@ -12,6 +12,5 @@ module ProtoProcessor
     attr_accessor :logger
   end
 end
-
 ProtoProcessor.logger = Logger.new(STDOUT)
-ProtoProcessor.logger.level = Logger::DEBUG
+ProtoProcessor.logger.level = Logger::ERROR

data/lib/proto_processor/strategy.rb

@@ -10,9 +10,11 @@ module ProtoProcessor::Strategy
   
   def run
     begin
+      ProtoProcessor.logger.info "Running strategy #{self.class.name}"
       process
     rescue StandardError => e
       report.fail!(e)
+      ProtoProcessor.logger.error e.class.name
       ProtoProcessor.logger.debug e.message + "\n" + e.backtrace.join("\n")
     end
     yield report if block_given?

data/lib/proto_processor/task.rb

@@ -26,7 +26,6 @@ module ProtoProcessor
     def self.included(base)
       base.class_eval do
         attr_reader :input, :options, :report, :error
-        puts "Including validations in #{base.name}"
         extend Validations
       end
       #base.extend Validations
@@ -42,15 +41,15 @@ module ProtoProcessor
       @error = nil
     end
     
-    class HaltedChainError < StandardError
-      def message
-        "Task not run because previous task failed"
-      end
-    end
+    # class HaltedChainError < StandardError
+    #       def message
+    #         "Task not run because previous task failed"
+    #       end
+    #     end
     
     def run
       begin
-        raise HaltedChainError if report[:status] == FAILURE
+        log_halt_task and return false if report[:status] == FAILURE
         run_validations!
         before_process
         process
@@ -64,7 +63,7 @@ module ProtoProcessor
         report!(:status, FAILURE)
         report!(:error, {:name => e.class.name, :message => e.message})
         @error = e
-        ProtoProcessor.logger.debug "TASK ERROR: #{self.class.name}: #{e.class.name} => #{e.message}"
+        ProtoProcessor.logger.error "#{self.class.name}: #{e.class.name} => #{e.message}"
         ProtoProcessor.logger.debug e.backtrace.join("\n")
       end
       [@input, @options, @report]
@@ -109,6 +108,10 @@ module ProtoProcessor
     
     protected
     
+    def log_halt_task
+      ProtoProcessor.logger.info "#{self.class.name} not run because previous task failed"
+    end
+    
     def validate
       # implement this in subclasses if needed
       true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ismasan-proto_processor
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ismael Celis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -07:00
+date: 2009-05-26 00:00:00 -07:00
 default_executable: 
 dependencies: []