nxt_pipeline 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4103a1a9d5d3220e1b2f6df7776878cc478d7ceec612e0f743fa24f3405b942a
-  data.tar.gz: 84c9da4b2f27e5814220f14007f7de259267a9dfca168ecfa4a69a97065abbbd
+  metadata.gz: 6b545c68dc71684330edc75197b306a9f87abfb90240efe4708d426299902782
+  data.tar.gz: d47d498587927798476462538f3c42ea7a151080fe6cdbdccd56e0e12baa9d05
 SHA512:
-  metadata.gz: 2a5f3d8efeb773ed700bbcd30aba75415554ab6221e4a95d518d38d9cf32d00c8982eca0e8ad0d46f280b25c845d3a306eda59e6797a8d94d2551740761a8d68
-  data.tar.gz: 7201abcca537229b6bc27d458a428f84f510c14a0a2c926af8387b2025f719e4336b22c062ba3b591c17adfb73f9c91039b99d2d731897b7d1d51e47ab8ca838
+  metadata.gz: ddfe39ac16d28a562a28f42e41205828f8ffe8c448b8135e798aecfd71a2083870e4faffc7e5fc0f1e19625d63eaf0f2930e1b2fbc21a6cb68987647446ae5de
+  data.tar.gz: 76ef2fc1b046dac15ed2c5f913048ea304b9ceddcfcd7f6777b9a623026d87e49322ecae0219ce35813b86aabf30867debb667ec69157adebd1adfd0620e6b53

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_pipeline (0.2.2)
+    nxt_pipeline (0.2.4)
       activesupport
 
 GEM

data/README.md

@@ -130,6 +130,24 @@ NxtPipeline::Pipeline.new do |p|
 end
 ``` 
 
+### Before and After callbacks
+
+You can also define callbacks that run before and after the `#execute` action. Both callback blocks get the pipeline instance (to access stuff like the `log`) and the argument of the pipeline yielded.
+
+```ruby
+NxtPipeline::Pipeline.new do |p|
+  p.before_execute do |pipeline, arg|
+    # Will be called from within #execute before entering the first step
+  end
+  
+  p.after_execute do |pipeline, arg|
+    # Will be called from within #execute after executing last step
+  end
+end
+```
+
+Note that the `after_execute` callback will not be called, when an error is raised in one of the steps. See the previous section (_Error callbacks_) for how to define callbacks that run in case of errors. 
+
 
 ## Development
 

data/lib/nxt_pipeline/pipeline.rb

@@ -46,10 +46,13 @@ module NxtPipeline
 
     def execute(arg, &block)
       reset_log
+      before_execute_callback.call(self, arg) if before_execute_callback.respond_to?(:call)
       configure(&block) if block_given?
-      steps.inject(arg) do |argument, step|
+      result = steps.inject(arg) do |argument, step|
         execute_step(step, argument)
       end
+      after_execute_callback.call(self, result) if after_execute_callback.respond_to?(:call)
+      result
     rescue StandardError => error
       log[current_step] = { status: :failed, reason: "#{error.class}: #{error.message}" }
       callback = find_error_callback(error)
@@ -64,6 +67,14 @@ module NxtPipeline
 
     alias :on_error :on_errors
 
+    def before_execute(&callback)
+      self.before_execute_callback = callback
+    end
+
+    def after_execute(&callback)
+      self.after_execute_callback = callback
+    end
+
     def configure(&block)
       block.call(self)
       self
@@ -72,7 +83,7 @@ module NxtPipeline
     private
 
     attr_reader :error_callbacks, :registry
-    attr_accessor :steps, :current_step, :current_arg, :default_constructor
+    attr_accessor :steps, :current_step, :current_arg, :default_constructor, :before_execute_callback, :after_execute_callback
     attr_writer :log
 
     def execute_step(step, arg)
@@ -98,4 +109,4 @@ module NxtPipeline
       self.current_arg = nil
     end
   end
-end
+end

data/lib/nxt_pipeline/version.rb

@@ -1,3 +1,3 @@
 module NxtPipeline
-  VERSION = "0.2.3".freeze
+  VERSION = "0.2.4".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Nils Sommer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport