burner 1.0.0.pre.alpha.6 → 1.0.0.pre.alpha.11

data/lib/burner/library/collection/objects_to_arrays.rb

@@ -15,40 +15,42 @@ module Burner
       # Burner::Modeling::KeyIndexMapping instances or hashable configurations which specifies
       # the key-to-index mappings to use.
       #
-      # Expected Payload#value input: array of hashes.
-      # Payload#value output: An array of arrays.
+      # Expected Payload[register] input: array of hashes.
+      # Payload[register] output: An array of arrays.
       #
       # An example using a configuration-first pipeline:
       #
-      #   config = {
-      #     jobs: [
-      #       {
-      #         name: 'set',
-      #         type: 'set_value',
-      #         value: [
-      #           [1, 'funky']
-      #         ]
-      #       },
-      #       {
-      #         name: 'map',
-      #         type: 'collection/objects_to_arrays',
-      #         mappings: [
-      #           { index: 0, key: 'id' },
-      #           { index: 1, key: 'name' }
-      #         ]
-      #       },
-      #       {
-      #         name: 'output',
-      #         type: 'echo',
-      #         message: 'value is currently: {__value}'
-      #       },
+      #  config = {
+      #    jobs: [
+      #      {
+      #        name: 'set',
+      #        type: 'b/set_value',
+      #        value: [
+      #          { 'id' => 1, 'name' => 'funky' }
+      #        ],
+      #        register: register
+      #      },
+      #      {
+      #        name: 'map',
+      #        type: 'b/collection/objects_to_arrays',
+      #        mappings: [
+      #          { index: 0, key: 'id' },
+      #          { index: 1, key: 'name' }
+      #        ],
+      #        register: register
+      #      },
+      #      {
+      #        name: 'output',
+      #        type: 'b/echo',
+      #        message: 'value is currently: {__value}'
+      #      },
       #
-      #     ],
-      #     steps: %w[set map output]
-      #   }
+      #    ],
+      #    steps: %w[set map output]
+      #  }
       #
-      #   Burner::Pipeline.make(config).execute
-      class ObjectsToArrays < Job
+      #  Burner::Pipeline.make(config).execute
+      class ObjectsToArrays < JobWithRegister
         attr_reader :mappings
 
         # If you wish to support nested objects you can pass in a string to use as a
@@ -56,8 +58,8 @@ module Burner
         # nested hashes then set separator to '.'.  For more information, see the underlying
         # library that supports this dot-notation concept:
         #   https://github.com/bluemarblepayroll/objectable
-        def initialize(name:, mappings: [], separator: '')
-          super(name: name)
+        def initialize(name:, mappings: [], register: '', separator: '')
+          super(name: name, register: register)
 
           @mappings = Modeling::KeyIndexMapping.array(mappings)
           @resolver = Objectable.resolver(separator: separator.to_s)
@@ -66,9 +68,7 @@ module Burner
         end
 
         def perform(_output, payload)
-          payload.value = array(payload.value).map { |object| key_to_index_map(object) }
-
-          nil
+          payload[register] = array(payload[register]).map { |object| key_to_index_map(object) }
         end
 
         private

data/lib/burner/library/collection/shift.rb

@@ -14,17 +14,17 @@ module Burner
       # attribute.  The initial use case for this was to remove "header" rows from arrays,
       # like you would expect when parsing CSV files.
       #
-      # Expected Payload#value input: nothing.
-      # Payload#value output: An array with N beginning elements removed.
-      class Shift < Job
+      # Expected Payload[register] input: nothing.
+      # Payload[register] output: An array with N beginning elements removed.
+      class Shift < JobWithRegister
         DEFAULT_AMOUNT = 0
 
         private_constant :DEFAULT_AMOUNT
 
         attr_reader :amount
 
-        def initialize(name:, amount: DEFAULT_AMOUNT)
-          super(name: name)
+        def initialize(name:, amount: DEFAULT_AMOUNT, register: '')
+          super(name: name, register: register)
 
           @amount = amount.to_i
 
@@ -34,9 +34,7 @@ module Burner
         def perform(output, payload)
           output.detail("Shifting #{amount} entries.")
 
-          payload.value = array(payload.value).slice(amount..-1)
-
-          nil
+          payload[register] = array(payload[register]).slice(amount..-1)
         end
       end
     end

data/lib/burner/library/collection/transform.rb

@@ -18,17 +18,17 @@ module Burner
       # For more information on the specific contract for attributes, see the
       # Burner::Modeling::Attribute class.
       #
-      # Expected Payload#value input: array of objects.
-      # Payload#value output: An array of objects.
-      class Transform < Job
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects.
+      class Transform < JobWithRegister
         BLANK = ''
 
         attr_reader :attribute_renderers,
                     :exclusive,
                     :resolver
 
-        def initialize(name:, attributes: [], exclusive: false, separator: BLANK)
-          super(name: name)
+        def initialize(name:, attributes: [], exclusive: false, register: '', separator: BLANK)
+          super(name: name, register: register)
 
           @resolver  = Objectable.resolver(separator: separator)
           @exclusive = exclusive || false
@@ -41,14 +41,12 @@ module Burner
         end
 
         def perform(output, payload)
-          payload.value = array(payload.value).map { |row| transform(row, payload.time) }
+          payload[register] = array(payload[register]).map { |row| transform(row, payload.time) }
 
           attr_count = attribute_renderers.length
-          row_count  = payload.value.length
+          row_count  = payload[register].length
 
           output.detail("Transformed #{attr_count} attributes(s) for #{row_count} row(s)")
-
-          nil
         end
 
         private

data/lib/burner/library/collection/unpivot.rb

@@ -14,13 +14,13 @@ module Burner
       # Under the hood it uses HashMath's Unpivot class:
       # https://github.com/bluemarblepayroll/hash_math
       #
-      # Expected Payload#value input: array of objects.
-      # Payload#value output: An array of objects.
-      class Unpivot < Job
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects.
+      class Unpivot < JobWithRegister
         attr_reader :unpivot
 
-        def initialize(name:, pivot_set: HashMath::Unpivot::PivotSet.new)
-          super(name: name)
+        def initialize(name:, pivot_set: HashMath::Unpivot::PivotSet.new, register: '')
+          super(name: name, register: register)
 
           @unpivot = HashMath::Unpivot.new(pivot_set)
 
@@ -28,18 +28,24 @@ module Burner
         end
 
         def perform(output, payload)
-          pivot_count   = unpivot.pivot_set.pivots.length
-          key_count     = unpivot.pivot_set.pivots.map { |p| p.keys.length }.sum
-          payload.value = array(payload.value)
-          object_count  = payload.value.length || 0
+          payload[register] = array(payload[register])
+          object_count      = payload[register].length || 0
 
           message = "#{pivot_count} Pivots, Key(s): #{key_count} key(s), #{object_count} objects(s)"
 
           output.detail(message)
 
-          payload.value = payload.value.flat_map { |object| unpivot.expand(object) }
+          payload[register] = payload[register].flat_map { |object| unpivot.expand(object) }
+        end
+
+        private
+
+        def pivot_count
+          unpivot.pivot_set.pivots.length
+        end
 
-          nil
+        def key_count
+          unpivot.pivot_set.pivots.map { |p| p.keys.length }.sum
         end
       end
     end

data/lib/burner/library/collection/validate.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Burner
+  module Library
+    module Collection
+      # Process each object in an array and see if its attribute values match a given set
+      # of validations.  The main register will include the valid objects and the invalid_register
+      # will contain the invalid objects.
+      #
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects that are valid.
+      # Payload[invalid_register] output: An array of objects that are invalid.
+      class Validate < JobWithRegister
+        DEFAULT_INVALID_REGISTER = 'invalid'
+        DEFAULT_JOIN_CHAR        = ', '
+        DEFAULT_MESSAGE_KEY      = 'errors'
+
+        attr_reader :invalid_register,
+                    :join_char,
+                    :message_key,
+                    :resolver,
+                    :validations
+
+        def initialize(
+          name:,
+          invalid_register: DEFAULT_INVALID_REGISTER,
+          join_char: DEFAULT_JOIN_CHAR,
+          message_key: DEFAULT_MESSAGE_KEY,
+          register: '',
+          separator: '',
+          validations: []
+        )
+          super(name: name, register: register)
+
+          @invalid_register = invalid_register.to_s
+          @join_char        = join_char.to_s
+          @message_key      = message_key.to_s
+          @resolver         = Objectable.resolver(separator: separator)
+          @validations      = Modeling::Validations.array(validations)
+
+          freeze
+        end
+
+        def perform(output, payload)
+          valid   = []
+          invalid = []
+
+          (payload[register] || []).each do |object|
+            errors = validate(object)
+
+            if errors.empty?
+              valid << object
+            else
+              invalid << make_in_error(object, errors)
+            end
+          end
+
+          output.detail("Valid count: #{valid.length}")
+          output.detail("Invalid count: #{invalid.length}")
+
+          payload[register]         = valid
+          payload[invalid_register] = invalid
+
+          nil
+        end
+
+        private
+
+        def validate(object)
+          validations.each_with_object([]) do |validation, memo|
+            next if validation.valid?(object, resolver)
+
+            memo << validation.message
+          end
+        end
+
+        def make_in_error(object, errors)
+          resolver.set(object, message_key, errors.join(join_char))
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/collection/values.rb

@@ -14,13 +14,13 @@ module Burner
       # If include_keys is true (it is false by default), then call #keys on the first
       # object and inject that as a "header" object.
       #
-      # Expected Payload#value input: array of objects.
-      # Payload#value output: An array of arrays.
-      class Values < Job
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of arrays.
+      class Values < JobWithRegister
         attr_reader :include_keys
 
-        def initialize(name:, include_keys: false)
-          super(name: name)
+        def initialize(name:, include_keys: false, register: '')
+          super(name: name, register: register)
 
           @include_keys = include_keys || false
 
@@ -28,12 +28,10 @@ module Burner
         end
 
         def perform(_output, payload)
-          payload.value = array(payload.value)
-          keys          = include_keys ? [keys(payload.value.first)] : []
-          values        = payload.value.map { |object| values(object) }
-          payload.value = keys + values
-
-          nil
+          payload[register] = array(payload[register])
+          keys = include_keys ? [keys(payload[register].first)] : []
+          values = payload[register].map { |object| values(object) }
+          payload[register] = keys + values
         end
 
         private

data/lib/burner/library/deserialize/csv.rb

@@ -12,16 +12,14 @@ module Burner
     module Deserialize
       # Take a CSV string and de-serialize into object(s).
       #
-      # Expected Payload#value input: nothing.
-      # Payload#value output: an array of arrays.  Each inner array represents one data row.
-      class Csv < Job
+      # Expected Payload[register] input: nothing.
+      # Payload[register] output: an array of arrays.  Each inner array represents one data row.
+      class Csv < JobWithRegister
         # This currently only supports returning an array of arrays, including the header row.
         # In the future this could be extended to offer more customizable options, such as
         # making it return an array of hashes with the columns mapped, etc.)
         def perform(_output, payload)
-          payload.value = CSV.new(payload.value, headers: false).to_a
-
-          nil
+          payload[register] = CSV.new(payload[register], headers: false).to_a
         end
       end
     end

data/lib/burner/library/deserialize/json.rb

@@ -12,13 +12,11 @@ module Burner
     module Deserialize
       # Take a JSON string and deserialize into object(s).
       #
-      # Expected Payload#value input: string of JSON data.
-      # Payload#value output: anything, as specified by the JSON de-serializer.
-      class Json < Job
+      # Expected Payload[register] input: string of JSON data.
+      # Payload[register] output: anything, as specified by the JSON de-serializer.
+      class Json < JobWithRegister
         def perform(_output, payload)
-          payload.value = JSON.parse(payload.value)
-
-          nil
+          payload[register] = JSON.parse(payload[register])
         end
       end
     end

data/lib/burner/library/deserialize/yaml.rb

@@ -15,13 +15,13 @@ module Burner
       # YAML.  If you wish to ease this restriction, for example if you have custom serialization
       # for custom classes, then you can pass in safe: false.
       #
-      # Expected Payload#value input: string of YAML data.
-      # Payload#value output: anything as specified by the YAML de-serializer.
-      class Yaml < Job
+      # Expected Payload[register] input: string of YAML data.
+      # Payload[register]output: anything as specified by the YAML de-serializer.
+      class Yaml < JobWithRegister
         attr_reader :safe
 
-        def initialize(name:, safe: true)
-          super(name: name)
+        def initialize(name:, register: '', safe: true)
+          super(name: name, register: register)
 
           @safe = safe
 
@@ -36,9 +36,9 @@ module Burner
         def perform(output, payload)
           output.detail('Warning: loading YAML not using safe_load.') unless safe
 
-          payload.value = safe ? YAML.safe_load(payload.value) : YAML.load(payload.value)
+          value = payload[register]
 
-          nil
+          payload[register] = safe ? YAML.safe_load(value) : YAML.load(value)
         end
         # rubocop:enable Security/YAMLLoad
       end

data/lib/burner/library/echo.rb

@@ -11,7 +11,7 @@ module Burner
   module Library
     # Output a simple message to the output.
     #
-    # Note: this does not use Payload#value.
+    # Note: this does not use Payload#registers.
     class Echo < Job
       attr_reader :message
 
@@ -27,8 +27,6 @@ module Burner
         compiled_message = job_string_template(message, output, payload)
 
         output.detail(compiled_message)
-
-        nil
       end
     end
   end

data/lib/burner/library/io/base.rb

@@ -11,11 +11,11 @@ module Burner
   module Library
     module IO
       # Common configuration/code for all IO Job subclasses.
-      class Base < Job
+      class Base < JobWithRegister
         attr_reader :path
 
-        def initialize(name:, path:)
-          super(name: name)
+        def initialize(name:, path:, register: '')
+          super(name: name, register: register)
 
           raise ArgumentError, 'path is required' if path.to_s.empty?