Module: Buff::Extensions::Kernel::Reporting
- Included in:
- Kernel
- Defined in:
- lib/buff/extensions/kernel/reporting.rb
Overview
Borrowd and modified from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/kernel/reporting.rb
Instance Method Summary collapse
-
#capture(stream) ⇒ Object
(also: #silence)
Captures the given stream and returns it:.
-
#enable_warnings ⇒ Object
Sets $VERBOSE to
true
for the duration of the block and back to its original value afterwards. -
#quietly ⇒ Object
Silences both STDOUT and STDERR, even for subprocesses.
-
#silence_stderr ⇒ Object
For compatibility.
-
#silence_stream(stream) ⇒ Object
Silences any stream for the duration of the block.
-
#silence_warnings ⇒ Object
Sets $VERBOSE to nil for the duration of the block and back to its original value afterwards.
-
#suppress(*exception_classes) ⇒ Object
Blocks and ignores any exception passed as argument if raised within the block.
-
#with_warnings(flag) ⇒ Object
Sets $VERBOSE for the duration of the block and back to its original value afterwards.
Instance Method Details
#capture(stream) ⇒ Object Also known as: silence
Captures the given stream and returns it:
stream = capture(:stdout) { puts 'notice' }
stream # => "notice\n"
stream = capture(:stderr) { warn 'error' }
stream # => "error\n"
even for subprocesses:
stream = capture(:stdout) { system('echo notice') }
stream # => "notice\n"
stream = capture(:stderr) { system('echo error 1>&2') }
stream # => "error\n"
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 86 def capture(stream) stream = stream.to_s captured_stream = Tempfile.new(stream) stream_io = eval("$#{stream}") origin_stream = stream_io.dup stream_io.reopen(captured_stream) yield stream_io.rewind return captured_stream.read ensure captured_stream.unlink stream_io.reopen(origin_stream) end |
#enable_warnings ⇒ Object
Sets $VERBOSE to true
for the duration of the block and back to its original value afterwards.
23 24 25 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 23 def enable_warnings with_warnings(true) { yield } end |
#quietly ⇒ Object
Silences both STDOUT and STDERR, even for subprocesses.
quietly { system 'bundle install' }
106 107 108 109 110 111 112 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 106 def quietly silence_stream(STDOUT) do silence_stream(STDERR) do yield end end end |
#silence_stderr ⇒ Object
For compatibility
37 38 39 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 37 def silence_stderr #:nodoc: silence_stream(STDERR) { yield } end |
#silence_stream(stream) ⇒ Object
Silences any stream for the duration of the block.
silence_stream(STDOUT) do
puts 'This will never be seen'
end
puts 'But this will'
48 49 50 51 52 53 54 55 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 48 def silence_stream(stream) old_stream = stream.dup stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null') stream.sync = true yield ensure stream.reopen(old_stream) end |
#silence_warnings ⇒ Object
Sets $VERBOSE to nil for the duration of the block and back to its original value afterwards.
silence_warnings do
value = noisy_call # no warning voiced
end
noisy_call # warning voiced
17 18 19 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 17 def silence_warnings with_warnings(nil) { yield } end |
#suppress(*exception_classes) ⇒ Object
Blocks and ignores any exception passed as argument if raised within the block.
suppress(ZeroDivisionError) do
1/0
puts 'This code is NOT reached'
end
puts 'This code gets executed and nothing related to ZeroDivisionError was seen'
65 66 67 68 69 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 65 def suppress(*exception_classes) yield rescue Exception => e raise unless exception_classes.any? { |cls| e.kind_of?(cls) } end |
#with_warnings(flag) ⇒ Object
Sets $VERBOSE for the duration of the block and back to its original value afterwards.
29 30 31 32 33 34 |
# File 'lib/buff/extensions/kernel/reporting.rb', line 29 def with_warnings(flag) old_verbose, $VERBOSE = $VERBOSE, flag yield ensure $VERBOSE = old_verbose end |