burner 1.4.0.pre.alpha → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4694264d232ea9b8c353973096b144283967676421524aa7aa2b9582f73469f
-  data.tar.gz: 1730498b8d7b18a1fee81a51b16817cb17e69f78bcd3091be7152b3139955806
+  metadata.gz: aa6bd0e3067707c53c82cd82816d3320ebe687ba071fa6bbbf97707035b5f46f
+  data.tar.gz: d104558bc6dcd8e4dd7186e7f5365294d3e421ff3e7fc13fe28765d3f7a69b7d
 SHA512:
-  metadata.gz: 1c473531a5422691fb36e14f5fbf7d7421fd19abe889d08e84e14265c146616f5761acbc3458c8cdd656ac784755dc96ec68370637234f260dbac16b0b8486b6
-  data.tar.gz: 88bce907acfcbb8fcec5c39d4be5ba8876fb630583ed55b268d96c3eca65c66412d15439f5abe4af8c29505099b54796dd4e9cdcb898a707d5e32a3e4dc0d838
+  metadata.gz: 47ff0ccaba50a39709a13b84f6727876a480dd8f4c6c420a9e374396db30fa9c74e64d62a32c4daf452320eca6266b662f3710d7f86262fbc9507391752a5d9c
+  data.tar.gz: d0900276a49941b883fddd34f1fdd78d126ca076e790cf53b7d72b94a7d24892142013710a53a7b314a270a1853ffcb8e51731868c5c7c47461322e38fd24315

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-# 1.4.0 (TBD)
+
+# 1.6.0 (December 22nd, 2020)
+
+Additions:
+
+* b/io/write now provides an optional `supress_side_effect` option.
+# 1.5.0 (December 21st, 2020)
+
+Added Jobs:
+
+* b/collection/zip
+# 1.4.0 (December 17th, 2020)
 
 Additions:
 

data/README.md

@@ -227,6 +227,7 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 * **b/collection/unpivot** [pivot_set, register]: 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).
 * **b/collection/validate** [invalid_register, join_char, message_key, register, separator, validations]: Take an array of objects, run it through each declared validator, and split the objects into two registers.  The valid objects will be split into the current register while the invalid ones will go into the invalid_register as declared.  Optional arguments, join_char and message_key, help determine the compiled error messages.  The separator option can be utilized to use dot-notation for validating keys.  See each validation's options by viewing their classes within the `lib/modeling/validations` directory.
 * **b/collection/values** [include_keys, register]: Take an array of objects and call `#values` on each object. If include_keys is true (it is false by default), then call `#keys` on the first object and inject that as a "header" object.
+* **b/collection/zip** [base_register, register, with_register]: Combines `base_register` and `with_register`s' data to form one single array in `register`.  It will combine each element, positionally in each array to form the final array.  For example:  ['hello', 'bugs'] + ['world', 'bunny'] => [['hello', 'world'], ['bugs', 'bunny']]
 
 #### Compression
 
@@ -245,7 +246,7 @@ By default all jobs will use the `Burner::Disks::Local` disk for its persistence
 * **b/io/exist** [disk, 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.
 * **b/io/read** [binary, disk, path, register]: 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.
 * **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]: 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.
+* **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.
 
 #### Serialization
 

data/lib/burner/jobs.rb

@@ -34,6 +34,7 @@ module Burner
     register 'b/collection/unpivot',           Library::Collection::Unpivot
     register 'b/collection/values',            Library::Collection::Values
     register 'b/collection/validate',          Library::Collection::Validate
+    register 'b/collection/zip',               Library::Collection::Zip
 
     register 'b/compress/row_reader',          Library::Compress::RowReader
 

data/lib/burner/library.rb

@@ -25,6 +25,7 @@ require_relative 'library/collection/transform'
 require_relative 'library/collection/unpivot'
 require_relative 'library/collection/validate'
 require_relative 'library/collection/values'
+require_relative 'library/collection/zip'
 
 require_relative 'library/compress/row_reader'
 

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

@@ -0,0 +1,53 @@
+# 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
+      # This job can take two arrays and coalesces them by index.  For example:
+      #
+      # input:
+      #   base_register: [ 'hello', 'bugs' ]
+      #   with_register: [ 'world', 'bunny' ]
+      # output:
+      #  register: [ ['hello', 'world'], ['bugs', 'bunny'] ]
+      #
+      # Expected Payload[base_register] input: array of objects.
+      # Expected Payload[with_register] input: array of objects.
+      # Payload[register] output: An array of two-dimensional arrays.
+      class Zip < JobWithRegister
+        attr_reader :base_register, :with_register
+
+        def initialize(
+          name:,
+          with_register:,
+          base_register: DEFAULT_REGISTER,
+          register: DEFAULT_REGISTER
+        )
+          super(name: name, register: register)
+
+          @base_register = base_register.to_s
+          @with_register = with_register.to_s
+
+          freeze
+        end
+
+        def perform(output, payload)
+          base_data = array(payload[base_register])
+          with_data = array(payload[with_register])
+
+          output.detail("Combining register: #{base_register} (#{base_data.length} record(s))")
+          output.detail("With register: #{with_register} (#{with_data.length} record(s))")
+
+          payload[register] = base_data.zip(with_data)
+        end
+      end
+    end
+  end
+end

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

@@ -12,11 +12,34 @@ require_relative 'open_file_base'
 module Burner
   module Library
     module IO
-      # Write value to disk.
+      # Write value to disk.  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.
       #
       # Expected Payload[register] input: anything.
       # Payload[register] output: whatever was passed in.
       class Write < OpenFileBase
+        attr_reader :supress_side_effect
+
+        def initialize(
+          name:,
+          path:,
+          binary: false,
+          disk: {},
+          register: DEFAULT_REGISTER,
+          supress_side_effect: false
+        )
+          @supress_side_effect = supress_side_effect || false
+
+          super(
+            binary: binary,
+            disk: disk,
+            name: name,
+            path: path,
+            register: register
+          )
+        end
+
         def perform(output, payload)
           logical_filename  = job_string_template(path, output, payload)
           physical_filename = nil
@@ -29,6 +52,10 @@ module Burner
 
           output.detail("Wrote to: #{physical_filename}")
 
+          return if supress_side_effect
+
+          output.detail("Saving to side effects: #{logical_filename}")
+
           side_effect = SideEffects::WrittenFile.new(
             logical_filename: logical_filename,
             physical_filename: physical_filename,

data/lib/burner/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Burner
-  VERSION = '1.4.0-alpha'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.4.0.pre.alpha
+  version: 1.6.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -252,6 +252,7 @@ files:
 - lib/burner/library/collection/unpivot.rb
 - lib/burner/library/collection/validate.rb
 - lib/burner/library/collection/values.rb
+- lib/burner/library/collection/zip.rb
 - lib/burner/library/compress/row_reader.rb
 - lib/burner/library/deserialize/csv.rb
 - lib/burner/library/deserialize/json.rb
@@ -309,9 +310,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: