burner 1.0.0.pre.alpha.1 → 1.0.0.pre.alpha.6

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

@@ -0,0 +1,44 @@
+# 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 < Job
+        attr_reader :key, :groups
+
+        def initialize(name:, key:, config: Hashematics::Configuration.new)
+          super(name: name)
+
+          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.value))
+
+          output.detail("Graphing: #{key}")
+
+          payload.value = graph.data(key)
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/collection/objects_to_arrays.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
+      # 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: '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}'
+      #       },
+      #
+      #     ],
+      #     steps: %w[set map output]
+      #   }
+      #
+      #   Burner::Pipeline.make(config).execute
+      class ObjectsToArrays < Job
+        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: [], separator: '')
+          super(name: name)
+
+          @mappings = Modeling::KeyIndexMapping.array(mappings)
+          @resolver = Objectable.resolver(separator: separator.to_s)
+
+          freeze
+        end
+
+        def perform(_output, payload)
+          payload.value = array(payload.value).map { |object| key_to_index_map(object) }
+
+          nil
+        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,44 @@
+# 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 < Job
+        DEFAULT_AMOUNT = 0
+
+        private_constant :DEFAULT_AMOUNT
+
+        attr_reader :amount
+
+        def initialize(name:, amount: DEFAULT_AMOUNT)
+          super(name: name)
+
+          @amount = amount.to_i
+
+          freeze
+        end
+
+        def perform(output, payload)
+          output.detail("Shifting #{amount} entries.")
+
+          payload.value = array(payload.value).slice(amount..-1)
+
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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 < Job
+        BLANK = ''
+
+        attr_reader :attribute_renderers,
+                    :exclusive,
+                    :resolver
+
+        def initialize(name:, attributes: [], exclusive: false, separator: BLANK)
+          super(name: name)
+
+          @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.value = array(payload.value).map { |row| transform(row, payload.time) }
+
+          attr_count = attribute_renderers.length
+          row_count  = payload.value.length
+
+          output.detail("Transformed #{attr_count} attributes(s) for #{row_count} row(s)")
+
+          nil
+        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,47 @@
+# 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 < Job
+        attr_reader :unpivot
+
+        def initialize(name:, pivot_set: HashMath::Unpivot::PivotSet.new)
+          super(name: name)
+
+          @unpivot = HashMath::Unpivot.new(pivot_set)
+
+          freeze
+        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
+
+          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) }
+
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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 call #values on each object.
+      # 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
+        attr_reader :include_keys
+
+        def initialize(name:, include_keys: false)
+          super(name: name)
+
+          @include_keys = include_keys || false
+
+          freeze
+        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
+        end
+
+        private
+
+        def keys(object)
+          object.respond_to?(:keys) ? object.keys : []
+        end
+
+        def values(object)
+          object.respond_to?(:values) ? object.values : []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# 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 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
+        # 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
+        end
+      end
+    end
+  end
+end

data/lib/burner/{jobs → library}/deserialize/json.rb

@@ -8,11 +8,14 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     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
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = JSON.parse(payload.value)
 
           nil

data/lib/burner/{jobs → library}/deserialize/yaml.rb

@@ -8,9 +8,15 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module Deserialize
-      # Take a YAML string and deserialize into object(s).
+      # Take a YAML string and deserialize into object(s).  It uses YAML#safe_load by default,
+      # which ensures only a limited number of Ruby object constants can be hydrated by the
+      # 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
         attr_reader :safe
 
@@ -27,7 +33,7 @@ module Burner
         # in a sandbox.  By default, though, we will try and drive them towards using it
         # in the safer alternative.
         # rubocop:disable Security/YAMLLoad
-        def perform(output, payload, _params)
+        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)

data/lib/burner/{jobs → library}/dummy.rb

@@ -8,10 +8,12 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     # Do nothing.
+    #
+    # Note: this does not use Payload#value.
     class Dummy < Job
-      def perform(_output, _payload, _params)
+      def perform(_output, _payload)
         nil
       end
     end

data/lib/burner/{jobs → library}/echo.rb

@@ -8,8 +8,10 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     # Output a simple message to the output.
+    #
+    # Note: this does not use Payload#value.
     class Echo < Job
       attr_reader :message
 
@@ -21,8 +23,8 @@ module Burner
         freeze
       end
 
-      def perform(output, _payload, params)
-        compiled_message = eval_string_template(message, params)
+      def perform(output, payload)
+        compiled_message = job_string_template(message, output, payload)
 
         output.detail(compiled_message)