burner 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c9f86d7e38af602d55db6f13473ef3943e7bb860bc531a49025c1cc42a4686
-  data.tar.gz: 732a8127ec38ea3e4160331fa05046d9fec8e4057a48ecefb309c12821f67254
+  metadata.gz: 9f7acc476043a573e329d1f0dc07e3b6f8a90f456517d4b98c66ac3e370f26fe
+  data.tar.gz: 8317c42ba254babbb8b72c7468dab2ca132e809a812625241d8f393077a8ba2f
 SHA512:
-  metadata.gz: 96c17f4c33e6aa21d9f6b5b075cee2d0fd456bef4b7b02c9401b9439925e2ae8b91c44ebae1e8bc1185d22215516b1f6d27ed6362760e14d8ddc069cceb8e22a
-  data.tar.gz: 71ddb54a2f7c286adf6c457aeffbb897989fe2d0d3a1c95cfbb0e86bb69db4dcae5bc06190485e43a6655ba664d02d2fce90977d9d391597261ccf4944986aeb
+  metadata.gz: 93a1a11b8b7506c2e5508e9e34c34224a1b988cf49364f29a487103e331396a0852636fc83615bf53a963df29f34393e9f69fd4a66c2062ede0ec4620680a6db
+  data.tar.gz: c82edbbe587a36c30573720908688cebf046ef7a13c864682a16b14fd14de5e6f19bc48d676fe568ccc35cdbdae25e4c64b2f835249d819d1bc2c415c330ad45

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 1.8.0 (March 31st, 2021)
+
+Added Jobs:
+
+* b/param/from_register
+* b/param/to_register
+
+Other:
+
+* Payload#param was added to access a param key's value.
+* Payload#update_param was added to update a param key's value.
+
+Internal Notes:
+
+Payload#register and Payload#params data stores have been internally consolidated while still maintaining the same public API surface area.
 
 # 1.7.0 (January 22nd, 2021)
 

data/README.md

@@ -297,6 +297,11 @@ By default all jobs will use the `Burner::Disks::Local` disk for its persistence
 * **b/io/row_reader** [data_key, disk, ignore_blank_path, ignore_file_not_found, path_key, register, separator]: Iterates over an array of objects, extracts a filepath from a key in each object, and attempts to load the file's content for each record.  The file's content will be stored at the specified data_key. By default missing paths or files will be treated as hard errors.  If you wish to ignore these then pass in true for ignore_blank_path and/or ignore_file_not_found.
 * **b/io/write** [binary, disk, path, register, supress_side_effect]: 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.  By default, written files are also logged as WrittenFile instances to the Payload#side_effects array.  You can pass in supress_side_effect: true to disable this behavior.
 
+#### Parameters
+
+* **b/param/from_register** [param_key, register]: Copy the value of a register to a param key.
+* **b/param/to_register** [param_key, register]: Copy the value of a param key to a register.
+
 #### Serialization
 
 * **b/serialize/csv** [byte_order_mark, register]: Take an array of arrays and create a CSV.  You can optionally pre-pend a byte order mark, see Burner::Modeling::ByteOrderMark for acceptable options.

data/lib/burner/data.rb

@@ -0,0 +1,46 @@
+# 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
+  # Defines a key value pair data store per our library.  It is basically a composite
+  # object around a hash with indifferent key typing.
+  class Data
+    extend Forwardable
+
+    def_delegators :internal_hash, :transform_keys
+
+    def initialize(hash = {})
+      @internal_hash = {}
+
+      (hash || {}).each { |k, v| self[k] = v }
+    end
+
+    def []=(key, value)
+      internal_hash[key.to_s] = value
+    end
+
+    def [](key)
+      internal_hash[key.to_s]
+    end
+
+    def to_h
+      internal_hash
+    end
+
+    def ==(other)
+      other.instance_of?(self.class) &&
+        to_h == other.to_h
+    end
+    alias eql? ==
+
+    private
+
+    attr_reader :internal_hash
+  end
+end

data/lib/burner/job.rb

@@ -46,15 +46,9 @@ module Burner
     protected
 
     def job_string_template(expression, output, payload)
-      templatable_params = payload.params
-                                  .merge(__id: output.id)
-                                  .merge(templatable_register_values(payload))
+      templatable_params = payload.params_and_registers_hash.merge(__id: output.id)
 
       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/jobs.rb

@@ -48,6 +48,9 @@ module Burner
     register 'b/io/row_reader',                Library::IO::RowReader
     register 'b/io/write',                     Library::IO::Write
 
+    register 'b/param/from_register',          Library::Param::FromRegister
+    register 'b/param/to_register',            Library::Param::ToRegister
+
     register 'b/serialize/csv',                Library::Serialize::Csv
     register 'b/serialize/json',               Library::Serialize::Json
     register 'b/serialize/yaml',               Library::Serialize::Yaml

data/lib/burner/library.rb

@@ -39,6 +39,9 @@ require_relative 'library/io/read'
 require_relative 'library/io/row_reader'
 require_relative 'library/io/write'
 
+require_relative 'library/param/from_register'
+require_relative 'library/param/to_register'
+
 require_relative 'library/serialize/csv'
 require_relative 'library/serialize/json'
 require_relative 'library/serialize/yaml'

data/lib/burner/library/param/base.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 Library
+    module Param
+      # Common logic shared across Param job subclasses.
+      class Base < JobWithRegister
+        BLANK = ''
+
+        attr_reader :param_key
+
+        def initialize(name: BLANK, param_key: BLANK, register: DEFAULT_REGISTER)
+          super(name: name, register: register)
+
+          @param_key = param_key.to_s
+
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/param/from_register.rb

@@ -0,0 +1,30 @@
+# 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 'base'
+
+module Burner
+  module Library
+    module Param
+      # Copy a register's value into a param key.  Generally speaking you should only be
+      # mutating registers, that way the params stay true to the passed in params for the
+      # pipeline.  But this job is available in case a param needs to be updated.
+      #
+      # Expected Payload[register] input: anything.
+      # Payload.params(param_key) output: whatever value was specified in the register.
+      class FromRegister < Base
+        def perform(output, payload)
+          output.detail("Pushing value from register: #{register} to param: #{param_key}")
+
+          payload.update_param(param_key, payload[register])
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/param/to_register.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.
+#
+
+require_relative 'base'
+
+module Burner
+  module Library
+    module Param
+      # Copy a param key's value into a register.
+      #
+      # Expected Payload.param(param_key) input: anything.
+      # Payload[register] output: whatever value was specified as the param_key's value.
+      class ToRegister < Base
+        def perform(output, payload)
+          output.detail("Pushing value to register: #{register} from param: #{param_key}")
+
+          payload[register] = payload.param(param_key)
+        end
+      end
+    end
+  end
+end

data/lib/burner/payload.rb

@@ -7,6 +7,8 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'data'
+
 module Burner
   # 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
@@ -24,10 +26,15 @@ module Burner
   # 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.
+  #
+  # The notion of params are somewhat conflated with registers here.  Both are hashes and both
+  # serve as data stores. The difference is registers are really meant to be the shared-data
+  # repository across jobs, while params are, more or less, the input into the _pipeline_.
+  # It is debatable if mutation of the params should be allowed but the design decision was made
+  # early on to allow for params to be mutable albeit with registers being the preferred mutable
+  # store.
   class Payload
-    attr_reader :params,
-                :registers,
-                :side_effects,
+    attr_reader :side_effects,
                 :time
 
     def initialize(
@@ -36,12 +43,32 @@ module Burner
       side_effects: [],
       time: Time.now.utc
     )
-      @params       = params || {}
-      @registers    = {}
+      @params       = Data.new(params)
+      @registers    = Data.new(registers)
       @side_effects = side_effects || []
       @time         = time || Time.now.utc
+    end
 
-      add_registers(registers)
+    # Backwards compatibility.  This allows for control over the underlying data structure
+    # while still maintaining the same public API as before.
+    def params
+      @params.to_h
+    end
+
+    # Backwards compatibility.  This allows for control over the underlying data structure
+    # while still maintaining the same public API as before.
+    def registers
+      @registers.to_h
+    end
+
+    # Law of Demeter: While params is an accessible hash, it is preferred that the
+    # public class methods are used.
+    def param(key)
+      @params[key]
+    end
+
+    def update_param(key, value)
+      tap { @params[key] = value }
     end
 
     # Add a side effect of a job.  This helps to keep track of things jobs do outside of its
@@ -52,12 +79,12 @@ module Burner
 
     # Set a register's value.
     def []=(key, value)
-      set(key, value)
+      @registers[key] = value
     end
 
     # Retrieve a register's value.
     def [](key)
-      registers[key.to_s]
+      @registers[key]
     end
 
     # Set halt_pipeline to true.  This will indicate to the pipeline to stop all
@@ -71,14 +98,11 @@ module Burner
       @halt_pipeline || false
     end
 
-    private
-
-    def set(key, value)
-      registers[key.to_s] = value
-    end
+    def params_and_registers_hash
+      registers_hash = @registers.transform_keys { |key| "__#{key}_register" }
+      params_hash    = @params.to_h
 
-    def add_registers(registers)
-      (registers || {}).each { |k, v| set(k, v) }
+      params_hash.merge(registers_hash)
     end
   end
 end

data/lib/burner/pipeline.rb

@@ -55,7 +55,7 @@ module Burner
     private
 
     def output_params(params, output)
-      if params.keys.any?
+      if params.any?
         output.write('Parameters:')
       else
         output.write('No parameters passed in.')

data/lib/burner/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Burner
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Matthew Ruggio
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -220,6 +220,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -234,6 +235,7 @@ files:
 - exe/burner
 - lib/burner.rb
 - lib/burner/cli.rb
+- lib/burner/data.rb
 - lib/burner/disks.rb
 - lib/burner/disks/local.rb
 - lib/burner/job.rb
@@ -266,6 +268,9 @@ files:
 - lib/burner/library/io/row_reader.rb
 - lib/burner/library/io/write.rb
 - lib/burner/library/nothing.rb
+- lib/burner/library/param/base.rb
+- lib/burner/library/param/from_register.rb
+- lib/burner/library/param/to_register.rb
 - lib/burner/library/serialize/csv.rb
 - lib/burner/library/serialize/json.rb
 - lib/burner/library/serialize/yaml.rb
@@ -304,7 +309,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/burner
   homepage_uri: https://github.com/bluemarblepayroll/burner
   source_code_uri: https://github.com/bluemarblepayroll/burner
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -320,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Declarative and extendable processing pipeline
 test_files: []