burner 1.0.0.pre.alpha → 1.0.0.pre.alpha.5

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

@@ -0,0 +1,43 @@
+# 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
+  class Jobs
+    module Collection
+      # Convert an array of arrays to an array of objects.
+      # Expected Payload#value input: array of arrays.
+      # Payload#value output: An array of hashes.
+      class ArraysToObjects < Job
+        attr_reader :mappings
+
+        def initialize(name:, mappings: [])
+          super(name: name)
+
+          @mappings = Modeling::KeyIndexMapping.array(mappings)
+
+          freeze
+        end
+
+        def perform(_output, payload)
+          payload.value = (payload.value || []).map { |array| index_to_key_map(array) }
+
+          nil
+        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/collection/graph.rb

@@ -0,0 +1,43 @@
+# 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
+  class Jobs
+    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(payload.value || [])
+
+          output.detail("Graphing: #{key}")
+
+          payload.value = graph.data(key)
+
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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
+  class Jobs
+    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.
+      # Expected Payload#value input: array of hashes.
+      # Payload#value output: An array of arrays.
+      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 '.'.
+        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 = (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/jobs/collection/shift.rb

@@ -0,0 +1,43 @@
+# 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
+  class Jobs
+    module Collection
+      # Take an array and remove the first N elements, where N is specified by the amount
+      # attribute.
+      # 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 ||= []
+          payload.value.shift(amount)
+
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# 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 'transform/attribute'
+require_relative 'transform/attribute_renderer'
+
+module Burner
+  class Jobs
+    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
+      # 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 = Attribute.array(attributes)
+                                          .map { |a| AttributeRenderer.new(a, resolver) }
+
+          freeze
+        end
+
+        def perform(output, payload)
+          payload.value = (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/jobs/collection/transform/attribute.rb

@@ -0,0 +1,33 @@
+# 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
+  class Jobs
+    module Collection
+      class Transform < Job
+        # Defines a top-level key and the associated transformers for deriving the final value
+        # to set the key to.
+        class Attribute
+          acts_as_hashable
+
+          attr_reader :key, :transformers
+
+          def initialize(key:, transformers: [])
+            raise ArgumentError, 'key is required' if key.to_s.empty?
+
+            @key          = key.to_s
+            @transformers = Realize::Transformers.array(transformers)
+
+            freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/burner/jobs/collection/transform/attribute_renderer.rb

@@ -0,0 +1,36 @@
+# 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
+  class Jobs
+    module Collection
+      class Transform < Job
+        # Composed of an Attribute instance and a Pipeline instance.  It knows how to
+        # render/transform an Attribute.  Since this library is data-first, these intermediary
+        # objects are necessary for non-data-centric modeling.
+        class AttributeRenderer
+          extend Forwardable
+
+          attr_reader :attribute, :pipeline
+
+          def_delegators :attribute, :key
+
+          def_delegators :pipeline, :transform
+
+          def initialize(attribute, resolver)
+            @attribute = attribute
+            @pipeline  = Realize::Pipeline.new(attribute.transformers, resolver: resolver)
+
+            freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# 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
+  class Jobs
+    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
+          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/jobs/collection/values.rb

@@ -0,0 +1,50 @@
+# 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
+  class Jobs
+    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)
+          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/jobs/deserialize/csv.rb

@@ -0,0 +1,28 @@
+# 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
+  class Jobs
+    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