burner 1.0.0.pre.alpha.4 → 1.0.0.pre.alpha.9

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

@@ -0,0 +1,75 @@
+# 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
+      # Convert an array of arrays to an array of objects.  Pass in an array of
+      # Burner::Modeling::KeyIndexMapping instances or hashable configurations which specifies
+      # the index-to-key mappings to use.
+      #
+      # Expected Payload#value input: array of arrays.
+      # Payload#value output: An array of hashes.
+      #
+      # An example using a configuration-first pipeline:
+      #
+      #   config = {
+      #     jobs: [
+      #       {
+      #         name: 'set',
+      #         type: 'b/set_value',
+      #         value: [
+      #           [1, 'funky']
+      #         ]
+      #       },
+      #       {
+      #         name: 'map',
+      #         type: 'b/collection/arrays_to_objects',
+      #         mappings: [
+      #           { index: 0, key: 'id' },
+      #           { index: 1, key: 'name' }
+      #         ]
+      #       },
+      #       {
+      #         name: 'output',
+      #         type: 'b/echo',
+      #         message: 'value is currently: {__value}'
+      #       },
+      #
+      #     ],
+      #     steps: %w[set map output]
+      #   }
+      #
+      #   Burner::Pipeline.make(config).execute
+      class ArraysToObjects < JobWithRegister
+        attr_reader :mappings
+
+        def initialize(name:, mappings: [], register: '')
+          super(name: name, register: register)
+
+          @mappings = Modeling::KeyIndexMapping.array(mappings)
+
+          freeze
+        end
+
+        def perform(_output, payload)
+          payload[register] = array(payload[register]).map { |array| index_to_key_map(array) }
+        end
+
+        private
+
+        def index_to_key_map(array)
+          mappings.each_with_object({}) do |mapping, memo|
+            memo[mapping.key] = array[mapping.index]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/burner/{jobs → library}/collection/graph.rb

@@ -8,17 +8,18 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module Collection
       # Take an array of (denormalized) objects and create an object hierarchy from them.
       # Under the hood it uses Hashematics: https://github.com/bluemarblepayroll/hashematics.
+      #
       # Expected Payload#value input: array of objects.
       # Payload#value output: An array of objects.
-      class Graph < Job
+      class Graph < JobWithRegister
         attr_reader :key, :groups
 
-        def initialize(name:, key:, config: Hashematics::Configuration.new)
-          super(name: name)
+        def initialize(name:, key:, config: Hashematics::Configuration.new, register: '')
+          super(name: name, register: register)
 
           raise ArgumentError, 'key is required' if key.to_s.empty?
 
@@ -29,13 +30,11 @@ module Burner
         end
 
         def perform(output, payload)
-          graph = Hashematics::Graph.new(groups).add(payload.value || [])
+          graph = Hashematics::Graph.new(groups).add(array(payload[register]))
 
           output.detail("Graphing: #{key}")
 
-          payload.value = graph.data(key)
-
-          nil
+          payload[register] = graph.data(key)
         end
       end
     end

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

@@ -0,0 +1,88 @@
+# 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
+      # Convert an array of objects to an array of arrays.  You can leverage the separator
+      # option to support key paths and nested objects.  Pass in an array of
+      # 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.
+      #
+      # An example using a configuration-first pipeline:
+      #
+      #   config = {
+      #     jobs: [
+      #       {
+      #         name: 'set',
+      #         type: 'b/set_value',
+      #         value: [
+      #           [1, 'funky']
+      #         ]
+      #       },
+      #       {
+      #         name: 'map',
+      #         type: 'b/collection/objects_to_arrays',
+      #         mappings: [
+      #           { index: 0, key: 'id' },
+      #           { index: 1, key: 'name' }
+      #         ]
+      #       },
+      #       {
+      #         name: 'output',
+      #         type: 'b/echo',
+      #         message: 'value is currently: {__value}'
+      #       },
+      #
+      #     ],
+      #     steps: %w[set map output]
+      #   }
+      #
+      #   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
+        # key path separator.  For example: if you would like to recognize dot-notation for
+        # 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: [], register: '', separator: '')
+          super(name: name, register: register)
+
+          @mappings = Modeling::KeyIndexMapping.array(mappings)
+          @resolver = Objectable.resolver(separator: separator.to_s)
+
+          freeze
+        end
+
+        def perform(_output, payload)
+          payload[register] = array(payload[register]).map { |object| key_to_index_map(object) }
+        end
+
+        private
+
+        attr_reader :resolver
+
+        def key_to_index_map(object)
+          mappings.each_with_object(prototype_array) do |mapping, memo|
+            memo[mapping.index] = resolver.get(object, mapping.key)
+          end
+        end
+
+        def prototype_array
+          Array.new(mappings.length)
+        end
+      end
+    end
+  end
+end

data/lib/burner/{jobs → library}/collection/shift.rb

@@ -8,21 +8,23 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module Collection
       # Take an array and remove the first N elements, where N is specified by the amount
-      # attribute.
+      # 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
+      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
 
@@ -32,10 +34,7 @@ module Burner
         def perform(output, payload)
           output.detail("Shifting #{amount} entries.")
 
-          payload.value ||= []
-          payload.value.shift(amount)
-
-          nil
+          payload[register] = array(payload[register]).slice(amount..-1)
         end
       end
     end

data/lib/burner/{jobs → library}/collection/transform.rb

@@ -7,44 +7,46 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'transform/attribute'
-require_relative 'transform/attribute_renderer'
-
 module Burner
-  class Jobs
+  module Library
     module Collection
-      # Iterate over all objects and return a new set of transformed objects.  Under the hood
-      # this uses the Realize library: https://github.com/bluemarblepayroll/realize
+      # Iterate over all objects and return a new set of transformed objects.  The object is
+      # transformed per the "transformers" attribute for its attributes.  An attribute defines
+      # the ultimate key to place the value in and then the transformer pipeline to use to
+      # derive the value.  Under the hood this uses the Realize library:
+      #   https://github.com/bluemarblepayroll/realize
+      # 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
+      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
 
-          @attribute_renderers = Attribute.array(attributes)
-                                          .map { |a| AttributeRenderer.new(a, resolver) }
+          @attribute_renderers =
+            Modeling::Attribute.array(attributes)
+                               .map { |a| Modeling::AttributeRenderer.new(a, resolver) }
 
           freeze
         end
 
         def perform(output, payload)
-          payload.value = (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/{jobs → library}/collection/unpivot.rb

@@ -8,18 +8,19 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module Collection
       # Take an array of objects and un-pivot groups of keys into rows.
       # 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
+      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)
 
@@ -27,17 +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
-          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,89 @@
+# 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#value input: array of objects.
+      # Payload#value output: An array of objects.
+      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