File: reporting.rb

package info (click to toggle)
ruby-buff-extensions 2.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 212 kB
  • sloc: ruby: 506; makefile: 3
file content (119 lines) | stat: -rw-r--r-- 3,306 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
require 'rbconfig'
require 'tempfile'

module Buff
  module Extensions::Kernel
    # Borrowd and modified from
    # {https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/kernel/reporting.rb}
    module Reporting
      # 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
      def silence_warnings
        with_warnings(nil) { yield }
      end

      # Sets $VERBOSE to +true+ for the duration of the block and back to its
      # original value afterwards.
      def enable_warnings
        with_warnings(true) { yield }
      end

      # Sets $VERBOSE for the duration of the block and back to its original
      # value afterwards.
      def with_warnings(flag)
        old_verbose, $VERBOSE = $VERBOSE, flag
        yield
      ensure
        $VERBOSE = old_verbose
      end

      # For compatibility
      def silence_stderr #:nodoc:
        silence_stream(STDERR) { yield }
      end

      # Silences any stream for the duration of the block.
      #
      #   silence_stream(STDOUT) do
      #     puts 'This will never be seen'
      #   end
      #
      #   puts 'But this will'
      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

      # 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'
      def suppress(*exception_classes)
        yield
      rescue Exception => e
        raise unless exception_classes.any? { |cls| e.kind_of?(cls) }
      end

      # 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"
      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
      alias :silence :capture

      # Silences both STDOUT and STDERR, even for subprocesses.
      #
      #   quietly { system 'bundle install' }
      def quietly
        silence_stream(STDOUT) do
          silence_stream(STDERR) do
            yield
          end
        end
      end
    end
  end
end

module Kernel
  include Buff::Extensions::Kernel::Reporting
end