business_flow 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2320f053af0c28e31b77f23e3147eeccbd8c1268
-  data.tar.gz: a02bf9a70b9e3360419cdcc9541f314811607766
+  metadata.gz: a606f274a7654da5d5ea5bcecec5ad78e6694a94
+  data.tar.gz: 16864e345d6f8b536dd7ae20631b4782511e349f
 SHA512:
-  metadata.gz: e036addb535580b05fe087e30bf8714ef8bf915ba6a4ec2fbf7ad5e9a79e6a4e00d7abc473f93407b9480c6a7e2cd160fa802e857f61f50297eb1687b4f2444e
-  data.tar.gz: 5733ad83bb8b44e8939d8ff8ab3f49b1c33c2612ef6db622f6356289df0f68b7fb7eefbdb2fffb792f74a49bff1c403404cc811fc614baba1b2386c9b72a38b9
+  metadata.gz: 067107876f8431cec4f40545b53ef44706127b64854ba8f130b8d65c1e378971c43ca3f642dc054acca7f80cfef205154b2e4cc82ad2424e7a399d3b8034a65f
+  data.tar.gz: 73ead3612688678e0490910751edc18f6a535e2e6fe8155c7222c4465771b4860631d166984f25f6ba6f99bcb18ed169cda0288980b13479e79e021fced3dd9f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    business_flow (0.4.2)
+    business_flow (0.4.3)
       activemodel (>= 3.0)
       activesupport (>= 3.0)
 
@@ -36,7 +36,7 @@ GEM
     json (2.1.0)
     minitest (5.11.3)
     parallel (1.12.1)
-    parser (2.5.0.3)
+    parser (2.5.0.4)
       ast (~> 2.4.0)
     powerpack (0.1.1)
     rainbow (3.0.0)

data/lib/business_flow/base.rb

@@ -4,6 +4,7 @@ module BusinessFlow
   # call! to raise errors
   # Hooks for cross cutting concerns
   # Figure out how much we can freeze
+  # :reek:ModuleInitialize
   module Base
     def self.included(klass)
       klass.include(DSL)
@@ -16,6 +17,9 @@ module BusinessFlow
       attr_reader :parameter_object
       private :parameter_object
 
+      # Initialize is here so that we can set the parameter object, and then
+      # allow our "parent" class to handle any additional initialization that
+      # it needs to do.
       def initialize(parameter_object)
         @parameter_object = parameter_object
         catch(:halt_step) do

data/lib/business_flow/default_step_executor.rb

@@ -9,7 +9,8 @@ module BusinessFlow
     end
 
     def call
-      ActiveSupport::Notifications.instrument(flow_name, flow: @flow) do
+      return if @flow.errors.present?
+      ActiveSupport::Notifications.instrument(flow_event_name, flow: @flow) do
         @step_queue.each do |step|
           break unless process_step(step)
         end
@@ -38,12 +39,19 @@ module BusinessFlow
     end
 
     def flow_name
-      "business_flow.flow.#{@flow.class.to_s.underscore}"
+      @flow_name ||= @flow.class.to_s.underscore
+    end
+
+    def flow_event_name
+      @flow_event_name ||= "business_flow.flow.#{flow_name}"
+    end
+
+    def step_event_name(step)
+      "#{flow_name}.#{step.to_s.underscore}"
     end
 
     def event_name(step)
-      "business_flow.step.#{@flow.class.to_s.underscore}." \
-        "#{step.to_s.underscore}"
+      "business_flow.step.#{step_event_name(step)}"
     end
   end
 end

data/lib/business_flow/step.rb

@@ -1,5 +1,8 @@
 module BusinessFlow
+  # Step is a conditional callable which can marshal its own inputs, and
+  # returns a value which can marshal errors and outputs into a given object.
   class Step
+    # Represents inputs needed to execute a step.
     class Inputs
       attr_reader :inputs
 
@@ -29,6 +32,8 @@ module BusinessFlow
       end
     end
 
+    # Represents the result of a step, and allows setting response values on
+    # an object, and merging error data into the same object.
     class Result
       def initialize(result, output_map)
         @result = result
@@ -67,7 +72,7 @@ module BusinessFlow
       def merge_errors_into(errors)
         return if @result_errors.blank?
         @result_errors.each do |attribute, message|
-          attribute = "#{@result.class.name}.#{attribute}"
+          attribute = "#{@result.class.name.underscore}.#{attribute}"
           (errors[attribute] << message).uniq!
         end
         throw :halt_step
@@ -103,7 +108,6 @@ module BusinessFlow
       @condition = opts[:condition] || proc { true }
     end
 
-    # @klass can be a symbol or class
     def call(parameter_source)
       parameters = @input_object.parameters_from_source(parameter_source)
       if @condition.call(parameter_source, parameters)

data/lib/business_flow/version.rb

@@ -1,3 +1,3 @@
 module BusinessFlow
-  VERSION = '0.4.2'.freeze
+  VERSION = '0.4.3'.freeze
 end

data/lib/business_flow.rb

@@ -8,5 +8,6 @@ require 'business_flow/default_step_executor'
 require 'business_flow/dsl'
 require 'business_flow/base'
 
+# Makes the magic happen.
 module BusinessFlow
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel