burner 1.0.0.pre.alpha → 1.0.0.pre.alpha.5

data/lib/burner/jobs/deserialize/json.rb

@@ -12,7 +12,7 @@ module Burner
     module Deserialize
       # Take a JSON string and deserialize into object(s).
       class Json < Job
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = JSON.parse(payload.value)
 
           nil

data/lib/burner/jobs/deserialize/yaml.rb

@@ -27,7 +27,7 @@ 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)

data/lib/burner/jobs/dummy.rb

@@ -11,7 +11,7 @@ module Burner
   class Jobs
     # Do nothing.
     class Dummy < Job
-      def perform(_output, _payload, _params)
+      def perform(_output, _payload)
         nil
       end
     end

data/lib/burner/jobs/echo.rb

@@ -21,8 +21,8 @@ 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)
 

data/lib/burner/jobs/io/base.rb

@@ -12,27 +12,14 @@ module Burner
     module IO
       # Common configuration/code for all IO Job subclasses.
       class Base < Job
-        attr_reader :binary, :path
+        attr_reader :path
 
-        def initialize(name:, path:, binary: false)
+        def initialize(name:, path:)
           super(name: name)
 
           raise ArgumentError, 'path is required' if path.to_s.empty?
 
-          @path   = path.to_s
-          @binary = binary || false
-
-          freeze
-        end
-
-        private
-
-        def compile_path(params)
-          eval_string_template(path, params)
-        end
-
-        def mode
-          binary ? 'wb' : 'w'
+          @path = path.to_s
         end
       end
     end

data/lib/burner/jobs/io/exist.rb

@@ -0,0 +1,43 @@
+# 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 'base'
+
+module Burner
+  class Jobs
+    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
+
+        def initialize(name:, path:, short_circuit: false)
+          super(name: name, path: path)
+
+          @short_circuit = short_circuit || false
+
+          freeze
+        end
+
+        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
+        end
+      end
+    end
+  end
+end

data/lib/burner/jobs/io/read.rb

@@ -14,8 +14,18 @@ module Burner
     module IO
       # Read value from disk.
       class Read < Base
-        def perform(output, payload, params)
-          compiled_path = compile_path(params)
+        attr_reader :binary
+
+        def initialize(name:, path:, binary: false)
+          super(name: name, path: path)
+
+          @binary = binary || false
+
+          freeze
+        end
+
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           output.detail("Reading: #{compiled_path}")
 

data/lib/burner/jobs/io/write.rb

@@ -14,14 +14,32 @@ module Burner
     module IO
       # Write value to disk.
       class Write < Base
-        def perform(output, payload, params)
-          compiled_path = compile_path(params)
+        attr_reader :binary
+
+        def initialize(name:, path:, binary: false)
+          super(name: name, path: path)
+
+          @binary = binary || false
+
+          freeze
+        end
+
+        def perform(output, payload)
+          compiled_path = job_string_template(path, output, payload)
 
           ensure_directory_exists(output, compiled_path)
 
           output.detail("Writing: #{compiled_path}")
 
-          File.open(compiled_path, mode) { |io| io.write(payload.value) }
+          time_in_seconds = Benchmark.measure do
+            File.open(compiled_path, mode) { |io| io.write(payload.value) }
+          end.real
+
+          payload.add_written_file(
+            logical_filename: compiled_path,
+            physical_filename: compiled_path,
+            time_in_seconds: time_in_seconds
+          )
 
           nil
         end
@@ -39,6 +57,10 @@ module Burner
 
           nil
         end
+
+        def mode
+          binary ? 'wb' : 'w'
+        end
       end
     end
   end

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

@@ -0,0 +1,38 @@
+# 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
+  class Jobs
+    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 < Job
+        def perform(_output, payload)
+          payload.value = CSV.generate(options) do |csv|
+            (payload.value || []).each do |row|
+              csv << row
+            end
+          end
+
+          nil
+        end
+
+        private
+
+        def options
+          {
+            headers: false,
+            write_headers: false
+          }
+        end
+      end
+    end
+  end
+end

data/lib/burner/jobs/serialize/json.rb

@@ -12,7 +12,7 @@ module Burner
     module Serialize
       # Treat value like a Ruby object and serialize it using JSON.
       class Json < Job
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = payload.value.to_json
 
           nil

data/lib/burner/jobs/serialize/yaml.rb

@@ -12,7 +12,7 @@ module Burner
     module Serialize
       # Treat value like a Ruby object and serialize it using YAML.
       class Yaml < Job
-        def perform(_output, payload, _params)
+        def perform(_output, payload)
           payload.value = payload.value.to_yaml
 
           nil

data/lib/burner/jobs/set.rb

@@ -21,7 +21,7 @@ module Burner
         freeze
       end
 
-      def perform(_output, payload, _params)
+      def perform(_output, payload)
         payload.value = value
 
         nil

data/lib/burner/jobs/sleep.rb

@@ -21,7 +21,7 @@ module Burner
         freeze
       end
 
-      def perform(output, _payload, _params)
+      def perform(output, _payload)
         output.detail("Going to sleep for #{seconds} second(s)")
 
         Kernel.sleep(seconds)

data/lib/burner/modeling.rb

@@ -0,0 +1,10 @@
+# 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 'modeling/key_index_mapping'

data/lib/burner/modeling/key_index_mapping.rb

@@ -0,0 +1,29 @@
+# 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
+    # Generic relationship between a numeric index and a key.
+    class KeyIndexMapping
+      acts_as_hashable
+
+      attr_reader :index, :key
+
+      def initialize(index:, key:)
+        raise ArgumentError, 'index is required' if index.to_s.empty?
+        raise ArgumentError, 'key is required'   if key.to_s.empty?
+
+        @index = index.to_i
+        @key   = key.to_s
+
+        freeze
+      end
+    end
+  end
+end

data/lib/burner/payload.rb

@@ -7,6 +7,8 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'written_file'
+
 module Burner
   # The input for all Job#perform methods.  The main notion of this object is its "value"
   # attribute.  This is dynamic and weak on purpose and is subject to whatever the Job#perform
@@ -16,11 +18,24 @@ module Burner
   class Payload
     attr_accessor :value
 
-    attr_reader :context
+    attr_reader :params,
+                :time,
+                :written_files
+
+    def initialize(
+      params: {},
+      time: Time.now.utc,
+      value: nil,
+      written_files: []
+    )
+      @params        = params || {}
+      @time          = time || Time.now.utc
+      @value         = value
+      @written_files = written_files || []
+    end
 
-    def initialize(context: {}, value: nil)
-      @context = context || {}
-      @value   = value
+    def add_written_file(written_file)
+      tap { written_files << WrittenFile.make(written_file) }
     end
   end
 end

data/lib/burner/pipeline.rb

@@ -35,14 +35,21 @@ module Burner
     end
 
     # The main entry-point for kicking off a pipeline.
-    def execute(params: {}, output: Output.new, payload: Payload.new)
+    def execute(output: Output.new, payload: Payload.new)
       output.write("Pipeline started with #{steps.length} step(s)")
 
-      output_params(params, output)
+      output_params(payload.params, output)
       output.ruler
 
       time_in_seconds = Benchmark.measure do
-        steps.each { |step| step.perform(output, payload, params) }
+        steps.each do |step|
+          return_value = step.perform(output, payload)
+
+          if return_value.is_a?(FalseClass)
+            output.detail('Job returned false, ending pipeline.')
+            break
+          end
+        end
       end.real.round(3)
 
       output.ruler

data/lib/burner/step.rb

@@ -28,16 +28,18 @@ module Burner
       freeze
     end
 
-    def perform(output, payload, params)
+    def perform(output, payload)
+      return_value = nil
+
       output.title("#{job.class.name}#{SEPARATOR}#{job.name}")
 
       time_in_seconds = Benchmark.measure do
-        job.perform(output, payload, params)
+        return_value = job.perform(output, payload)
       end.real.round(3)
 
       output.complete(time_in_seconds)
 
-      nil
+      return_value
     end
   end
 end

data/lib/burner/string_template.rb

@@ -9,10 +9,11 @@
 
 module Burner
   # Can take in a string and an object and use the object for formatting string interpolations
-  # using tokens of form: {attribute_name}.  It can also understand dot-notation for nested
-  # objects using the Objectable library.  Another benefit of using Objectable for resolution
-  # is that it can understand almost any type of object: Hash, Struct, OpenStruct, custom
-  # objects, etc.  For more information see underlying libraries:
+  # using tokens of form: {attribute_name}.  This templating class does not understand nested
+  # structures, so input should be a flat object/hash in the form of key-value pairs.  A benefit of
+  # using Objectable for resolution is that it can understand almost any type of
+  # object: Hash, Struct, OpenStruct, custom objects, etc.
+  # For more information see underlying libraries:
   #   * Stringento: https://github.com/bluemarblepayroll/stringento
   #   * Objectable: https://github.com/bluemarblepayroll/objectable
   class StringTemplate
@@ -21,7 +22,7 @@ module Burner
     attr_reader :resolver
 
     def initialize
-      @resolver = Objectable.resolver
+      @resolver = Objectable.resolver(separator: '')
 
       freeze
     end

data/lib/burner/version.rb

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

data/lib/burner/written_file.rb

@@ -0,0 +1,28 @@
+# 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
+  # Describes a file that was generated by a Job.  If a Job emits a file, it should also add the
+  # file details to the Payload#written_files array using the Payload#add_written_file method.
+  class WrittenFile
+    acts_as_hashable
+
+    attr_reader :logical_filename,
+                :physical_filename,
+                :time_in_seconds
+
+    def initialize(logical_filename:, physical_filename:, time_in_seconds:)
+      @logical_filename  = logical_filename.to_s
+      @physical_filename = physical_filename.to_s
+      @time_in_seconds   = time_in_seconds.to_f
+
+      freeze
+    end
+  end
+end