burner 1.0.0.pre.alpha.3 → 1.0.0.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca551c813e385ad98bd5856ff74be816d43a57fe60003da061536b9a0a27b2a6
-  data.tar.gz: 484f1490830bd27d5eaeae2dd097ac8ee0a2024d0d231ae09f2607ab1275cd9e
+  metadata.gz: 6e96a8d656466219851ff06ebced5aacac54fe0b6a78de2e1f0e5bf76480e1ca
+  data.tar.gz: a4ba7e8d001f7e25ee7c404ed539089e51f295098d0062d14a3fcf473db64d7d
 SHA512:
-  metadata.gz: ee7bdfe6e3571918730bf6ff983d88b3cbb10514c90feae0df736167dfaeee4cce41f3e307c743012a528e43b0c0251e60b07008908e5a1e400aec7b65fe4005
-  data.tar.gz: ebd8cde5363fcc8c509d4856ec9978c14a1601d85f492a92f76e5e35dd10629fbd19566d51d13093b8216366035cbda9b4fbef610995796f17881d09e3e45d81
+  metadata.gz: 1cc60f86ee2931902ab8e6870f5bda78f953e6740c2a5d76dc306c12457e93511646b9cbfe4db8fa583a3242bc1d361715011ea98ea5682045356a6c6f269808
+  data.tar.gz: 5b9cf06f4426d1629f9c6672ee5c469052863e07bf01079b021494f5b6e0bc4ae0ef57be64e1a37d1652803039a1e11061c5415ca4a83f39672d4c55085feeac

data/README.md

@@ -73,19 +73,21 @@ params = {
   input_file: 'input.json',
   output_file: 'output.yaml'
 }
+
+payload = Burner::Payload.new(params: params)
 ````
 
 Assuming we are running this script from a directory where an `input.json` file exists, we can then programatically process the pipeline:
 
 ````ruby
-Burner::Pipeline.make(pipeline).execute(params: params)
+Burner::Pipeline.make(pipeline).execute(payload: payload)
 ````
 
 We should now see a output.yaml file created.
 
 Some notes:
 
-* Some values are able to be string-interpolated using the provided params.  This allows for the passing runtime configuration/data into pipelines/jobs.
+* Some values are able to be string-interpolated using the provided Payload#params.  This allows for the passing runtime configuration/data into pipelines/jobs.
 * The job's ID can be accessed using the `__id` key.
 * The current job's payload value can be accessed using the `__value` key.
 * Jobs can be re-used (just like the output_id and output_value jobs).
@@ -116,8 +118,9 @@ end
 
 string_out = StringOut.new
 output     = Burner::Output.new(outs: string_out)
+payload    = Burner::Payload.new(params: params)
 
-Burner::Pipeline.make(pipeline).execute(output: output, params: params)
+Burner::Pipeline.make(pipeline).execute(output: output, payload: payload)
 
 log = string_out.read
 ````
@@ -228,15 +231,37 @@ Burner::Cli.new(args).invoke
 
 This library only ships with very basic, rudimentary jobs that are meant to just serve as a baseline:
 
+#### Collection
+
+* **collection/arrays_to_objects** [mappings]: Convert an array of arrays to an array of objects.
+* **collection/graph** [config, key]: Use (Hashematics)[https://github.com/bluemarblepayroll/hashematics] to turn a flat array of objects into a deeply nested object tree.
+* **collection/objects_to_arrays** [mappings]: Convert an array of objects to an array of arrays.
+* **collection/shift** [amount]: Remove the first N number of elements from an array.
+* **collection/transform** [attributes, exclusive, separator]: Iterate over all objects and transform each key per the attribute transformers specifications.  If exclusive is set to false then the current object will be overridden/merged.  Separator can also be set for key path support.  This job uses (Realize)[https://github.com/bluemarblepayroll/realize], which provides its own extendable value-transformation pipeline.
+* **collection/unpivot** [pivot_set]: Take an array of objects and unpivot specific sets of keys into rows.  Under the hood it uses [HashMath's Unpivot class](https://github.com/bluemarblepayroll/hash_math#unpivot-hash-key-coalescence-and-row-extrapolation).
+
+#### De-serialization
+
+* **deserialize/csv** []: Take a CSV string and de-serialize into object(s).  Currently it will return an array of arrays, with each nested array representing one row.
 * **deserialize/json** []: Treat input as a string and de-serialize it to JSON.
 * **deserialize/yaml** [safe]: Treat input as a string and de-serialize it to YAML.  By default it will try and (safely de-serialize)[https://ruby-doc.org/stdlib-2.6.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load] it (only using core classes).  If you wish to de-serialize it to any class type, pass in `safe: false`
-* **dummy** []: Do nothing
-* **echo** [message]: Write a message to the output.  The message parameter can be interpolated using params.
-* **io/exist** [path, short_circuit]: Check to see if a file exists. The path parameter can be interpolated using params.  If short_circuit was set to true (defaults to false) and the file does not exist then the pipeline will be short-circuited.
-* **io/read** [binary, path]: Read in a local file.  The path parameter can be interpolated using params.  If the contents are binary, pass in `binary: true` to open it up in binary+read mode.
-* **io/write** [binary, path]: Write to a local file.  The path parameter can be interpolated using params.  If the contents are binary, pass in `binary: true` to open it up in binary+write mode.
+
+#### IO
+
+* **io/exist** [path, short_circuit]: Check to see if a file exists. The path parameter can be interpolated using `Payload#params`.  If short_circuit was set to true (defaults to false) and the file does not exist then the pipeline will be short-circuited.
+* **io/read** [binary, path]: Read in a local file.  The path parameter can be interpolated using `Payload#params`.  If the contents are binary, pass in `binary: true` to open it up in binary+read mode.
+* **io/write** [binary, path]: Write to a local file.  The path parameter can be interpolated using `Payload#params`.  If the contents are binary, pass in `binary: true` to open it up in binary+write mode.
+
+#### Serialization
+
+* **serialize/csv** []: Take an array of arrays and create a CSV.
 * **serialize/json** []: Convert value to JSON.
 * **serialize/yaml** []: Convert value to YAML.
+
+#### General
+
+* **dummy** []: Do nothing
+* **echo** [message]: Write a message to the output.  The message parameter can be interpolated using  `Payload#params`.
 * **set** [value]: Set the value to any arbitrary value.
 * **sleep** [seconds]: Sleep the thread for X number of seconds.
 
@@ -249,7 +274,7 @@ Let's say we would like to register a job to parse a CSV:
 
 ````ruby
 class ParseCsv < Burner::Job
-  def perform(output, payload, params)
+  def perform(output, payload)
     payload.value = CSV.parse(payload.value, headers: true).map(&:to_h)
 
     nil
@@ -309,7 +334,9 @@ params = {
   output_file: File.join(TEMP_DIR, "#{SecureRandom.uuid}.yaml")
 }
 
-Burner::Pipeline.make(pipeline).execute(output: output, params: params)
+payload = Burner::Payload.new(params: params)
+
+Burner::Pipeline.make(pipeline).execute(output: output, payload: payload)
 ````
 
 ## Contributing

data/burner.gemspec

@@ -29,7 +29,10 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.5'
 
   s.add_dependency('acts_as_hashable', '~>1.2')
+  s.add_dependency('hashematics', '~>1.1')
+  s.add_dependency('hash_math', '~>1.2')
   s.add_dependency('objectable', '~>1.0')
+  s.add_dependency('realize', '~>1.2')
   s.add_dependency('stringento', '~>2.1')
 
   s.add_development_dependency('guard-rspec', '~>4.7')

data/lib/burner.rb

@@ -9,12 +9,21 @@
 
 require 'acts_as_hashable'
 require 'benchmark'
+require 'csv'
 require 'forwardable'
+require 'hash_math'
+require 'hashematics'
 require 'json'
 require 'objectable'
+require 'realize'
 require 'securerandom'
 require 'singleton'
 require 'stringento'
+require 'time'
 require 'yaml'
 
+# Common/Shared
+require_relative 'burner/modeling'
+
+# Main Entrypoint(s)
 require_relative 'burner/cli'

data/lib/burner/cli.rb

@@ -12,20 +12,18 @@ require_relative 'pipeline'
 module Burner
   # Process a single string as a Pipeline.  This is mainly to back the command-line interface.
   class Cli
-    attr_reader :params, :pipeline
+    attr_reader :payload, :pipeline
 
     def initialize(args)
-      path       = args.first
-      cli_params = extract_cli_params(args)
-      config     = read_yaml(path)
-      @pipeline  = Burner::Pipeline.make(jobs: config['jobs'], steps: config['steps'])
-      @params    = (config['params'] || {}).merge(cli_params)
+      path      = args.first
+      params    = extract_cli_params(args)
+      config    = read_yaml(path)
+      @pipeline = Burner::Pipeline.make(jobs: config['jobs'], steps: config['steps'])
+      @payload  = Payload.new(params: params)
     end
 
-    def execute(output: Output.new, params: {}, payload: Payload.new)
-      final_params = @params.merge(params || {})
-
-      pipeline.execute(output: output, params: final_params, payload: payload)
+    def execute
+      pipeline.execute(payload: payload)
     end
 
     private

data/lib/burner/job.rb

@@ -28,8 +28,10 @@ module Burner
 
     private
 
-    def eval_string_template(expression, input)
-      string_template.evaluate(expression, input)
+    def job_string_template(expression, output, payload)
+      templatable_params = payload.params.merge(__id: output.id, __value: payload.value)
+
+      string_template.evaluate(expression, templatable_params)
     end
   end
 end

data/lib/burner/jobs.rb

@@ -8,6 +8,13 @@
 #
 
 require_relative 'job'
+require_relative 'jobs/collection/arrays_to_objects'
+require_relative 'jobs/collection/graph'
+require_relative 'jobs/collection/objects_to_arrays'
+require_relative 'jobs/collection/shift'
+require_relative 'jobs/collection/transform'
+require_relative 'jobs/collection/unpivot'
+require_relative 'jobs/deserialize/csv'
 require_relative 'jobs/deserialize/json'
 require_relative 'jobs/deserialize/yaml'
 require_relative 'jobs/dummy'
@@ -15,6 +22,7 @@ require_relative 'jobs/echo'
 require_relative 'jobs/io/exist'
 require_relative 'jobs/io/read'
 require_relative 'jobs/io/write'
+require_relative 'jobs/serialize/csv'
 require_relative 'jobs/serialize/json'
 require_relative 'jobs/serialize/yaml'
 require_relative 'jobs/set'
@@ -27,16 +35,24 @@ 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
+    register 'collection/arrays_to_objects', Collection::ArraysToObjects
+    register 'collection/graph',             Collection::Graph
+    register 'collection/objects_to_arrays', Collection::ObjectsToArrays
+    register 'collection/shift',             Collection::Shift
+    register 'collection/transform',         Collection::Transform
+    register 'collection/unpivot',           Collection::Unpivot
+    register 'deserialize/csv',              Deserialize::Csv
+    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/csv',                Serialize::Csv
+    register 'serialize/json',               Serialize::Json
+    register 'serialize/yaml',               Serialize::Yaml
+    register 'set',                          Set
+    register 'sleep',                        Sleep
   end
 end

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/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

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

@@ -12,7 +12,7 @@ module Burner
     module Deserialize
       # Take a JSON string and deserialize into object(s).
       class Json < Job
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = JSON.parse(payload.value)
 
           nil

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

@@ -27,7 +27,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/dummy.rb

@@ -11,7 +11,7 @@ module Burner
   class Jobs
     # Do nothing.
     class Dummy < Job
-      def perform(_output, _payload, _params)
+      def perform(_output, _payload)
         nil
       end
     end

data/lib/burner/jobs/echo.rb

@@ -21,8 +21,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)
 

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

@@ -21,12 +21,6 @@ module Burner
 
           @path = path.to_s
         end
-
-        private
-
-        def compile_path(params)
-          eval_string_template(path, params)
-        end
       end
     end
   end

data/lib/burner/jobs/io/exist.rb

@@ -25,8 +25,8 @@ module Burner
           freeze
         end
 
-        def perform(output, _payload, params)
-          compiled_path = compile_path(params)
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           exists = File.exist?(compiled_path)
           verb   = exists ? 'does' : 'does not'

data/lib/burner/jobs/io/read.rb

@@ -24,8 +24,8 @@ module Burner
           freeze
         end
 
-        def perform(output, payload, params)
-          compiled_path = compile_path(params)
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           output.detail("Reading: #{compiled_path}")
 

data/lib/burner/jobs/io/write.rb

@@ -24,8 +24,8 @@ module Burner
           freeze
         end
 
-        def perform(output, payload, params)
-          compiled_path = compile_path(params)
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           ensure_directory_exists(output, compiled_path)
 

data/lib/burner/jobs/serialize/csv.rb

@@ -0,0 +1,38 @@
+# 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 Serialize
+      # Take an array of arrays and create a CSV.
+      # Expected Payload#value input: array of arrays.
+      # Payload#value output: a serialized CSV string.
+      class Csv < Job
+        def perform(_output, payload)
+          payload.value = CSV.generate(options) do |csv|
+            (payload.value || []).each do |row|
+              csv << row
+            end
+          end
+
+          nil
+        end
+
+        private
+
+        def options
+          {
+            headers: false,
+            write_headers: false
+          }
+        end
+      end
+    end
+  end
+end

data/lib/burner/jobs/serialize/json.rb

@@ -12,7 +12,7 @@ module Burner
     module Serialize
       # Treat value like a Ruby object and serialize it using JSON.
       class Json < Job
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = payload.value.to_json
 
           nil

data/lib/burner/jobs/serialize/yaml.rb

@@ -12,7 +12,7 @@ module Burner
     module Serialize
       # Treat value like a Ruby object and serialize it using YAML.
       class Yaml < Job
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = payload.value.to_yaml
 
           nil

data/lib/burner/jobs/set.rb

@@ -21,7 +21,7 @@ module Burner
         freeze
       end
 
-      def perform(_output, payload, _params)
+      def perform(_output, payload)
         payload.value = value
 
         nil

data/lib/burner/jobs/sleep.rb

@@ -21,7 +21,7 @@ module Burner
         freeze
       end
 
-      def perform(output, _payload, _params)
+      def perform(output, _payload)
         output.detail("Going to sleep for #{seconds} second(s)")
 
         Kernel.sleep(seconds)

data/lib/burner/modeling.rb

@@ -0,0 +1,10 @@
+# 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 'modeling/key_index_mapping'

data/lib/burner/modeling/key_index_mapping.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 Modeling
+    # Generic relationship between a numeric index and a key.
+    class KeyIndexMapping
+      acts_as_hashable
+
+      attr_reader :index, :key
+
+      def initialize(index:, key:)
+        raise ArgumentError, 'index is required' if index.to_s.empty?
+        raise ArgumentError, 'key is required'   if key.to_s.empty?
+
+        @index = index.to_i
+        @key   = key.to_s
+
+        freeze
+      end
+    end
+  end
+end

data/lib/burner/payload.rb

@@ -18,10 +18,18 @@ module Burner
   class Payload
     attr_accessor :value
 
-    attr_reader :context, :written_files
+    attr_reader :params,
+                :time,
+                :written_files
 
-    def initialize(context: {}, value: nil, written_files: [])
-      @context       = context || {}
+    def initialize(
+      params: {},
+      time: Time.now.utc,
+      value: nil,
+      written_files: []
+    )
+      @params        = params || {}
+      @time          = time || Time.now.utc
       @value         = value
       @written_files = written_files || []
     end

data/lib/burner/pipeline.rb

@@ -35,15 +35,15 @@ module Burner
     end
 
     # The main entry-point for kicking off a pipeline.
-    def execute(output: Output.new, params: {}, payload: Payload.new)
+    def execute(output: Output.new, payload: Payload.new)
       output.write("Pipeline started with #{steps.length} step(s)")
 
-      output_params(params, output)
+      output_params(payload.params, output)
       output.ruler
 
       time_in_seconds = Benchmark.measure do
         steps.each do |step|
-          return_value = step.perform(output, payload, params)
+          return_value = step.perform(output, payload)
 
           if return_value.is_a?(FalseClass)
             output.detail('Job returned false, ending pipeline.')

data/lib/burner/step.rb

@@ -28,15 +28,13 @@ module Burner
       freeze
     end
 
-    def perform(output, payload, params)
+    def perform(output, payload)
       return_value = nil
 
       output.title("#{job.class.name}#{SEPARATOR}#{job.name}")
 
       time_in_seconds = Benchmark.measure do
-        job_params = (params || {}).merge(__id: output.id, __value: payload.value)
-
-        return_value = job.perform(output, payload, job_params)
+        return_value = job.perform(output, payload)
       end.real.round(3)
 
       output.complete(time_in_seconds)

data/lib/burner/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Burner
-  VERSION = '1.0.0-alpha.3'
+  VERSION = '1.0.0-alpha.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.3
+  version: 1.0.0.pre.alpha.4
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hashematics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hash_math
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: objectable
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: realize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: stringento
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +221,15 @@ files:
 - lib/burner/cli.rb
 - lib/burner/job.rb
 - lib/burner/jobs.rb
+- lib/burner/jobs/collection/arrays_to_objects.rb
+- lib/burner/jobs/collection/graph.rb
+- lib/burner/jobs/collection/objects_to_arrays.rb
+- lib/burner/jobs/collection/shift.rb
+- lib/burner/jobs/collection/transform.rb
+- lib/burner/jobs/collection/transform/attribute.rb
+- lib/burner/jobs/collection/transform/attribute_renderer.rb
+- lib/burner/jobs/collection/unpivot.rb
+- lib/burner/jobs/deserialize/csv.rb
 - lib/burner/jobs/deserialize/json.rb
 - lib/burner/jobs/deserialize/yaml.rb
 - lib/burner/jobs/dummy.rb
@@ -187,10 +238,13 @@ files:
 - lib/burner/jobs/io/exist.rb
 - lib/burner/jobs/io/read.rb
 - lib/burner/jobs/io/write.rb
+- lib/burner/jobs/serialize/csv.rb
 - lib/burner/jobs/serialize/json.rb
 - lib/burner/jobs/serialize/yaml.rb
 - lib/burner/jobs/set.rb
 - lib/burner/jobs/sleep.rb
+- lib/burner/modeling.rb
+- lib/burner/modeling/key_index_mapping.rb
 - lib/burner/output.rb
 - lib/burner/payload.rb
 - lib/burner/pipeline.rb