nxt_pipeline 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ddc6f3289300268adabdfda7f6b0a2c50561e9127f6951f0a29ebfb26d48298
-  data.tar.gz: 13af4e35b2014025fb33d16bd9ed1cf74048d6e20404035c5001fedf7db18b02
+  metadata.gz: 0f47be27dd03af5d8a11274b4667a40e2a0c14b4be0a373dd90e1fc7deb93c03
+  data.tar.gz: 6964e21671bb458e187dd3289538e49243e42b06c38c804ffc2b69ed94146612
 SHA512:
-  metadata.gz: c174e7fae2b76cb47b0b2bd1388ad50796603d49283c94056e5af96fbbf46d5d51c745c2cf09015967ac5aa92057f94ec3e6b86412e93686b6b1728db4058c7a
-  data.tar.gz: b9e44023b319bd809e71b83eae038676f51e06aae032c40686ed9c1eee6ee9093b7fe38814c22db9139cf4e2ba5d2bfefeda258d70fb883a7a3e738e27429f46
+  metadata.gz: 5ba8339e42e2e485e9c0c00a35d6df56324b1145605d564039a4931d384d0297ef44b3613c8e45e83dfcfea83f0ed7b5a377f3a6e89f2a03e5b9dbfcc6e47b9a
+  data.tar.gz: f9c938b9302bf9f2b4c126ddaa1b978b99c2f02fe1cdbc6d17be307135a22a504e002c6b110fa0b2eb92a04b5623f4293c8f92575c82ad2240f3de0b4a49a8ad

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## nxt_pipeline 0.4.3 (October 20, 2020)
+
+Add new attribute readers on step object.
+
+After executing a step execution_finished_at execution_started_at and execution_duration
+will be set and can be accessed via attribute readers.
+
 ## nxt_pipeline 0.4.2 (October 12, 2020)
 
 * Fix bug when registering an error without passing arguments in which case the callback didn't get executed. More info: https://github.com/nxt-insurance/nxt_pipeline/issues/39

data/Gemfile.lock

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

data/README.md

@@ -24,35 +24,35 @@ Or install it yourself as:
 
 ### Constructors
 
-First you probably want to configure a pipeline so that it can execute your steps. 
-Therefore you want to define constructors for your steps. Constructors take a name 
+First you probably want to configure a pipeline so that it can execute your steps.
+Therefore you want to define constructors for your steps. Constructors take a name
 as the first argument and step options as the second. All step options are being exposed
-by the step yielded to the constructor. 
+by the step yielded to the constructor.
 
 ```ruby
 pipeline = NxtPipeline::Pipeline.new do |p|
   # Add a named constructor that will be used to execute your steps later
   # All options that you pass in your step will be available through accessors in your constructor
-  # You can call :to_s on a step to set it by default. You can later overwrite at execution for each step if needed. 
+  # You can call :to_s on a step to set it by default. You can later overwrite at execution for each step if needed.
   p.constructor(:service, default: true) do |step, arg:|
     step.to_s = step.service_class.to_s
     result = step.service_class.new(options: arg).call
     result && { arg: result }
   end
-  
+
   p.constructor(:job) do |step, arg:|
     step.job_class.perform_later(*arg) && { arg: arg }
   end
 end
 
-# Once a pipeline was created you can still configure it 
+# Once a pipeline was created you can still configure it
 pipeline.constructor(:call) do |step, arg:|
   result = step.caller.new(arg).call
   result && { arg: result }
 end
 
-# same with block syntax 
-# You can use this to split up execution from configuration  
+# same with block syntax
+# You can use this to split up execution from configuration
 pipeline.configure do |p|
  p.constructor(:call) do |step, arg:|
    result = step.caller.new(arg).call
@@ -61,13 +61,13 @@ pipeline.configure do |p|
 end
 ```
 
-### Defining steps 
+### Defining steps
 
 Once your pipeline knows how to execute your steps you can add those.
 
 ```ruby
 pipeline.step :service, service_class: MyServiceClass, to_s: 'First step'
-pipeline.step service_class: MyOtherServiceClass, to_s: 'Second step' 
+pipeline.step service_class: MyOtherServiceClass, to_s: 'Second step'
 # ^ Since service is the default step you don't have to specify it the step type each time
 pipeline.step :job, job_class: MyJobClass # to_s is optional
 pipeline.step :job, job_class: MyOtherJobClass
@@ -82,12 +82,12 @@ end
 ```
 
 You can also define inline steps, meaning the block will be executed. When you do not provide a :to_s option, type
-will be used as :to_s option per default. When no type was given for an inline block the type of the inline block 
-will be set to :inline. 
+will be used as :to_s option per default. When no type was given for an inline block the type of the inline block
+will be set to :inline.
 
 ### Execution
 
-You can then execute the steps with: 
+You can then execute the steps with:
 
 ```ruby
 pipeline.execute(arg: 'initial argument')
@@ -111,13 +111,13 @@ NxtPipeline::Pipeline.execute(arg: 'initial argument') do |p|
     { arg: arg.upcase }
   end
 end
-``` 
+```
 
-You can query the steps of your pipeline simply by calling `pipeline.steps`. A NxtPipeline::Step will provide you with 
-an interface to it's type, options, status (:success, :skipped, :failed), result, error and the index in the pipeline.
+You can query the steps of your pipeline simply by calling `pipeline.steps`. A NxtPipeline::Step will provide you with
+an interface to it's type, options, status (:success, :skipped, :failed), execution_finished_at execution_started_at, execution_duration, result, error and the index in the pipeline.
 
 ```
-pipeline.steps.first 
+pipeline.steps.first
 # will give you something like this:
 
 #<NxtPipeline::Step:0x00007f83eb399448
@@ -128,20 +128,23 @@ pipeline.steps.first
  @opts={:to_s=>:transformer, :method=>:upcase},
  @result=nil,
  @status=nil,
- @type=:transformer> 
-``` 
+ @type=:transformer
+ @execution_duration=1.0e-05,
+ @execution_finished_at=2020-10-22 15:52:55.806417 +0100,
+ @execution_started_at=2020-10-22 15:52:55.806407 +0100,>
+```
 
 ### Guard clauses
 
 You can also define guard clauses that take a proc to prevent the execution of a step.
-When the guard takes an argument the step argument is yielded.  
+When the guard takes an argument the step argument is yielded.
 
  ```ruby
  pipeline.execute(arg: 'initial argument') do |p|
    p.step :service, service_class: MyServiceClass, if: -> (arg:) { arg == 'initial argument' }
    p.step :service, service_class: MyOtherServiceClass, unless: -> { false }
  end
- 
+
  ```
 
 ### Error callbacks
@@ -153,25 +156,25 @@ NxtPipeline::Pipeline.new do |p|
   p.step do |_, arg:|
     { arg: arg.upcase }
   end
-  
+
   p.on_error MyCustomError do |step, opts, error|
     # First matching error callback will be executed!
   end
-  
+
   p.on_errors ArgumentError, KeyError do |step, opts, error|
     # First matching error callback will be executed!
   end
-  
+
   p.on_errors YetAnotherError, halt_on_error: false do |step, opts, error|
     # After executing the callback the pipeline will not halt but continue to
     # execute the next steps.
   end
-  
+
   p.on_errors do |step, opts, error|
     # This will match all errors inheriting from StandardError
   end
 end
-``` 
+```
 
 ### Before and After callbacks
 
@@ -181,27 +184,27 @@ You can also define callbacks that run before and after the `#execute` action. B
 NxtPipeline::Pipeline.new do |p|
   p.before_execute do |pipeline, arg:|
     # Will be called from within #execute before entering the first step
-    # After any configure block though!  
+    # After any configure block though!
   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. 
+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.
 
 ### Step resolvers
 
 NxtPipeline is using so called step_resolvers to find the constructor for a given step by the arguments passed in.
-You can also use this if you are not fine with resolving the constructor from the step argument. Check out the 
-`nxt_pipeline/spec/step_resolver_spec.rb` for examples how you can implement your own step_resolvers.  
+You can also use this if you are not fine with resolving the constructor from the step argument. Check out the
+`nxt_pipeline/spec/step_resolver_spec.rb` for examples how you can implement your own step_resolvers.
 
 
 ## Topics
 - Step orchestration (chainable steps)
-- Constructors should take arg as first and step as second arg 
+- Constructors should take arg as first and step as second arg
 
 ## Development
 

data/lib/nxt_pipeline/step.rb

@@ -16,47 +16,57 @@ module NxtPipeline
       @mapped_options = nil
     end
 
-    attr_reader :argument, :result, :status, :error, :opts, :index, :mapped_options
+    attr_reader :argument, :result, :status, :execution_started_at, :execution_finished_at, :execution_duration, :error, :opts, :index, :mapped_options
     attr_accessor :to_s
 
     alias_method :name=, :to_s=
     alias_method :name, :to_s
 
     def execute(**changeset)
-      mapper = options_mapper || default_options_mapper
-      mapper_args = [changeset, self].take(mapper.arity)
-      self.mapped_options = mapper.call(*mapper_args)
-
-      guard_args = [changeset, self]
+      track_execution_time do
+        set_mapped_options(changeset)
+        guard_args = [changeset, self]
 
-      if_guard_args = guard_args.take(if_guard.arity)
-      unless_guard_guard_args = guard_args.take(unless_guard.arity)
-
-      if !instrumentalize_callable(unless_guard, unless_guard_guard_args) && instrumentalize_callable(if_guard, if_guard_args)
-        constructor_args = [self, changeset]
-        constructor_args = constructor_args.take(constructor.arity)
+        if evaluate_unless_guard(guard_args) && evaluate_if_guard(guard_args)
+          self.result = construct_result(changeset)
+        end
 
-        self.result = instrumentalize_callable(constructor, constructor_args)
+        set_status
+        result
       end
-
-      set_status
-      result
     rescue StandardError => e
       self.status = :failed
       self.error = e
       raise
     end
 
-    # def type?(potential_type)
-    #   constructor.resolve_type(potential_type)
-    # end
+    def set_mapped_options(changeset)
+      mapper = options_mapper || default_options_mapper
+      mapper_args = [changeset, self].take(mapper.arity)
+      self.mapped_options = mapper.call(*mapper_args)
+    end
 
     private
 
-    attr_writer :result, :status, :error, :mapped_options
+    attr_writer :result, :status, :error, :mapped_options, :execution_started_at, :execution_finished_at, :execution_duration
     attr_reader :constructor, :options_mapper
-    
-    def instrumentalize_callable(callable, args)
+
+    def evaluate_if_guard(args)
+      execute_callable(if_guard, args)
+    end
+
+    def evaluate_unless_guard(args)
+      !execute_callable(unless_guard, args)
+    end
+
+    def construct_result(changeset)
+      args = [self, changeset]
+      execute_callable(constructor, args)
+    end
+
+    def execute_callable(callable, args)
+      args =  args.take(callable.arity)
+
       if args.last.is_a?(Hash)
         callable.call(*args.take(args.length - 1), **args.last)
       else
@@ -88,9 +98,29 @@ module NxtPipeline
       self.status = result.present? ? :success : :skipped
     end
 
+    def track_execution_time(&block)
+      set_execution_started_at
+      block.call
+    ensure
+      set_execution_finished_at
+      set_execution_duration
+    end
+
+    def set_execution_started_at
+      self.execution_started_at = Time.current
+    end
+
+    def set_execution_finished_at
+      self.execution_finished_at = Time.current
+    end
+
+    def set_execution_duration
+      self.execution_duration = execution_finished_at - execution_started_at
+    end
+
     def default_options_mapper
       # returns an empty hash
-      ->(changeset) { {} }
+      ->(_) { {} }
     end
   end
-end
+end

data/lib/nxt_pipeline/version.rb

@@ -1,4 +1,4 @@
 module NxtPipeline
-  VERSION = "0.4.2".freeze
+  VERSION = "0.4.3".freeze
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Nils Sommer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport