pdi 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f99b35960e8b34b16146e824e1970fc9e9d39e0f7b982f850f62c6ff67e1e2cf
-  data.tar.gz: b81e3b25c302c3505f23d60d15872ea2497245601bd69a7252d3f6e5fa5d9704
+  metadata.gz: 7aad69dc7048e9bc7b4c017d42b2343bca49c98718d1ba3d44981bb4434562f4
+  data.tar.gz: 5405f5f819e2ae116de4831d5a609b32cbf0d08b9117992f3126ca0eefc39e67
 SHA512:
-  metadata.gz: 3b0994605738f6643ad5ef0320529a8b6d87964e4690322c75de42fac8711c2f53b579cab759d7ff3c21eb97ba93c645058a365ef3d6f9f625cec739c5e04e74
-  data.tar.gz: b843cc9261b0997b23a241f89f327f208d9e7ef11e9728c854155ef5921940fea69e1ca84108e4f7733d4fb1a8457493f556999b30576ec2ca146a625a5f8981
+  metadata.gz: 2e3fbfc5cb28c486153acda733620c63c21ccb7a7521cb8534de0c153364ff01d12f0af0fcd1a495eeaa8c146430faf002f3c9bd06d1e1ce6a9b35df12af6f76
+  data.tar.gz: c220cf297f8b8a3377fc1f6287e236efdb1549867680bdf6e52a3e9b905e6e717e4420df093d1be537dcb768540a8040e23bac3eaea12aa49cfbb1282c2ef8ff

data/.rubocop.yml

@@ -13,10 +13,10 @@ Metrics/BlockLength:
     - define
 
 Metrics/MethodLength:
-  Max: 25
+  Max: 17
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
 
 Metrics/AbcSize:
   Max: 16

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.6.6

data/.travis.yml

@@ -4,10 +4,9 @@ env:
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.5
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.1.0 (June 3rd, 2020)
+
+Enhancements:
+
+* Support for streamed command output.
+
 # 2.0.0 (May 11th, 2020)
 
 Breaking Changes:

data/README.md

@@ -70,13 +70,21 @@ result = spoon.run(options)
 
 `Spoon#run` will return:
 
-* `Pdi::Spoon::Result` upon a successful run.
+* `Pdi::Executor::Result` upon a successful run.
 * If a non-zero exit code was returned then a `Pdi::Spoon::PanError` or `Pdi::Spoon::KitchenError` will be raised.
 
 You can access the raw command line results by tapping into the execution attribute of the result or error object.
 
 Note: Not all options are currently supported.  See PDI's official references for [Pan](https://help.pentaho.com/Documentation/6.1/0L0/0Y0/070/000) and [Kitchen](https://help.pentaho.com/Documentation/6.1/0L0/0Y0/070/010) to see all options.
 
+### Output
+
+There are two ways to see the output of a `Pdi::Spoon` run.  First, the output is available when a run completes through `Pdi::Executor::Result#out`. It is also possible to get the output throughout the run by passing a block to run. For example:
+
+````ruby
+spoon.run(options) { |output| print output }
+````
+
 ## Contributing
 
 ### Development Environment Configuration

data/lib/pdi/executor.rb

@@ -21,34 +21,48 @@ module Pdi
       freeze
     end
 
-    def run(args)
+    def run(args, &streaming_reader)
       args = Array(args).map(&:to_s)
 
       IO.popen(args, err: %i[child out]) do |io|
-        begin
-          io_read =
-            if timeout_in_seconds
-              Timeout.timeout(timeout_in_seconds) { io.read }
-            else
-              io.read
-            end
-
-          io.close
-          status = $CHILD_STATUS
-
-          Result.new(
-            args: args,
-            status: {
-              code: status.exitstatus,
-              out: io_read,
-              pid: status.pid
-            }
-          )
-        rescue Timeout::Error => e
-          Process.kill(9, io.pid)
-          raise e
-        end
+        io_read = read(io, &streaming_reader)
+        io.close
+        status = $CHILD_STATUS
+
+        Result.new(
+          args: args,
+          status: {
+            code: status.exitstatus,
+            out: io_read,
+            pid: status.pid
+          }
+        )
+      rescue Timeout::Error => e
+        Process.kill(9, io.pid)
+        raise e
+      end
+    end
+
+    private
+
+    def read(io, &streaming_reader)
+      if timeout_in_seconds
+        Timeout.timeout(timeout_in_seconds) { streamed_read(io, &streaming_reader) }
+      else
+        streamed_read(io, &streaming_reader)
       end
     end
+
+    def streamed_read(io, &streaming_reader)
+      return io.read unless block_given?
+
+      read = ''
+      io.each_line do |line_read|
+        streaming_reader.call(line_read)
+        read += line_read
+      end
+
+      read
+    end
   end
 end

data/lib/pdi/spoon.rb

@@ -60,13 +60,18 @@ module Pdi
       Result.new(result, version_line)
     end
 
-    # Returns an Executor::Result instance when PDI returns error code 0 or else raises
-    # a PanError (transformation) or KitchenError (job).
-    def run(options)
+    # Returns a <tt>Pdi::Executor::Result</tt> instance when PDI returns error
+    # code 0 or else raises a PanError (transformation) or KitchenError (job).
+    #
+    # An optional block may be passed in so that the output of a run is
+    # available in a streaming manner during the run. This block takes one
+    # parameter which is the current chunk of output and is called repeatedly
+    # throughout the run.
+    def run(options, &streaming_reader)
       options  = Options.make(options)
       all_args = run_args(options)
 
-      executor.run(all_args).tap do |result|
+      executor.run(all_args, &streaming_reader).tap do |result|
         raise(error_constant(options), result) if result.code != 0
       end
     end

data/lib/pdi/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Pdi
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/pdi.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
     Pentaho Data Integration allows for the creation of ETL transformation and jobs.  This library allows those ETL tasks to be executed from Ruby.
   DESCRIPTION
 
-  s.authors     = ['Matthew Ruggio']
+  s.authors     = ['Matthew Ruggio', 'Ryan Gerry']
   s.email       = ['mruggio@bluemarblepayroll.com']
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/pdi'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.8'
+  s.required_ruby_version = '>= 2.5.8'
 
   s.add_dependency('acts_as_hashable', '~>1')
 

data/spec/pdi/executor_spec.rb

@@ -13,6 +13,7 @@ describe Pdi::Executor do
   let(:script)      { File.join('spec', 'mocks', 'spoon', 'sleep.sh') }
   let(:one_second)  { 1 }
   let(:return_code) { 33 }
+  let(:script_output) { "std_out\nerr_out\nafter_sleep\n" }
 
   describe '#run' do
     context 'with a timeout' do
@@ -45,7 +46,18 @@ describe Pdi::Executor do
 
         result = subject.run(args)
 
-        expect(result.out).to eq("std_out\nerr_out\nafter_sleep\n")
+        expect(result.out).to eq script_output
+      end
+
+      describe 'streaming output' do
+        it 'accepts a block and passes in the Pentaho output and populates result output' do
+          found_output = ''
+
+          result = subject.run([script, 0, return_code]) { |output| found_output += output }
+
+          expect(found_output).to eq script_output
+          expect(result.out).to eq script_output
+        end
       end
     end
   end

data/spec/pdi/spoon_spec.rb

@@ -25,6 +25,8 @@ describe Pdi::Spoon do
   end
 
   describe '#run' do
+    let(:script_output) { "output to stdout\noutput to sterr\n" }
+
     context 'transformations' do
       let(:options) do
         {
@@ -43,19 +45,22 @@ describe Pdi::Spoon do
       end
 
       context 'when code is 0' do
-        it 'returns correct stdout, stderr and code' do
-          subject = described_class.new(
-            args: 0,
-            dir: dir,
-            kitchen: script,
-            pan: script
-          )
+        let(:subject) { described_class.new(args: 0, dir: dir, kitchen: script, pan: script) }
 
+        it 'returns correct stdout, stderr and code' do
           result = subject.run(options)
 
-          expect(result.out).to  eq("output to stdout\noutput to sterr\n")
+          expect(result.out).to eq script_output
           expect(result.code).to eq(0)
         end
+
+        it 'allows for streaming output when passed a block' do
+          found_output = ''
+
+          subject.run(options) { |output| found_output += output }
+
+          expect(found_output).to eq script_output
+        end
       end
 
       [1, 2, 3, 7, 8, 9].each do |code|

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pdi
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
+- Ryan Gerry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -182,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.8
+      version: 2.5.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="