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

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/step.rb

@@ -28,20 +28,14 @@ module Burner
       freeze
     end
 
-    def perform(output, payload, params)
-      return_value = nil
-
+    def perform(output, payload)
       output.title("#{job.class.name}#{SEPARATOR}#{job.name}")
 
       time_in_seconds = Benchmark.measure do
-        job_params = (params || {}).merge(__id: output.id, __value: payload.value)
-
-        return_value = job.perform(output, payload, job_params)
+        job.perform(output, payload)
       end.real.round(3)
 
       output.complete(time_in_seconds)
-
-      return_value
     end
   end
 end

data/lib/burner/util.rb

@@ -0,0 +1,11 @@
+# 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'
+require_relative 'util/string_template'

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/util/string_template.rb

@@ -0,0 +1,42 @@
+# 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
+    # Can take in a string and an object and use the object for formatting string interpolations
+    # 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
+      include Singleton
+
+      attr_reader :resolver
+
+      def initialize
+        @resolver = Objectable.resolver(separator: '')
+
+        freeze
+      end
+
+      # For general consumption
+      def evaluate(expression, input)
+        Stringento.evaluate(expression, input, resolver: self)
+      end
+
+      # For Stringento consumption
+      def resolve(value, input)
+        resolver.get(input, value)
+      end
+    end
+  end
+end

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.3
+  version: 1.0.0.pre.alpha.8
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: hashematics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hash_math
+  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: objectable
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: realize
+  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
@@ -150,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:
@@ -178,26 +221,49 @@ files:
 - lib/burner.rb
 - lib/burner/cli.rb
 - lib/burner/job.rb
+- lib/burner/job_with_register.rb
 - lib/burner/jobs.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/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/validate.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/modeling/validations.rb
+- lib/burner/modeling/validations/base.rb
+- lib/burner/modeling/validations/blank.rb
+- lib/burner/modeling/validations/present.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/util/string_template.rb
 - lib/burner/version.rb
-- lib/burner/written_file.rb
 homepage: https://github.com/bluemarblepayroll/burner
 licenses:
 - MIT

data/lib/burner/string_template.rb

@@ -1,40 +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
-  # Can take in a string and an object and use the object for formatting string interpolations
-  # 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
-    include Singleton
-
-    attr_reader :resolver
-
-    def initialize
-      @resolver = Objectable.resolver(separator: '')
-
-      freeze
-    end
-
-    # For general consumption
-    def evaluate(expression, input)
-      Stringento.evaluate(expression, input, resolver: self)
-    end
-
-    # For Stringento consumption
-    def resolve(value, input)
-      resolver.get(input, value)
-    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