burner 1.0.0 → 1.1.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3d251463ade2de965d0dd1e0d635967571d3d1d4cab46a7d1271ab057d1c2e3
-  data.tar.gz: 2eac66d3f745888be07cf5d2d66f6e8429c61b0255ad0916f7c6f8c792194dcd
+  metadata.gz: 9dea13fe31b6e7bc97eafb25201508afc0a05d2d4e2eb86aeab00004695674f1
+  data.tar.gz: 6569debdcc9ad51a0e180ee6b0bac192029b95d59ad767ddae7c6711dba9830d
 SHA512:
-  metadata.gz: c57dabbc95d1b58b5f0fe15429f36682d0dec0771951bb01b6e8c6345ddd9e95b5805ad57f0e0166e8e4e87d0296885915c022895818e46c3389049207e0e719
-  data.tar.gz: f23ecf1374570ad2f5cc6dfb70c88c895e4d45e0c2eb7453878038dc507d1a808ca3894c50a320b4a259df09ad7f1368a4b8c7bd790624b27baac487df1b48cf
+  metadata.gz: 20cb03d16e9495edd35a9323f9507780b006f0be2ef61b0423e198ada1bdcc672e7a7fc471d606bc5cd47d3f727237922285bf71dd9648381b92bc5b90327174
+  data.tar.gz: 977cd155d3a717af7a4fc4876694f27b665844780fadf23556cdf1d7fb120a124741c341dbf1d4725fad8a0dbe12260f7475e36d9cd7e1415618929b73fb9794

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.1.0 (TBD)
+
+Added Jobs:
+
+* b/collection/coalesce
+* b/collection/group
+
 # 1.0.0 (November 5th, 2020)
 
 Initial version publication.

data/README.md

@@ -234,8 +234,10 @@ 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/coalesce** [register, grouped_register, key_mappings, keys, separator]: Merge two datasets together based on the key values of one dataset (array) with a grouped dataset (hash).
 * **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/group** [keys, register, separator]: Take a register's value (an array of objects) and group the objects by the specified keys.
 * **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.
 * **b/collection/transform** [attributes, exclusive, separator, register]: Iterate over all objects and transform each key per the attribute transformers specifications.  If exclusive is set to false then the current object will be overridden/merged.  Separator can also be set for key path support.  This job uses [Realize](https://github.com/bluemarblepayroll/realize), which provides its own extendable value-transformation pipeline.

data/lib/burner/jobs.rb

@@ -23,8 +23,10 @@ module Burner
     register 'b/sleep',                        Library::Sleep
 
     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/objects_to_arrays', Library::Collection::ObjectsToArrays
     register 'b/collection/shift',             Library::Collection::Shift
     register 'b/collection/transform',         Library::Collection::Transform

data/lib/burner/library.rb

@@ -14,8 +14,10 @@ require_relative 'library/nothing'
 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/graph'
+require_relative 'library/collection/group'
 require_relative 'library/collection/objects_to_arrays'
 require_relative 'library/collection/shift'
 require_relative 'library/collection/transform'

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

@@ -0,0 +1,73 @@
+# 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 is generally used right after the Group job has been executed on a separate
+      # dataset in a separate register.  This job can match up specified values in its dataset
+      # with lookup values in another.  If it finds a match then it will (shallow) copy over
+      # the values into the respective dataset.
+      #
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: array of objects.
+      class Coalesce < JobWithRegister
+        attr_reader :grouped_register, :key_mappings, :keys, :resolver
+
+        def initialize(
+          name:,
+          grouped_register:,
+          key_mappings: [],
+          keys: [],
+          register: DEFAULT_REGISTER,
+          separator: ''
+        )
+          super(name: name, register: register)
+
+          @grouped_register = grouped_register.to_s
+          @key_mappings     = Modeling::KeyMapping.array(key_mappings)
+          @keys             = Array(keys)
+          @resolver         = Objectable.resolver(separator: separator.to_s)
+
+          raise ArgumentError, 'at least one key is required' if @keys.empty?
+
+          freeze
+        end
+
+        def perform(output, payload)
+          payload[register] = array(payload[register])
+          count             = payload[register].length
+
+          output.detail("Coalescing based on key(s): #{keys} for #{count} records(s)")
+
+          payload[register].each do |record|
+            key    = make_key(record)
+            lookup = find_lookup(payload, key)
+
+            key_mappings.each do |key_mapping|
+              value = resolver.get(lookup, key_mapping.from)
+
+              resolver.set(record, key_mapping.to, value)
+            end
+          end
+        end
+
+        private
+
+        def find_lookup(payload, key)
+          (payload[grouped_register] || {})[key] || {}
+        end
+
+        def make_key(record)
+          keys.map { |key| resolver.get(record, key) }
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,8 @@ module Burner
         attr_reader :key, :groups
 
         def initialize(
-          name:, key:,
+          name:,
+          key:,
           config: Hashematics::Configuration.new,
           register: DEFAULT_REGISTER
         )

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

@@ -0,0 +1,66 @@
+# 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 a register's value (an array of objects) and group the objects by the specified keys.
+      # It essentially creates a hash from an array. This is useful for creating a O(1) lookup
+      # which can then be used in conjunction with the Coalesce Job for another array of data.
+      #
+      # An example of this specific job:
+      #
+      # input: [{ id: 1, code: 'a' }, { id: 2, code: 'b' }]
+      # keys: [:code]
+      # output: { 'a' => { id: 1, code: 'a' }, 'b' => { id: 2, code: 'b' } }
+      #
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: hash.
+      class Group < JobWithRegister
+        attr_reader :keys, :resolver
+
+        def initialize(
+          name:,
+          keys: [],
+          register: DEFAULT_REGISTER,
+          separator: ''
+        )
+          super(name: name, register: register)
+
+          @keys     = Array(keys)
+          @resolver = Objectable.resolver(separator: separator.to_s)
+
+          raise ArgumentError, 'at least one key is required' if @keys.empty?
+
+          freeze
+        end
+
+        def perform(output, payload)
+          payload[register] = array(payload[register])
+          count             = payload[register].length
+
+          output.detail("Grouping based on key(s): #{keys} for #{count} records(s)")
+
+          grouped_records = payload[register].each_with_object({}) do |record, memo|
+            key       = make_key(record)
+            memo[key] = record
+          end
+
+          payload[register] = grouped_records
+        end
+
+        private
+
+        def make_key(record)
+          keys.map { |key| resolver.get(record, key) }
+        end
+      end
+    end
+  end
+end

data/lib/burner/modeling.rb

@@ -10,4 +10,5 @@
 require_relative 'modeling/attribute'
 require_relative 'modeling/attribute_renderer'
 require_relative 'modeling/key_index_mapping'
+require_relative 'modeling/key_mapping'
 require_relative 'modeling/validations'

data/lib/burner/modeling/key_mapping.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 Modeling
+    # Generic mapping from a key to another key.
+    class KeyMapping
+      acts_as_hashable
+
+      attr_reader :from, :to
+
+      def initialize(from:, to:)
+        raise ArgumentError, 'from is required' if from.to_s.empty?
+        raise ArgumentError, 'to is required'   if to.to_s.empty?
+
+        @from = from.to_s
+        @to   = to.to_s
+
+        freeze
+      end
+    end
+  end
+end

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre.alpha
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -225,8 +225,10 @@ files:
 - 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/graph.rb
+- lib/burner/library/collection/group.rb
 - lib/burner/library/collection/objects_to_arrays.rb
 - lib/burner/library/collection/shift.rb
 - lib/burner/library/collection/transform.rb
@@ -252,6 +254,7 @@ files:
 - lib/burner/modeling/attribute.rb
 - lib/burner/modeling/attribute_renderer.rb
 - lib/burner/modeling/key_index_mapping.rb
+- lib/burner/modeling/key_mapping.rb
 - lib/burner/modeling/validations.rb
 - lib/burner/modeling/validations/base.rb
 - lib/burner/modeling/validations/blank.rb
@@ -286,9 +289,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: