burner 1.8.0 → 1.9.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f7acc476043a573e329d1f0dc07e3b6f8a90f456517d4b98c66ac3e370f26fe
-  data.tar.gz: 8317c42ba254babbb8b72c7468dab2ca132e809a812625241d8f393077a8ba2f
+  metadata.gz: eca471b05b356ad1e96f71c0173673109622e14dc7d7d46bdab0beccc1e03396
+  data.tar.gz: 55f81d7080c1f0eb4a4cc1d51df7534376306362a1d97a8369f3fd85c0107a3b
 SHA512:
-  metadata.gz: 93a1a11b8b7506c2e5508e9e34c34224a1b988cf49364f29a487103e331396a0852636fc83615bf53a963df29f34393e9f69fd4a66c2062ede0ec4620680a6db
-  data.tar.gz: c82edbbe587a36c30573720908688cebf046ef7a13c864682a16b14fd14de5e6f19bc48d676fe568ccc35cdbdae25e4c64b2f835249d819d1bc2c415c330ad45
+  metadata.gz: bbd76fedb82b0499f7f8913e5530a1c35e2d4fc613ef11e95fb8ad6c759a28a7f4737d5ae29a71e0409dbd8f45b03de5b96dc22b84e3b85384cb256d1742eb9c
+  data.tar.gz: 311f81afb55fdbf5548c9394ec1ee30e020833f205e4e1c53fef87630c2e77d0b6cbd6639689efaa8956ae7bb188555f35ffb1dca7c08c2cedb6881f959cd508

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.9.0 (TBD)
+
+Added Jobs:
+
+* b/collection/pivot
 # 1.8.0 (March 31st, 2021)
 
 Added Jobs:

data/README.md

@@ -271,6 +271,8 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 * **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/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.
 * **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.  If an attribute is not set with `explicit: true` then it will automatically start from the key's value from the record.  If `explicit: true` is started, then it will start from the record itself.
 * **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).

data/lib/burner/jobs.rb

@@ -30,6 +30,7 @@ module Burner
     register 'b/collection/nested_aggregate',  Library::Collection::NestedAggregate
     register 'b/collection/number',            Library::Collection::Number
     register 'b/collection/objects_to_arrays', Library::Collection::ObjectsToArrays
+    register 'b/collection/pivot',             Library::Collection::Pivot
     register 'b/collection/shift',             Library::Collection::Shift
     register 'b/collection/transform',         Library::Collection::Transform
     register 'b/collection/unpivot',           Library::Collection::Unpivot

data/lib/burner/library.rb

@@ -21,6 +21,7 @@ require_relative 'library/collection/group'
 require_relative 'library/collection/nested_aggregate'
 require_relative 'library/collection/number'
 require_relative 'library/collection/objects_to_arrays'
+require_relative 'library/collection/pivot'
 require_relative 'library/collection/shift'
 require_relative 'library/collection/transform'
 require_relative 'library/collection/unpivot'

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

@@ -0,0 +1,150 @@
+# 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 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 and Table classes:
+      # https://github.com/bluemarblepayroll/hash_math
+      #
+      # An example of a normalized dataset that could be pivoted:
+      #
+      # records = [
+      #   { patient_id: 1, key: :first_name, value: 'bozo' },
+      #   { patient_id: 1, key: :last_name,  value: 'clown' },
+      #   { patient_id: 2, key: :first_name, value: 'frank' },
+      #   { patient_id: 2, key: :last_name,  value: 'rizzo' },
+      # ]
+      #
+      # Using the following job configuration:
+      #
+      # config = {
+      #   unique_key: :patient_id
+      # }
+      #
+      # Once ran through this job, it would set the register to:
+      #
+      # records = [
+      #   { patient_id: 1, first_name: 'bozo', last_name: 'clown' },
+      #   { patient_id: 2, first_name: 'frank', last_name: 'rizzo' },
+      # ]
+      #
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: An array of objects.
+      class Pivot < JobWithRegister
+        DEFAULT_PIVOT_KEY       = :key
+        DEFAULT_PIVOT_VALUE_KEY = :value
+
+        attr_reader :insensitive,
+                    :other_keys,
+                    :non_pivoted_keys,
+                    :pivot_key,
+                    :pivot_value_key,
+                    :resolver,
+                    :unique_keys
+
+        def initialize(
+          unique_keys:,
+          insensitive: false,
+          name: '',
+          other_keys: [],
+          pivot_key: DEFAULT_PIVOT_KEY,
+          pivot_value_key: DEFAULT_PIVOT_KEY_VALUE,
+          register: DEFAULT_REGISTER,
+          separator: ''
+        )
+          super(name: name, register: register)
+
+          @insensitive      = insensitive || false
+          @pivot_key        = pivot_key.to_s
+          @pivot_value_key  = pivot_value_key.to_s
+          @resolver         = Objectable.resolver(separator: separator)
+          @unique_keys      = Array(unique_keys)
+          @other_keys       = Array(other_keys)
+          @non_pivoted_keys = @unique_keys + @other_keys
+
+          freeze
+        end
+
+        def perform(output, payload)
+          objects = array(payload[register])
+          table   = make_table(objects)
+
+          output.detail("Pivoting #{objects.length} object(s)")
+          output.detail("By key: #{pivot_key} and value: #{pivot_value_key}")
+
+          objects.each { |object| object_to_table(object, table) }
+
+          pivoted_objects = table.to_a.map(&:fields)
+
+          output.detail("Resulting dataset has #{pivoted_objects.length} object(s)")
+
+          payload[register] = pivoted_objects
+        end
+
+        private
+
+        def resolve_key(object)
+          key_to_use = resolver.get(object, pivot_key)
+
+          make_key(key_to_use)
+        end
+
+        def make_key(value)
+          insensitive ? value.to_s.downcase : value
+        end
+
+        def make_row_id(object)
+          unique_keys.map { |k| make_key(resolver.get(object, k)) }
+        end
+
+        def make_key_map(objects)
+          objects.each_with_object({}) do |object, key_map|
+            key = resolver.get(object, pivot_key)
+            unique_key = make_key(key)
+
+            key_map[unique_key] ||= Set.new
+
+            key_map[unique_key] << key
+          end
+        end
+
+        def make_record(objects)
+          key_map = make_key_map(objects)
+          keys    = non_pivoted_keys + key_map.values.map(&:first)
+
+          HashMath::Record.new(keys)
+        end
+
+        def make_table(objects)
+          HashMath::Table.new(make_record(objects))
+        end
+
+        def object_to_table(object, table)
+          row_id = make_row_id(object)
+
+          non_pivoted_keys.each do |key|
+            value = resolver.get(object, key)
+
+            table.add(row_id, key, value)
+          end
+
+          key_to_use   = resolve_key(object)
+          value_to_use = resolver.get(object, pivot_value_key)
+
+          table.add(row_id, key_to_use, value_to_use)
+
+          self
+        end
+      end
+    end
+  end
+end

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0.pre.alpha
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -251,6 +251,7 @@ files:
 - lib/burner/library/collection/nested_aggregate.rb
 - lib/burner/library/collection/number.rb
 - lib/burner/library/collection/objects_to_arrays.rb
+- lib/burner/library/collection/pivot.rb
 - lib/burner/library/collection/shift.rb
 - lib/burner/library/collection/transform.rb
 - lib/burner/library/collection/unpivot.rb
@@ -320,9 +321,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: