burner 1.0.0.pre.alpha.4 → 1.0.0.pre.alpha.9

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.4
+  version: 1.0.0.pre.alpha.9
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -192,8 +192,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
-description: "    This library serves as the skeleton for a processing engine.  It
-  allows you to organize your code into Jobs, then stitch those jobs together as steps.\n"
+description: "    This library serves as the backbone for a configurable processing
+  engine.  It allows you to organize your code into jobs, then stitch those jobs together
+  as steps.\n"
 email:
 - mruggio@bluemarblepayroll.com
 executables:
@@ -220,38 +221,49 @@ files:
 - lib/burner.rb
 - lib/burner/cli.rb
 - lib/burner/job.rb
+- lib/burner/job_with_register.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
-- lib/burner/jobs/echo.rb
-- lib/burner/jobs/io/base.rb
-- 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/library.rb
+- lib/burner/library/collection/arrays_to_objects.rb
+- lib/burner/library/collection/graph.rb
+- lib/burner/library/collection/objects_to_arrays.rb
+- lib/burner/library/collection/shift.rb
+- lib/burner/library/collection/transform.rb
+- lib/burner/library/collection/unpivot.rb
+- lib/burner/library/collection/validate.rb
+- lib/burner/library/collection/values.rb
+- lib/burner/library/deserialize/csv.rb
+- lib/burner/library/deserialize/json.rb
+- lib/burner/library/deserialize/yaml.rb
+- lib/burner/library/dummy.rb
+- lib/burner/library/echo.rb
+- lib/burner/library/io/base.rb
+- lib/burner/library/io/exist.rb
+- lib/burner/library/io/read.rb
+- lib/burner/library/io/write.rb
+- lib/burner/library/serialize/csv.rb
+- lib/burner/library/serialize/json.rb
+- lib/burner/library/serialize/yaml.rb
+- lib/burner/library/set_value.rb
+- lib/burner/library/sleep.rb
 - lib/burner/modeling.rb
+- lib/burner/modeling/attribute.rb
+- lib/burner/modeling/attribute_renderer.rb
 - lib/burner/modeling/key_index_mapping.rb
+- lib/burner/modeling/validations.rb
+- lib/burner/modeling/validations/base.rb
+- lib/burner/modeling/validations/blank.rb
+- lib/burner/modeling/validations/present.rb
 - lib/burner/output.rb
 - lib/burner/payload.rb
 - lib/burner/pipeline.rb
+- lib/burner/side_effects.rb
+- lib/burner/side_effects/written_file.rb
 - lib/burner/step.rb
-- lib/burner/string_template.rb
+- lib/burner/util.rb
+- lib/burner/util/arrayable.rb
+- lib/burner/util/string_template.rb
 - lib/burner/version.rb
-- lib/burner/written_file.rb
 homepage: https://github.com/bluemarblepayroll/burner
 licenses:
 - MIT

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

@@ -1,43 +0,0 @@
-# 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/objects_to_arrays.rb

@@ -1,54 +0,0 @@
-# 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/transform/attribute.rb

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

@@ -1,36 +0,0 @@
-# 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/string_template.rb

@@ -1,40 +0,0 @@
-# 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
-  # Can take in a string and an object and use the object for formatting string interpolations
-  # using tokens of form: {attribute_name}.  This templating class does not understand nested
-  # structures, so input should be a flat object/hash in the form of key-value pairs.  A benefit of
-  # using Objectable for resolution is that it can understand almost any type of
-  # object: Hash, Struct, OpenStruct, custom objects, etc.
-  # For more information see underlying libraries:
-  #   * Stringento: https://github.com/bluemarblepayroll/stringento
-  #   * Objectable: https://github.com/bluemarblepayroll/objectable
-  class StringTemplate
-    include Singleton
-
-    attr_reader :resolver
-
-    def initialize
-      @resolver = Objectable.resolver(separator: '')
-
-      freeze
-    end
-
-    # For general consumption
-    def evaluate(expression, input)
-      Stringento.evaluate(expression, input, resolver: self)
-    end
-
-    # For Stringento consumption
-    def resolve(value, input)
-      resolver.get(input, value)
-    end
-  end
-end

data/lib/burner/written_file.rb

@@ -1,28 +0,0 @@
-# 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
-  # Describes a file that was generated by a Job.  If a Job emits a file, it should also add the
-  # file details to the Payload#written_files array using the Payload#add_written_file method.
-  class WrittenFile
-    acts_as_hashable
-
-    attr_reader :logical_filename,
-                :physical_filename,
-                :time_in_seconds
-
-    def initialize(logical_filename:, physical_filename:, time_in_seconds:)
-      @logical_filename  = logical_filename.to_s
-      @physical_filename = physical_filename.to_s
-      @time_in_seconds   = time_in_seconds.to_f
-
-      freeze
-    end
-  end
-end