rockflow 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97479cf2dc7550e329b306cf38bdbd8939271f0d
-  data.tar.gz: 719a5a64754c3218af753d0417ff8db6ea91df3f
+  metadata.gz: 6ae1762c75ba21ee5a1ec36364cadb752ab3bd11
+  data.tar.gz: 82617c7fa4a418858ce1fb91abbce792e4211eb2
 SHA512:
-  metadata.gz: 4a3a394180bd88788fc829616070f967a9f4e4e4ab27066c1429ea0743cd4ab6e01eb94538f1ee05a7bb5031008ffebec9be9c3d2c29f8d6cd2940dc9ecf0069
-  data.tar.gz: 7c4eb50446fe6c01c4c39c00b74bf6b53b74ccdbb65384a931731c15683be1a1d1e34ae595d530b5bda36b932335f8c8e47f87edbb27961f78a9f69492cba7d4
+  metadata.gz: 06f91f0e3da1cce9f1c79de01e6c8c2e673814265e7ad2ef1cad3877d473d6b7618062d491911ac931907e6afb57ce66984d240eb2984bf370730c04863cf99f
+  data.tar.gz: 1ab3a8863bdc09cce9e9a7b7d713bb5b75d963f52a63b307b6041c243a8b1f65a2e5c0ce8b520f1c6a52b2cc810ba7a9391d671a4eed681e2bb17444a1aeb24c

data/README.md

@@ -21,6 +21,15 @@ Or install it yourself as:
 
     $ gem install rockflow
 
+## Getting started
+Run the bundle command to install it.
+After you install Rockflow and add it to your Gemfile, you need to run the generator:
+
+```bash
+rails generate rockflow:install
+```
+The generator will install an initializer which describes all of Rockflow's configuration options.
+
 ## Usage
 
 To write your own flow you need two ingredients: the **flow** and your **steps** lets start by looking at the flow.
@@ -76,9 +85,12 @@ So now i have defined my steps and my flow but how can i execute it? Well simple
 
 ```ruby
 flow = AwesomeFlow.new
-flow.concert! # execute all steps
+flow.concert! # execute all steps and returns all steps
+flow.concert # returns false or true
 ```
 
+Please note that if any of your steps fail the parallel execution is interrupted and and an exception is raised. 
+
 #### Summary
 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.

data/lib/generators/rockflow/install_generator.rb

@@ -0,0 +1,9 @@
+module Rockflow
+  class InstallGenerator < Rails::Generators::Base
+    source_root(File.expand_path(File.dirname(__FILE__)))
+
+    def copy_initializer
+      copy_file '../../templates/rockflow.rb', 'config/initializers/rockflow.rb'
+    end
+  end
+end

data/lib/rockflow/flow.rb

@@ -41,15 +41,29 @@ module Rockflow
 
     def execute_steps
       while !steps_finished?
-        ::Parallel.each(next_free_steps, in_threads: 4) do |step|
-          step.execute_pre_conditions
-          step.it_up unless step.failed?
-          step.execute_post_conditions
-          step.finish! unless step.failed?
+        ::Parallel.each(next_free_steps, threads_or_processes.to_sym => Rockflow.configuration.thread_or_processes) do |step|
+          begin
+            step.execute_pre_conditions
+            step.it_up unless step.failed?
+            step.execute_post_conditions
+            step.finish! unless step.failed?
+          rescue e
+            raise Parallel::Break, e.message
+          end
         end
       end
       @steps
     end
 
+    private
+
+    def threads_or_processes
+      if Rockflow.configuration.use_threads
+        :in_threads
+      else
+        :in_processes
+      end
+    end
+
   end
 end

data/lib/rockflow/version.rb

@@ -1,3 +1,3 @@
 module Rockflow
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/lib/rockflow.rb

@@ -5,4 +5,24 @@ require 'rockflow/errors/post_condition'
 require 'rockflow/errors/pre_condition'
 require 'parallel'
 module Rockflow
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :use_processes
+    attr_accessor :use_threads
+    attr_accessor :thread_or_processes
+
+    def initialize
+      @use_processes = false
+      @use_threads = true
+      @thread_or_processes = 4
+    end
+  end
 end

data/lib/templates/rockflow.rb

@@ -0,0 +1,15 @@
+Rockflow.configure do |config|
+  # Define if you want to use processes instead of threads.
+  # Please keep in mind to set the option use_threads to false if you want to use processes
+  # Processes are set to false by default
+  # config.use_processes = false
+
+  # Define if you want to use threads instead of processes.
+  # Please keep in mind to set the option use_processes to false if you want to use threads.
+  # Threads are set to true by default
+  # config.use_threads = true
+
+  # Set the count of threads or processes to be used by rockflow.
+  # The default value is 4
+  # config.thread_or_processes = 4
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rockflow
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Erwin Schens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -86,12 +86,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/rockflow/install_generator.rb
 - 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
+- lib/templates/rockflow.rb
 - rockflow.gemspec
 homepage: http://qurasoft.de
 licenses: