burner 1.0.0.pre.alpha.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebd1332e7b4a01aace974be43aaa77e02b3bcb13e36b2360b08192bde2b99705
-  data.tar.gz: '09095dcd305279cf2e246cca6e36256a0f7943d12d335366aa6ff9dcc92c6198'
+  metadata.gz: d3d251463ade2de965d0dd1e0d635967571d3d1d4cab46a7d1271ab057d1c2e3
+  data.tar.gz: 2eac66d3f745888be07cf5d2d66f6e8429c61b0255ad0916f7c6f8c792194dcd
 SHA512:
-  metadata.gz: 31e45b0c0cc815d05f3424a04e77a8e36ed96e912ec0fed2dfcf8e171ecbe7f0ade1841991cdb97751bbd10d103b161d173120abd0a68689281a258de524697c
-  data.tar.gz: 751091b32afae9e386814cb16856c5b0d41393b51e4e98070579d6508484e61a27a21bddba4be08f7a8416a86b50de71eeac3d886c635c785572f1597cb9095c
+  metadata.gz: c57dabbc95d1b58b5f0fe15429f36682d0dec0771951bb01b6e8c6345ddd9e95b5805ad57f0e0166e8e4e87d0296885915c022895818e46c3389049207e0e719
+  data.tar.gz: f23ecf1374570ad2f5cc6dfb70c88c895e4d45e0c2eb7453878038dc507d1a808ca3894c50a320b4a259df09ad7f1368a4b8c7bd790624b27baac487df1b48cf

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0 (November 5th, 2020)
+
+Initial version publication.
+
 # 0.0.1
 
 Shell

data/README.md

@@ -234,6 +234,7 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 #### Collection
 
 * **b/collection/arrays_to_objects** [mappings, register]: Convert an array of arrays to an array of objects.
+* **b/collection/concatenate** [from_registers, to_register]: Concatenate each from_register's value and place the newly concatenated array into the to_register.  Note: this does not do any deep copying and should be assumed it is shallow copying all objects.
 * **b/collection/graph** [config, key, register]: Use [Hashematics](https://github.com/bluemarblepayroll/hashematics) to turn a flat array of objects into a deeply nested object tree.
 * **b/collection/objects_to_arrays** [mappings, register]: Convert an array of objects to an array of arrays.
 * **b/collection/shift** [amount, register]: Remove the first N number of elements from an array.
@@ -260,11 +261,15 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 * **b/serialize/json** [register]: Convert value to JSON.
 * **b/serialize/yaml** [register]: Convert value to YAML.
 
+#### Value
+
+* **b/value/copy** [from_register, to_register]: Copy from_register's value into the to_register.  Note: this does not do any deep copying and should be assumed it is shallow copying all objects.
+* **b/value/static** [register, value]: Set the value to any arbitrary value.
+
 #### General
 
-* **b/dummy** []: Do nothing
 * **b/echo** [message]: Write a message to the output.  The message parameter can be interpolated using  `Payload#params`.
-* **b/set** [register, value]: Set the value to any arbitrary value.
+* **b/nothing** []: Do nothing.
 * **b/sleep** [seconds]: Sleep the thread for X number of seconds.
 
 Notes:
@@ -273,6 +278,8 @@ Notes:
 
 ### Adding & Registering Jobs
 
+Note: Jobs have to be registered with a type in the Burner::Jobs factory.  All jobs that ship with this library are prefixed with `b/` in their type in order to provide a namespace for 'burner-specific' jobs vs. externally provided jobs.
+
 Where this library shines is when additional jobs are plugged in.  Burner uses its `Burner::Jobs` class as its class-level registry built with [acts_as_hashable](https://github.com/bluemarblepayroll/acts_as_hashable)'s acts_as_hashable_factory directive.
 
 Let's say we would like to register a job to parse a CSV:

data/burner.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   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('realize', '~>1.3')
   s.add_dependency('stringento', '~>2.1')
 
   s.add_development_dependency('guard-rspec', '~>4.7')

data/lib/burner.rb

@@ -29,3 +29,9 @@ require_relative 'burner/util'
 
 # Main Entrypoint(s)
 require_relative 'burner/cli'
+
+# Top-level namespace
+module Burner
+  # All jobs that need to reference the main register should use this constant.
+  DEFAULT_REGISTER = 'default'
+end

data/lib/burner/job.rb

@@ -31,10 +31,11 @@ module Burner
     # The #perform method takes in two arguments: output (an instance of Burner::Output)
     # and payload (an instance of Burner::Payload).  Jobs can leverage output to emit
     # information to the pipeline's log(s).  The payload is utilized to pass data from job to job,
-    # with its most important attribute being #value.  The value attribute is mutable
-    # per the individual job's context (meaning of it is unknown without understanding a job's
-    # input and output value of #value.).  Therefore #value can mean anything and it is up to the
-    # engineers to clearly document the assumptions of its use.
+    # with its most important attribute being #registers.  The registers attribute is a mutable
+    # and accessible hash per the individual job's context
+    # (meaning of it is unknown without understanding a job's input and output value
+    # of #registers.).  Therefore #register key values can mean anything
+    # and it is up to consumers to clearly document the assumptions of its use.
     #
     # Returning false will short-circuit the pipeline right after the job method exits.
     # Returning anything else besides false just means "continue".
@@ -47,9 +48,15 @@ module Burner
     protected
 
     def job_string_template(expression, output, payload)
-      templatable_params = payload.params.merge(__id: output.id, __value: payload[''])
+      templatable_params = payload.params
+                                  .merge(__id: output.id)
+                                  .merge(templatable_register_values(payload))
 
       Util::StringTemplate.instance.evaluate(expression, templatable_params)
     end
+
+    def templatable_register_values(payload)
+      payload.registers.transform_keys { |key| "__#{key}_register" }
+    end
   end
 end

data/lib/burner/job_with_register.rb

@@ -15,7 +15,7 @@ module Burner
   class JobWithRegister < Job
     attr_reader :register
 
-    def initialize(name:, register: '')
+    def initialize(name:, register: DEFAULT_REGISTER)
       super(name: name)
 
       @register = register.to_s

data/lib/burner/jobs.rb

@@ -16,20 +16,21 @@ module Burner
   class Jobs
     acts_as_hashable_factory
 
-    # Dummy is the default as noted by the ''.  This means if a type is omitted, nil, or blank
-    # string then the dummy job will be used.
-    register 'b/dummy', '',                    Library::Dummy
+    # Nothing is the default as noted by the ''.  This means if a type is omitted, nil, or blank
+    # string then the nothing job will be used.
     register 'b/echo',                         Library::Echo
-    register 'b/set_value',                    Library::SetValue
+    register 'b/nothing', '',                  Library::Nothing
     register 'b/sleep',                        Library::Sleep
 
     register 'b/collection/arrays_to_objects', Library::Collection::ArraysToObjects
+    register 'b/collection/concatenate',       Library::Collection::Concatenate
     register 'b/collection/graph',             Library::Collection::Graph
     register 'b/collection/objects_to_arrays', Library::Collection::ObjectsToArrays
     register 'b/collection/shift',             Library::Collection::Shift
     register 'b/collection/transform',         Library::Collection::Transform
     register 'b/collection/unpivot',           Library::Collection::Unpivot
     register 'b/collection/values',            Library::Collection::Values
+    register 'b/collection/validate',          Library::Collection::Validate
 
     register 'b/deserialize/csv',              Library::Deserialize::Csv
     register 'b/deserialize/json',             Library::Deserialize::Json
@@ -42,5 +43,8 @@ module Burner
     register 'b/serialize/csv',                Library::Serialize::Csv
     register 'b/serialize/json',               Library::Serialize::Json
     register 'b/serialize/yaml',               Library::Serialize::Yaml
+
+    register 'b/value/copy',                   Library::Value::Copy
+    register 'b/value/static',                 Library::Value::Static
   end
 end

data/lib/burner/library.rb

@@ -9,7 +9,12 @@
 
 require_relative 'job_with_register'
 
+require_relative 'library/echo'
+require_relative 'library/nothing'
+require_relative 'library/sleep'
+
 require_relative 'library/collection/arrays_to_objects'
+require_relative 'library/collection/concatenate'
 require_relative 'library/collection/graph'
 require_relative 'library/collection/objects_to_arrays'
 require_relative 'library/collection/shift'
@@ -17,16 +22,18 @@ require_relative 'library/collection/transform'
 require_relative 'library/collection/unpivot'
 require_relative 'library/collection/validate'
 require_relative 'library/collection/values'
+
 require_relative 'library/deserialize/csv'
 require_relative 'library/deserialize/json'
 require_relative 'library/deserialize/yaml'
-require_relative 'library/dummy'
-require_relative 'library/echo'
+
 require_relative 'library/io/exist'
 require_relative 'library/io/read'
 require_relative 'library/io/write'
+
 require_relative 'library/serialize/csv'
 require_relative 'library/serialize/json'
 require_relative 'library/serialize/yaml'
-require_relative 'library/set_value'
-require_relative 'library/sleep'
+
+require_relative 'library/value/copy'
+require_relative 'library/value/static'

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

@@ -14,8 +14,8 @@ module Burner
       # Burner::Modeling::KeyIndexMapping instances or hashable configurations which specifies
       # the index-to-key mappings to use.
       #
-      # Expected Payload#value input: array of arrays.
-      # Payload#value output: An array of hashes.
+      # Expected Payload[register] input: array of arrays.
+      # Payload[register] output: An array of hashes.
       #
       # An example using a configuration-first pipeline:
       #
@@ -23,7 +23,7 @@ module Burner
       #     jobs: [
       #       {
       #         name: 'set',
-      #         type: 'b/set_value',
+      #         type: 'b/value/static',
       #         value: [
       #           [1, 'funky']
       #         ]
@@ -47,10 +47,15 @@ module Burner
       #   }
       #
       #   Burner::Pipeline.make(config).execute
+      #
+      # Given the above example, the expected output would be:
+      #  [
+      #    { 'id' => 1, 'name' => 'funky' }
+      #  ]
       class ArraysToObjects < JobWithRegister
         attr_reader :mappings
 
-        def initialize(name:, mappings: [], register: '')
+        def initialize(name:, mappings: [], register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           @mappings = Modeling::KeyIndexMapping.array(mappings)

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

@@ -0,0 +1,42 @@
+# 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 the list of from_registers and concatenate each of their values together.
+      # Each from_value will be coerced into an array if it not an array.
+      #
+      # Expected Payload[from_register] input: array of objects.
+      # Payload[to_register] output: An array of objects.
+      class Concatenate < Job
+        attr_reader :from_registers, :to_register
+
+        def initialize(name:, from_registers: [], to_register: DEFAULT_REGISTER)
+          super(name: name)
+
+          @from_registers = Array(from_registers)
+          @to_register    = to_register.to_s
+
+          freeze
+        end
+
+        def perform(output, payload)
+          output.detail("Concatenating registers: '#{from_registers}' to: '#{to_register}'")
+
+          payload[to_register] = from_registers.each_with_object([]) do |from_register, memo|
+            from_register_value = array(payload[from_register])
+
+            memo.concat(from_register_value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,12 +13,16 @@ module Burner
       # 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.
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects.
       class Graph < JobWithRegister
         attr_reader :key, :groups
 
-        def initialize(name:, key:, config: Hashematics::Configuration.new, register: '')
+        def initialize(
+          name:, key:,
+          config: Hashematics::Configuration.new,
+          register: DEFAULT_REGISTER
+        )
           super(name: name, register: register)
 
           raise ArgumentError, 'key is required' if key.to_s.empty?

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

@@ -15,39 +15,41 @@ module Burner
       # 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.
+      # Expected Payload[register] input: array of hashes.
+      # Payload[register] output: An array of arrays.
       #
       # An example using a configuration-first pipeline:
       #
-      #   config = {
-      #     jobs: [
-      #       {
-      #         name: 'set',
-      #         type: 'b/set_value',
-      #         value: [
-      #           [1, 'funky']
-      #         ]
-      #       },
-      #       {
-      #         name: 'map',
-      #         type: 'b/collection/objects_to_arrays',
-      #         mappings: [
-      #           { index: 0, key: 'id' },
-      #           { index: 1, key: 'name' }
-      #         ]
-      #       },
-      #       {
-      #         name: 'output',
-      #         type: 'b/echo',
-      #         message: 'value is currently: {__value}'
-      #       },
+      #  config = {
+      #    jobs: [
+      #      {
+      #        name: 'set',
+      #        type: 'b/value/static',
+      #        value: [
+      #          { 'id' => 1, 'name' => 'funky' }
+      #        ],
+      #        register: register
+      #      },
+      #      {
+      #        name: 'map',
+      #        type: 'b/collection/objects_to_arrays',
+      #        mappings: [
+      #          { index: 0, key: 'id' },
+      #          { index: 1, key: 'name' }
+      #        ],
+      #        register: register
+      #      },
+      #      {
+      #        name: 'output',
+      #        type: 'b/echo',
+      #        message: 'value is currently: {__value}'
+      #      },
       #
-      #     ],
-      #     steps: %w[set map output]
-      #   }
+      #    ],
+      #    steps: %w[set map output]
+      #  }
       #
-      #   Burner::Pipeline.make(config).execute
+      #  Burner::Pipeline.make(config).execute
       class ObjectsToArrays < JobWithRegister
         attr_reader :mappings
 
@@ -56,7 +58,7 @@ module Burner
         # 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: [], register: '', separator: '')
+        def initialize(name:, mappings: [], register: DEFAULT_REGISTER, separator: '')
           super(name: name, register: register)
 
           @mappings = Modeling::KeyIndexMapping.array(mappings)

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

@@ -14,8 +14,8 @@ module Burner
       # 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.
+      # Expected Payload[register] input: nothing.
+      # Payload[register] output: An array with N beginning elements removed.
       class Shift < JobWithRegister
         DEFAULT_AMOUNT = 0
 
@@ -23,7 +23,7 @@ module Burner
 
         attr_reader :amount
 
-        def initialize(name:, amount: DEFAULT_AMOUNT, register: '')
+        def initialize(name:, amount: DEFAULT_AMOUNT, register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           @amount = amount.to_i

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

@@ -18,8 +18,8 @@ module Burner
       # 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.
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects.
       class Transform < JobWithRegister
         BLANK = ''
 
@@ -27,7 +27,13 @@ module Burner
                     :exclusive,
                     :resolver
 
-        def initialize(name:, attributes: [], exclusive: false, register: '', separator: BLANK)
+        def initialize(
+          name:,
+          attributes: [],
+          exclusive: false,
+          register: DEFAULT_REGISTER,
+          separator: BLANK
+        )
           super(name: name, register: register)
 
           @resolver  = Objectable.resolver(separator: separator)

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

@@ -14,12 +14,16 @@ module Burner
       # 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.
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects.
       class Unpivot < JobWithRegister
         attr_reader :unpivot
 
-        def initialize(name:, pivot_set: HashMath::Unpivot::PivotSet.new, register: '')
+        def initialize(
+          name:,
+          pivot_set: HashMath::Unpivot::PivotSet.new,
+          register: DEFAULT_REGISTER
+        )
           super(name: name, register: register)
 
           @unpivot = HashMath::Unpivot.new(pivot_set)

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

@@ -14,8 +14,9 @@ module Burner
       # of validations.  The main register will include the valid objects and the invalid_register
       # will contain the invalid objects.
       #
-      # Expected Payload#value input: array of objects.
-      # Payload#value output: An array of objects.
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects that are valid.
+      # Payload[invalid_register] output: An array of objects that are invalid.
       class Validate < JobWithRegister
         DEFAULT_INVALID_REGISTER = 'invalid'
         DEFAULT_JOIN_CHAR        = ', '
@@ -32,7 +33,7 @@ module Burner
           invalid_register: DEFAULT_INVALID_REGISTER,
           join_char: DEFAULT_JOIN_CHAR,
           message_key: DEFAULT_MESSAGE_KEY,
-          register: '',
+          register: DEFAULT_REGISTER,
           separator: '',
           validations: []
         )

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

@@ -14,12 +14,12 @@ module Burner
       # 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.
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of arrays.
       class Values < JobWithRegister
         attr_reader :include_keys
 
-        def initialize(name:, include_keys: false, register: '')
+        def initialize(name:, include_keys: false, register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           @include_keys = include_keys || false

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

@@ -12,8 +12,8 @@ module Burner
     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.
+      # Expected Payload[register] input: nothing.
+      # Payload[register] output: an array of arrays.  Each inner array represents one data row.
       class Csv < JobWithRegister
         # 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

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

@@ -12,8 +12,8 @@ module Burner
     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.
+      # Expected Payload[register] input: string of JSON data.
+      # Payload[register] output: anything, as specified by the JSON de-serializer.
       class Json < JobWithRegister
         def perform(_output, payload)
           payload[register] = JSON.parse(payload[register])

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

@@ -15,12 +15,12 @@ module Burner
       # 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.
+      # Expected Payload[register] input: string of YAML data.
+      # Payload[register]output: anything as specified by the YAML de-serializer.
       class Yaml < JobWithRegister
         attr_reader :safe
 
-        def initialize(name:, register: '', safe: true)
+        def initialize(name:, register: DEFAULT_REGISTER, safe: true)
           super(name: name, register: register)
 
           @safe = safe

data/lib/burner/library/echo.rb

@@ -11,7 +11,7 @@ module Burner
   module Library
     # Output a simple message to the output.
     #
-    # Note: this does not use Payload#value.
+    # Note: this does not use Payload#registers.
     class Echo < Job
       attr_reader :message
 

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

@@ -14,7 +14,7 @@ module Burner
       class Base < JobWithRegister
         attr_reader :path
 
-        def initialize(name:, path:, register: '')
+        def initialize(name:, path:, register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           raise ArgumentError, 'path is required' if path.to_s.empty?

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

@@ -15,7 +15,7 @@ module Burner
       # Check to see if a file exists.  If short_circuit is set to true and the file
       # does not exist then the job will return false and short circuit the pipeline.
       #
-      # Note: this does not use Payload#value.
+      # Note: this does not use Payload#registers.
       class Exist < Job
         attr_reader :path, :short_circuit
 

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

@@ -14,12 +14,12 @@ module Burner
     module IO
       # Read value from disk.
       #
-      # Expected Payload#value input: nothing.
-      # Payload#value output: contents of the specified file.
+      # Expected Payload[register] input: nothing.
+      # Payload[register] output: contents of the specified file.
       class Read < Base
         attr_reader :binary
 
-        def initialize(name:, path:, binary: false, register: '')
+        def initialize(name:, path:, binary: false, register: DEFAULT_REGISTER)
           super(name: name, path: path, register: register)
 
           @binary = binary || false

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

@@ -14,12 +14,12 @@ module Burner
     module IO
       # Write value to disk.
       #
-      # Expected Payload#value input: anything.
-      # Payload#value output: whatever was passed in.
+      # Expected Payload[register] input: anything.
+      # Payload[register] output: whatever was passed in.
       class Write < Base
         attr_reader :binary
 
-        def initialize(name:, path:, binary: false, register: '')
+        def initialize(name:, path:, binary: false, register: DEFAULT_REGISTER)
           super(name: name, path: path, register: register)
 
           @binary = binary || false

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

@@ -11,8 +11,8 @@ module Burner
   module Library
     # Do nothing.
     #
-    # Note: this does not use Payload#value.
-    class Dummy < Job
+    # Note: this does not use Payload#registers.
+    class Nothing < Job
       def perform(_output, _payload); end
     end
   end

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

@@ -12,8 +12,8 @@ module Burner
     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.
+      # Expected Payload[register] input: array of arrays.
+      # Payload[register] output: a serialized CSV string.
       class Csv < JobWithRegister
         def perform(_output, payload)
           payload[register] = CSV.generate(options) do |csv|

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

@@ -12,8 +12,8 @@ module Burner
     module Serialize
       # Treat value like a Ruby object and serialize it using JSON.
       #
-      # Expected Payload#value input: anything.
-      # Payload#value output: string representing the output of the JSON serializer.
+      # Expected Payload[register] input: anything.
+      # Payload[register] output: string representing the output of the JSON serializer.
       class Json < JobWithRegister
         def perform(_output, payload)
           payload[register] = payload[register].to_json

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

@@ -12,8 +12,8 @@ module Burner
     module Serialize
       # Treat value like a Ruby object and serialize it using YAML.
       #
-      # Expected Payload#value input: anything.
-      # Payload#value output: string representing the output of the YAML serializer.
+      # Expected Payload[register] input: anything.
+      # Payload[register] output: string representing the output of the YAML serializer.
       class Yaml < JobWithRegister
         def perform(_output, payload)
           payload[register] = payload[register].to_yaml

data/lib/burner/library/sleep.rb

@@ -11,7 +11,7 @@ module Burner
   module Library
     # Arbitrarily put thread to sleep for X number of seconds
     #
-    # Payload#value output: whatever value was specified in this job.
+    # Note: this does not use Payload#registers.
     class Sleep < Job
       attr_reader :seconds
 

data/lib/burner/library/value/copy.rb

@@ -0,0 +1,39 @@
+# 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 Value
+      # Copy one value in a register to another.  Note that this does *not* perform any type of
+      # deep copy, it simply points one register's value to another.  If you decide to later mutate
+      # one register then you may mutate the other.
+      #
+      # Expected Payload[from_register] input: anything.
+      # Payload[to_register] output: whatever value was specified in the from_register.
+      class Copy < Job
+        attr_reader :from_register, :to_register
+
+        def initialize(name:, to_register: DEFAULT_REGISTER, from_register: DEFAULT_REGISTER)
+          super(name: name)
+
+          @from_register = from_register.to_s
+          @to_register   = to_register.to_s
+
+          freeze
+        end
+
+        def perform(output, payload)
+          output.detail("Copying register: '#{from_register}' to: '#{to_register}'")
+
+          payload[to_register] = payload[from_register]
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/value/static.rb

@@ -0,0 +1,34 @@
+# 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 Value
+      # Arbitrarily set the value of a register.
+      #
+      # Expected Payload[register] input: anything.
+      # Payload[register] output: whatever value was specified in this job.
+      class Static < JobWithRegister
+        attr_reader :value
+
+        def initialize(name:, register: DEFAULT_REGISTER, value: nil)
+          super(name: name, register: register)
+
+          @value = value
+
+          freeze
+        end
+
+        def perform(_output, payload)
+          payload[register] = value
+        end
+      end
+    end
+  end
+end

data/lib/burner/modeling/attribute.rb

@@ -10,7 +10,9 @@
 module Burner
   module Modeling
     # Defines a top-level key and the associated transformers for deriving the final value
-    # to set the key to.
+    # to set the key to.  The transformers that can be passed in can be any Realize::Transformers
+    # subclasses.  For more information, see the Realize library at:
+    # https://github.com/bluemarblepayroll/realize
     class Attribute
       acts_as_hashable
 

data/lib/burner/modeling/validations/base.rb

@@ -27,7 +27,7 @@ module Burner
         end
 
         def message
-          @message.to_s.empty? ? "#{key}#{default_message}" : @message.to_s
+          @message.to_s.empty? ? "#{key} #{default_message}" : @message.to_s
         end
       end
     end

data/lib/burner/modeling/validations/blank.rb

@@ -16,14 +16,18 @@ module Burner
       class Blank < Base
         acts_as_hashable
 
+        BLANK_RE = /\A[[:space:]]*\z/.freeze
+
         def valid?(object, resolver)
-          resolver.get(object, key).to_s.empty?
+          value = resolver.get(object, key).to_s
+
+          value.empty? || BLANK_RE.match?(value)
         end
 
         private
 
         def default_message
-          ' must be blank'
+          'must be blank'
         end
       end
     end

data/lib/burner/modeling/validations/present.rb

@@ -7,23 +7,23 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'base'
+require_relative 'blank'
 
 module Burner
   module Modeling
     class Validations
       # Check if a value is present.  If it is blank (null or empty) then it is invalid.
-      class Present < Base
+      class Present < Blank
         acts_as_hashable
 
         def valid?(object_value, resolver)
-          !resolver.get(object_value, key).to_s.empty?
+          !super(object_value, resolver)
         end
 
         private
 
         def default_message
-          ' is required'
+          'is required'
         end
       end
     end

data/lib/burner/payload.rb

@@ -8,16 +8,22 @@
 #
 
 module Burner
-  # The input for all Job#perform methods.  The main notion of this object is its "value"
-  # attribute.  This is dynamic and weak on purpose and is subject to whatever the Job#perform
-  # methods decides it is.  This definitely adds an order-of-magnitude complexity to this whole
-  # library and lifecycle, but I am not sure there is any other way around it: trying to build
-  # a generic, open-ended object pipeline to serve almost any use case.
+  # The input for all Job#perform methods.  The main notion of this object is its 'registers'
+  # attribute.  This registers attribute is a key-indifferent hash, accessible on Payload using
+  # the brackets setter and getter methods.  This is dynamic and weak on purpose and is subject
+  # to whatever the Job#perform methods decides it is.  This definitely adds an order-of-magnitude
+  # complexity to this whole library and lifecycle, but I am not sure there is any other way
+  # around it: trying to build a generic, open-ended processing pipeline to serve almost
+  # any use case.
   #
   # The side_effects attribute can also be utilized as a way for jobs to emit any data in a more
   # structured/additive manner.  The initial use case for this was for Burner's core IO jobs to
   # report back the files it has written in a more structured data way (as opposed to simply
   # writing some information to the output.)
+  #
+  # The 'time' attribute is important in that it should for the replaying of pipelines and jobs.
+  # Instead of having job's utilizing Time.now, Date.today, etc... they should rather opt to
+  # use this value instead.
   class Payload
     attr_reader :params,
                 :registers,

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: stringento
   requirement: !ruby/object:Gem::Requirement
@@ -225,6 +225,7 @@ files:
 - lib/burner/jobs.rb
 - lib/burner/library.rb
 - lib/burner/library/collection/arrays_to_objects.rb
+- lib/burner/library/collection/concatenate.rb
 - lib/burner/library/collection/graph.rb
 - lib/burner/library/collection/objects_to_arrays.rb
 - lib/burner/library/collection/shift.rb
@@ -235,17 +236,18 @@ files:
 - 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/nothing.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/library/value/copy.rb
+- lib/burner/library/value/static.rb
 - lib/burner/modeling.rb
 - lib/burner/modeling/attribute.rb
 - lib/burner/modeling/attribute_renderer.rb
@@ -284,9 +286,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

data/lib/burner/library/set_value.rb

@@ -1,32 +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
-  module Library
-    # Arbitrarily set value
-    #
-    # Expected Payload#value input: anything.
-    # Payload#value output: whatever value was specified in this job.
-    class SetValue < JobWithRegister
-      attr_reader :value
-
-      def initialize(name:, register: '', value: nil)
-        super(name: name, register: register)
-
-        @value = value
-
-        freeze
-      end
-
-      def perform(_output, payload)
-        payload[register] = value
-      end
-    end
-  end
-end