burner 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b775833cacea64e30e78943c176e3317e3f72510cb3653066a3ce16c70dc1f3d
-  data.tar.gz: 51da8ebaac4ea928c441898e9c7b46052efa9e5c95f454e6933e8a036093709b
+  metadata.gz: f687d9818e7a090c0999f144096eef52c5ba7093a069a8d2ef784f5abdb859d7
+  data.tar.gz: cae3bb23c2671ab69263fe7359c93a47777c72fc387ab93a03006c38a2bc83cd
 SHA512:
-  metadata.gz: 9276607a43419b630a7804ce5c83b53844dc0a42abddfd218e4a3f9d62aaaf608c24d821a980f3c618d058de0fbb2fb3abb6b8d1195f165d5f773121727ca1b1
-  data.tar.gz: 3c6ff8a7428940aaff2bb1a46f1bb7dfb4ac077e700ffbae7b006de8e0458c0d55ff719b846fd4daad6f5aa62f8b826c6abd96e185ba7d6dc6f4799b60d59291
+  metadata.gz: 3d1740b55ec51e3459092d99165f75197dcad75d2dcce28ae285ed9dc1e1fcbb2a85002f8abeb868e0bc388424e8e85056bab1b41a54046023d06fbd836f0598
+  data.tar.gz: bffbcf8567d03252bc04fb8e207674595b271635da2ef4cec963cd6ac329e4e58194167f0b474dc522785cbaef10a239b504e12825c56fb9d55042f4733b1840

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.11.0 (May 17th, 2021)
+
+Added Jobs:
+
+* b/collection/flat_file_parse
+
 # 1.10.0 (May 17th, 2021)
 
 Added Jobs:

data/README.md

@@ -266,12 +266,13 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 * **b/collection/arrays_to_objects** [mappings, register]: Convert an array of arrays to an array of objects.
 * **b/collection/coalesce** [grouped_register, insensitive, key_mappings, keys, register, separator]: Merge two datasets together based on the key values of one dataset (array) with a grouped dataset (hash).  If insensitive (false by default) is true then each key's value will be converted/coerced to a lowercase string.
 * **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/flat_file_parse** [keys_register, register, separator]: Map an array of arrays to an array of hashes.  These keys can be realized at run-time as they are pulled from the first entry in the array.  The `keys_register` will also be set to the keys used for mapping.
 * **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/group** [insensitive, keys, register, separator]: Take a register's value (an array of objects) and group the objects by the specified keys.  If insensitive (false by default) is true then each key's value will be converted/coerced to a lowercase string.
 * **b/collection/nested_aggregate** [register, key_mappings, key, separator]: Traverse a set of objects, resolving key's value for each object, optionally copying down key_mappings to the child records, then merging all the inner records together.
 * **b/collection/number** [key, register, separator, start_at]: This job can iterate over a set of records and sequence them (set the specified key to a sequential index value.)
 * **b/collection/objects_to_arrays** [mappings, register]: Convert an array of objects to an array of arrays.
-* **b/collection/only_keys** [keys_register, register, separator]: Limit an array of objects' keys to a specified set of keys.  These keys can be realized at run-time as they are pulled from another register (keys_register) thus making it dynamic.
+* **b/collection/only_keys** [keys_register, register, separator]: Limit an array of objects' keys to a specified set of keys.  These keys can be realized at run-time as they are pulled from another register (`keys_register`) thus making it dynamic.
 * **b/collection/pivot** [unique_keys, insensitive, other_keys, pivot_key, pivot_value_key, register, separator]:
 Take an array of objects and pivot a key into multiple keys.  It essentially takes all the values for a key and creates N number of keys (one per value.) Under the hood it uses HashMath's [Record](https://github.com/bluemarblepayroll/hash_math#record-the-hash-prototype) and [Table](https://github.com/bluemarblepayroll/hash_math#table-the-double-hash-hash-of-hashes) classes.
 * **b/collection/shift** [amount, register]: Remove the first N number of elements from an array.

data/lib/burner/job_with_dynamic_keys.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.
+#
+
+require_relative 'job_with_register'
+
+module Burner
+  # Add on a register attribute to the configuration for a job.  This indicates that a job
+  # either accesses and/or mutates the payload's registers.
+  class JobWithDynamicKeys < JobWithRegister
+    attr_reader :keys_register,
+                :resolver
+
+    def initialize(
+      keys_register:,
+      name: '',
+      register: DEFAULT_REGISTER,
+      separator: BLANK
+    )
+      super(name: name, register: register)
+
+      @keys_register = keys_register.to_s
+      @resolver      = Objectable.resolver(separator: separator)
+
+      freeze
+    end
+  end
+end

data/lib/burner/job_with_register.rb

@@ -13,6 +13,8 @@ module Burner
   # Add on a register attribute to the configuration for a job.  This indicates that a job
   # either accesses and/or mutates the payload's registers.
   class JobWithRegister < Job
+    BLANK = ''
+
     attr_reader :register
 
     def initialize(name: '', register: DEFAULT_REGISTER)

data/lib/burner/jobs.rb

@@ -25,8 +25,9 @@ module Burner
     register 'b/collection/arrays_to_objects', Library::Collection::ArraysToObjects
     register 'b/collection/coalesce',          Library::Collection::Coalesce
     register 'b/collection/concatenate',       Library::Collection::Concatenate
-    register 'b/collection/graph',             Library::Collection::Graph
     register 'b/collection/group',             Library::Collection::Group
+    register 'b/collection/flat_file_parse',   Library::Collection::FlatFileParse
+    register 'b/collection/graph',             Library::Collection::Graph
     register 'b/collection/nested_aggregate',  Library::Collection::NestedAggregate
     register 'b/collection/number',            Library::Collection::Number
     register 'b/collection/objects_to_arrays', Library::Collection::ObjectsToArrays

data/lib/burner/library.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'job_with_register'
+require_relative 'job_with_dynamic_keys'
 
 require_relative 'library/echo'
 require_relative 'library/nothing'
@@ -16,6 +16,7 @@ require_relative 'library/sleep'
 require_relative 'library/collection/arrays_to_objects'
 require_relative 'library/collection/coalesce'
 require_relative 'library/collection/concatenate'
+require_relative 'library/collection/flat_file_parse'
 require_relative 'library/collection/graph'
 require_relative 'library/collection/group'
 require_relative 'library/collection/nested_aggregate'

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

@@ -0,0 +1,57 @@
+# 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
+      # Convert an array of arrays to an array of objects.  The difference between this
+      # job and ArraysToObjects is that this one does not take in mappings and instead
+      # will use the first entry as the array of keys to positionally map to.
+      #
+      # For example, if a register had this:
+      #
+      #   [['id', 'first', 'last'], [1, 'frank', 'rizzo']]
+      #
+      # Then executing this job would result in this:
+      #
+      #   [{ 'id' => 1, 'first' => frank, 'last' => rizzo }]
+      #
+      # As a side-effect, the keys_register would result in this:
+      #
+      #   ['id', 'first', 'last']
+      #
+      # Expected Payload[register] input: array of arrays.
+      # Payload[register] output: An array of hashes.
+      class FlatFileParse < JobWithDynamicKeys
+        def perform(output, payload)
+          objects = array(payload[register])
+          keys    = array(objects.shift)
+          count   = objects.length
+
+          output.detail("Mapping #{count} array(s) to key(s): #{keys.join(', ')}")
+
+          payload[register]      = objects.map { |object| transform(object, keys) }
+          payload[keys_register] = keys
+        end
+
+        private
+
+        def transform(object, keys)
+          object.each_with_object({}).with_index do |(value, memo), index|
+            next if index >= keys.length
+
+            key = keys[index]
+
+            resolver.set(memo, key, value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,26 +16,7 @@ module Burner
       #
       # Expected Payload[register] input: array of objects.
       # Payload[register] output: An array of objects.
-      class OnlyKeys < JobWithRegister
-        BLANK = ''
-
-        attr_reader :keys_register,
-                    :resolver
-
-        def initialize(
-          keys_register:,
-          name: '',
-          register: DEFAULT_REGISTER,
-          separator: BLANK
-        )
-          super(name: name, register: register)
-
-          @keys_register = keys_register.to_s
-          @resolver      = Objectable.resolver(separator: separator)
-
-          freeze
-        end
-
+      class OnlyKeys < JobWithDynamicKeys
         def perform(output, payload)
           objects = array(payload[register])
           count   = objects.length

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

@@ -21,8 +21,6 @@ module Burner
       # Expected Payload[register] input: array of objects.
       # Payload[register] output: An array of objects.
       class Transform < JobWithRegister
-        BLANK = ''
-
         attr_reader :attribute_renderers,
                     :exclusive,
                     :resolver

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

@@ -12,8 +12,6 @@ module Burner
     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)

data/lib/burner/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Burner
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -240,12 +240,14 @@ files:
 - lib/burner/disks/local.rb
 - lib/burner/job.rb
 - lib/burner/job_set.rb
+- lib/burner/job_with_dynamic_keys.rb
 - lib/burner/job_with_register.rb
 - lib/burner/jobs.rb
 - lib/burner/library.rb
 - lib/burner/library/collection/arrays_to_objects.rb
 - lib/burner/library/collection/coalesce.rb
 - lib/burner/library/collection/concatenate.rb
+- lib/burner/library/collection/flat_file_parse.rb
 - lib/burner/library/collection/graph.rb
 - lib/burner/library/collection/group.rb
 - lib/burner/library/collection/nested_aggregate.rb