Module: Kernel
- Defined in:
- lib/active_support/core_ext/kernel/debugger.rb,
lib/active_support/core_ext/kernel/reporting.rb,
lib/active_support/core_ext/kernel/singleton_class.rb
Instance Method Summary collapse
-
#capture(stream) ⇒ Object
(also: #silence)
Captures the given stream and returns it:.
-
#class_eval(*args, &block) ⇒ Object
class_eval on an object acts like singleton_class.class_eval.
-
#debugger ⇒ Object
(also: #breakpoint)
Starts a debugging session if ruby-debug has been loaded (call rails server –debugger to do load 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.
-
#singleton_class ⇒ Object
Returns the object’s singleton class.
-
#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 "Cool" }
stream # => "Cool\n"
70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 70 def capture(stream) begin stream = stream.to_s eval "$#{stream} = StringIO.new" yield result = eval("$#{stream}").string ensure eval("$#{stream} = #{stream.upcase}") end result end |
#class_eval(*args, &block) ⇒ Object
class_eval on an object acts like singleton_class.class_eval.
10 11 12 |
# File 'lib/active_support/core_ext/kernel/singleton_class.rb', line 10 def class_eval(*args, &block) singleton_class.class_eval(*args, &block) end |
#debugger ⇒ Object Also known as: breakpoint
Starts a debugging session if ruby-debug has been loaded (call rails server –debugger to do load it).
4 5 6 7 |
# File 'lib/active_support/core_ext/kernel/debugger.rb', line 4 def debugger = "\n***** Debugger requested, but was not available (ensure ruby-debug is listed in Gemfile/installed as gem): Start server with --debugger to enable *****\n" defined?(Rails) ? Rails.logger.info() : $stderr.puts() end |
#enable_warnings ⇒ Object
Sets $VERBOSE to true for the duration of the block and back to its original value afterwards.
17 18 19 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 17 def enable_warnings with_warnings(true) { yield } end |
#quietly ⇒ Object
Silences both STDOUT and STDERR, even for subprocesses.
quietly { system 'bundle install' }
88 89 90 91 92 93 94 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 88 def quietly silence_stream(STDOUT) do silence_stream(STDERR) do yield end end end |
#silence_stderr ⇒ Object
For compatibility
30 31 32 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 30 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'
41 42 43 44 45 46 47 48 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 41 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
12 13 14 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 12 def silence_warnings with_warnings(nil) { yield } end |
#singleton_class ⇒ Object
Returns the object’s singleton class.
3 4 5 6 7 |
# File 'lib/active_support/core_ext/kernel/singleton_class.rb', line 3 def singleton_class class << self self end 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"
58 59 60 61 62 63 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 58 def suppress(*exception_classes) begin yield rescue Exception => e raise unless exception_classes.any? { |cls| e.kind_of?(cls) } end end |
#with_warnings(flag) ⇒ Object
Sets $VERBOSE for the duration of the block and back to its original value afterwards.
22 23 24 25 26 27 |
# File 'lib/active_support/core_ext/kernel/reporting.rb', line 22 def with_warnings(flag) old_verbose, $VERBOSE = $VERBOSE, flag yield ensure $VERBOSE = old_verbose end |