business_flow 0.19.5 → 0.19.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82c431371d59045db43a3e6a53b1f5be3169396eb684cd3dd57360c13e66de93
-  data.tar.gz: 7af7df17705aba80a4c27099a72a122413029bf95f73490d87de2ae66336dd4d
+  metadata.gz: e3d7a4e0a69860a84583948ad6d3b6189619629e2b6b8a3dac4bdc10c5467c8d
+  data.tar.gz: b3ae0a3456b06ad06826cd55f1c0a7b0c1f5d2789d5d4514b8a155603fb28388
 SHA512:
-  metadata.gz: 27e674b0357b3312991ad8d65c91b95e0fed8481259512bdee9e3e2a262e9841af6a1d2b30de250781de36e4aa7544a5d17482ee75013067c9f59c837603958d
-  data.tar.gz: 8c3fe93115e9ac88c71812c1392e9a88702a410ce904f12b2982640a115066a93b1b676fc671be99ef9675073f5e90454d231409e2c13c67ded91f595aa588ae
+  metadata.gz: '08d17ede87236b175510b8e08d9f09815e77f24dd922d3abd5bbd22f447a6a6abbde9f7a3ab36158b70a9dbde879c0ab7949524c39da2162dd66cf16149c87cd'
+  data.tar.gz: e738a183b1fc48a0632eb4db0f6c3212b1e270d1e36f3fcdee7bbe1b1c2e0c6655de48036f66f25e7aa289f7b46cbe561e7f9b524534a05e1b9c836719a7e937

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    business_flow (0.19.5)
+    business_flow (0.19.6)
       activemodel (>= 4.2, < 8)
       activesupport (>= 4.2, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.3.2)
-      activesupport (= 7.1.3.2)
-    activesupport (7.1.3.2)
+    activemodel (7.1.4)
+      activesupport (= 7.1.4)
+    activesupport (7.1.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -22,48 +22,48 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     coderay (1.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
-    docile (1.4.0)
+    docile (1.4.1)
     drb (2.2.1)
-    i18n (1.14.4)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     kwalify (0.7.2)
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
-    minitest (5.22.3)
+    minitest (5.25.1)
     mutex_m (0.2.0)
-    parallel (1.24.0)
+    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.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
     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.0)
+    regexp_parser (2.9.2)
     retryable (3.0.5)
-    rexml (3.2.6)
+    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.0)
+    rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
@@ -80,28 +80,28 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.20.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    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.28.3)
+    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.8)
+    timecop (0.9.10)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby

data/lib/business_flow/instrument.rb

@@ -13,8 +13,22 @@ 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,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.19.5
+  version: 0.19.6
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel