business_flow 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d21b7217a94afe45033d87426bf8628ca4575b9a
-  data.tar.gz: 80243c17f8ce51b704eb16b7da5dc0d909a1072c
+  metadata.gz: b19571c7a852ebc68f87ac03d0fd74a7f904c517
+  data.tar.gz: aec53ddd83cc11ac5f0b969a78e1c5927d682fbb
 SHA512:
-  metadata.gz: 91b1128808b743615388bc72b636b6dc838f0d0275a6ceacd1a1c7fa33916aae39124eae90dc6fbacc5659b74d236818803bc12a75447c54a9447ae3e374d117
-  data.tar.gz: 82cbb8c46c60750c4d5a121c922f49d6a398e8eac537980dcc647bd0816e99cb98b045409687593c2806435b339cd54962e56022e685a8b6d8f0b2fc6f982d94
+  metadata.gz: b2cbfe1ab1e7cffa2355262084decfc8e376d2dd08ad3a9e3098f1df4aecc08408462cdc980386d2ed2b6f5463a775b3283022caaad8c5e706def64a7bed6be1
+  data.tar.gz: f31ecaaaf8795914c45dacb71cdfb76e0ceae1d756649c50ac9b2d46a33276548b84996cb3674537363f7174ab2de0092550e628b6698533dee5c19925cbdb89

data/Gemfile.lock

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

data/lib/business_flow/cacheable.rb

@@ -8,7 +8,7 @@ module BusinessFlow
     def cache_key
       klass = self.class
       key = Digest::SHA256.hexdigest(klass.cache_key.call(self, nil).to_s)
-      "#{klass.name.underscore}/#{key}"
+      "#{klass.name.underscore}/#{key}/v2"
     end
 
     # DSL Methods
@@ -56,14 +56,29 @@ 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) do
-          super(flow)
-          raise FlowFailedException, flow if flow.errors.any?
-          flow
+          result = add_cache_key(super(flow), flow)
+          raise FlowFailedException, result if result.errors?
+          result
         end
-      rescue FlowFailedException
-        flow
+      rescue FlowFailedException => exc
+        exc.flow
+      end
+
+      def add_cache_key_to_result_class
+        return if @cache_key_added
+        DSL::PublicField.new(:cache_key).add_to(const_get(:Result))
+        @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

data/lib/business_flow/callable.rb

@@ -8,7 +8,9 @@ module BusinessFlow
       check_callable
     end
 
-    # :reek:ManualDispatch
+    # :reek:ManualDispatch At this stage @callable is a symbol and is either
+    # a method or a constant. Checking respond_to? is easier and faster than
+    # generating a NoMethodError and catching it.
     def call(instance, inputs)
       if instance.respond_to?(@callable, true)
         send_callable(instance, inputs)

data/lib/business_flow/dsl.rb

@@ -44,15 +44,15 @@ module BusinessFlow
       end
 
       def call(parameter_object)
-        output = flow = build(parameter_object)
-        catch(:halt_step) { output = execute(flow) }
-        output
+        _business_flow_finalize_result_class
+        execute(build(parameter_object))
       end
 
-      # :reek:UtilityFunction
+      # :reek:UtilityFunction This is a function on us so that other modules
+      # can change execution behavior.
       def execute(flow)
-        flow.call
-        flow
+        catch(:halt_step) { flow.call }
+        result_from(flow)
       end
 
       def build(parameter_object)
@@ -66,7 +66,7 @@ module BusinessFlow
 
       def call!(*args)
         flow = call(*args)
-        raise FlowFailedException, flow if flow.errors.any?
+        raise FlowFailedException, flow if flow.errors?
         flow
       end
 
@@ -81,10 +81,56 @@ module BusinessFlow
           @executor_class ||= ::BusinessFlow::DefaultStepExecutor
         end
       end
+
+      def _business_flow_finalize_result_class
+        return if @result_finalized
+        FieldList.new(provides, PublicField, const_get(:Result))
+        @result_finalized = true
+      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)
+      end
     end
 
+    RESULT_DEF = %(
+      class Result
+        def initialize(errors, provides)
+          @errors = errors
+          provides.each do |(name, value)|
+            instance_variable_set("@" + name.to_s, value)
+          end
+        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
+      end
+    ).freeze
+
     def self.included(klass)
       klass.extend(ClassMethods)
+      klass.class_eval RESULT_DEF, __FILE__, __LINE__
     end
 
     attr_reader :parameter_object
@@ -99,7 +145,7 @@ module BusinessFlow
     # 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
+    # :reek:NilCheck This is where we ensure that our needs are non-nil.
     private def _business_flow_dsl_initialize(parameter_object, needs)
       @parameter_object = parameter_object
       needs.each do |need|
@@ -116,10 +162,14 @@ module BusinessFlow
     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
 
@@ -132,9 +182,10 @@ module BusinessFlow
       attr_reader :field_list
 
       def initialize(field_list, field_klass, klass)
-        @field_list = field_list
+        @field_list = []
         @field_klass = field_klass
         @klass = klass
+        add_fields(field_list)
       end
 
       def add_fields(fields)
@@ -297,6 +348,10 @@ module BusinessFlow
         value
       end
 
+      def to_s
+        @parameters.to_s
+      end
+
       private
 
       def inner_fetch(key)

data/lib/business_flow/version.rb

@@ -1,3 +1,3 @@
 module BusinessFlow
-  VERSION = '0.8.2'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel