burner 0.0.0 → 1.0.0.pre.alpha.4

data/lib/burner.rb

@@ -7,8 +7,23 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'burner/cli'
+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'
 
-# Placeholder
-module Burner
-end
+# Main Entrypoint(s)
+require_relative 'burner/cli'

data/lib/burner/cli.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.
+#
+
+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 :payload, :pipeline
+
+    def initialize(args)
+      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
+      pipeline.execute(payload: payload)
+    end
+
+    private
+
+    def read_yaml(path)
+      yaml = IO.read(path)
+
+      YAML.safe_load(yaml)
+    end
+
+    def extract_cli_params(args)
+      args[1..-1].each_with_object({}) do |arg, memo|
+        parts = arg.to_s.split('=')
+
+        memo[parts.first] = parts.last
+      end
+    end
+  end
+end

data/lib/burner/job.rb

@@ -0,0 +1,37 @@
+# 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 'string_template'
+
+module Burner
+  # Abstract base class for all job subclasses.  The only public method a subclass needs to
+  # implement #perform(params, payload, reporter) and then you can register it for use using
+  # the Burner::Jobs factory class method #register.  An example of a registration:
+  #   Burner::Jobs.register('your_class', YourClass)
+  class Job
+    acts_as_hashable
+
+    attr_reader :name, :string_template
+
+    def initialize(name:)
+      raise ArgumentError, 'name is required' if name.to_s.empty?
+
+      @name            = name.to_s
+      @string_template = StringTemplate.instance
+    end
+
+    private
+
+    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

@@ -0,0 +1,58 @@
+# 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'
+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'
+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'
+require_relative 'jobs/sleep'
+
+module Burner
+  # Main library of jobs.  This file contains all the basic/default jobs.  All other consumer
+  # libraries/applications can register their own, for example:
+  #   Burner::Jobs.register('your_class', YourClass)
+  class Jobs
+    acts_as_hashable_factory
+
+    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