burner 1.0.0.pre.alpha.3 → 1.0.0.pre.alpha.8

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

@@ -0,0 +1,89 @@
+# 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
+      # Process each object in an array and see if its attribute values match a given set
+      # of validations.  The main register will include the valid objects and the invalid_register
+      # will contain the invalid objects.
+      #
+      # Expected Payload#value input: array of objects.
+      # Payload#value output: An array of objects.
+      class Validate < JobWithRegister
+        DEFAULT_INVALID_REGISTER = 'invalid'
+        DEFAULT_JOIN_CHAR        = ', '
+        DEFAULT_MESSAGE_KEY      = 'errors'
+
+        attr_reader :invalid_register,
+                    :join_char,
+                    :message_key,
+                    :resolver,
+                    :validations
+
+        def initialize(
+          name:,
+          invalid_register: DEFAULT_INVALID_REGISTER,
+          join_char: DEFAULT_JOIN_CHAR,
+          message_key: DEFAULT_MESSAGE_KEY,
+          register: '',
+          separator: '',
+          validations: []
+        )
+          super(name: name, register: register)
+
+          @invalid_register = invalid_register.to_s
+          @join_char        = join_char.to_s
+          @message_key      = message_key.to_s
+          @resolver         = Objectable.resolver(separator: separator)
+          @validations      = Modeling::Validations.array(validations)
+
+          freeze
+        end
+
+        def perform(output, payload)
+          valid   = []
+          invalid = []
+
+          (payload[register] || []).each do |object|
+            errors = validate(object)
+
+            if errors.empty?
+              valid << object
+            else
+              invalid << make_in_error(object, errors)
+            end
+          end
+
+          output.detail("Valid count: #{valid.length}")
+          output.detail("Invalid count: #{invalid.length}")
+
+          payload[register]         = valid
+          payload[invalid_register] = invalid
+
+          nil
+        end
+
+        private
+
+        def validate(object)
+          validations.each_with_object([]) do |validation, memo|
+            next if validation.valid?(object, resolver)
+
+            memo << validation.message
+          end
+        end
+
+        def make_in_error(object, errors)
+          resolver.set(object, message_key, errors.join(join_char))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# 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 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.
+      #
+      # Expected Payload#value input: array of objects.
+      # Payload#value output: An array of arrays.
+      class Values < JobWithRegister
+        attr_reader :include_keys
+
+        def initialize(name:, include_keys: false, register: '')
+          super(name: name, register: register)
+
+          @include_keys = include_keys || false
+
+          freeze
+        end
+
+        def perform(_output, payload)
+          payload[register] = array(payload[register])
+          keys = include_keys ? [keys(payload[register].first)] : []
+          values = payload[register].map { |object| values(object) }
+          payload[register] = keys + values
+        end
+
+        private
+
+        def keys(object)
+          object.respond_to?(:keys) ? object.keys : []
+        end
+
+        def values(object)
+          object.respond_to?(:values) ? object.values : []
+        end
+      end
+    end
+  end
+end

data/lib/burner/library/deserialize/csv.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 Library
+    module Deserialize
+      # Take a CSV string and de-serialize into object(s).
+      #
+      # Expected Payload#value input: nothing.
+      # Payload#value output: an array of arrays.  Each inner array represents one data row.
+      class Csv < JobWithRegister
+        # This currently only supports returning an array of arrays, including the header row.
+        # In the future this could be extended to offer more customizable options, such as
+        # making it return an array of hashes with the columns mapped, etc.)
+        def perform(_output, payload)
+          payload[register] = CSV.new(payload[register], headers: false).to_a
+        end
+      end
+    end
+  end
+end

data/lib/burner/{jobs → library}/deserialize/json.rb

@@ -8,14 +8,15 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module Deserialize
       # Take a JSON string and deserialize into object(s).
-      class Json < Job
-        def perform(_output, payload, _params)
-          payload.value = JSON.parse(payload.value)
-
-          nil
+      #
+      # Expected Payload#value input: string of JSON data.
+      # Payload#value output: anything, as specified by the JSON de-serializer.
+      class Json < JobWithRegister
+        def perform(_output, payload)
+          payload[register] = JSON.parse(payload[register])
         end
       end
     end

data/lib/burner/{jobs → library}/deserialize/yaml.rb

@@ -8,14 +8,20 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module Deserialize
-      # Take a YAML string and deserialize into object(s).
-      class Yaml < Job
+      # Take a YAML string and deserialize into object(s).  It uses YAML#safe_load by default,
+      # which ensures only a limited number of Ruby object constants can be hydrated by the
+      # YAML.  If you wish to ease this restriction, for example if you have custom serialization
+      # for custom classes, then you can pass in safe: false.
+      #
+      # Expected Payload#value input: string of YAML data.
+      # Payload#value output: anything as specified by the YAML de-serializer.
+      class Yaml < JobWithRegister
         attr_reader :safe
 
-        def initialize(name:, safe: true)
-          super(name: name)
+        def initialize(name:, register: '', safe: true)
+          super(name: name, register: register)
 
           @safe = safe
 
@@ -27,12 +33,12 @@ module Burner
         # in a sandbox.  By default, though, we will try and drive them towards using it
         # in the safer alternative.
         # rubocop:disable Security/YAMLLoad
-        def perform(output, payload, _params)
+        def perform(output, payload)
           output.detail('Warning: loading YAML not using safe_load.') unless safe
 
-          payload.value = safe ? YAML.safe_load(payload.value) : YAML.load(payload.value)
+          value = payload[register]
 
-          nil
+          payload[register] = safe ? YAML.safe_load(value) : YAML.load(value)
         end
         # rubocop:enable Security/YAMLLoad
       end

data/lib/burner/{jobs → library}/dummy.rb

@@ -8,12 +8,12 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     # Do nothing.
+    #
+    # Note: this does not use Payload#value.
     class Dummy < Job
-      def perform(_output, _payload, _params)
-        nil
-      end
+      def perform(_output, _payload); end
     end
   end
 end

data/lib/burner/{jobs → library}/echo.rb

@@ -8,8 +8,10 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     # Output a simple message to the output.
+    #
+    # Note: this does not use Payload#value.
     class Echo < Job
       attr_reader :message
 
@@ -21,12 +23,10 @@ module Burner
         freeze
       end
 
-      def perform(output, _payload, params)
-        compiled_message = eval_string_template(message, params)
+      def perform(output, payload)
+        compiled_message = job_string_template(message, output, payload)
 
         output.detail(compiled_message)
-
-        nil
       end
     end
   end

data/lib/burner/{jobs → library}/io/base.rb

@@ -8,25 +8,19 @@
 #
 
 module Burner
-  class Jobs
+  module Library
     module IO
       # Common configuration/code for all IO Job subclasses.
-      class Base < Job
+      class Base < JobWithRegister
         attr_reader :path
 
-        def initialize(name:, path:)
-          super(name: name)
+        def initialize(name:, path:, register: '')
+          super(name: name, register: register)
 
           raise ArgumentError, 'path is required' if path.to_s.empty?
 
           @path = path.to_s
         end
-
-        private
-
-        def compile_path(params)
-          eval_string_template(path, params)
-        end
       end
     end
   end

data/lib/burner/{jobs → library}/io/exist.rb

@@ -10,32 +10,34 @@
 require_relative 'base'
 
 module Burner
-  class Jobs
+  module Library
     module IO
       # Check to see if a file exists.  If short_circuit is set to true and the file
       # does not exist then the job will return false and short circuit the pipeline.
-      class Exist < Base
-        attr_reader :short_circuit
+      #
+      # Note: this does not use Payload#value.
+      class Exist < Job
+        attr_reader :path, :short_circuit
 
         def initialize(name:, path:, short_circuit: false)
-          super(name: name, path: path)
+          super(name: name)
 
-          @short_circuit = short_circuit || false
+          raise ArgumentError, 'path is required' if path.to_s.empty?
 
-          freeze
+          @path          = path.to_s
+          @short_circuit = short_circuit || false
         end
 
-        def perform(output, _payload, params)
-          compiled_path = compile_path(params)
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           exists = File.exist?(compiled_path)
           verb   = exists ? 'does' : 'does not'
 
           output.detail("The path: #{compiled_path} #{verb} exist")
 
-          # if anything but false is returned then the pipeline will not short circuit.  So
-          # we need to make sure we explicitly return false.
-          short_circuit && !exists ? false : nil
+          # if anything but false is returned then the pipeline will not short circuit.
+          payload.halt_pipeline if short_circuit && !exists
         end
       end
     end

data/lib/burner/{jobs → library}/io/read.rb

@@ -10,28 +10,29 @@
 require_relative 'base'
 
 module Burner
-  class Jobs
+  module Library
     module IO
       # Read value from disk.
+      #
+      # Expected Payload#value input: nothing.
+      # Payload#value output: contents of the specified file.
       class Read < Base
         attr_reader :binary
 
-        def initialize(name:, path:, binary: false)
-          super(name: name, path: path)
+        def initialize(name:, path:, binary: false, register: '')
+          super(name: name, path: path, register: register)
 
           @binary = binary || false
 
           freeze
         end
 
-        def perform(output, payload, params)
-          compiled_path = compile_path(params)
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           output.detail("Reading: #{compiled_path}")
 
-          payload.value = File.open(compiled_path, mode, &:read)
-
-          nil
+          payload[register] = File.open(compiled_path, mode, &:read)
         end
 
         private

data/lib/burner/{jobs → library}/io/write.rb

@@ -10,38 +10,41 @@
 require_relative 'base'
 
 module Burner
-  class Jobs
+  module Library
     module IO
       # Write value to disk.
+      #
+      # Expected Payload#value input: anything.
+      # Payload#value output: whatever was passed in.
       class Write < Base
         attr_reader :binary
 
-        def initialize(name:, path:, binary: false)
-          super(name: name, path: path)
+        def initialize(name:, path:, binary: false, register: '')
+          super(name: name, path: path, register: register)
 
           @binary = binary || false
 
           freeze
         end
 
-        def perform(output, payload, params)
-          compiled_path = compile_path(params)
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           ensure_directory_exists(output, compiled_path)
 
           output.detail("Writing: #{compiled_path}")
 
           time_in_seconds = Benchmark.measure do
-            File.open(compiled_path, mode) { |io| io.write(payload.value) }
+            File.open(compiled_path, mode) { |io| io.write(payload[register]) }
           end.real
 
-          payload.add_written_file(
+          side_effect = SideEffects::WrittenFile.new(
             logical_filename: compiled_path,
             physical_filename: compiled_path,
             time_in_seconds: time_in_seconds
           )
 
-          nil
+          payload.add_side_effect(side_effect)
         end
 
         private

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

@@ -0,0 +1,37 @@
+# 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 Serialize
+      # Take an array of arrays and create a CSV.
+      #
+      # Expected Payload#value input: array of arrays.
+      # Payload#value output: a serialized CSV string.
+      class Csv < JobWithRegister
+        def perform(_output, payload)
+          payload[register] = CSV.generate(options) do |csv|
+            array(payload[register]).each do |row|
+              csv << row
+            end
+          end
+        end
+
+        private
+
+        def options
+          {
+            headers: false,
+            write_headers: false
+          }
+        end
+      end
+    end
+  end
+end