business_flow 0.19.5 → 0.20.0

data/lib/business_flow/dsl.rb

@@ -65,10 +65,10 @@ module BusinessFlow
       end
 
       # Allows a field to be retrieved from the initialiaztion parameters
-      def wants(field, default = nil, opts = {}, &blk)
+      def wants(field, default = nil, opts = {}, &)
         internal_name = :"wants_#{field}"
         default = proc {} unless default || block_given?
-        uses(internal_name, default, opts, &blk)
+        uses(internal_name, default, opts, &)
         inputs.add_wants(ParameterField.new(field, internal_name))
       end
 
@@ -238,7 +238,7 @@ module BusinessFlow
         key
       end
 
-      # Provides the miniimum necessary instance methods to support the use of
+      # Provides the minimum necessary instance methods to support the use of
       # ActiveMode::Errors, outside of what's provided by ActiveModel::Naming
       module InstanceMethods
         def read_attribute_for_validation(key)
@@ -270,11 +270,33 @@ module BusinessFlow
       klass.step_executor.new(klass.step_queue, self).call
     end
 
+    def errors
+      @errors ||= ActiveModel::Errors.new(self)
+    end
+
+    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&.present?
+    end
+
+    def valid?(_context = nil)
+      # We're explicitly using the instance variable here so that if no
+      # errors have been created, we don't initialize the error object.
+      @errors.blank?
+    end
+
+    def invalid?(context = nil)
+      !valid?(context)
+    end
+
+    private
+
     # Responsible for setting the parameter object and validating inputs.
     # This is a method directly on the object instead of something we
     # handle through instance_eval/exec for performance reasons.
     # :reek:NilCheck This is where we ensure that our needs are non-nil.
-    private def _business_flow_dsl_initialize(parameter_object, needs)
+    def _business_flow_dsl_initialize(parameter_object, needs)
       @parameter_object = parameter_object
       needs.each do |need|
         if send(need).nil?
@@ -286,7 +308,7 @@ module BusinessFlow
     end
 
     # :reek:NilCheck
-    private def _business_flow_parameter_fetch(key)
+    def _business_flow_parameter_fetch(key)
       value = _business_flow_parameter_inner_fetch(key)
       # We only want to fall back to a default if we were
       # given nil. Other falsy vlues should be directly used.
@@ -295,7 +317,7 @@ module BusinessFlow
       value
     end
 
-    private def _business_flow_parameter_inner_fetch(key)
+    def _business_flow_parameter_inner_fetch(key)
       if @parameter_object.is_a?(Hash) && @parameter_object.key?(key)
         @parameter_object[key]
       else
@@ -305,31 +327,11 @@ module BusinessFlow
       nil
     end
 
-    private def _business_flow_dsl_parameters
+    def _business_flow_dsl_parameters
       @_business_flow_dsl_parameters ||=
         self.class.inputs.all.to_h { |input| [input, _business_flow_parameter_inner_fetch(input)] }
     end
 
-    def errors
-      @errors ||= ActiveModel::Errors.new(self)
-    end
-
-    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&.present?
-    end
-
-    def valid?(_context = nil)
-      # We're explicitly using the instance variable here so that if no
-      # errors have been created, we don't initialize the error object.
-      @errors.blank?
-    end
-
-    def invalid?(context = nil)
-      !valid?(context)
-    end
-
     # Responsible for creating fields on one or more classes and noting the of
     # field
     class FieldList

data/lib/business_flow/instrument.rb

@@ -13,8 +13,23 @@ module BusinessFlow
     module ClassMethods
       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

data/lib/business_flow/instrumented_executor.rb

@@ -4,12 +4,11 @@ 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
@@ -19,13 +18,5 @@ module BusinessFlow
 
       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
-    end
   end
 end

data/lib/business_flow/instrumented_step_executor.rb

@@ -7,7 +7,10 @@ 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 +24,9 @@ module BusinessFlow
     def event_name(step)
       "business_flow.step.#{step_event_name(step)}"
     end
+
+    def flow_name
+      @flow_name ||= flow.class.instrumentation_name
+    end
   end
 end

data/lib/business_flow/step.rb

@@ -229,8 +229,6 @@ module BusinessFlow
       @callable.to_s
     end
 
-    private
-
     PARAMETERS_NO_INPUT = 'parameter_source'
     PARAMETERS_WITH_INPUT =
       '@input_object.parameters_from_source(parameter_source)'
@@ -244,7 +242,9 @@ module BusinessFlow
       else
         CONDITION_FAILED
       end
-    )
+    ).freeze
+
+    private
 
     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.5'
+  VERSION = '0.20.0'
 end

data/lib/business_flow.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'active_model'
 require 'active_support/core_ext'
 require 'business_flow/compat'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.19.5
+  version: 0.20.0
 platform: ruby
 authors:
 - Alex Scarborough
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -19,7 +18,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +38,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,14 +48,14 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
-description:
+        version: '8.1'
 email:
 - alex@teak.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rspec"
@@ -64,6 +63,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -72,6 +72,21 @@ files:
 - bin/console
 - bin/setup
 - business_flow.gemspec
+- gemfiles/.bundle/config
+- gemfiles/activemodel_4.2.gemfile
+- gemfiles/activemodel_4.2.gemfile.lock
+- gemfiles/activemodel_5.2.gemfile
+- gemfiles/activemodel_5.2.gemfile.lock
+- gemfiles/activemodel_6.1.gemfile
+- gemfiles/activemodel_6.1.gemfile.lock
+- gemfiles/activemodel_7.0.gemfile
+- gemfiles/activemodel_7.0.gemfile.lock
+- gemfiles/activemodel_7.1.gemfile
+- gemfiles/activemodel_7.1.gemfile.lock
+- gemfiles/activemodel_7.2.gemfile
+- gemfiles/activemodel_7.2.gemfile.lock
+- gemfiles/activemodel_8.0.gemfile
+- gemfiles/activemodel_8.0.gemfile.lock
 - lib/business_flow.rb
 - lib/business_flow/base.rb
 - lib/business_flow/cacheable.rb
@@ -93,7 +108,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,15 +115,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: General purpose management of service object flows
 test_files: []