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

data/lib/burner/pipeline.rb

@@ -19,11 +19,16 @@ module Burner
     acts_as_hashable
 
     class JobNotFoundError < StandardError; end
+    class DuplicateJobNameError < StandardError; end
 
     attr_reader :steps
 
     def initialize(jobs: [], steps: [])
-      jobs_by_name = Jobs.array(jobs).map { |job| [job.name, job] }.to_h
+      jobs = Jobs.array(jobs)
+
+      assert_unique_job_names(jobs)
+
+      jobs_by_name = jobs.map { |job| [job.name, job] }.to_h
 
       @steps = Array(steps).map do |step_name|
         job = jobs_by_name[step_name.to_s]
@@ -60,6 +65,20 @@ module Burner
 
     private
 
+    def assert_unique_job_names(jobs)
+      unique_job_names = Set.new
+
+      jobs.each do |job|
+        if unique_job_names.include?(job.name)
+          raise DuplicateJobNameError, "job with name: #{job.name} already declared"
+        end
+
+        unique_job_names << job.name
+      end
+
+      nil
+    end
+
     def output_params(params, output)
       if params.keys.any?
         output.write('Parameters:')

data/lib/burner/side_effects.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 'side_effects/written_file'

data/lib/burner/side_effects/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
+  module SideEffects
+    # 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#side_effects array using the Payload#add_side_effect method.
+    class WrittenFile
+      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
+end

data/lib/burner/util.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 'util/arrayable'

data/lib/burner/util/arrayable.rb

@@ -0,0 +1,30 @@
+# 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 Util
+    # Provide helper methods for dealing with Arrays.
+    module Arrayable
+      # Since Ruby's Kernel#Array will properly call #to_a for scalar Hash objects, this could
+      # return something funky in the context of this library.  In this library, Hash instances
+      # are typically viewed as an atomic key-value-based "object".  This library likes to deal
+      # with object-like things, treating Hash, OpenStruct, Struct, or Object subclasses as
+      # basically the same thing.  In this vein, this library leverages Objectable to help
+      # unify access data from objects.  See the Objectable library for more information:
+      # https://github.com/bluemarblepayroll/objectable
+      def array(value)
+        if value.is_a?(Hash)
+          [value]
+        else
+          Array(value)
+        end
+      end
+    end
+  end
+end

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.5
+  version: 1.0.0.pre.alpha.6
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -221,38 +221,42 @@ files:
 - lib/burner/cli.rb
 - lib/burner/job.rb
 - lib/burner/jobs.rb
-- lib/burner/jobs/collection/arrays_to_objects.rb
-- lib/burner/jobs/collection/graph.rb
-- lib/burner/jobs/collection/objects_to_arrays.rb
-- lib/burner/jobs/collection/shift.rb
-- lib/burner/jobs/collection/transform.rb
-- lib/burner/jobs/collection/transform/attribute.rb
-- lib/burner/jobs/collection/transform/attribute_renderer.rb
-- lib/burner/jobs/collection/unpivot.rb
-- lib/burner/jobs/collection/values.rb
-- lib/burner/jobs/deserialize/csv.rb
-- lib/burner/jobs/deserialize/json.rb
-- lib/burner/jobs/deserialize/yaml.rb
-- lib/burner/jobs/dummy.rb
-- lib/burner/jobs/echo.rb
-- lib/burner/jobs/io/base.rb
-- lib/burner/jobs/io/exist.rb
-- lib/burner/jobs/io/read.rb
-- lib/burner/jobs/io/write.rb
-- lib/burner/jobs/serialize/csv.rb
-- lib/burner/jobs/serialize/json.rb
-- lib/burner/jobs/serialize/yaml.rb
-- lib/burner/jobs/set.rb
-- lib/burner/jobs/sleep.rb
+- lib/burner/library.rb
+- lib/burner/library/collection/arrays_to_objects.rb
+- lib/burner/library/collection/graph.rb
+- lib/burner/library/collection/objects_to_arrays.rb
+- lib/burner/library/collection/shift.rb
+- lib/burner/library/collection/transform.rb
+- lib/burner/library/collection/unpivot.rb
+- lib/burner/library/collection/values.rb
+- lib/burner/library/deserialize/csv.rb
+- lib/burner/library/deserialize/json.rb
+- lib/burner/library/deserialize/yaml.rb
+- lib/burner/library/dummy.rb
+- lib/burner/library/echo.rb
+- lib/burner/library/io/base.rb
+- lib/burner/library/io/exist.rb
+- lib/burner/library/io/read.rb
+- lib/burner/library/io/write.rb
+- lib/burner/library/serialize/csv.rb
+- lib/burner/library/serialize/json.rb
+- lib/burner/library/serialize/yaml.rb
+- lib/burner/library/set_value.rb
+- lib/burner/library/sleep.rb
 - lib/burner/modeling.rb
+- lib/burner/modeling/attribute.rb
+- lib/burner/modeling/attribute_renderer.rb
 - lib/burner/modeling/key_index_mapping.rb
 - lib/burner/output.rb
 - lib/burner/payload.rb
 - lib/burner/pipeline.rb
+- lib/burner/side_effects.rb
+- lib/burner/side_effects/written_file.rb
 - lib/burner/step.rb
 - lib/burner/string_template.rb
+- lib/burner/util.rb
+- lib/burner/util/arrayable.rb
 - lib/burner/version.rb
-- lib/burner/written_file.rb
 homepage: https://github.com/bluemarblepayroll/burner
 licenses:
 - MIT

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

@@ -1,43 +0,0 @@
-# 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 Collection
-      # Convert an array of arrays to an array of objects.
-      # Expected Payload#value input: array of arrays.
-      # Payload#value output: An array of hashes.
-      class ArraysToObjects < Job
-        attr_reader :mappings
-
-        def initialize(name:, mappings: [])
-          super(name: name)
-
-          @mappings = Modeling::KeyIndexMapping.array(mappings)
-
-          freeze
-        end
-
-        def perform(_output, payload)
-          payload.value = (payload.value || []).map { |array| index_to_key_map(array) }
-
-          nil
-        end
-
-        private
-
-        def index_to_key_map(array)
-          mappings.each_with_object({}) do |mapping, memo|
-            memo[mapping.key] = array[mapping.index]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/burner/jobs/collection/transform/attribute.rb

@@ -1,33 +0,0 @@
-# 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 Collection
-      class Transform < Job
-        # Defines a top-level key and the associated transformers for deriving the final value
-        # to set the key to.
-        class Attribute
-          acts_as_hashable
-
-          attr_reader :key, :transformers
-
-          def initialize(key:, transformers: [])
-            raise ArgumentError, 'key is required' if key.to_s.empty?
-
-            @key          = key.to_s
-            @transformers = Realize::Transformers.array(transformers)
-
-            freeze
-          end
-        end
-      end
-    end
-  end
-end

data/lib/burner/jobs/collection/transform/attribute_renderer.rb

@@ -1,36 +0,0 @@
-# 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 Collection
-      class Transform < Job
-        # Composed of an Attribute instance and a Pipeline instance.  It knows how to
-        # render/transform an Attribute.  Since this library is data-first, these intermediary
-        # objects are necessary for non-data-centric modeling.
-        class AttributeRenderer
-          extend Forwardable
-
-          attr_reader :attribute, :pipeline
-
-          def_delegators :attribute, :key
-
-          def_delegators :pipeline, :transform
-
-          def initialize(attribute, resolver)
-            @attribute = attribute
-            @pipeline  = Realize::Pipeline.new(attribute.transformers, resolver: resolver)
-
-            freeze
-          end
-        end
-      end
-    end
-  end
-end

data/lib/burner/written_file.rb

@@ -1,28 +0,0 @@
-# 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