burner 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc10e53512597eb8d3bde5968a4c2003afe7b31841aec4c5c7b92926afccce38
-  data.tar.gz: 946b54a3bad8ab10b9d03e626d0a9ca09033206c9f8e7a32402bc29f4680deb5
+  metadata.gz: b775833cacea64e30e78943c176e3317e3f72510cb3653066a3ce16c70dc1f3d
+  data.tar.gz: 51da8ebaac4ea928c441898e9c7b46052efa9e5c95f454e6933e8a036093709b
 SHA512:
-  metadata.gz: 5c79c9c45bc6541f3e18b521f79644cee6223b6000d749762f571a36e0f327fbf9892055b65f5bb5ced89bc4ce01c9fca42f2ededc2302da66436722222848d8
-  data.tar.gz: 2f955e12724ff194802e532ffe6b12a475ac2aed7481a46b2a4e2a2fcfd2dec9f4fe8114b7dbd1a4b5a6745edfc4571ac7d72a441ff9b8505b5f145984ea4003
+  metadata.gz: 9276607a43419b630a7804ce5c83b53844dc0a42abddfd218e4a3f9d62aaaf608c24d821a980f3c618d058de0fbb2fb3abb6b8d1195f165d5f773121727ca1b1
+  data.tar.gz: 3c6ff8a7428940aaff2bb1a46f1bb7dfb4ac077e700ffbae7b006de8e0458c0d55ff719b846fd4daad6f5aa62f8b826c6abd96e185ba7d6dc6f4799b60d59291

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.10.0 (May 17th, 2021)
+
+Added Jobs:
+
+* b/collection/only_keys
 # 1.9.0 (April 13th, 2021)
 
 Added Jobs:

data/README.md

@@ -271,6 +271,7 @@ 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/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/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/only_keys',         Library::Collection::OnlyKeys
     register 'b/collection/pivot',             Library::Collection::Pivot
     register 'b/collection/shift',             Library::Collection::Shift
     register 'b/collection/transform',         Library::Collection::Transform

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/only_keys'
 require_relative 'library/collection/pivot'
 require_relative 'library/collection/shift'
 require_relative 'library/collection/transform'

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

@@ -0,0 +1,61 @@
+# 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 knows how to take an array of objects and limit it to a specific set of keys.
+      # The keys are pulled from another register which helps make it dynamic (you can load
+      # up this other register with a dynamic list of keys at run-time.)
+      #
+      # 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
+
+        def perform(output, payload)
+          objects = array(payload[register])
+          count   = objects.length
+          keys    = array(payload[keys_register])
+
+          output.detail("Dynamically limiting #{count} object(s) with key(s): #{keys.join(', ')}")
+
+          payload[register] = objects.map { |object| transform(object, keys) }
+        end
+
+        private
+
+        def transform(object, keys)
+          keys.each_with_object({}) do |key, memo|
+            value = resolver.get(object, key)
+
+            resolver.set(memo, key, value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-05-17 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/only_keys.rb
 - lib/burner/library/collection/pivot.rb
 - lib/burner/library/collection/shift.rb
 - lib/burner/library/collection/transform.rb