burner 1.0.0.pre.alpha.3 → 1.0.0.pre.alpha.8

data/lib/burner/jobs.rb

@@ -7,18 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'job'
-require_relative 'jobs/deserialize/json'
-require_relative 'jobs/deserialize/yaml'
-require_relative 'jobs/dummy'
-require_relative 'jobs/echo'
-require_relative 'jobs/io/exist'
-require_relative 'jobs/io/read'
-require_relative 'jobs/io/write'
-require_relative 'jobs/serialize/json'
-require_relative 'jobs/serialize/yaml'
-require_relative 'jobs/set'
-require_relative 'jobs/sleep'
+require_relative 'library'
 
 module Burner
   # Main library of jobs.  This file contains all the basic/default jobs.  All other consumer
@@ -27,16 +16,31 @@ module Burner
   class Jobs
     acts_as_hashable_factory
 
-    register 'deserialize/json', Deserialize::Json
-    register 'deserialize/yaml', Deserialize::Yaml
-    register 'dummy', '',        Dummy
-    register 'echo',             Echo
-    register 'io/exist',         IO::Exist
-    register 'io/read',          IO::Read
-    register 'io/write',         IO::Write
-    register 'serialize/json',   Serialize::Json
-    register 'serialize/yaml',   Serialize::Yaml
-    register 'set',              Set
-    register 'sleep',            Sleep
+    # Dummy is the default as noted by the ''.  This means if a type is omitted, nil, or blank
+    # string then the dummy job will be used.
+    register 'b/dummy', '',                    Library::Dummy
+    register 'b/echo',                         Library::Echo
+    register 'b/set_value',                    Library::SetValue
+    register 'b/sleep',                        Library::Sleep
+
+    register 'b/collection/arrays_to_objects', Library::Collection::ArraysToObjects
+    register 'b/collection/graph',             Library::Collection::Graph
+    register 'b/collection/objects_to_arrays', Library::Collection::ObjectsToArrays
+    register 'b/collection/shift',             Library::Collection::Shift
+    register 'b/collection/transform',         Library::Collection::Transform
+    register 'b/collection/unpivot',           Library::Collection::Unpivot
+    register 'b/collection/values',            Library::Collection::Values
+
+    register 'b/deserialize/csv',              Library::Deserialize::Csv
+    register 'b/deserialize/json',             Library::Deserialize::Json
+    register 'b/deserialize/yaml',             Library::Deserialize::Yaml
+
+    register 'b/io/exist',                     Library::IO::Exist
+    register 'b/io/read',                      Library::IO::Read
+    register 'b/io/write',                     Library::IO::Write
+
+    register 'b/serialize/csv',                Library::Serialize::Csv
+    register 'b/serialize/json',               Library::Serialize::Json
+    register 'b/serialize/yaml',               Library::Serialize::Yaml
   end
 end

data/lib/burner/library.rb

@@ -0,0 +1,32 @@
+# 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.
+#
+
+require_relative 'job_with_register'
+
+require_relative 'library/collection/arrays_to_objects'
+require_relative 'library/collection/graph'
+require_relative 'library/collection/objects_to_arrays'
+require_relative 'library/collection/shift'
+require_relative 'library/collection/transform'
+require_relative 'library/collection/unpivot'
+require_relative 'library/collection/validate'
+require_relative 'library/collection/values'
+require_relative 'library/deserialize/csv'
+require_relative 'library/deserialize/json'
+require_relative 'library/deserialize/yaml'
+require_relative 'library/dummy'
+require_relative 'library/echo'
+require_relative 'library/io/exist'
+require_relative 'library/io/read'
+require_relative 'library/io/write'
+require_relative 'library/serialize/csv'
+require_relative 'library/serialize/json'
+require_relative 'library/serialize/yaml'
+require_relative 'library/set_value'
+require_relative 'library/sleep'

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/library/collection/graph.rb

@@ -0,0 +1,42 @@
+# 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
+      # 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 < JobWithRegister
+        attr_reader :key, :groups
+
+        def initialize(name:, key:, config: Hashematics::Configuration.new, register: '')
+          super(name: name, register: register)
+
+          raise ArgumentError, 'key is required' if key.to_s.empty?
+
+          @groups = Hashematics::Configuration.new(config).groups
+          @key    = key.to_s
+
+          freeze
+        end
+
+        def perform(output, payload)
+          graph = Hashematics::Graph.new(groups).add(array(payload[register]))
+
+          output.detail("Graphing: #{key}")
+
+          payload[register] = graph.data(key)
+        end
+      end
+    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/library/collection/shift.rb

@@ -0,0 +1,42 @@
+# 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
+      # Take an array and remove the first N elements, where N is specified by the amount
+      # 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 < JobWithRegister
+        DEFAULT_AMOUNT = 0
+
+        private_constant :DEFAULT_AMOUNT
+
+        attr_reader :amount
+
+        def initialize(name:, amount: DEFAULT_AMOUNT, register: '')
+          super(name: name, register: register)
+
+          @amount = amount.to_i
+
+          freeze
+        end
+
+        def perform(output, payload)
+          output.detail("Shifting #{amount} entries.")
+
+          payload[register] = array(payload[register]).slice(amount..-1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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
+      # 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 < JobWithRegister
+        BLANK = ''
+
+        attr_reader :attribute_renderers,
+                    :exclusive,
+                    :resolver
+
+        def initialize(name:, attributes: [], exclusive: false, register: '', separator: BLANK)
+          super(name: name, register: register)
+
+          @resolver  = Objectable.resolver(separator: separator)
+          @exclusive = exclusive || false
+
+          @attribute_renderers =
+            Modeling::Attribute.array(attributes)
+                               .map { |a| Modeling::AttributeRenderer.new(a, resolver) }
+
+          freeze
+        end
+
+        def perform(output, payload)
+          payload[register] = array(payload[register]).map { |row| transform(row, payload.time) }
+
+          attr_count = attribute_renderers.length
+          row_count  = payload[register].length
+
+          output.detail("Transformed #{attr_count} attributes(s) for #{row_count} row(s)")
+        end
+
+        private
+
+        def transform(row, time)
+          outgoing_row = exclusive ? {} : row
+
+          attribute_renderers.each_with_object(outgoing_row) do |attribute_renderer, memo|
+            value = attribute_renderer.transform(row, time)
+
+            resolver.set(memo, attribute_renderer.key, value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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
+      # 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 < JobWithRegister
+        attr_reader :unpivot
+
+        def initialize(name:, pivot_set: HashMath::Unpivot::PivotSet.new, register: '')
+          super(name: name, register: register)
+
+          @unpivot = HashMath::Unpivot.new(pivot_set)
+
+          freeze
+        end
+
+        def perform(output, payload)
+          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[register] = payload[register].flat_map { |object| unpivot.expand(object) }
+        end
+
+        private
+
+        def pivot_count
+          unpivot.pivot_set.pivots.length
+        end
+
+        def key_count
+          unpivot.pivot_set.pivots.map { |p| p.keys.length }.sum
+        end
+      end
+    end
+  end
+end