burner 1.0.0.pre.alpha.13 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d682634e7c0c8b850b98d80a33e4e44012a3f7ae058b72e3c828830d7e177a0a
-  data.tar.gz: afc1daecbec70a6ec88f19ab11ea92f93f28a7dd8bc8ea4821cb6a222db3f824
+  metadata.gz: d3d251463ade2de965d0dd1e0d635967571d3d1d4cab46a7d1271ab057d1c2e3
+  data.tar.gz: 2eac66d3f745888be07cf5d2d66f6e8429c61b0255ad0916f7c6f8c792194dcd
 SHA512:
-  metadata.gz: d75499b61c0b30b4882fb8cf10c74ea2cd0dfa8562824bf3a0a61c3311b78808eaeb5e0dfc1db1faa81400a23a998e4dd6b37ba35ad170ec2945c8708804d7c7
-  data.tar.gz: 42e5b5d6fead52793eefa7ef6f41423254e870e0fd319d7aad8b011c88c8048bbaec78cac79d0acdeed98f446777014b46e419ed86e39ea0f7fd9f888c786a4d
+  metadata.gz: c57dabbc95d1b58b5f0fe15429f36682d0dec0771951bb01b6e8c6345ddd9e95b5805ad57f0e0166e8e4e87d0296885915c022895818e46c3389049207e0e719
+  data.tar.gz: f23ecf1374570ad2f5cc6dfb70c88c895e4d45e0c2eb7453878038dc507d1a808ca3894c50a320b4a259df09ad7f1368a4b8c7bd790624b27baac487df1b48cf

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0 (November 5th, 2020)
+
+Initial version publication.
+
 # 0.0.1
 
 Shell

data/README.md

@@ -278,6 +278,8 @@ Notes:
 
 ### Adding & Registering Jobs
 
+Note: Jobs have to be registered with a type in the Burner::Jobs factory.  All jobs that ship with this library are prefixed with `b/` in their type in order to provide a namespace for 'burner-specific' jobs vs. externally provided jobs.
+
 Where this library shines is when additional jobs are plugged in.  Burner uses its `Burner::Jobs` class as its class-level registry built with [acts_as_hashable](https://github.com/bluemarblepayroll/acts_as_hashable)'s acts_as_hashable_factory directive.
 
 Let's say we would like to register a job to parse a CSV:

data/burner.gemspec

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

data/lib/burner.rb

@@ -29,3 +29,9 @@ require_relative 'burner/util'
 
 # Main Entrypoint(s)
 require_relative 'burner/cli'
+
+# Top-level namespace
+module Burner
+  # All jobs that need to reference the main register should use this constant.
+  DEFAULT_REGISTER = 'default'
+end

data/lib/burner/job_with_register.rb

@@ -15,7 +15,7 @@ module Burner
   class JobWithRegister < Job
     attr_reader :register
 
-    def initialize(name:, register: '')
+    def initialize(name:, register: DEFAULT_REGISTER)
       super(name: name)
 
       @register = register.to_s

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

@@ -55,7 +55,7 @@ module Burner
       class ArraysToObjects < JobWithRegister
         attr_reader :mappings
 
-        def initialize(name:, mappings: [], register: '')
+        def initialize(name:, mappings: [], register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           @mappings = Modeling::KeyIndexMapping.array(mappings)

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

@@ -18,7 +18,7 @@ module Burner
       class Concatenate < Job
         attr_reader :from_registers, :to_register
 
-        def initialize(name:, from_registers: [], to_register: '')
+        def initialize(name:, from_registers: [], to_register: DEFAULT_REGISTER)
           super(name: name)
 
           @from_registers = Array(from_registers)

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

@@ -18,7 +18,11 @@ module Burner
       class Graph < JobWithRegister
         attr_reader :key, :groups
 
-        def initialize(name:, key:, config: Hashematics::Configuration.new, register: '')
+        def initialize(
+          name:, key:,
+          config: Hashematics::Configuration.new,
+          register: DEFAULT_REGISTER
+        )
           super(name: name, register: register)
 
           raise ArgumentError, 'key is required' if key.to_s.empty?

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

@@ -58,7 +58,7 @@ module Burner
         # nested hashes then set separator to '.'.  For more information, see the underlying
         # library that supports this dot-notation concept:
         #   https://github.com/bluemarblepayroll/objectable
-        def initialize(name:, mappings: [], register: '', separator: '')
+        def initialize(name:, mappings: [], register: DEFAULT_REGISTER, separator: '')
           super(name: name, register: register)
 
           @mappings = Modeling::KeyIndexMapping.array(mappings)

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

@@ -23,7 +23,7 @@ module Burner
 
         attr_reader :amount
 
-        def initialize(name:, amount: DEFAULT_AMOUNT, register: '')
+        def initialize(name:, amount: DEFAULT_AMOUNT, register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           @amount = amount.to_i

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

@@ -27,7 +27,13 @@ module Burner
                     :exclusive,
                     :resolver
 
-        def initialize(name:, attributes: [], exclusive: false, register: '', separator: BLANK)
+        def initialize(
+          name:,
+          attributes: [],
+          exclusive: false,
+          register: DEFAULT_REGISTER,
+          separator: BLANK
+        )
           super(name: name, register: register)
 
           @resolver  = Objectable.resolver(separator: separator)

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

@@ -19,7 +19,11 @@ module Burner
       class Unpivot < JobWithRegister
         attr_reader :unpivot
 
-        def initialize(name:, pivot_set: HashMath::Unpivot::PivotSet.new, register: '')
+        def initialize(
+          name:,
+          pivot_set: HashMath::Unpivot::PivotSet.new,
+          register: DEFAULT_REGISTER
+        )
           super(name: name, register: register)
 
           @unpivot = HashMath::Unpivot.new(pivot_set)

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

@@ -33,7 +33,7 @@ module Burner
           invalid_register: DEFAULT_INVALID_REGISTER,
           join_char: DEFAULT_JOIN_CHAR,
           message_key: DEFAULT_MESSAGE_KEY,
-          register: '',
+          register: DEFAULT_REGISTER,
           separator: '',
           validations: []
         )

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

@@ -19,7 +19,7 @@ module Burner
       class Values < JobWithRegister
         attr_reader :include_keys
 
-        def initialize(name:, include_keys: false, register: '')
+        def initialize(name:, include_keys: false, register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           @include_keys = include_keys || false

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

@@ -20,7 +20,7 @@ module Burner
       class Yaml < JobWithRegister
         attr_reader :safe
 
-        def initialize(name:, register: '', safe: true)
+        def initialize(name:, register: DEFAULT_REGISTER, safe: true)
           super(name: name, register: register)
 
           @safe = safe

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

@@ -14,7 +14,7 @@ module Burner
       class Base < JobWithRegister
         attr_reader :path
 
-        def initialize(name:, path:, register: '')
+        def initialize(name:, path:, register: DEFAULT_REGISTER)
           super(name: name, register: register)
 
           raise ArgumentError, 'path is required' if path.to_s.empty?

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

@@ -19,7 +19,7 @@ module Burner
       class Read < Base
         attr_reader :binary
 
-        def initialize(name:, path:, binary: false, register: '')
+        def initialize(name:, path:, binary: false, register: DEFAULT_REGISTER)
           super(name: name, path: path, register: register)
 
           @binary = binary || false

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

@@ -19,7 +19,7 @@ module Burner
       class Write < Base
         attr_reader :binary
 
-        def initialize(name:, path:, binary: false, register: '')
+        def initialize(name:, path:, binary: false, register: DEFAULT_REGISTER)
           super(name: name, path: path, register: register)
 
           @binary = binary || false

data/lib/burner/library/value/copy.rb

@@ -12,14 +12,14 @@ module Burner
     module Value
       # Copy one value in a register to another.  Note that this does *not* perform any type of
       # deep copy, it simply points one register's value to another.  If you decide to later mutate
-      # one register, you are *not* guaranteed to not mutate the other.
+      # one register then you may mutate the other.
       #
       # Expected Payload[from_register] input: anything.
       # Payload[to_register] output: whatever value was specified in the from_register.
       class Copy < Job
         attr_reader :from_register, :to_register
 
-        def initialize(name:, to_register: '', from_register: '')
+        def initialize(name:, to_register: DEFAULT_REGISTER, from_register: DEFAULT_REGISTER)
           super(name: name)
 
           @from_register = from_register.to_s

data/lib/burner/library/value/static.rb

@@ -17,7 +17,7 @@ module Burner
       class Static < JobWithRegister
         attr_reader :value
 
-        def initialize(name:, register: '', value: nil)
+        def initialize(name:, register: DEFAULT_REGISTER, value: nil)
           super(name: name, register: register)
 
           @value = value

data/lib/burner/modeling/validations/base.rb

@@ -27,7 +27,7 @@ module Burner
         end
 
         def message
-          @message.to_s.empty? ? "#{key}#{default_message}" : @message.to_s
+          @message.to_s.empty? ? "#{key} #{default_message}" : @message.to_s
         end
       end
     end

data/lib/burner/modeling/validations/blank.rb

@@ -16,14 +16,18 @@ module Burner
       class Blank < Base
         acts_as_hashable
 
+        BLANK_RE = /\A[[:space:]]*\z/.freeze
+
         def valid?(object, resolver)
-          resolver.get(object, key).to_s.empty?
+          value = resolver.get(object, key).to_s
+
+          value.empty? || BLANK_RE.match?(value)
         end
 
         private
 
         def default_message
-          ' must be blank'
+          'must be blank'
         end
       end
     end

data/lib/burner/modeling/validations/present.rb

@@ -7,23 +7,23 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'base'
+require_relative 'blank'
 
 module Burner
   module Modeling
     class Validations
       # Check if a value is present.  If it is blank (null or empty) then it is invalid.
-      class Present < Base
+      class Present < Blank
         acts_as_hashable
 
         def valid?(object_value, resolver)
-          !resolver.get(object_value, key).to_s.empty?
+          !super(object_value, resolver)
         end
 
         private
 
         def default_message
-          ' is required'
+          'is required'
         end
       end
     end

data/lib/burner/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.13
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: stringento
   requirement: !ruby/object:Gem::Requirement
@@ -286,9 +286,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: