Class: RSpec::Matchers::BuiltIn::Output Private

Inherits:
BaseMatcher show all
Defined in:
lib/rspec/matchers/built_in/output.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Provides the implementation for output. Not intended to be instantiated directly.

Constant Summary

Constants inherited from BaseMatcher

BaseMatcher::UNDEFINED

Instance Method Summary collapse

Methods inherited from BaseMatcher

#expects_call_stack_jump?, #match_unless_raises

Methods included from Composable

#===, #and, #description_of, #or, should_enumerate?, surface_descriptions_in, unreadable_io?, #values_match?

Constructor Details

#initialize(expected) ⇒ Output

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Output.

10
11
12
13
14
15
 
# File 'lib/rspec/matchers/built_in/output.rb', line 10
def initialize(expected)
  @expected        = expected
  @actual          = ""
  @block           = nil
  @stream_capturer = NullCapture
end

Instance Method Details

#description ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 
76
77
78
79
80
81
82
 
# File 'lib/rspec/matchers/built_in/output.rb', line 76
def description
  if @expected
    "output #{description_of @expected} to #{@stream_capturer.name}"
  else
    "output to #{@stream_capturer.name}"
  end
end

#diffable? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 
86
87
88
 
# File 'lib/rspec/matchers/built_in/output.rb', line 86
def diffable?
  true
end

#does_not_match?(block) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 
24
25
26
 
# File 'lib/rspec/matchers/built_in/output.rb', line 24
def does_not_match?(block)
  !matches?(block) && Proc === block
end

#failure_message ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 
64
65
66
 
# File 'lib/rspec/matchers/built_in/output.rb', line 64
def failure_message
  "expected block to #{description}, but #{positive_failure_reason}"
end

#failure_message_when_negated ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 
70
71
72
 
# File 'lib/rspec/matchers/built_in/output.rb', line 70
def failure_message_when_negated
  "expected block to not #{description}, but #{negative_failure_reason}"
end

#matches?(block) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 
17
18
19
20
21
22
 
# File 'lib/rspec/matchers/built_in/output.rb', line 17
def matches?(block)
  @block = block
  return false unless Proc === block
  @actual = @stream_capturer.capture(block)
  @expected ? values_match?(@expected, @actual) : captured?
end

#supports_block_expectations? ⇒ True

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Indicates this matcher matches against a block.

Returns:

  • (True) 
93
94
95
 
# File 'lib/rspec/matchers/built_in/output.rb', line 93
def supports_block_expectations?
  true
end

#to_stderr ⇒ Object

Tells the matcher to match against stderr. Works only when the main Ruby process prints to stderr

39
40
41
42
 
# File 'lib/rspec/matchers/built_in/output.rb', line 39
def to_stderr
  @stream_capturer = CaptureStderr
  self
end

#to_stderr_from_any_process ⇒ Object

Tells the matcher to match against stderr. Works when subprocesses print to stderr as well. This is significantly (~30x) slower than to_stderr

57
58
59
60
 
# File 'lib/rspec/matchers/built_in/output.rb', line 57
def to_stderr_from_any_process
  @stream_capturer = CaptureStreamToTempfile.new("stderr", $stderr)
  self
end

#to_stdout ⇒ Object

Tells the matcher to match against stdout. Works only when the main Ruby process prints to stdout

31
32
33
34
 
# File 'lib/rspec/matchers/built_in/output.rb', line 31
def to_stdout
  @stream_capturer = CaptureStdout
  self
end

#to_stdout_from_any_process ⇒ Object

Tells the matcher to match against stdout. Works when subprocesses print to stdout as well. This is significantly (~30x) slower than to_stdout

48
49
50
51
 
# File 'lib/rspec/matchers/built_in/output.rb', line 48
def to_stdout_from_any_process
  @stream_capturer = CaptureStreamToTempfile.new("stdout", $stdout)
  self
end