pdi 1.0.0.pre.alpha

data/lib/pdi/spoon/kitchen_error.rb

@@ -0,0 +1,34 @@
+# 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 PDI
+  class Spoon
+    # This class subclasses Ruby's StandardError and provides a mapping to custom Kitchen
+    # specific error codes to messages.
+    class KitchenError < StandardError
+      MESSAGES = {
+        '1' => 'Errors occurred during processing',
+        '2' => 'An unexpected error occurred during loading or running of the job',
+        '7' => "The job couldn't be loaded from XML or the Repository",
+        '8' => 'Error loading steps or plugins (error in loading one of the plugins mostly)',
+        '9' => 'Command line usage printing'
+      }.freeze
+
+      attr_reader :execution
+
+      def initialize(execution)
+        @execution = execution
+
+        message = MESSAGES[execution.code.to_s] || 'Unknown'
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/pdi/spoon/options.rb

@@ -0,0 +1,93 @@
+# 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 'kitchen_error'
+require_relative 'options/level'
+require_relative 'options/param'
+require_relative 'pan_error'
+
+module PDI
+  class Spoon
+    # This class serves as the input for executing a transformation or job through Pan or Kitchen.
+    class Options
+      acts_as_hashable
+
+      module Type
+        JOB            = :job
+        TRANSFORMATION = :transformation
+      end
+
+      TYPES_TO_ERRORS = {
+        Type::JOB => KitchenError,
+        Type::TRANSFORMATION => PanError
+      }.freeze
+
+      TYPES_TO_KEYS = {
+        Type::JOB => Arg::Key::JOB,
+        Type::TRANSFORMATION => Arg::Key::TRANS
+      }.freeze
+
+      attr_reader :level,
+                  :name,
+                  :params,
+                  :repository,
+                  :type
+
+      def initialize(
+        level: Level::BASIC,
+        name:,
+        params: {},
+        repository:,
+        type:
+      )
+        raise ArgumentError, 'name is required'       if name.to_s.empty?
+        raise ArgumentError, 'repository is required' if repository.to_s.empty?
+        raise ArgumentError, 'type is required'       if type.to_s.empty?
+
+        @level      = constant(Level, level)
+        @name       = name.to_s
+        @params     = params || {}
+        @repository = repository.to_s
+        @type       = constant(Type, type)
+
+        freeze
+      end
+
+      def to_args
+        base_args + param_args
+      end
+
+      def error_constant
+        TYPES_TO_ERRORS.fetch(type)
+      end
+
+      private
+
+      def key
+        TYPES_TO_KEYS.fetch(type)
+      end
+
+      def base_args
+        [
+          Arg.new(Arg::Key::REP, repository),
+          Arg.new(key, name),
+          Arg.new(Arg::Key::LEVEL, level)
+        ]
+      end
+
+      def param_args
+        params.map { |key, value| Param.new(key, value) }
+      end
+
+      def constant(constant, value)
+        constant.const_get(value.to_s.upcase.to_sym)
+      end
+    end
+  end
+end

data/lib/pdi/spoon/options/arg.rb

@@ -0,0 +1,68 @@
+# 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 PDI
+  class Spoon
+    class Options
+      # This class can form Pentaho-specific command-line arguments.
+      class Arg
+        COLON         = ':'
+        DOUBLE_QUOTE  = '"'
+        EMPTY         = ''
+        HYPHEN        = '-'
+        SPACE         = ' '
+
+        module Key
+          JOB     = :job
+          LEVEL   = :level
+          PARAM   = :param
+          REP     = :rep
+          TRANS   = :trans
+          VERSION = :version
+        end
+
+        attr_reader :key, :value
+
+        def initialize(key, value = '')
+          raise ArgumentError, 'key is required' if key.to_s.empty?
+
+          @key   = Key.const_get(key.to_s.upcase.to_sym)
+          @value = value.to_s
+
+          freeze
+        end
+
+        def to_s
+          separator = value.to_s.empty? ? EMPTY : COLON
+          wrapper   = wrap?(key, value) ? DOUBLE_QUOTE : EMPTY
+          prefix    = HYPHEN
+
+          "#{wrapper}#{prefix}#{key}#{separator}#{value}#{wrapper}"
+        end
+
+        def hash
+          [key, value].hash
+        end
+
+        def ==(other)
+          other.instance_of?(self.class) &&
+            key == other.key &&
+            value == other.value
+        end
+        alias eql? ==
+
+        private
+
+        def wrap?(key, value)
+          key.to_s.include?(SPACE) || value.to_s.include?(SPACE)
+        end
+      end
+    end
+  end
+end

data/lib/pdi/spoon/options/level.rb

@@ -0,0 +1,23 @@
+# 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 PDI
+  class Spoon
+    class Options
+      module Level
+        BASIC     = 'Basic'
+        DETAILED  = 'Detailed'
+        DEBUG     = 'Debug'
+        ERROR     = 'Error'
+        NOTHING   = 'Nothing'
+        ROW_LEVEL = 'Rowlevel'
+      end
+    end
+  end
+end

data/lib/pdi/spoon/options/param.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.
+#
+
+require_relative 'arg'
+
+module PDI
+  class Spoon
+    class Options
+      # This class sub-classes Arg and knows how to form param key-value pair arguments.
+      class Param < Arg
+        EQUALS = '='
+
+        attr_reader :key, :value
+
+        def initialize(key, value = '')
+          super(Key::PARAM, "#{key}#{EQUALS}#{value}")
+
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/pdi/spoon/pan_error.rb

@@ -0,0 +1,35 @@
+# 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 PDI
+  class Spoon
+    # This class subclasses Ruby's StandardError and provides a mapping to custom Pan
+    # specific error codes to messages.
+    class PanError < StandardError
+      MESSAGES = {
+        '1' => 'Errors occurred during processing',
+        '2' => 'An unexpected error occurred during loading / running of the transformation',
+        '3' => 'Unable to prepare and initialize this transformation',
+        '7' => "The transformation couldn't be loaded from XML or the Repository",
+        '8' => 'Error loading steps or plugins (error in loading one of the plugins mostly)',
+        '9' => 'Command line usage printing'
+      }.freeze
+
+      attr_reader :execution
+
+      def initialize(execution)
+        @execution = execution
+
+        message = MESSAGES[execution.code.to_s] || 'Unknown'
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/pdi/spoon/parser.rb

@@ -0,0 +1,25 @@
+# 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 PDI
+  class Spoon
+    # This class knows how to parse the output of a Pan#version call.
+    class Parser
+      NEW_LINE = "\n"
+
+      def version(string)
+        string.to_s
+              .chomp
+              .split(NEW_LINE)
+              .last
+              .to_s
+      end
+    end
+  end
+end

data/lib/pdi/spoon/result.rb

@@ -0,0 +1,25 @@
+# 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 PDI
+  class Spoon
+    # General return object for wrapping up a execution call result (execution) and
+    # a usable result (value)
+    class Result
+      attr_reader :execution, :value
+
+      def initialize(execution, value)
+        @execution = execution
+        @value     = value
+
+        freeze
+      end
+    end
+  end
+end

data/lib/pdi/version.rb

@@ -0,0 +1,12 @@
+# 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 PDI
+  VERSION = '1.0.0-alpha'
+end

data/pdi.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require './lib/pdi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'pdi'
+  s.version     = PDI::VERSION
+  s.summary     = 'Fill out summary'
+
+  s.description = <<-DESCRIPTION
+    Fill out description.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/pdi'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('acts_as_hashable', '~>1')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rake', '~> 13')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~>0.79.0')
+  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('simplecov-console', '~>0.6.0')
+end

data/spec/mocks/spoon/return_0.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit 0

data/spec/mocks/spoon/return_1.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit 1

data/spec/mocks/spoon/return_2.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit 2

data/spec/mocks/spoon/return_3.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit 3