business_flow 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e290b1ee2ae04716265134fba7524c9807aca356
-  data.tar.gz: eac9618cc742dcf1d9414511f16dc9e7b589bfbe
+  metadata.gz: 74bfeb7c6a69ab685707ad54578b1d7defcf9965
+  data.tar.gz: c7cbebb026219e58f9adcb4ae2ad29de2c813201
 SHA512:
-  metadata.gz: e405489e1b36df74ba88023c1a6dab81f70a635caaa0536db9b1939ee5af323e1e1bbc148cb4035af3a51af19c2039e3e553c0b2b3eba31a846fc028d348ae4e
-  data.tar.gz: 9506dd03a58ee98d3e3d24a453c57b766af2710ecb9ee370b2ccda2a76c2dff482b730614b1d91f7a39742a9e56c2f92fdd5bddfe0925152e49949d8f661b924
+  metadata.gz: 816b7e6b843375488b16a19559fdfd64806d0283042a7577a919061f9625a4ddc577a029ff27454ecdf2febb7da04891c8a56fec48dc51c0496fc1e513fcd6f3
+  data.tar.gz: cff7f66cab24eca4215ce189bec3c92883c260b0edb84a43a76a3cb22002e5eaa75ef45bd96c39200d31c33bb2c7350916f2a6e4b0d92d3a1da9ca6177677fd7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    business_flow (0.10.0)
+    business_flow (0.11.0)
       activemodel (>= 3.0)
       activesupport (>= 3.0)
 

data/lib/business_flow/cacheable.rb

@@ -58,31 +58,37 @@ module BusinessFlow
         end
       end
 
-      # :reek:TooManyStatements This can't be easily simplified any further,
-      # as best as I can tell.
       def execute(flow)
-        add_cache_key_to_result_class
-        cache_store.fetch(flow.cache_key,
-                          cache_options.to_store_options(flow)) do
-          result = add_cache_key(super(flow), flow)
-          raise FlowFailedException, result if result.errors?
-          result
+        with_cache(flow) do
+          super(flow)._business_flow_cacheable_finalize(flow.cache_key)
         end
       rescue FlowFailedException => exc
         exc.flow
       end
 
+      def with_cache(flow, &blk)
+        add_cache_key_to_result_class
+        catch(:halt_step) do
+          return cache_store.fetch(flow.cache_key,
+                                   cache_options.to_store_options(flow), &blk)
+        end
+        raise FlowFailedException, flow
+      end
+
+      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
-        DSL::PublicField.new(:cache_key).add_to(const_get(:Result))
+        result_class = const_get(:Result)
+        DSL::PublicField.new(:cache_key).add_to(result_class)
+        result_class.send(:define_method, :_business_flow_cacheable_finalize,
+                          RESULT_FINALIZE)
         @cache_key_added = true
       end
-
-      # :reek:UtilityFunction Not entirey sure where else to put this.
-      def add_cache_key(result, flow)
-        result.instance_variable_set('@cache_key'.freeze, flow.cache_key)
-        result
-      end
     end
   end
 end

data/lib/business_flow/dsl.rb

@@ -25,6 +25,9 @@ module BusinessFlow
       # Declares that you will expose a field to the outside world.
       def provides(*fields)
         @provides ||= FieldList.new([], PublicField, [self, const_get(:Result)])
+        @result_copy ||= 'def from_flow(flow)'
+        @result_copy += fields.map { |field| "@#{field} = flow.#{field}" }
+                              .join("\n")
         @provides.add_fields(fields)
       end
 
@@ -55,10 +58,11 @@ module BusinessFlow
       end
 
       def build(parameter_object)
+        finalize_initializer
         allocate.tap do |flow|
           catch(:halt_step) do
             flow.send(:_business_flow_dsl_initialize,
-                      ParameterObject.new(parameter_object), needs)
+                      ParameterObject.new(parameter_object))
           end
         end
       end
@@ -82,21 +86,48 @@ module BusinessFlow
       end
 
       def result_from(flow)
-        result_class = const_get(:Result)
-        provides_hash = Hash[provides.map do |field|
-          [field, flow.public_send(field)]
-        end]
-        result_class.new(flow.instance_variable_get(:@errors), provides_hash)
+        finalize_result_provider
+        # We use instance_variable_get here instead of making it part of
+        # from_flow to ensure that we do not create the errors object unless
+        # we need it.
+        result = const_get(:Result).new(flow.instance_variable_get(:@errors))
+        result.from_flow(flow) if @result_copy
+        result
+      end
+
+      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
+        needs.map do |need|
+          %(if #{need}.nil?
+              errors[:#{need}] << 'must not be nil'
+              throw :halt_step
+            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
+            #{needs_code}
+            initialize
+          end
+        }, __FILE__, __LINE__ - 6
+        @finalized_initializer = true
       end
     end
 
     RESULT_DEF = %(
       class Result
-        def initialize(errors, provides)
+        def initialize(errors)
           @errors = errors
-          provides.each do |(name, value)|
-            instance_variable_set("@" + name.to_s, value)
-          end
         end
 
         def errors
@@ -121,9 +152,20 @@ module BusinessFlow
       end
     ).freeze
 
+    # Provides the minimum necessary methods to support the use of
+    # ActiveModel::Errors
+    module ErrorSupport
+      def human_attribute_name(key, _opts = {})
+        key
+      end
+    end
+
+    # :reek:ManualDispatch I have no need to actually call human_attribute_name,
+    # 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)
     end
 
     attr_reader :parameter_object

data/lib/business_flow/step.rb

@@ -35,13 +35,10 @@ module BusinessFlow
     # Represents the result of a step, and allows setting response values on
     # an object, and merging error data into the same object.
     class Result
-      # :reek:ManualDispatch Checking respond_to? is signficantly faster than
-      # eating the NoMethodError when grabbing our error object.
       def initialize(result, output_map, output_callable)
         @result = result
         @output_map = output_map
         @output_callable = output_callable
-        @result_errors = result.respond_to?(:errors) ? result.errors : nil
       end
 
       def merge_into(object)
@@ -53,8 +50,10 @@ module BusinessFlow
         true
       end
 
+      # :reek:ManualDispatch Checking respond_to? is signficantly faster than
+      # eating the NoMethodError when grabbing our error object.
       def errors?
-        @result_errors.present?
+        @result.respond_to?(:errors?) ? @result.errors? : false
       end
 
       def output
@@ -73,8 +72,8 @@ module BusinessFlow
       private
 
       def merge_errors_into(object)
-        return if @result_errors.blank?
-        @result_errors.each do |attribute, message|
+        return unless errors?
+        @result.errors.each do |attribute, message|
           attribute = "#{@result.class.name.underscore}.#{attribute}"
           (object.errors[attribute] << message).uniq!
         end

data/lib/business_flow/version.rb

@@ -1,3 +1,3 @@
 module BusinessFlow
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2019-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel