business_flow 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1548094c4a7a8b46825a764e4263b325c14a2638
-  data.tar.gz: 4c0e8ccdb9f0879688a4296beeb876f888d96753
+  metadata.gz: 30ea0891a62bcdd44afbf082b704e4a3deb7e5b1
+  data.tar.gz: 6cc8b240e591ffe7d9415cbc0293a1b466c880d7
 SHA512:
-  metadata.gz: bd2f51dd71d2b4b3895907e453797cab7ca368007e841a41a73baf04f356f137f4270f54819cfdf79ecc3f3a42d8629c0e0c5ebd36cdfc4bbd20c76642e3b86e
-  data.tar.gz: f023287d3915f2df21a43e0a678b68eb20173940586b3e3d4161956c3c19dc649ae2cfd52f049b09bab82086180706afcd43d52bf0b544e6ced5d6ed8d6af880
+  metadata.gz: 8d706886574479bc3c9bbd2cf1b1c444bf76737473d612b0beb429fcfbfb23de2e26b1c86428095bdeab950beefc7aff647f65be2584f86ed511e370cd3a8ce5
+  data.tar.gz: e480293a62820301a174da33c9264b81db9c098a9715d1aaac65c67b09e7290f7e859a1de83420c800ba0bf9fdf7a5f06e099e2db43a3f96418580bcd0892309

data/Gemfile.lock

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

data/lib/business_flow/dsl.rb

@@ -16,16 +16,19 @@ module BusinessFlow
 
         def add_needs(fields)
           @all += fields
+          @all.uniq!
           @needs.add_fields(fields)
         end
 
         def add_optional(fields)
           @all += fields
+          @all.uniq!
           @optionals.add_fields(fields)
         end
 
         def add_wants(field)
           @all << field.name
+          @all.uniq!
           @optionals.add_field(field)
         end
       end
@@ -46,10 +49,23 @@ module BusinessFlow
         inputs.add_optional(fields)
       end
 
+      # Provides an alternate way to look up the value for a field. This can be
+      # thought of as using a 'wants' combined with an expectation of presence,
+      # without having to check for whether or not the wants can be executed.
+      #
+      # :reek:NilCheck This is one of the places where we eliminate nil.
+      def lookup(field, by:, with:)
+        by = Array.wrap(by)
+        optional(*by)
+        wants field, with, unless: -> { by.any? { |input| send(input).nil? } },
+                           default_output: field
+      end
+
       # Allows a field to be retrieved from the initialiaztion parameters
-      def wants(field, default = proc { nil }, opts = {})
+      def wants(field, default = nil, opts = {}, &blk)
         internal_name = "wants_#{field}".to_sym
-        uses(internal_name, default, opts)
+        default = proc { nil } unless default || block_given?
+        uses(internal_name, default, opts, &blk)
         inputs.add_wants(ParameterField.new(field, internal_name))
       end
 
@@ -59,8 +75,8 @@ 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)'
+        @provides ||= FieldList.new([], PublicField, [self, @result_klass])
+        @result_copy ||= FROM_FLOW_PREAMBLE
         @result_copy += fields.map { |field| "\n@#{field} = flow.#{field}" }
                               .join
         @provides.add_fields(fields)
@@ -71,16 +87,16 @@ module BusinessFlow
       def uses(field, klass = nil, opts = {}, &blk)
         step = Step.new(Callable.new(klass || blk),
                         { default_output: field }.merge(opts))
-        retriever = proc { step.call(self).output }
+        retriever = proc { step.call(self).merge_into(self) }
         UsesField.new(field, retriever).add_to(self)
       end
 
-      def step(klass, opts = {})
-        step = Step.new(Callable.new(klass), opts)
+      # :reek:ControlParameter It's just nicer to have this fall back to a
+      # block than have a different DSL method when using/not using blocks
+      def step(klass, opts = {}, &blk)
+        step = Step.new(Callable.new(blk || klass), opts)
         step_queue.push(step)
-        step.outputs
-            .values
-            .select { |field| field.is_a?(Symbol) }
+        step.output_fields
             .each { |field| Field.new(field).add_to(self) }
       end
 
@@ -127,18 +143,18 @@ module BusinessFlow
       end
 
       def result_from(flow)
-        finalize_result_provider
+        finalize_result_provider unless @finalized_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 = @result_klass.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__
+        @result_klass.class_eval "#{@result_copy}\nend", __FILE__, __LINE__
         @finalized_result_provider = true
       end
 
@@ -165,6 +181,11 @@ module BusinessFlow
       end
     end
 
+    FROM_FLOW_PREAMBLE = %(
+      def from_flow(flow)
+        return if errors?
+    ).freeze
+
     RESULT_DEF = %(
       class Result
         def initialize(errors)
@@ -178,7 +199,7 @@ module BusinessFlow
         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?
+          @errors && @errors.present?
         end
 
         def valid?(_context = nil)
@@ -206,6 +227,7 @@ module BusinessFlow
     def self.included(klass)
       klass.extend(ClassMethods)
       klass.class_eval RESULT_DEF, __FILE__, __LINE__
+      klass.instance_variable_set(:@result_klass, klass.const_get(:Result))
       klass.extend(ErrorSupport) unless klass.respond_to?(:human_attribute_name)
     end
 
@@ -267,7 +289,7 @@ module BusinessFlow
     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?
+      @errors && @errors.present?
     end
 
     def valid?(_context = nil)
@@ -296,6 +318,7 @@ module BusinessFlow
         fields.each do |field|
           add_field(@field_klass.new(field))
         end
+        @field_list.uniq! if fields.present?
         @field_list
       end
 

data/lib/business_flow/step.rb

@@ -44,8 +44,8 @@ module BusinessFlow
       end
 
       def merge_into(object)
-        merge_errors_into(object)
-        merge_outputs_into(object)
+        merge_errors_into(object) if mergeable_errors?
+        merge_outputs_into(object) if @output_map
         output
       end
 
@@ -88,7 +88,6 @@ module BusinessFlow
       end
 
       def merge_errors_into(object)
-        return unless mergeable_errors?
         @result.errors.each do |attribute, message|
           (object.errors[attribute] << message).uniq!
         end
@@ -174,7 +173,7 @@ module BusinessFlow
       end
 
       def result_factory
-        ResultFactory.new(opts[:outputs] || {},
+        ResultFactory.new(opts[:outputs],
                           opts[:output],
                           opts[:default_output])
       end
@@ -200,6 +199,8 @@ module BusinessFlow
       update_call_method
     end
 
+    # This will show up as not covered in coverage reports, because it is
+    # dynamically redefined by #update_call_method below.
     def call(parameter_source)
       parameters = @input_object.parameters_from_source(parameter_source)
       if !@condition || @condition.call(parameter_source, parameters)
@@ -218,6 +219,11 @@ module BusinessFlow
       @result_factory.outputs
     end
 
+    def output_fields
+      return [] unless outputs
+      outputs.values.select { |field| field.is_a?(Symbol) }
+    end
+
     def to_s
       @callable.to_s
     end

data/lib/business_flow/version.rb

@@ -1,3 +1,3 @@
 module BusinessFlow
-  VERSION = '0.16.0'.freeze
+  VERSION = '0.17.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Alex Scarborough
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel