command_runner_ng 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a81766b72e2152688fa7ec9329557394dbecb320
-  data.tar.gz: 4443fc0fa5f5b0c3524607505283f8c20e4bc4d3
+SHA256:
+  metadata.gz: 98450272fb53a9e40131a84b04dbf6d52d8afcb597977ef5e9c19081524fe63c
+  data.tar.gz: 17ff322d1aa87e0e195fafd816520acbe7d175fc924604dd8632fa2354ae10ab
 SHA512:
-  metadata.gz: 3e479989e2f54239a84f27561e8c754838b0924a323ebdc1341fc5cc539a468b05e69af1940164370a6ddca0060bcc820ad46c7fb57b04d995b392bb0f749e1d
-  data.tar.gz: 9bffe871f6c0155167ee0f97410345b59d92e10f0acff36f88bef8808f18917a167e628d4826e43ca5ce6fd32f215b2dbba9c27d3c1cf6e32a4d80c349e83f21
+  metadata.gz: 557a9333803ac3b0ab1e533f48b432ae057dfc84284b0df46cac8edec5e2da5f9c4f4096cf4e9cdfe76c621d9cf16314c7ca7823c90346431c43fe28ce09b873
+  data.tar.gz: 7bbc1b9b2e6dc4a22a479a20e89157ff86b95210402d1224092cb3192dc02244cb83be0e6e8db8156e6c3bbec81502409e61f75fb71f46fb9c17256fd182e535

data/lib/command_runner.rb

@@ -55,7 +55,7 @@ module CommandRunner
   # all process start, stop, and timeouts here. To enable debug logging for all commands call
   # CommandRunner.set_debug_log!($stderr) (or with some other object responding to :puts).
   #
-  def self.run(*args, timeout: nil, environment: {}, debug_log: nil, split_stderr: false, options: DEFAULT_OPTIONS)
+  def self.run(*args, timeout: nil, environment: {}, debug_log: nil, split_stderr: false, encoding: nil, options: DEFAULT_OPTIONS)
     if debug_log.nil?
       debug_log = @@global_debug_log
     end
@@ -99,7 +99,7 @@ module CommandRunner
 
     # Spawn child, merging stderr into stdout
     io = IO.popen(environment, *args, options)
-    debug_log.puts("CommandRunnerNG spawn: args=#{args}, timeout=#{timeout}, options: #{options}, PID: #{io.pid}") if debug_log.respond_to?(:puts)
+    debug_log.puts("CommandRunnerNG spawn: args=#{args}, timeout=#{timeout}, encoding=#{encoding}, options: #{options}, PID: #{io.pid}") if debug_log.respond_to?(:puts)
     data = ""
 
     err_w.close if split_stderr
@@ -113,9 +113,9 @@ module CommandRunner
         if Process.wait(io.pid, Process::WNOHANG)
           read_nonblock_safe!(io, data, tick)
           read_nonblock_safe!(err_r, errbuf, 0) if split_stderr
-          result = {:out => data, :status => $?, pid: io.pid}
+          result = {:out => ensure_command_output_encoded(data, args.join(" "), encoding), :status => $?, pid: io.pid}
           if split_stderr
-            result[:err] = errbuf
+            result[:err] = ensure_command_output_encoded(errbuf, args.join(" "), encoding)
             err_r.close
           end
           debug_log.puts("CommandRunnerNG exit: PID: #{io.pid}, code: #{result[:status].exitstatus}") if debug_log.respond_to?(:puts)
@@ -160,9 +160,9 @@ module CommandRunner
     end
     Process.wait(io.pid)
 
-    result = {:out => data, :status => $?, pid: io.pid}
+    result = {:out => ensure_command_output_encoded(data, args.join(" "), encoding), :status => $?, pid: io.pid}
     if split_stderr
-      result[:err] = errbuf
+      result[:err] = ensure_command_output_encoded(errbuf, args.join(" "), encoding)
       err_r.close
     end
 
@@ -173,6 +173,34 @@ module CommandRunner
     result
   end
 
+  # Forces encoding in the specified character set
+  # Defaults to no change (outputs in original encoding)
+  def self.ensure_command_output_encoded(string, command, encoding = nil)
+    return '' if !string
+
+    return string if encoding.nil? ||  encoding != :safe
+
+    encodingName = 'UTF-8'
+
+    firstPass = string.force_encoding(encodingName)
+
+    return firstPass if firstPass.valid_encoding?
+
+    encoded = firstPass.encode(encodingName, encodingName,
+                          invalid: :replace,
+                          undef: :replace,
+                          replace: "")
+
+    return encoded if encoded.valid_encoding?
+
+    raise EncodingError, %Q{
+      Could not force #{encodingName} encoding on this string:
+      #{string}
+      which is the output of this command:
+      #{command}
+    }
+  end
+
   # Create a helper instance to launch a command with a given configuration.
   # Invoke the command with the run() method. The configuration given to create()
   # can be overriden on each invocation of run().
@@ -184,8 +212,8 @@ module CommandRunner
   # git.run(:pull, 'origin', 'master')
   # git.run(:pull, 'origin', 'master', timeout: 2) # override default timeout of 10
   # git.run(:status) # will raise an error because :status is not in list of allowed commands
-  def self.create(*args, timeout: nil, environment: {}, allowed_sub_commands: [], debug_log: nil, split_stderr: false, options: DEFAULT_OPTIONS)
-    CommandInstance.new(args, timeout, environment, allowed_sub_commands, debug_log, split_stderr, options)
+  def self.create(*args, timeout: nil, environment: {}, allowed_sub_commands: [], debug_log: nil, split_stderr: false, encoding: nil, options: DEFAULT_OPTIONS)
+    CommandInstance.new(args, timeout, environment, allowed_sub_commands, debug_log, split_stderr, encoding, options)
   end
 
   # Log all command line invocations to a logger object responding to :puts. Set to nil to disable.
@@ -205,7 +233,7 @@ module CommandRunner
 
   class CommandInstance
 
-    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands, debug_log, split_stderr, options)
+    def initialize(default_args, default_timeout, default_environment, allowed_sub_commands, debug_log, split_stderr, encoding, options)
       unless default_args.first.is_a? Array
         raise "First argument must be an array of command line args. Found #{default_args}"
       end
@@ -216,6 +244,7 @@ module CommandRunner
       @allowed_sub_commands = allowed_sub_commands
       @debug_log = debug_log
       @split_stderr = split_stderr
+      @encoding = encoding
       @options = options
     end
 
@@ -243,6 +272,7 @@ module CommandRunner
                         environment: @default_environment.merge(environment),
                         debug_log: @debug_log,
                         split_stderr: @split_stderr,
+                        encoding: @encoding,
                         options: @options)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_runner_ng
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Mikkel Kamstrup Erlandsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies: []
 description: Helper APIs for advanced interactions with subprocesses and shell commands
 email: kamikkel@microsoft.com
@@ -37,7 +37,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Command Runner NG