childprocess 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8fff702a88edcf12e690bc426dc20f31f17ed0d
-  data.tar.gz: 12b43475977dd21b946f034a81d78bf0511b758f
+  metadata.gz: 489236aacb3714c55ea91562be7530b61d3bd573
+  data.tar.gz: 5c1c4576e85e5887b35a9ce472cec901f01d7e90
 SHA512:
-  metadata.gz: a91ee53c379d04b8f2e5df225494442bfc89670e3e0a8d0e6cb36aec5afb0929a50bdabcb6663b35ae23ca060765aa45b50a7be714253003961eb9dc7412daba
-  data.tar.gz: d110af9984b5e2e6f062ff1f6c9f77d08c0976a2a4a7acdcddef9de862b6227e042a87cf3563c60bfc9df5c508c2120ba3fe1f90543a8ab32152a155dc9b0703
+  metadata.gz: af337f4fbb1e151c787810d63cbbb2d0f16d3631dea31579f2b2d11b4a04228e2b1f423272d19f7f1d33fffc580138363f9f8b4e033ea2e37852c659dc7b4013
+  data.tar.gz: c7b80f7b7e1879da50e54a81250f03aa6358f488539cf1ee7d8fe18d6f9e70911dcead16a2bed0e149a92f7b8aac26c86e4f49dbb0afc66a2d736e2783be7300

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### Version 0.7.0 / 2017-05-07
+
+* Debugging information now uses a Logger, which can be configured.
+
+
 ### Version 0.6.3 / 2017-03-24
 
 See beta release notes.

data/README.md

@@ -154,6 +154,16 @@ ChildProcess.build("cmd.exe", "/c", "bundle")
 ChildProcess.build("ruby", "-S", "bundle")
 ```
 
+#### Log to file
+
+Errors and debugging information are logged to `$stderr` by default but a custom logger can be used instead. 
+
+```ruby
+logger = Logger.new('logfile.log')
+logger.level = Logger::DEBUG
+ChildProcess.logger = logger
+```
+
 ## Caveats
 
 * With JRuby on Unix, modifying `ENV["PATH"]` before using childprocess could lead to 'Command not found' errors, since JRuby is unable to modify the environemnt used for PATH searches in `java.lang.ProcessBuilder`. This can be avoided by setting `ChildProcess.posix_spawn = true`.

data/lib/childprocess.rb

@@ -3,12 +3,15 @@ require 'childprocess/errors'
 require 'childprocess/abstract_process'
 require 'childprocess/abstract_io'
 require "fcntl"
+require 'logger'
 
 module ChildProcess
 
   @posix_spawn = false
 
   class << self
+    attr_writer :logger
+
     def new(*args)
       case os
       when :macosx, :linux, :solaris, :bsd, :cygwin, :aix
@@ -27,6 +30,15 @@ module ChildProcess
     end
     alias_method :build, :new
 
+    def logger
+      return @logger if @logger
+
+      @logger = Logger.new($stderr)
+      @logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
+
+      @logger
+    end
+
     def platform
       if RUBY_PLATFORM == "java"
         :jruby
@@ -164,7 +176,7 @@ module ChildProcess
 
       unless @warnings[msg]
         @warnings[msg] = true
-        $stderr.puts msg
+        logger.warn msg
       end
     end
 

data/lib/childprocess/abstract_process.rb

@@ -176,7 +176,7 @@ module ChildProcess
     end
 
     def log(*args)
-      $stderr.puts "#{self.inspect} : #{args.inspect}" if $DEBUG
+      ChildProcess.logger.debug "#{self.inspect} : #{args.inspect}"
     end
 
     def assert_started

data/lib/childprocess/jruby/pump.rb

@@ -44,7 +44,8 @@ module ChildProcess
 
         @output.flush
       rescue java.io.IOException => ex
-        $stderr.puts ex.message, ex.backtrace if $DEBUG
+        ChildProcess.logger.debug ex.message
+        ChildProcess.logger.debug ex.backtrace
       end
 
     end # Pump

data/lib/childprocess/version.rb

@@ -1,3 +1,3 @@
 module ChildProcess
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end

data/spec/childprocess_spec.rb

@@ -288,4 +288,80 @@ describe ChildProcess do
 
     expect(proc).to be_exited
   end
+
+
+  it 'has a logger' do
+    expect(ChildProcess).to respond_to(:logger)
+  end
+
+  it 'can change its logger' do
+    expect(ChildProcess).to respond_to(:logger=)
+
+    original_logger = ChildProcess.logger
+    begin
+      ChildProcess.logger = :some_other_logger
+      expect(ChildProcess.logger).to eq(:some_other_logger)
+    ensure
+      ChildProcess.logger = original_logger
+    end
+  end
+
+
+  describe 'logger' do
+
+    before(:each) do
+      ChildProcess.logger = logger
+    end
+
+    after(:all) do
+      ChildProcess.logger = nil
+    end
+
+
+    context 'with the default logger' do
+
+      let(:logger) { nil }
+
+
+      it 'logs at INFO level by default' do
+        expect(ChildProcess.logger.level).to eq(Logger::INFO)
+      end
+
+      it 'logs at DEBUG level by default if $DEBUG is on' do
+        original_debug = $DEBUG
+
+        begin
+          $DEBUG = true
+
+          expect(ChildProcess.logger.level).to eq(Logger::DEBUG)
+        ensure
+          $DEBUG = original_debug
+        end
+      end
+
+      it "logs to stderr by default" do
+        cap = capture_std { generate_log_messages }
+
+        expect(cap.stdout).to be_empty
+        expect(cap.stderr).to_not be_empty
+      end
+
+    end
+
+    context 'with a custom logger' do
+
+      let(:logger) { Logger.new($stdout) }
+
+
+      it "logs to configured logger" do
+        cap = capture_std { generate_log_messages }
+
+        expect(cap.stdout).to_not be_empty
+        expect(cap.stderr).to be_empty
+      end
+
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -233,6 +233,14 @@ module ChildProcessSpecHelper
     STDERR.reopen orig_err
   end
 
+  def generate_log_messages
+    ChildProcess.logger.level = Logger::DEBUG
+
+    process = exit_with(0).start
+    process.wait
+    process.poll_for_exit(0.1)
+  end
+
 end # ChildProcessSpecHelper
 
 Thread.abort_on_exception = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: childprocess
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Jari Bakken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi