rockflow 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 819099699ced7464dab4ee7da34befdfaabb7105
-  data.tar.gz: d25ff7b3b6ecf716189c66f6f75f9d3bd89f5702
+  metadata.gz: 546f63965d1789bdc29172964e3125bc7eac9612
+  data.tar.gz: 220b01079dd75f593fdbcc28752973c6dcfadb35
 SHA512:
-  metadata.gz: 2547a34beced3dcb0d6eeca1c3a9982f43ed8bed799fa4b6ca7857e5154ed35a2f3501504a8cf49d56d101fdffd90137dcf023976e07db61e3aec00a2e27cae4
-  data.tar.gz: 3d83e5122f6adb07ad979ebbac1f3df04bf9d247f234cf7b44b564689c5292874c0fa84df3a01b7da020b45d127fb8c6fd5102ad5c8b5d9b183913bf53f70b73
+  metadata.gz: 444410dd4f41b0047b8e6cc9cec9195c3655f2f9b2b518567fb9cd70300ffba039f99d68003e35912309a272ab85384007ca1475e0888e3f331b0c67f12e4432
+  data.tar.gz: 0668671711e72e3f9273182e508713b8909d31c15ce647ae707085c8c089fdade49bc8bd2cb1aed7eedf54c4156f5d23dd3f71566794a65c859375d747370d18

data/README.md

@@ -1,4 +1,5 @@
 # Rockflow
+[![Gem Version](https://badge.fury.io/rb/rockflow.svg)](http://badge.fury.io/rb/rockflow)
 
 What is rockflow? Well with rockflow you are able to define workflows (yes even parallel workflows) by writing simple small steps and aggregating them in your flow (the bigger picture... you know)
 
@@ -29,7 +30,7 @@ To write your own flow you need two ingredients: the **flow** and your **steps**
 # app/workflows/awesome_flow.rb
 class AwesomeFlow < Rockflow::Flow
     def setup
-        rock RockStep1
+        rock RockStep1, conditions: [{pre: -> { payload[:foo].present? }}]
         rock RockStep2, params: {lorem: 'ipsum'}
         rock RockStep3, after: [RockStep1, RockStep2]
     end
@@ -82,6 +83,24 @@ flow.concert! # execute all steps
 Define your flow by inheriting from **RockFlow::Flow**. Inside your defined flow override the setup method and use the **rock** keyword defined by your step class. Available options for the rock method are at the moment:
 - **after** which takes a StepClass or an array of step classes.
 - **params** you can specify extra params to be used in a step.
+- **conditions** are used to define pre or post conditions for every step.
+
+#### Conditions 
+Conditions are used to define pre or post conditions for every step. To finish a step each given pre or post condition must evaluate to true. 
+Let me give you an example:
+```ruby 
+class MyFlow < Rockflow::Flow
+
+  def setup
+    rock Step1, conditions: [{pre: -> { false }},
+                             {post: -> { true }}]
+  end
+
+end
+
+flow = MyFlow.new
+flow.concert # => returns false because the pre condition is false
+```
 
 After that start writing your steps by inheriting from **RockFlow::Step** and overriding the **it_up** method. Inside of your inherited class you can use following methods.
 

data/lib/rockflow/errors/post_condition.rb

@@ -0,0 +1,6 @@
+module Rockflow
+  module Errors
+    class PostCondition < StandardError
+    end
+  end
+end

data/lib/rockflow/errors/pre_condition.rb

@@ -0,0 +1,6 @@
+module Rockflow
+  module Errors
+    class PreCondition < StandardError
+    end
+  end
+end

data/lib/rockflow/flow.rb

@@ -16,15 +16,16 @@ module Rockflow
       @steps << klazz.new(self, opts)
     end
 
-    def concert!
-      while !steps_finished?
-        ::Parallel.each(next_free_steps, in_threads: 4) do |step|
-          step.it_up
-          step.finish!
-        end
+    def concert
+      execute_steps.inject(true) do |result, elem|
+        result && !elem.errors.any?
       end
     end
 
+    def concert!
+      execute_steps
+    end
+
     def next_free_steps
       @steps.select do |step|
         step.after_dependencies_finished? && !step.finished?
@@ -33,10 +34,22 @@ module Rockflow
 
     def steps_finished?
       @steps.inject(true) do |result, elem|
-        result = result && elem.finished?
+        result = result && (elem.finished? || elem.failed?)
         result
       end
     end
 
+    def execute_steps
+      while !steps_finished?
+        ::Parallel.each(next_free_steps, in_threads: 4) do |step|
+          step.execute_pre_conditions
+          step.it_up
+          step.execute_post_conditions
+          step.finish! unless step.failed?
+        end
+      end
+      @steps
+    end
+
   end
 end

data/lib/rockflow/step.rb

@@ -1,12 +1,14 @@
 module Rockflow
   class Step
-    attr_accessor :flow, :status, :params
+    attr_accessor :flow, :status, :params, :conditions, :errors
 
     def initialize(flow, opts = {})
       @flow = flow
       @after_dependencies = []
+      @errors = []
       @params = opts[:params]
       @status = :not_started
+      @conditions = opts[:conditions]
       add_after_dependencies(opts[:after])
     end
 
@@ -25,6 +27,14 @@ module Rockflow
       @status == :finished
     end
 
+    def fail!
+      @status = :failed
+    end
+
+    def failed?
+      @status == :failed
+    end
+
     def add_payload(key, value)
       @flow.payload[key] = value
     end
@@ -45,5 +55,58 @@ module Rockflow
       end
     end
 
+    def select_conditions(pre_or_post)
+      conditions.select do |cond|
+        cond[pre_or_post.to_sym]
+      end.map do |cond|
+        cond[pre_or_post.to_sym]
+      end
+    end
+
+    def execute_pre_conditions
+      select_conditions(:pre).each do |cond|
+        exec_condition(cond, ::Rockflow::Errors::PreCondition)
+      end
+    end
+
+    def execute_post_conditions
+      select_conditions(:post).each do |cond|
+        exec_condition(cond, ::Rockflow::Errors::PostCondition)
+      end
+    end
+
+    private
+
+    def exec_condition(block_or_symbol, error)
+      exec_block_or_symbol(block_or_symbol, error) do
+        exec_condition_block(block_or_symbol, error)
+      end
+    end
+
+    def exec_block_or_symbol(block_or_symbol, error)
+      if block_or_symbol.is_a? Proc
+        yield
+      elsif block_or_symbol.is_a? Symbol
+        exec_method(block_or_symbol, error)
+      end
+    end
+
+    def exec_condition_block(block, error)
+      unless block.call
+        fail_execution(error)
+      end
+    end
+
+    def exec_method(method, error)
+      unless self.step.send(method.to_sym)
+        fail_execution(error)
+      end
+    end
+
+    def fail_execution(error)
+      self.fail!
+      @errors << error.new(self)
+    end
+
   end
 end

data/lib/rockflow/version.rb

@@ -1,3 +1,3 @@
 module Rockflow
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/rockflow.rb

@@ -1,6 +1,8 @@
 require 'rockflow/version'
 require 'rockflow/flow'
 require 'rockflow/step'
+require 'rockflow/errors/post_condition'
+require 'rockflow/errors/pre_condition'
 require 'parallel'
 module Rockflow
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rockflow
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Erwin Schens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -87,6 +87,8 @@ files:
 - bin/console
 - bin/setup
 - lib/rockflow.rb
+- lib/rockflow/errors/post_condition.rb
+- lib/rockflow/errors/pre_condition.rb
 - lib/rockflow/flow.rb
 - lib/rockflow/step.rb
 - lib/rockflow/version.rb
@@ -111,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Create workflows the easy way