burner 1.3.0.pre.alpha → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340ebade1c4d3cc238925cb21718571dd666c3c16b6ee60d8de73c4fe017d562
-  data.tar.gz: 33b272e7a4b4a15a8e92b5f7eccb9df7ec6d685f767ecbf8434dedcf7ed901b5
+  metadata.gz: 432bc8b6df5023860fce0b34698d777e30389d3af17c800c978f304ec5eef53c
+  data.tar.gz: e75d8dac2a871e44b427f62dd727aefe32beefaad9838af28d7d5a34da6bf6ed
 SHA512:
-  metadata.gz: a5d082d14302d38e2acf89ab1275004ae69f78087e40da2a68c15e25770a9ebfc7fa2cb8e9e7268d132e2ade6c3d6db9e259ab3e8254ae476fcd1d46a4f40eb2
-  data.tar.gz: c1a9bda279afa44c5cb5a41c4ac792a62af317d91985799a14609c7b6d33e5494d322ad14262281b3fead76cc6471bebd7b507e1158dea7f9278196b36ab1726
+  metadata.gz: 2c040e39a740139a320a98fc76e75180558585546a97218d7842cb746e9f0d451665b6abd647595b64ecf0ffb8e67de8c1103649bae80d88f801f228f0cb1980
+  data.tar.gz: a39ea1c4eca448a39e969d52bae28f1fc30c3e50009a96058beb9f519ca73d1dd3ee46adb8ca99a5c9e63edffdb5a858e561869d93b26adc36cc4e7f7f05f611

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-# 1.3.0 (TBD)
+
+# 1.5.0 (December 21st, 2020)
+
+Added Jobs:
+
+* b/collection/zip
+# 1.4.0 (December 17th, 2020)
+
+Additions:
+
+* byte_order_mark option for b/serialize/csv job
+
+Added Jobs:
+
+* b/compress/row_reader
+* b/io/row_reader
+# 1.3.0 (December 11th, 2020)
 
 Additions:
 

data/README.md

@@ -227,6 +227,11 @@ This library only ships with very basic, rudimentary jobs that are meant to just
 * **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.
+* **b/collection/zip** [base_register, register, with_register]: Combines `base_register` and `with_register`s' data to form one single array in `register`.  It will combine each element, positionally in each array to form the final array.  For example:  ['hello', 'bugs'] + ['world', 'bunny'] => [['hello', 'world'], ['bugs', 'bunny']]
+
+#### Compression
+
+* **b/compress/row_reader** [data_key, ignore_blank_path, ignore_blank_data, path_key, register, separator]: Iterates over an array of objects, extracts a path and data in each object, and creates a zip file.
 
 #### De-serialization
 
@@ -240,11 +245,12 @@ By default all jobs will use the `Burner::Disks::Local` disk for its persistence
 
 * **b/io/exist** [disk, 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, disk, 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/row_reader** [data_key, disk, ignore_blank_path, ignore_file_not_found, path_key, register, separator]: Iterates over an array of objects, extracts a filepath from a key in each object, and attempts to load the file's content for each record.  The file's content will be stored at the specified data_key. By default missing paths or files will be treated as hard errors.  If you wish to ignore these then pass in true for ignore_blank_path and/or ignore_file_not_found.
 * **b/io/write** [binary, disk, 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
 
-* **b/serialize/csv** [register]: Take an array of arrays and create a CSV.
+* **b/serialize/csv** [byte_order_mark, register]: Take an array of arrays and create a CSV.  You can optionally pre-pend a byte order mark, see Burner::Modeling::ByteOrderMark for acceptable options.
 * **b/serialize/json** [register]: Convert value to JSON.
 * **b/serialize/yaml** [register]: Convert value to YAML.
 

data/burner.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency('hash_math', '~>1.2')
   s.add_dependency('objectable', '~>1.0')
   s.add_dependency('realize', '~>1.3')
+  s.add_dependency('rubyzip', '~>1.2')
   s.add_dependency('stringento', '~>2.1')
 
   s.add_development_dependency('guard-rspec', '~>4.7')

data/lib/burner.rb

@@ -22,6 +22,7 @@ require 'singleton'
 require 'stringento'
 require 'time'
 require 'yaml'
+require 'zip'
 
 # Common/Shared
 require_relative 'burner/disks'

data/lib/burner/jobs.rb

@@ -34,6 +34,9 @@ module Burner
     register 'b/collection/unpivot',           Library::Collection::Unpivot
     register 'b/collection/values',            Library::Collection::Values
     register 'b/collection/validate',          Library::Collection::Validate
+    register 'b/collection/zip',               Library::Collection::Zip
+
+    register 'b/compress/row_reader',          Library::Compress::RowReader
 
     register 'b/deserialize/csv',              Library::Deserialize::Csv
     register 'b/deserialize/json',             Library::Deserialize::Json
@@ -41,6 +44,7 @@ module Burner
 
     register 'b/io/exist',                     Library::IO::Exist
     register 'b/io/read',                      Library::IO::Read
+    register 'b/io/row_reader',                Library::IO::RowReader
     register 'b/io/write',                     Library::IO::Write
 
     register 'b/serialize/csv',                Library::Serialize::Csv

data/lib/burner/library.rb

@@ -25,6 +25,9 @@ require_relative 'library/collection/transform'
 require_relative 'library/collection/unpivot'
 require_relative 'library/collection/validate'
 require_relative 'library/collection/values'
+require_relative 'library/collection/zip'
+
+require_relative 'library/compress/row_reader'
 
 require_relative 'library/deserialize/csv'
 require_relative 'library/deserialize/json'
@@ -32,6 +35,7 @@ require_relative 'library/deserialize/yaml'
 
 require_relative 'library/io/exist'
 require_relative 'library/io/read'
+require_relative 'library/io/row_reader'
 require_relative 'library/io/write'
 
 require_relative 'library/serialize/csv'

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

@@ -0,0 +1,53 @@
+# 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 can take two arrays and coalesces them by index.  For example:
+      #
+      # input:
+      #   base_register: [ 'hello', 'bugs' ]
+      #   with_register: [ 'world', 'bunny' ]
+      # output:
+      #  register: [ ['hello', 'world'], ['bugs', 'bunny'] ]
+      #
+      # Expected Payload[base_register] input: array of objects.
+      # Expected Payload[with_register] input: array of objects.
+      # Payload[register] output: An array of two-dimensional arrays.
+      class Zip < JobWithRegister
+        attr_reader :base_register, :with_register
+
+        def initialize(
+          name:,
+          with_register:,
+          base_register: DEFAULT_REGISTER,
+          register: DEFAULT_REGISTER
+        )
+          super(name: name, register: register)
+
+          @base_register = base_register.to_s
+          @with_register = with_register.to_s
+
+          freeze
+        end
+
+        def perform(output, payload)
+          base_data = array(payload[base_register])
+          with_data = array(payload[with_register])
+
+          output.detail("Combining register: #{base_register} (#{base_data.length} record(s))")
+          output.detail("With register: #{with_register} (#{with_data.length} record(s))")
+
+          payload[register] = base_data.zip(with_data)
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/compress/row_reader.rb

@@ -0,0 +1,102 @@
+# 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 Compress
+      # Iterates over an array of objects, extracts a path and data in each object, and
+      # creates a zip file.  By default, if a path is blank then an ArgumentError will be raised.
+      # If this is undesirable then you can set ignore_blank_path to true and the record will be
+      # skipped.  You also have the option to supress blank files being added by configuring
+      # ignore_blank_data as true.
+      #
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: compressed binary zip file contents.
+      class RowReader < JobWithRegister
+        Content = Struct.new(:path, :data)
+
+        private_constant :Content
+
+        DEFAULT_DATA_KEY = 'data'
+        DEFAULT_PATH_KEY = 'path'
+
+        attr_reader :data_key,
+                    :ignore_blank_data,
+                    :ignore_blank_path,
+                    :path_key,
+                    :resolver
+
+        def initialize(
+          name:,
+          data_key: DEFAULT_DATA_KEY,
+          ignore_blank_data: false,
+          ignore_blank_path: false,
+          path_key: DEFAULT_PATH_KEY,
+          register: DEFAULT_REGISTER,
+          separator: ''
+        )
+          super(name: name, register: register)
+
+          @data_key          = data_key.to_s
+          @ignore_blank_data = ignore_blank_data || false
+          @ignore_blank_path = ignore_blank_path || false
+          @path_key          = path_key.to_s
+          @resolver          = Objectable.resolver(separator: separator)
+
+          freeze
+        end
+
+        def perform(output, payload)
+          payload[register] = Zip::OutputStream.write_buffer do |zip|
+            array(payload[register]).each.with_index(1) do |record, index|
+              content = extract_path_and_data(record, index, output)
+
+              next unless content
+
+              zip.put_next_entry(content.path)
+              zip.write(content.data)
+            end
+          end.string
+        end
+
+        private
+
+        def extract_path_and_data(record, index, output)
+          path = strip_leading_separator(resolver.get(record, path_key))
+          data = resolver.get(record, data_key)
+
+          return if assert_and_skip_missing_path?(path, index, output)
+          return if skip_missing_data?(data, index, output)
+
+          Content.new(path, data)
+        end
+
+        def strip_leading_separator(path)
+          path.to_s.start_with?(File::SEPARATOR) ? path.to_s[1..-1] : path.to_s
+        end
+
+        def assert_and_skip_missing_path?(path, index, output)
+          if ignore_blank_path && path.to_s.empty?
+            output.detail("Skipping record #{index} because of blank path")
+            true
+          elsif path.to_s.empty?
+            raise ArgumentError, "Record #{index} is missing a path at key: #{path_key}"
+          end
+        end
+
+        def skip_missing_data?(data, index, output)
+          return false unless ignore_blank_data && data.to_s.empty?
+
+          output.detail("Skipping record #{index} because of blank data")
+          true
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/io/row_reader.rb

@@ -0,0 +1,119 @@
+# 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 'open_file_base'
+
+module Burner
+  module Library
+    module IO
+      # Iterates over an array of objects, extracts a filepath from a key in each object,
+      # and attempts to load the file's content for each record.  The file's content will be
+      # stored at the specified data_key. By default missing paths or files will be
+      # treated as hard errors.  If you wish to ignore these then pass in true for
+      # ignore_blank_path and/or ignore_file_not_found.
+      #
+      # Expected Payload[register] input: array of objects.
+      # Payload[register] output: array of objects.
+      class RowReader < JobWithRegister
+        class FileNotFoundError < StandardError; end
+
+        DEFAULT_DATA_KEY = 'data'
+        DEFAULT_PATH_KEY = 'path'
+
+        attr_reader :binary,
+                    :data_key,
+                    :disk,
+                    :ignore_blank_path,
+                    :ignore_file_not_found,
+                    :path_key,
+                    :resolver
+
+        def initialize(
+          name:,
+          binary: false,
+          data_key: DEFAULT_DATA_KEY,
+          disk: {},
+          ignore_blank_path: false,
+          ignore_file_not_found: false,
+          path_key: DEFAULT_PATH_KEY,
+          register: DEFAULT_REGISTER,
+          separator: ''
+        )
+          super(name: name, register: register)
+
+          @binary                = binary || false
+          @data_key              = data_key.to_s
+          @disk                  = Disks.make(disk)
+          @ignore_blank_path     = ignore_blank_path || false
+          @ignore_file_not_found = ignore_file_not_found || false
+          @path_key              = path_key.to_s
+          @resolver              = Objectable.resolver(separator: separator)
+
+          freeze
+        end
+
+        def perform(output, payload)
+          records = array(payload[register])
+
+          output.detail("Reading path_key: #{path_key} for #{payload[register].length} records(s)")
+          output.detail("Storing read data in: #{path_key}")
+
+          payload[register] = records.map.with_index(1) do |object, index|
+            load_data(object, index, output)
+          end
+        end
+
+        private
+
+        def assert_and_skip_missing_path?(path, index, output)
+          missing_path            = path.to_s.empty?
+          blank_path_raises_error = !ignore_blank_path
+
+          if missing_path && blank_path_raises_error
+            output.detail("Record #{index} is missing a path, raising error")
+
+            raise ArgumentError, "Record #{index} is missing a path"
+          elsif missing_path
+            output.detail("Record #{index} is missing a path")
+
+            true
+          end
+        end
+
+        def assert_and_skip_file_not_found?(path, index, output)
+          does_not_exist              = !disk.exist?(path)
+          file_not_found_raises_error = !ignore_file_not_found
+
+          if file_not_found_raises_error && does_not_exist
+            output.detail("Record #{index} path: '#{path}' does not exist, raising error")
+
+            raise FileNotFoundError, "#{path} does not exist"
+          elsif does_not_exist
+            output.detail("Record #{index} path: '#{path}' does not exist, skipping")
+
+            true
+          end
+        end
+
+        def load_data(object, index, output)
+          path = resolver.get(object, path_key)
+
+          return object if assert_and_skip_missing_path?(path, index, output)
+          return object if assert_and_skip_file_not_found?(path, index, output)
+
+          data = disk.read(path, binary: binary)
+
+          resolver.set(object, data_key, data)
+
+          object
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/serialize/csv.rb

@@ -10,17 +10,30 @@
 module Burner
   module Library
     module Serialize
-      # Take an array of arrays and create a CSV.
+      # Take an array of arrays and create a CSV.  You can optionally pre-pend a byte order mark,
+      # see Burner::Modeling::ByteOrderMark for acceptable options.
       #
       # Expected Payload[register] input: array of arrays.
       # Payload[register] output: a serialized CSV string.
       class Csv < JobWithRegister
+        attr_reader :byte_order_mark
+
+        def initialize(name:, byte_order_mark: nil, register: DEFAULT_REGISTER)
+          super(name: name, register: register)
+
+          @byte_order_mark = Modeling::ByteOrderMark.resolve(byte_order_mark)
+
+          freeze
+        end
+
         def perform(_output, payload)
-          payload[register] = CSV.generate(options) do |csv|
+          serialized_rows = CSV.generate(options) do |csv|
             array(payload[register]).each do |row|
               csv << row
             end
           end
+
+          payload[register] = "#{byte_order_mark}#{serialized_rows}"
         end
 
         private

data/lib/burner/modeling.rb

@@ -9,6 +9,7 @@
 
 require_relative 'modeling/attribute'
 require_relative 'modeling/attribute_renderer'
+require_relative 'modeling/byte_order_mark'
 require_relative 'modeling/key_index_mapping'
 require_relative 'modeling/key_mapping'
 require_relative 'modeling/validations'

data/lib/burner/modeling/byte_order_mark.rb

@@ -0,0 +1,27 @@
+# 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
+    # Define all acceptable byte order mark values.
+    module ByteOrderMark
+      UTF_8    = "\xEF\xBB\xBF"
+      UTF_16BE = "\xFE\xFF"
+      UTF_16LE = "\xFF\xFE"
+      UTF_32BE = "\x00\x00\xFE\xFF"
+      UTF_32LE = "\xFE\xFF\x00\x00"
+
+      class << self
+        def resolve(value)
+          value ? const_get(value.to_s.upcase.to_sym) : nil
+        end
+      end
+    end
+  end
+end

data/lib/burner/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Burner
-  VERSION = '1.3.0-alpha'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.3.0.pre.alpha
+  version: 1.5.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: stringento
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +252,8 @@ files:
 - lib/burner/library/collection/unpivot.rb
 - lib/burner/library/collection/validate.rb
 - lib/burner/library/collection/values.rb
+- lib/burner/library/collection/zip.rb
+- lib/burner/library/compress/row_reader.rb
 - lib/burner/library/deserialize/csv.rb
 - lib/burner/library/deserialize/json.rb
 - lib/burner/library/deserialize/yaml.rb
@@ -245,6 +261,7 @@ files:
 - lib/burner/library/io/exist.rb
 - lib/burner/library/io/open_file_base.rb
 - lib/burner/library/io/read.rb
+- lib/burner/library/io/row_reader.rb
 - lib/burner/library/io/write.rb
 - lib/burner/library/nothing.rb
 - lib/burner/library/serialize/csv.rb
@@ -256,6 +273,7 @@ files:
 - lib/burner/modeling.rb
 - lib/burner/modeling/attribute.rb
 - lib/burner/modeling/attribute_renderer.rb
+- lib/burner/modeling/byte_order_mark.rb
 - lib/burner/modeling/key_index_mapping.rb
 - lib/burner/modeling/key_mapping.rb
 - lib/burner/modeling/validations.rb
@@ -292,9 +310,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: