Class: CLI::UI::StdoutRouter::Capture

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/cli/ui/stdout_router.rb

Defined Under Namespace

Classes: BlockingInput

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from T::Sig

sig

Constructor Details

#initialize(with_frame_inset: true, merged_output: false, duplicate_output_to: File.open(File::NULL, 'w'), &block) ⇒ Capture

Returns a new instance of Capture.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cli/ui/stdout_router.rb', line 195

def initialize(
  with_frame_inset: true,
  merged_output: false,
  duplicate_output_to: File.open(File::NULL, 'w'),
  &block
)
  @with_frame_inset = with_frame_inset
  @merged_output = merged_output
  @duplicate_output_to = duplicate_output_to
  @block = block
  @print_captured_output = false
  @out = StringIO.new
  @err = StringIO.new
end

Instance Attribute Details

Returns the value of attribute print_captured_output.



211
212
213
 
# File 'lib/cli/ui/stdout_router.rb', line 211

def print_captured_output
  @print_captured_output
end

Class Method Details

.current_capture ⇒ Object 



105
106
107
 
# File 'lib/cli/ui/stdout_router.rb', line 105

def current_capture
  Thread.current[:cliui_current_capture]
end

.current_capture! ⇒ Object 



110
111
112
 
# File 'lib/cli/ui/stdout_router.rb', line 110

def current_capture!
  T.must(current_capture)
end

.in_alternate_screen(&block) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cli/ui/stdout_router.rb', line 115

def in_alternate_screen(&block)
  stdin_synchronize do
    previous_print_captured_output = current_capture&.print_captured_output
    current_capture&.print_captured_output = true
    Spinner::SpinGroup.pause_spinners do
      if outermost_uncaptured?
        begin
          prev_hook = Thread.current[:cliui_output_hook]
          Thread.current[:cliui_output_hook] = nil
          replay = current_capture!.stdout.gsub(ANSI.match_alternate_screen, '')
          CLI::UI.raw do
            print("#{ANSI.enter_alternate_screen}#{replay}")
          end
        ensure
          Thread.current[:cliui_output_hook] = prev_hook
        end
      end
      block.call
    ensure
      print(ANSI.exit_alternate_screen) if outermost_uncaptured?
    end
  ensure
    current_capture&.print_captured_output = !!previous_print_captured_output
  end
end

.stdin_synchronize(&block) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cli/ui/stdout_router.rb', line 142

def stdin_synchronize(&block)
  @stdin_mutex.synchronize do
    case $stdin
    when BlockingInput
      $stdin.synchronize do
        block.call
      end
    else
      block.call
    end
  end
end

.with_stdin_masked(&block) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/cli/ui/stdout_router.rb', line 156

def with_stdin_masked(&block)
  @capture_mutex.synchronize do
    if @active_captures.zero?
      @stdin_mutex.synchronize do
        @saved_stdin = $stdin
        $stdin = BlockingInput.new(@saved_stdin)
      end
    end
    @active_captures += 1
  end

  yield
ensure
  @capture_mutex.synchronize do
    @active_captures -= 1
    if @active_captures.zero?
      @stdin_mutex.synchronize do
        $stdin = @saved_stdin
      end
    end
  end
end

Instance Method Details

#run ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/cli/ui/stdout_router.rb', line 214

def run
  require 'stringio'

  StdoutRouter.assert_enabled!

  Thread.current[:cliui_current_capture] = self

  prev_frame_inset = Thread.current[:no_cliui_frame_inset]
  prev_hook = Thread.current[:cliui_output_hook]

  if Thread.current.respond_to?(:report_on_exception)
    Thread.current.report_on_exception = false
  end

  self.class.with_stdin_masked do
    Thread.current[:no_cliui_frame_inset] = !@with_frame_inset
    Thread.current[:cliui_output_hook] = ->(data, stream) do
      stream = :stdout if @merged_output
      case stream
      when :stdout
        @out.write(data)
        @duplicate_output_to.write(data)
      when :stderr
        @err.write(data)
      else raise
      end
      print_captured_output # suppress writing to terminal by default
    end

    @block.call
  end
ensure
  Thread.current[:cliui_output_hook] = prev_hook
  Thread.current[:no_cliui_frame_inset] = prev_frame_inset
  Thread.current[:cliui_current_capture] = nil
end

#stderr ⇒ Object 



257
258
259
 
# File 'lib/cli/ui/stdout_router.rb', line 257

def stderr
  @err.string
end

#stdout ⇒ Object 



252
253
254
 
# File 'lib/cli/ui/stdout_router.rb', line 252

def stdout
  @out.string
end