Class: RSpec::Core::Formatters::DeprecationFormatter

Inherits:

Object

• Object
• RSpec::Core::Formatters::DeprecationFormatter

show all

Defined in:

lib/rspec/core/formatters/deprecation_formatter.rb

Defined Under Namespace

Classes: DelayedPrinter, FileStream, GeneratedDeprecationMessage, ImmediatePrinter, RaiseErrorStream, SpecifiedDeprecationMessage

Constant Summary

RAISE_ERROR_CONFIG_NOTICE =

<<-EOS.gsub(/^\s+\|/, '')
  |
  |If you need more of the backtrace for any of these deprecations to
  |identify where to make the necessary changes, you can configure
  |`config.raise_errors_for_deprecations!`, and it will turn the
  |deprecation warnings into errors, giving you the full backtrace.
EOS

DEPRECATION_STREAM_NOTICE =

"Pass `--deprecation-out` or set " +
"`config.deprecation_stream` to a file for full output."

Instance Attribute Summary (collapse)

• - (Object) count readonly

  Returns the value of attribute count.

• - (Object) deprecation_stream readonly

  Returns the value of attribute deprecation_stream.

• - (Object) summary_stream readonly

  Returns the value of attribute summary_stream.

Instance Method Summary (collapse)

• - (Object) deprecation(data)
• - (Object) deprecation_message_for(data)
• - (Object) deprecation_summary
• - (DeprecationFormatter) initialize(deprecation_stream, summary_stream) constructor

  A new instance of DeprecationFormatter.

• - (Object) printer
• - (Object) start(example_count = nil)

10
11
12
13
14
15

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 10
def initialize(deprecation_stream, summary_stream)
  @deprecation_stream = deprecation_stream
  @summary_stream = summary_stream
  @seen_deprecations = Set.new
  @count = 0
end

8
9
10

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 8
def count
  @count
end

8
9
10

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 8
def deprecation_stream
  @deprecation_stream
end

8
9
10

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 8
def summary_stream
  @summary_stream
end

28
29
30
31
32
33
34

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 28
def deprecation(data)
  return if @seen_deprecations.include?(data)
  @count += 1
  printer.print_deprecation_message data
  @seen_deprecations << data
end

44
45
46
47
48
49
50

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 44
def deprecation_message_for(data)
  if data[:message]
    SpecifiedDeprecationMessage.new(data)
  else
    GeneratedDeprecationMessage.new(data)
  end
end

36
37
38

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 36
def deprecation_summary
  printer.deprecation_summary
end

17
18
19
20
21
22
23
24
25
26

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 17
def printer
  @printer ||= case deprecation_stream
               when File
                 ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
               when RaiseErrorStream
                 ImmediatePrinter.new(deprecation_stream, summary_stream, self)
               else
                 DelayedPrinter.new(deprecation_stream, summary_stream, self)
               end
end

40
41
42

# File 'lib/rspec/core/formatters/deprecation_formatter.rb', line 40
def start(example_count=nil)
  #no-op to fix #966
end