burner 1.0.0.pre.alpha.7 → 1.0.0.pre.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cb851b5c317d3566c1b3b77c9c904e26970de8e0ce4329e2c8b83336c372b02
-  data.tar.gz: 0ad28e56c8b52ceede4ed321812e45edfaef2bcd4000428738c348e5e849092a
+  metadata.gz: ebd1332e7b4a01aace974be43aaa77e02b3bcb13e36b2360b08192bde2b99705
+  data.tar.gz: '09095dcd305279cf2e246cca6e36256a0f7943d12d335366aa6ff9dcc92c6198'
 SHA512:
-  metadata.gz: cf5bc810ffa5dba106e6538dbab2f44e6763f5ad073da2b645e46eff3e976e61f9a0d551ae4d5ad9998c5c1d87b5e2913b902901020ad77f20b4c29800321df5
-  data.tar.gz: ef83de8173fbad28c2cc07c44f101175ebe9c60d5a9275d2e7280ba1b621a8c51082504ae5d5c917916d398a7a89d06ca7416dd08ba7148ebebb87cd42dd7b05
+  metadata.gz: 31e45b0c0cc815d05f3424a04e77a8e36ed96e912ec0fed2dfcf8e171ecbe7f0ade1841991cdb97751bbd10d103b161d173120abd0a68689281a258de524697c
+  data.tar.gz: 751091b32afae9e386814cb16856c5b0d41393b51e4e98070579d6508484e61a27a21bddba4be08f7a8416a86b50de71eeac3d886c635c785572f1597cb9095c

data/README.md

@@ -31,30 +31,30 @@ pipeline = {
   jobs: [
     {
       name: :read,
-      type: 'io/read',
+      type: 'b/io/read',
       path: '{input_file}'
     },
     {
       name: :output_id,
-      type: :echo,
+      type: 'b/echo',
       message: 'The job id is: {__id}'
     },
     {
       name: :output_value,
-      type: :echo,
+      type: 'b/echo',
       message: 'The current value is: {__value}'
     },
     {
       name: :parse,
-      type: 'deserialize/json'
+      type: 'b/deserialize/json'
     },
     {
       name: :convert,
-      type: 'serialize/yaml'
+      type: 'b/serialize/yaml'
     },
     {
       name: :write,
-      type: 'io/write',
+      type: 'b/io/write',
       path: '{output_file}'
     }
   ],
@@ -172,25 +172,25 @@ Write the following json_to_yaml_pipeline.yaml file to disk:
 ````yaml
 jobs:
   - name: read
-    type: io/read
+    type: b/io/read
     path: '{input_file}'
 
   - name: output_id
-    type: echo
+    type: b/echo
     message: 'The job id is: {__id}'
 
   - name: output_value
-    type: echo
+    type: b/echo
     message: 'The current value is: {__value}'
 
   - name: parse
-    type: deserialize/json
+    type: b/deserialize/json
 
   - name: convert
-    type: serialize/yaml
+    type: b/serialize/yaml
 
   - name: write
-    type: io/write
+    type: b/io/write
     path: '{output_file}'
 
 steps:
@@ -233,39 +233,39 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 
 #### Collection
 
-* **collection/arrays_to_objects** [mappings, register]: Convert an array of arrays to an array of objects.
-* **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.
-* **collection/objects_to_arrays** [mappings, register]: Convert an array of objects to an array of arrays.
-* **collection/shift** [amount, register]: Remove the first N number of elements from an array.
-* **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.
-* **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).
-* **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.
-* **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/arrays_to_objects** [mappings, register]: Convert an array of arrays to an array of 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/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.
+* **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.
 
 #### De-serialization
 
-* **deserialize/csv** [register]: Take a CSV string and de-serialize into object(s).  Currently it will return an array of arrays, with each nested array representing one row.
-* **deserialize/json** [register]: Treat input as a string and de-serialize it to JSON.
-* **deserialize/yaml** [register, safe]: Treat input as a string and de-serialize it to YAML.  By default it will try and [safely de-serialize](https://ruby-doc.org/stdlib-2.6.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load) it (only using core classes).  If you wish to de-serialize it to any class type, pass in `safe: false`
+* **b/deserialize/csv** [register]: Take a CSV string and de-serialize into object(s).  Currently it will return an array of arrays, with each nested array representing one row.
+* **b/deserialize/json** [register]: Treat input as a string and de-serialize it to JSON.
+* **b/deserialize/yaml** [register, safe]: Treat input as a string and de-serialize it to YAML.  By default it will try and [safely de-serialize](https://ruby-doc.org/stdlib-2.6.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load) it (only using core classes).  If you wish to de-serialize it to any class type, pass in `safe: false`
 
 #### IO
 
-* **io/exist** [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.
-* **io/read** [binary, 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.
-* **io/write** [binary, 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/exist** [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, 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/write** [binary, 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.
 
 #### Serialization
 
-* **serialize/csv** [register]: Take an array of arrays and create a CSV.
-* **serialize/json** [register]: Convert value to JSON.
-* **serialize/yaml** [register]: Convert value to YAML.
+* **b/serialize/csv** [register]: Take an array of arrays and create a CSV.
+* **b/serialize/json** [register]: Convert value to JSON.
+* **b/serialize/yaml** [register]: Convert value to YAML.
 
 #### General
 
-* **dummy** []: Do nothing
-* **echo** [message]: Write a message to the output.  The message parameter can be interpolated using  `Payload#params`.
-* **set** [register, value]: Set the value to any arbitrary value.
-* **sleep** [seconds]: Sleep the thread for X number of seconds.
+* **b/dummy** []: Do nothing
+* **b/echo** [message]: Write a message to the output.  The message parameter can be interpolated using  `Payload#params`.
+* **b/set** [register, value]: Set the value to any arbitrary value.
+* **b/sleep** [seconds]: Sleep the thread for X number of seconds.
 
 Notes:
 
@@ -296,17 +296,17 @@ pipeline = {
   jobs: [
     {
       name: :read,
-      type: 'io/read',
+      type: 'b/io/read',
       path: '{input_file}'
     },
     {
       name: :output_id,
-      type: :echo,
+      type: 'b/echo',
       message: 'The job id is: {__id}'
     },
     {
       name: :output_value,
-      type: :echo,
+      type: 'b/echo',
       message: 'The current value is: {__value}'
     },
     {
@@ -315,11 +315,11 @@ pipeline = {
     },
     {
       name: :convert,
-      type: 'serialize/yaml'
+      type: 'b/serialize/yaml'
     },
     {
       name: :write,
-      type: 'io/write',
+      type: 'b/io/write',
       path: '{output_file}'
     }
   ],

data/burner.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Declarative and extendable processing pipeline'
 
   s.description = <<-DESCRIPTION
-    This library serves as the skeleton for a processing engine.  It allows you to organize your code into Jobs, then stitch those jobs together as steps.
+    This library serves as the backbone for a configurable processing engine.  It allows you to organize your code into jobs, then stitch those jobs together as steps.
   DESCRIPTION
 
   s.authors     = ['Matthew Ruggio']

data/lib/burner/jobs.rb

@@ -16,25 +16,31 @@ module Burner
   class Jobs
     acts_as_hashable_factory
 
-    register 'collection/arrays_to_objects', Library::Collection::ArraysToObjects
-    register 'collection/graph',             Library::Collection::Graph
-    register 'collection/objects_to_arrays', Library::Collection::ObjectsToArrays
-    register 'collection/shift',             Library::Collection::Shift
-    register 'collection/transform',         Library::Collection::Transform
-    register 'collection/unpivot',           Library::Collection::Unpivot
-    register 'collection/values',            Library::Collection::Values
-    register 'deserialize/csv',              Library::Deserialize::Csv
-    register 'deserialize/json',             Library::Deserialize::Json
-    register 'deserialize/yaml',             Library::Deserialize::Yaml
-    register 'dummy', '',                    Library::Dummy
-    register 'echo',                         Library::Echo
-    register 'io/exist',                     Library::IO::Exist
-    register 'io/read',                      Library::IO::Read
-    register 'io/write',                     Library::IO::Write
-    register 'serialize/csv',                Library::Serialize::Csv
-    register 'serialize/json',               Library::Serialize::Json
-    register 'serialize/yaml',               Library::Serialize::Yaml
-    register 'set_value',                    Library::SetValue
-    register 'sleep',                        Library::Sleep
+    # Dummy is the default as noted by the ''.  This means if a type is omitted, nil, or blank
+    # string then the dummy job will be used.
+    register 'b/dummy', '',                    Library::Dummy
+    register 'b/echo',                         Library::Echo
+    register 'b/set_value',                    Library::SetValue
+    register 'b/sleep',                        Library::Sleep
+
+    register 'b/collection/arrays_to_objects', Library::Collection::ArraysToObjects
+    register 'b/collection/graph',             Library::Collection::Graph
+    register 'b/collection/objects_to_arrays', Library::Collection::ObjectsToArrays
+    register 'b/collection/shift',             Library::Collection::Shift
+    register 'b/collection/transform',         Library::Collection::Transform
+    register 'b/collection/unpivot',           Library::Collection::Unpivot
+    register 'b/collection/values',            Library::Collection::Values
+
+    register 'b/deserialize/csv',              Library::Deserialize::Csv
+    register 'b/deserialize/json',             Library::Deserialize::Json
+    register 'b/deserialize/yaml',             Library::Deserialize::Yaml
+
+    register 'b/io/exist',                     Library::IO::Exist
+    register 'b/io/read',                      Library::IO::Read
+    register 'b/io/write',                     Library::IO::Write
+
+    register 'b/serialize/csv',                Library::Serialize::Csv
+    register 'b/serialize/json',               Library::Serialize::Json
+    register 'b/serialize/yaml',               Library::Serialize::Yaml
   end
 end

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

@@ -23,14 +23,14 @@ module Burner
       #     jobs: [
       #       {
       #         name: 'set',
-      #         type: 'set_value',
+      #         type: 'b/set_value',
       #         value: [
       #           [1, 'funky']
       #         ]
       #       },
       #       {
       #         name: 'map',
-      #         type: 'collection/arrays_to_objects',
+      #         type: 'b/collection/arrays_to_objects',
       #         mappings: [
       #           { index: 0, key: 'id' },
       #           { index: 1, key: 'name' }
@@ -38,7 +38,7 @@ module Burner
       #       },
       #       {
       #         name: 'output',
-      #         type: 'echo',
+      #         type: 'b/echo',
       #         message: 'value is currently: {__value}'
       #       },
       #

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

@@ -24,14 +24,14 @@ module Burner
       #     jobs: [
       #       {
       #         name: 'set',
-      #         type: 'set_value',
+      #         type: 'b/set_value',
       #         value: [
       #           [1, 'funky']
       #         ]
       #       },
       #       {
       #         name: 'map',
-      #         type: 'collection/objects_to_arrays',
+      #         type: 'b/collection/objects_to_arrays',
       #         mappings: [
       #           { index: 0, key: 'id' },
       #           { index: 1, key: 'name' }
@@ -39,7 +39,7 @@ module Burner
       #       },
       #       {
       #         name: 'output',
-      #         type: 'echo',
+      #         type: 'b/echo',
       #         message: 'value is currently: {__value}'
       #       },
       #

data/lib/burner/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.7
+  version: 1.0.0.pre.alpha.8
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -192,8 +192,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
-description: "    This library serves as the skeleton for a processing engine.  It
-  allows you to organize your code into Jobs, then stitch those jobs together as steps.\n"
+description: "    This library serves as the backbone for a configurable processing
+  engine.  It allows you to organize your code into jobs, then stitch those jobs together
+  as steps.\n"
 email:
 - mruggio@bluemarblepayroll.com
 executables: