nxt_pipeline 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8762564262fbcc4274226dd10acd423e960f31624ae20ca539a4951a626e211
-  data.tar.gz: 17f1adb27f76aaddf71e2dd00ae303e8837560e4fdfae911a98812f30408e541
+  metadata.gz: 5d27e24e15af26cd6a1e617ee4a5e71a7b3b556af42983625800e7e74e61f0ef
+  data.tar.gz: b2b21c668222af41422878246fc179f6fc25174e23a7873e536df1df2dc64966
 SHA512:
-  metadata.gz: efb282aef978706713a0f76332a66298c99d5278794e6935742d08a5d54d271d9c01a633e0c8fcf7d5b67a4c0f945d3fe4de64b871558e7e4a80ac5e87088264
-  data.tar.gz: 48b4ba6cbb45a9a7f2848e70bc3bd4e6bde884badf820e74cda8d1fea69903f5119204bc073f5f8b6e6386ef6c805f5b0e009938dd881a024d8842947a3697e5
+  metadata.gz: 03d15d8834d22ca23f4567cac7e8e0d01a77818468e40866a964c164c9fb4adbd59d0a5a79c9acfaee434c44f0f0a2590a982173b107fd9f581cf7f68e381a8b
+  data.tar.gz: ed153b7d64fa2c45314cdbb494e5567dc7fda6d8c6f848d3596a979c330a3e4f03e6eaf0f18a77b43b160f0dcfabaf99df18c6f6ba847c797d9830b099f93535

data/.circleci/config.yml

@@ -7,7 +7,9 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.6.1-node
+      - image: circleci/ruby:2.7.0-node
+    environment:
+      BUNDLER_VERSION: 2.1.4
 
     working_directory: ~/repo
 
@@ -19,6 +21,8 @@ jobs:
           keys:
             - v1-dependencies-{{ checksum "Gemfile.lock" }}
 
+      - run: gem install bundler --version $BUNDLER_VERSION
+
       - run:
           name: install dependencies
           command: |

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.0

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## Unreleased
+## nxt_pipeline 0.4.1 (March 13, 2020)
+
+* Fix deprecation warnings for Ruby 2.7
 
 ## nxt_pipeline 0.2.0 (March 10, 2019)
 

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    nxt_pipeline (0.4.0)
+    nxt_pipeline (0.4.1)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
+    byebug (11.1.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     ffi (1.11.1)
     formatador (0.2.5)
@@ -32,7 +33,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.6.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -40,7 +41,7 @@ GEM
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
     method_source (0.9.2)
-    minitest (5.11.3)
+    minitest (5.14.0)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -48,44 +49,47 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (12.3.3)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (13.0.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.9)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.1)
   guard-rspec
   nxt_pipeline!
-  pry
-  rake (~> 12.3)
+  pry-byebug
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec_junit_formatter
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -192,55 +192,12 @@ 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. 
 
-### DSL
+### Step resolvers
 
-The gem also comes with an easy DSL to make pipeline handling in your code more convenient. 
-Simply include NxtPipeline::Dsl in your class:
+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.  
 
-```ruby
-class MyAwesomeClass
-  include NxtPipeline::Dsl
-  
-  # register a pipeline with a name and a block
-  pipeline :validation do |p|
-    pipeline.constructor(:validate) do |step, arg:|
-      result = step.validator.call(arg: arg)
-      result && { arg: result }
-    end
-    
-    pipeline.step :validate, validator: NameValidator
-    pipeline.step :validate, validator: AdressValidator
-    pipeline.step :validate, validator: BankAccountValidator
-    pipeline.step :validate, validator: PhoneNumberValidator
-    
-    p.on_error ValidationError do |step, opts, error|
-      # ...
-    end
-  end
-  
-  pipeline :execution do |p|
-    p.step do |_, arg:|
-      { arg: arg.upcase }
-    end
-      
-    p.on_error MyCustomError do |step, opts, error|
-      # nesting pipelines also works
-      pipeline(:error).execute(error)
-    end
-  end
-  
-  pipeline :error do |p|
-    p.step do |_, error|
-      error # do something here
-    end
-  end
-  
-  def call(arg)
-    # execute a pipeline simply by fetching it and calling execute on it as you would normally
-    pipeline(:execution).execute(arg: arg)
-  end
-end
-```
 
 ## Topics
 - Step orchestration (chainable steps)

data/lib/nxt_pipeline.rb

@@ -5,7 +5,6 @@ require 'nxt_pipeline/constructor'
 require 'nxt_pipeline/pipeline'
 require 'nxt_pipeline/step'
 require 'nxt_pipeline/error_callback'
-require 'nxt_pipeline/dsl'
 
 module NxtPipeline
 end

data/lib/nxt_pipeline/constructor.rb

@@ -1,13 +1,20 @@
 module NxtPipeline
   class Constructor
-    def initialize(name, opts, block)
+    def initialize(name, **opts, &block)
       @name = name
       @block = block
       @opts = opts
     end
 
     attr_reader :opts, :block
-
-    delegate :call, :arity, to: :block
+    
+    delegate :arity, to: :block
+    
+    def call(*args, **opts, &block)
+      # ActiveSupport's #delegate does not properly handle keyword arg passing
+      # in the latest released version. Thefore we bypass delegation by reimplementing
+      # the method ourselves. This is already fixed in Rails master though.
+      self.block.call(*args, **opts, &block)
+    end
   end
 end

data/lib/nxt_pipeline/error_callback.rb

@@ -1,6 +1,6 @@
 module NxtPipeline
   class ErrorCallback
-    def initialize(errors, halt_on_error, callback)
+    def initialize(errors, halt_on_error, &callback)
       @errors = errors
       @halt_on_error = halt_on_error
       @callback = callback

data/lib/nxt_pipeline/pipeline.rb

@@ -25,7 +25,7 @@ module NxtPipeline
       name = name.to_sym
       raise StandardError, "Already registered step :#{name}" if constructors[name]
 
-      constructors[name] = Constructor.new(name, opts, constructor)
+      constructors[name] = Constructor.new(name, **opts, &constructor)
 
       return unless opts.fetch(:default, false)
       set_default_constructor(name)
@@ -50,7 +50,7 @@ module NxtPipeline
         # fall back to :inline if no type is given
         argument ||= :inline
         opts.reverse_merge!(to_s: argument)
-        Constructor.new(:inline, opts, block)
+        Constructor.new(:inline, **opts, &block)
       else
         constructor = step_resolvers.lazy.map do |resolver|
           resolver.call(argument)
@@ -78,6 +78,16 @@ module NxtPipeline
       result = steps.inject(changeset) do |changeset, step|
         execute_step(step, **changeset)
       rescue StandardError => error
+        logger_for_error = logger
+
+        error.define_singleton_method :details do
+          OpenStruct.new(
+            changeset: changeset,
+            logger: logger_for_error,
+            step: step
+          )
+        end
+
         callback = find_error_callback(error)
         raise unless callback && callback.continue_after_error?
         handle_step_error(error)
@@ -100,7 +110,7 @@ module NxtPipeline
     end
 
     def on_errors(*errors, halt_on_error: true, &callback)
-      error_callbacks << ErrorCallback.new(errors, halt_on_error, callback)
+      error_callbacks << ErrorCallback.new(errors, halt_on_error, &callback)
     end
 
     alias :on_error :on_errors

data/lib/nxt_pipeline/step.rb

@@ -32,10 +32,11 @@ module NxtPipeline
       if_guard_args = guard_args.take(if_guard.arity)
       unless_guard_guard_args = guard_args.take(unless_guard.arity)
 
-      if !unless_guard.call(*unless_guard_guard_args) && if_guard.call(*if_guard_args)
+      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)
-        self.result = constructor.call(*constructor_args)
+
+        self.result = instrumentalize_callable(constructor, constructor_args)
       end
 
       set_status
@@ -54,6 +55,14 @@ module NxtPipeline
 
     attr_writer :result, :status, :error, :mapped_options
     attr_reader :constructor, :options_mapper
+    
+    def instrumentalize_callable(callable, args)
+      if args.last.is_a?(Hash)
+        callable.call(*args.take(args.length - 1), **args.last)
+      else
+        callable.call(*args)
+      end
+    end
 
     def if_guard
       opts.fetch(:if) { guard(true) }

data/lib/nxt_pipeline/version.rb

@@ -1,4 +1,4 @@
 module NxtPipeline
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end
 

data/nxt_pipeline.gemspec

@@ -35,9 +35,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_pipeline
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Nils Sommer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gitignore"
+- ".pryrc"
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
@@ -121,7 +122,6 @@ files:
 - bin/setup
 - lib/nxt_pipeline.rb
 - lib/nxt_pipeline/constructor.rb
-- lib/nxt_pipeline/dsl.rb
 - lib/nxt_pipeline/error_callback.rb
 - lib/nxt_pipeline/logger.rb
 - lib/nxt_pipeline/pipeline.rb
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: DSL to build Pipeline with mountable Segments to process things.

data/lib/nxt_pipeline/dsl.rb

@@ -1,48 +0,0 @@
-module NxtPipeline
-  module Dsl
-    module ClassMethods
-      def pipeline(name = :default, parent = NxtPipeline::Pipeline, &block)
-        name = name.to_sym
-        raise ArgumentError, "No block given!" unless block_given?
-        raise_already_registered_error(name) if pipeline_registry.key?(name)
-        register_pipeline(name, block, parent)
-      end
-
-      def pipeline!(name, parent = NxtPipeline::Pipeline, &block)
-        raise ArgumentError, "No block given!" unless block_given?
-        register_pipeline(name, block, parent)
-      end
-
-      private
-
-      def inherited(child)
-        child.instance_variable_set(:@pipeline_registry, pipeline_registry.deep_dup)
-      end
-
-      def raise_already_registered_error(name)
-        raise KeyError, "Already registered a pipeline #{name}. Call pipeline! to overwrite already registered pipelines"
-      end
-
-      def pipeline_registry
-        @pipeline_registry ||= ActiveSupport::HashWithIndifferentAccess.new
-      end
-
-      def register_pipeline(name, block, parent)
-        pipeline_registry[name] = { config: block, parent: parent }
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-
-      def pipeline(name = :default)
-        registry = self.class.send(:pipeline_registry)
-        entry = registry.fetch(name) { raise KeyError, "No pipeline #{name} registered"}
-        config = entry.fetch(:config)
-        pipeline = entry.fetch(:parent).new
-        instance_exec(pipeline, &config)
-        pipeline
-      end
-    end
-  end
-end