business_flow 0.19.4 → 0.19.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 307a7eda1932f6d130f00e092df7a21cb2a33b011e83673558fdcf0fcbddb197
-  data.tar.gz: 6397d9e3d64e63892323e1d17489aab5d8c65a81dd38723cb7160278c2cbb41b
+  metadata.gz: e3d7a4e0a69860a84583948ad6d3b6189619629e2b6b8a3dac4bdc10c5467c8d
+  data.tar.gz: b3ae0a3456b06ad06826cd55f1c0a7b0c1f5d2789d5d4514b8a155603fb28388
 SHA512:
-  metadata.gz: 73d2958f6aabc69cb04f442a317c1b4cf561f305cbc2641e88a623d003d46dd496d69d62b240fba1d9e0567f4297ed6fa80ef935ea832629563ce31205b419c3
-  data.tar.gz: 15db0becd4c584ef9dd926eb02d4ffe34b30b184ffdbd484fc44b8264e25c1a856b8ea41049ba3f005a342d438dd16e1a75a32842c5e9e1c4d00a8c668eeec88
+  metadata.gz: '08d17ede87236b175510b8e08d9f09815e77f24dd922d3abd5bbd22f447a6a6abbde9f7a3ab36158b70a9dbde879c0ab7949524c39da2162dd66cf16149c87cd'
+  data.tar.gz: e738a183b1fc48a0632eb4db0f6c3212b1e270d1e36f3fcdee7bbe1b1c2e0c6655de48036f66f25e7aa289f7b46cbe561e7f9b524534a05e1b9c836719a7e937

data/.reek.yml

@@ -0,0 +1,13 @@
+# Auto generated by Reeks --todo flag
+---
+detectors:
+  FeatureEnvy:
+    exclude:
+    - BusinessFlow::ClusterLock::ClassMethods::LockFailure#add_to
+  LongParameterList:
+    exclude:
+    - BusinessFlow#self.add_error
+  UncommunicativeVariableName:
+    # N.B. If we want to enable this, we need to tweak the RuboCop config.  In particular, RuboCop
+    # prefers `e` for exceptions.
+    enabled: false

data/.rubocop.yml

@@ -0,0 +1,84 @@
+require:
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - coverage/**/*
+
+# Excluding specs here because of RSpec's tendency to look at the line-number info on a backtrace to
+# decide what to show you when a matcher fails.  I.E. a very long line may be needed to ensure you
+# get good diagnostic info on a test failure.
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - spec/**/*
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/IndexedLet:
+  # We have specs that are describing process steps, so... numbers are kinda the best way to describe that.
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/LeakyConstantDeclaration:
+  # This effectively duplicates Lint/ConstantDefinitionInBlock.
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+  - spec/**/*
+
+Naming/MemoizedInstanceVariableName:
+  # This conflicts with Reek.
+  Enabled: false
+
+# Explicit is bettr than implicit.
+Style/EmptyElse:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+  - spec/**/*
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+# Explicit is bettr than implicit.
+FactoryBot/SyntaxMethods:
+  Enabled: false
+
+# For `match(hash_including(...))`, in specs, this rule would make things pretty unreadable.
+Layout/ClosingParenthesisIndentation:
+  Exclude:
+  - spec/**/*
+
+# This makes things pretty unreadable in a lot of cases, including but not limited to
+# `match(hash_including(...))` in specs.
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'
+
+Lint/EmptyBlock:
+  Enabled: false
+
+# OpenStruct is unwise for actual application code (esp. in light of potentially using yjit in the
+# future), but the flexibility is handy for specs.
+Style/OpenStructUse:
+  Exclude:
+  - spec/**/*
+
+# Disabling this because the "preferred" way requires allocating a Range which is stupid and wrong.
+Style/RandomWithOffset:
+  Enabled: false
+
+# What, exactly, does the Ruby community have against the Truthiness Operator?!
+Style/DoubleNegation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+business_flow

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.4

data/Gemfile

@@ -1,6 +1,18 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in business_flow.gemspec
 gemspec
+
+gem 'pry', '~> 0.14.2'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.1'
+gem 'retryable', '~> 3.0.4'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.59.0'
+gem 'rubocop-rspec', '~> 2.29.1'
+gem 'simplecov', '~> 0.22.0'
+gem 'timecop', '~> 0.9.1'

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    business_flow (0.19.4)
+    business_flow (0.19.6)
       activemodel (>= 4.2, < 8)
       activesupport (>= 4.2, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.3)
-      activesupport (= 7.1.3)
-    activesupport (7.1.3)
+    activemodel (7.1.4)
+      activesupport (= 7.1.4)
+    activesupport (7.1.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -22,75 +22,99 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    concurrent-ruby (1.2.3)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    drb (2.2.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
+    json (2.7.2)
     kwalify (0.7.2)
-    minitest (5.21.2)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    minitest (5.25.1)
     mutex_m (0.2.0)
-    parallel (1.22.1)
-    parser (3.2.2.1)
+    parallel (1.26.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (10.5.0)
+    rake (13.2.1)
     reek (6.1.4)
       kwalify (~> 0.7.0)
       parser (~> 3.2.0)
       rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.9.2)
     retryable (3.0.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rexml (3.3.7)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (0.68.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-rspec (1.24.0)
-      rubocop (>= 0.53.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.0)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.0)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    timecop (0.9.6)
+    timecop (0.9.10)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.5.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   business_flow!
-  rake (~> 10.0)
+  pry (~> 0.14.2)
+  rake (~> 13.0)
   reek (~> 6.1)
   retryable (~> 3.0.4)
   rspec (~> 3.0)
-  rubocop (~> 0.53)
-  rubocop-rspec (~> 1.24.0)
+  rubocop (~> 1.59.0)
+  rubocop-rspec (~> 2.29.1)
   simplecov (~> 0.22.0)
   timecop (~> 0.9.1)
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'business_flow'
 

data/business_flow.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -23,12 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activemodel', '>= 4.2', '< 8'
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
 
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'reek', '~> 6.1'
-  spec.add_development_dependency 'retryable', '~> 3.0.4'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.53'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.24.0'
-  spec.add_development_dependency 'simplecov', '~> 0.22.0'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.required_ruby_version = '>= 2.7.0'
 end

data/lib/business_flow/cacheable.rb

@@ -68,13 +68,14 @@ module BusinessFlow
 
       def clear_cache(parameter_object = {})
         clear_cache!(parameter_object)
-      rescue FlowFailedException => exc
-        exc.flow
+      rescue FlowFailedException => e
+        e.flow
       end
 
       def clear_cache!(parameter_object = {})
         flow = build(parameter_object)
         raise FlowFailedException, result_from(flow) if flow.errors?
+
         ClassMethods.clear_cache(flow)
       end
 
@@ -91,8 +92,8 @@ module BusinessFlow
         with_cache(flow) do
           super(flow)._business_flow_cacheable_finalize(flow.cache_key)
         end
-      rescue FlowFailedException => exc
-        exc.flow
+      rescue FlowFailedException => e
+        e.flow
       end
 
       def with_cache(flow, &blk)
@@ -117,11 +118,13 @@ module BusinessFlow
       RESULT_FINALIZE = proc do |cache_key|
         @cache_key = cache_key
         raise FlowFailedException, self if errors?
+
         self
       end
 
       def add_cache_key_to_result_class
         return if @cache_key_added
+
         result_class = const_get(:Result)
         DSL::PublicField.new(:cache_key).add_to(result_class)
         result_class.send(:define_method, :_business_flow_cacheable_finalize,

data/lib/business_flow/callable.rb

@@ -98,11 +98,9 @@ module BusinessFlow
     def lookup_callable(first_instance)
       constant_name = @callable.to_s.camelcase
       first_instance.class.module_parents.each do |parent|
-        begin
-          return parent.const_get(constant_name)
-        rescue NameError
-          next
-        end
+        return parent.const_get(constant_name)
+      rescue NameError
+        next
       end
       nil
     end

data/lib/business_flow/cluster_lock.rb

@@ -20,23 +20,24 @@ module BusinessFlow
     end
 
     def self.default_servers=(servers)
-      if servers.is_a?(String)
-        @default_servers = proc { servers }
-      elsif servers
-        @default_servers = Callable.new(servers)
-      else
-        @default_servers = nil
-      end
+      @default_servers = if servers.is_a?(String)
+                           proc { servers }
+                         elsif servers
+                           Callable.new(servers)
+                         else
+                           nil
+                         end
     end
 
     def self.default_servers
-      @default_servers ||= proc { nil }
+      @default_servers ||= proc {}
     end
 
     def assert_cluster_lock!
-      @_business_flow_cluster_lock.assert! if !BusinessFlow::ClusterLock.disabled?
-    rescue ZK::Exceptions::ZKError => exc
-      errors.add(:cluster_lock, :assert_failed, message: exc.message)
+      @_business_flow_cluster_lock.assert! unless BusinessFlow::ClusterLock.disabled?
+    rescue ZK::Exceptions::ZKError => e
+      BusinessFlow.add_error(errors, :cluster_lock, :assert_failed, e.message)
+
       raise
     end
 
@@ -49,10 +50,11 @@ module BusinessFlow
     end
 
     # DSL Methods
-    module ClassMethods
+    module ClassMethods # rubocop:disable Metrics/ModuleLength
       # Error raised when there is an internal issue with acquiring a lock.
       class LockFailure < StandardError
         attr_reader :error_type
+
         def initialize(error_type, message)
           @error_type = error_type
           super(message)
@@ -60,7 +62,9 @@ module BusinessFlow
 
         def add_to(flow)
           errors = flow.errors
-          errors.add(:cluster_lock, error_type, message: message) if !errors.key?(:cluster_lock)
+          unless errors.key?(:cluster_lock)
+            BusinessFlow.add_error(errors, :cluster_lock, error_type, message)
+          end
           flow
         end
       end
@@ -114,8 +118,8 @@ module BusinessFlow
         ClassMethods.with_lock(flow, lock_info) do
           super(flow)._business_flow_cluster_lock_finalize(lock_info)
         end
-      rescue LockFailure => exc
-        return result_from(exc.add_to(flow))._business_flow_cluster_lock_finalize(lock_info)
+      rescue LockFailure => e
+        result_from(e.add_to(flow))._business_flow_cluster_lock_finalize(lock_info)
       end
 
       RESULT_FINALIZE = proc do |cluster_lock_info|
@@ -125,6 +129,7 @@ module BusinessFlow
 
       def add_cluster_luck_info_to_result_class
         return if @cluster_lock_info_added
+
         result_class = const_get(:Result)
         DSL::PublicField.new(:cluster_lock_info).add_to(result_class)
         result_class.send(:define_method, :_business_flow_cluster_lock_finalize,
@@ -134,19 +139,23 @@ module BusinessFlow
 
       # :reek:NilCheck
       def self.zookeeper_server_list(flow)
-        servers = catch(:halt_step) { flow.class.with_zookeeper_servers.call(flow)&.merge_into(flow)&.to_s }
-        if servers.nil? || servers.length == 0
+        servers =
+          catch(:halt_step) { flow.class.with_zookeeper_servers.call(flow)&.merge_into(flow)&.to_s }
+        if servers.nil? || servers.empty?
           raise LockFailure.new(:no_servers, 'no zookeeper servers provided')
         end
+
         servers
       end
 
       # :reek:NilCheck
       def self.lock_name(flow)
-        lock_name = catch(:halt_step) { flow.class.with_cluster_lock.call(flow)&.merge_into(flow)&.to_s }
-        if lock_name.nil? || lock_name.length == 0
+        lock_name =
+          catch(:halt_step) { flow.class.with_cluster_lock.call(flow)&.merge_into(flow)&.to_s }
+        if lock_name.nil? || lock_name.empty?
           raise LockFailure.new(:no_lock_name, 'no lock name provided')
         end
+
         lock_name
       end
 
@@ -169,7 +178,7 @@ module BusinessFlow
       def self.inner_acquire_lock(zk_connection, lock, payload)
         lock_held = lock.lock(wait: false)
         payload[:lock_acquired] = lock_held if payload
-        if !lock_held
+        unless lock_held
           zk_connection.close!
           raise LockFailure.new(:lock_unavailable, 'the lock was not available')
         end
@@ -178,11 +187,11 @@ module BusinessFlow
 
       def self.cleanup(lock, zk_connection)
         begin
-          lock.unlock if lock
+          lock&.unlock
         rescue ZK::Exceptions::OperationTimeOut
           # Just let the connection close handle this.
         end
-        zk_connection.close! if zk_connection
+        zk_connection&.close!
       end
 
       # :reek:ControlParameter
@@ -199,16 +208,16 @@ module BusinessFlow
         end
       end
 
-      def self.with_lock(flow, lock_info, &blk)
-        zk_connection, lock =
-          if !BusinessFlow::ClusterLock.disabled?
+      def self.with_lock(flow, lock_info, &_blk)
+        unless BusinessFlow::ClusterLock.disabled?
+          zk_connection, lock =
             instrumented_acquire_lock(flow, lock_info)
-          end
+        end
         yield lock_info
-      rescue ZK::Exceptions::LockAssertionFailedError, ZK::Exceptions::OperationTimeOut => exc
+      rescue ZK::Exceptions::LockAssertionFailedError, ZK::Exceptions::OperationTimeOut => e
         # This would occur if we asserted a cluster lock while executing the flow.
         # This will have set an error on the flow, so we can carry on.
-        raise LockFailure.new(exception_to_error_type(exc), exc.message)
+        raise LockFailure.new(exception_to_error_type(e), e.message)
       ensure
         cleanup(lock, zk_connection)
       end

data/lib/business_flow/compat.rb

@@ -3,7 +3,7 @@
 module BusinessFlow
   # Provides compatibility for ActiveSupport/Model 4.x through 7.x
   module Compat
-    if !Module.instance_methods.include?(:module_parents)
+    unless Module.instance_methods.include?(:module_parents)
       # ActiveSupport 5 removed #parents in favor of #module_parents.
       class ::Module
         def module_parents
@@ -12,13 +12,16 @@ module BusinessFlow
       end
     end
 
-    if !ActiveModel::Errors.instance_methods.include?(:merge!)
+    unless ActiveModel::Errors.instance_methods.include?(:merge!)
       # ActiveModel 5 added details (which we do not use here) and #merge!
       # :reek:MissingSafeMethod Look it's the API.
-      class ::ActiveModel::Errors
-        def merge!(other)
-          other.each do |attribute, message|
-            self[attribute] << message
+      module ::ActiveModel
+        # Amend the errors class with a convenience method.
+        class Errors
+          def merge!(other)
+            other.each do |attribute, message|
+              self[attribute] << message
+            end
           end
         end
       end

data/lib/business_flow/default_step_executor.rb

@@ -13,6 +13,7 @@ module BusinessFlow
     def call
       @step_queue.each do |step|
         break if @flow.errors?
+
         execute_step(step)
       end
     end

data/lib/business_flow/dsl.rb

@@ -5,7 +5,7 @@ module BusinessFlow
   # ClassMethods.
   module DSL
     # Contains the DSL for BusinessFlow
-    module ClassMethods
+    module ClassMethods # rubocop:disable Metrics/ModuleLength
       # Holds metadata about inputs to a flow
       class Inputs
         attr_reader :all, :needs, :optionals
@@ -66,8 +66,8 @@ module BusinessFlow
 
       # Allows a field to be retrieved from the initialiaztion parameters
       def wants(field, default = nil, opts = {}, &blk)
-        internal_name = "wants_#{field}".to_sym
-        default = proc { nil } unless default || block_given?
+        internal_name = :"wants_#{field}"
+        default = proc {} unless default || block_given?
         uses(internal_name, default, opts, &blk)
         inputs.add_wants(ParameterField.new(field, internal_name))
       end
@@ -106,6 +106,7 @@ module BusinessFlow
       def call(parameter_object = {})
         flow = build(parameter_object)
         return result_from(flow) if flow.errors?
+
         execute(flow)
       end
 
@@ -128,6 +129,7 @@ module BusinessFlow
       def call!(*args)
         flow = call(*args)
         raise FlowFailedException, flow if flow.errors?
+
         flow
       end
 
@@ -137,9 +139,9 @@ module BusinessFlow
 
       def step_executor(executor_class = nil)
         if executor_class
-          @executor_class = executor_class
+          @step_executor = executor_class
         else
-          @executor_class ||= ::BusinessFlow::DefaultStepExecutor
+          @step_executor ||= ::BusinessFlow::DefaultStepExecutor
         end
       end
 
@@ -159,22 +161,32 @@ module BusinessFlow
 
       def finalize_result_provider
         return if @finalized_result_provider || !@result_copy
+
         const_get(:Result).class_eval "#{@result_copy}\nend", __FILE__, __LINE__
         @finalized_result_provider = true
       end
 
-      def needs_code
+      def needs_code # rubocop:disable Metrics/MethodLength
         needs.map do |need|
-          %(if #{need}.nil?
-              errors.add(:#{need}, :invalid, message: 'must not be nil')
-              throw :halt_step
-            end
-          )
+          if BusinessFlow.active_model5?
+            %(if #{need}.nil?
+                errors.add(:#{need}, :invalid, message: 'must not be nil')
+                throw :halt_step
+              end
+            )
+          else
+            %(if #{need}.nil?
+                errors.add(:#{need}, 'must not be nil')
+                throw :halt_step
+              end
+            )
+          end
         end.join("\n")
       end
 
       def finalize_initializer
         return if @finalized_initializer
+
         class_eval %{
           private def _business_flow_dsl_initialize(parameter_object)
             @parameter_object = parameter_object
@@ -189,7 +201,7 @@ module BusinessFlow
     FROM_FLOW_PREAMBLE = %(
       def from_flow(flow)
         return if errors?
-    ).freeze
+    )
 
     RESULT_DEF = %(
       class Result
@@ -217,7 +229,7 @@ module BusinessFlow
           !valid?(context)
         end
       end
-    ).freeze
+    )
 
     # Provides the minimum necessary methods to support the use of
     # ActiveModel::Errors
@@ -236,13 +248,16 @@ module BusinessFlow
     end
 
     # :reek:ManualDispatch I have no need to actually call human_attribute_name,
+    # :reek:TooManyStatements Breaking this up would add complexity.
     # I just need to know if I have to provide my own.
     def self.included(klass)
       klass.extend(ClassMethods)
       klass.class_eval RESULT_DEF, __FILE__, __LINE__
       klass.extend(ErrorSupport) unless klass.respond_to?(:human_attribute_name)
       klass.extend(ActiveModel::Naming)
-      klass.include(ErrorSupport::InstanceMethods) unless klass.respond_to?(:read_attribute_for_validation)
+      return if klass.respond_to?(:read_attribute_for_validation)
+
+      klass.include(ErrorSupport::InstanceMethods)
     end
 
     attr_reader :parameter_object
@@ -250,6 +265,7 @@ module BusinessFlow
 
     def call
       return if invalid?
+
       klass = self.class
       klass.step_executor.new(klass.step_queue, self).call
     end
@@ -262,7 +278,7 @@ module BusinessFlow
       @parameter_object = parameter_object
       needs.each do |need|
         if send(need).nil?
-          errors.add(need, :invalid, message: 'must not be nil')
+          BusinessFlow.add_error(need, :invalid, error_type, 'must not be nil')
           throw :halt_step
         end
       end
@@ -275,6 +291,7 @@ module BusinessFlow
       # We only want to fall back to a default if we were
       # given nil. Other falsy vlues should be directly used.
       return yield if value.nil? && block_given?
+
       value
     end
 
@@ -289,11 +306,8 @@ module BusinessFlow
     end
 
     private def _business_flow_dsl_parameters
-      @_business_flow_dsl_parameters ||= Hash[
-        self.class.inputs.all.map do |input|
-          [input, _business_flow_parameter_inner_fetch(input)]
-        end
-      ]
+      @_business_flow_dsl_parameters ||=
+        self.class.inputs.all.to_h { |input| [input, _business_flow_parameter_inner_fetch(input)] }
     end
 
     def errors
@@ -303,7 +317,7 @@ module BusinessFlow
     def errors?
       # We're explicitly using the instance variable here so that if no
       # errors have been created, we don't initialize the error object.
-      @errors && @errors.present?
+      @errors&.present?
     end
 
     def valid?(_context = nil)
@@ -364,6 +378,7 @@ module BusinessFlow
       def self.eval_method(klass, name, str)
         return if klass.method_defined?(name) ||
                   klass.private_method_defined?(name)
+
         unsafe_eval_method(klass, name, str)
       end
 
@@ -444,12 +459,10 @@ module BusinessFlow
       end
 
       def safe_ivar_name
-        @safe_ivar_name ||= begin
-          "@business_flow_dsl_#{field}"
-            .sub(/\?$/, '_query')
-            .sub(/\!$/, '_bang')
-            .to_sym
-        end
+        @safe_ivar_name ||= "@business_flow_dsl_#{field}"
+                            .sub(/\?$/, '_query')
+                            .sub(/!$/, '_bang')
+                            .to_sym
       end
     end
 
@@ -476,7 +489,7 @@ module BusinessFlow
 
       def retriever_method_name
         @retriever_method_name ||=
-          "_business_flow_dsl_execute_step_for_#{@name}".to_sym
+          :"_business_flow_dsl_execute_step_for_#{@name}"
       end
     end
 

data/lib/business_flow/instrument.rb

@@ -11,10 +11,24 @@ module BusinessFlow
 
     # Contains methods that we add to the DSL
     module ClassMethods
-      INSTRUMENTATION_PREFIX = 'business_flow'.freeze
+      INSTRUMENTATION_PREFIX = 'business_flow'
+
+      def with_instrument_payload(payload = nil, opts = {}, &blk)
+        if payload.is_a?(Hash)
+          @payload = Step.new(Callable.new(proc { payload }), {})
+        elsif payload || blk
+          @payload = Step.new(Callable.new(payload || blk), { default_output: :instrument_payload}.merge(opts))
+        else
+          @payload ||= Step.new(Callable.new(proc { {} }), opts)
+        end
+      end
+
+      def self.instrument_payload(flow)
+        catch(:halt_step) { flow.class.with_instrument_payload.call(flow)&.merge_into(flow) }
+      end
 
       def instrument(name, flow)
-        payload = { flow: flow }
+        payload = { flow: flow }.merge(ClassMethods.instrument_payload(flow))
         ActiveSupport::Notifications.instrument(
           "#{INSTRUMENTATION_PREFIX}.#{name}.#{instrumentation_name}", payload
         ) do
@@ -33,7 +47,7 @@ module BusinessFlow
 
       def event_name
         @event_name ||=
-          "#{INSTRUMENTATION_PREFIX}.flow.#{instrumentation_name}".freeze
+          "#{INSTRUMENTATION_PREFIX}.flow.#{instrumentation_name}"
       end
     end
   end

data/lib/business_flow/instrumented_executor.rb

@@ -4,27 +4,19 @@ module BusinessFlow
   # Fire ActiveSupport events for every step that's run and on errors
   class InstrumentedExecutor < DefaultStepExecutor
     def call
-      name = flow_event_name
-      payload = { flow: flow }
-      ActiveSupport::Notifications.instrument(name, payload) do
+      f_class = flow.class
+      f_class.instrument('flow', flow) do |payload|
         super
+        notify_errors(f_class.event_name, payload)
       end
-      notify_errors(name, payload)
     end
 
     protected
 
     def notify_errors(name, payload)
       return unless flow.errors?
-      ActiveSupport::Notifications.publish(name + '.error', payload)
-    end
-
-    def flow_name
-      @flow_name ||= flow.class.instrumentation_name
-    end
 
-    def flow_event_name
-      @flow_event_name ||= flow.class.event_name
+      ActiveSupport::Notifications.publish("#{name}.error", payload)
     end
   end
 end

data/lib/business_flow/instrumented_step_executor.rb

@@ -7,7 +7,7 @@ module BusinessFlow
 
     def execute_step(step)
       i_name = event_name(step)
-      i_payload = { flow: flow, step: step }
+      i_payload = { flow: flow, step: step }.merge(::BusinessFlow::Instrument::ClassMethods.instrument_payload(flow))
       ActiveSupport::Notifications.instrument(i_name, i_payload) do |payload|
         payload[:step_result] = super
       end
@@ -21,5 +21,11 @@ module BusinessFlow
     def event_name(step)
       "business_flow.step.#{step_event_name(step)}"
     end
+
+  protected
+
+    def flow_name
+      @flow_name ||= flow.class.instrumentation_name
+    end
   end
 end

data/lib/business_flow/retryable.rb

@@ -3,7 +3,7 @@
 begin
   require 'retryable'
 rescue LoadError
-  STDERR.puts 'BusinessFlow::Retryable requires the retryable gem'
+  warn 'BusinessFlow::Retryable requires the retryable gem'
   raise
 end
 

data/lib/business_flow/step.rb

@@ -14,12 +14,13 @@ module BusinessFlow
 
       def parameters_from_source(source)
         return source if inputs.blank?
-        Hash[inputs.map do |input_name, input_value|
-               [
-                 input_name,
-                 Inputs.process_input(source, input_value)
-               ]
-             end]
+
+        inputs.to_h do |input_name, input_value| # rubocop:disable Style/HashTransformValues
+          [
+            input_name,
+            Inputs.process_input(source, input_value)
+          ]
+        end
       end
 
       def self.process_input(source, input_value)
@@ -133,7 +134,7 @@ module BusinessFlow
         Result.new(step_result, outputs, output)
       end
 
-    private
+      private
 
       # :reek:ManualDispatch This is faster.
       def callable_for(step_result)
@@ -183,9 +184,7 @@ module BusinessFlow
         opts.fetch(:condition) do
           if_stmts = opts[:if]
           unless_stmts = opts[:unless]
-          if if_stmts.present? || unless_stmts.present?
-            ConditionList.new(if_stmts, unless_stmts)
-          end
+          ConditionList.new(if_stmts, unless_stmts) if if_stmts.present? || unless_stmts.present?
         end
       end
     end
@@ -222,6 +221,7 @@ module BusinessFlow
 
     def output_fields
       return [] unless outputs
+
       outputs.values.select { |field| field.is_a?(Symbol) }
     end
 
@@ -231,20 +231,20 @@ module BusinessFlow
 
     private
 
-    PARAMETERS_NO_INPUT = 'parameter_source'.freeze
+    PARAMETERS_NO_INPUT = 'parameter_source'
     PARAMETERS_WITH_INPUT =
-      '@input_object.parameters_from_source(parameter_source)'.freeze
+      '@input_object.parameters_from_source(parameter_source)'
     WITHOUT_CONDITION = %(
       @result_factory.result(@callable.call(parameter_source, parameters),
                              parameter_source)
-    ).freeze
+    )
     WITH_CONDITION = %(
       if @condition.call(parameter_source, parameters)
         #{WITHOUT_CONDITION}
       else
         CONDITION_FAILED
       end
-    ).freeze
+    )
 
     def update_call_method
       params = @input_object ? PARAMETERS_WITH_INPUT : PARAMETERS_NO_INPUT

data/lib/business_flow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BusinessFlow
-  VERSION = '0.19.4'.freeze
+  VERSION = '0.19.6'
 end

data/lib/business_flow.rb

@@ -18,4 +18,15 @@ require 'business_flow/instrument'
 
 # Makes the magic happen.
 module BusinessFlow
+  def self.active_model5?
+    @active_model5_in_use ||= ActiveModel.version >= Gem::Version.new('5.0.0')
+  end
+
+  def self.add_error(errors, field, error_type, message)
+    if active_model5?
+      errors.add(field, error_type, message: message)
+    else
+      errors.add(field, message)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.19.4
+  version: 0.19.6
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -50,118 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: retryable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.4
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.53'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.53'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.24.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.24.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.1
 description:
 email:
 - alex@teak.io
@@ -170,7 +58,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -199,7 +91,8 @@ files:
 homepage: https://teak.io
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -208,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="