Class: RSpec::Expectations::Configuration

Inherits:

Object

• Object
• RSpec::Expectations::Configuration

show all

Defined in:

lib/rspec/expectations/configuration.rb

Overview

RSpec.configure do |rspec|
  rspec.expect_with :rspec do |c|
    # c is the config object
  end
end
# or

RSpec::Expectations.configuration

Constant Summary

NullBacktraceFormatter =

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

Null implementation of a backtrace formatter used by default when rspec-core is not loaded. Does no filtering.

Module.new do
  def self.format_backtrace(backtrace)
    backtrace
  end
end

Instance Attribute Summary (collapse)

• - (Object) backtrace_formatter

  Sets or gets the backtrace formatter.

• - (Object) color writeonly

  Indicates whether or not diffs should be colored.

• - (Object) include_chain_clauses_in_custom_matcher_descriptions writeonly

  Sets if custom matcher descriptions and failure messages should include clauses from methods defined using chain.

• - (Object) on_potential_false_positives

  Indicates what RSpec will do about matcher use which will potentially cause false positives in tests, generally you want to avoid such scenarios so this defaults to true.

Instance Method Summary (collapse)

• - (Object) add_should_and_should_not_to(*modules)

  Adds should and should_not to the given classes or modules.

• - (Boolean) color?

  Indicates whether or not diffs should be colored.

• - (Boolean) include_chain_clauses_in_custom_matcher_descriptions?

  Indicates whether or not custom matcher descriptions and failure messages should include clauses from methods defined using chain.

• - (Configuration) initialize constructor

  A new instance of Configuration.

• - (Array<Symbol>) syntax

  The list of configured syntaxes.

• - (Object) syntax=(values)

  Configures the supported syntax.

• - (Object) warn_about_potential_false_positives=(boolean)

  Configures whether RSpec will warn about matcher use which will potentially cause false positives in tests.

• - (Boolean) warn_about_potential_false_positives?

  Indicates whether RSpec will warn about matcher use which will potentially cause false positives in tests, generally you want to avoid such scenarios so this defaults to true.

29
30
31

# File 'lib/rspec/expectations/configuration.rb', line 29
def initialize
  @on_potential_false_positives = :warn
end

113

# File 'lib/rspec/expectations/configuration.rb', line 113
attr_writer :backtrace_formatter

80
81
82

# File 'lib/rspec/expectations/configuration.rb', line 80
def color=(value)
  @color = value
end

125
126
127

# File 'lib/rspec/expectations/configuration.rb', line 125
def include_chain_clauses_in_custom_matcher_descriptions=(value)
  @include_chain_clauses_in_custom_matcher_descriptions = value
end

177
178
179

# File 'lib/rspec/expectations/configuration.rb', line 177
def on_potential_false_positives
  @on_potential_false_positives
end

97
98
99
100
101

# File 'lib/rspec/expectations/configuration.rb', line 97
def add_should_and_should_not_to(*modules)
  modules.each do |mod|
    Expectations::Syntax.enable_should(mod)
  end
end

85
86
87

# File 'lib/rspec/expectations/configuration.rb', line 85
def color?
  ::RSpec.configuration.color_enabled?
end

130
131
132

# File 'lib/rspec/expectations/configuration.rb', line 130
def include_chain_clauses_in_custom_matcher_descriptions?
  @include_chain_clauses_in_custom_matcher_descriptions ||= false
end

unless RSpec::Matchers.configuration.syntax.include?(:expect)
  raise "this RSpec extension gem requires the rspec-expectations `:expect` syntax"
end

65
66
67
68
69
70

# File 'lib/rspec/expectations/configuration.rb', line 65
def syntax
  syntaxes = []
  syntaxes << :should if Expectations::Syntax.should_enabled?
  syntaxes << :expect if Expectations::Syntax.expect_enabled?
  syntaxes
end

RSpec.configure do |rspec|
  rspec.expect_with :rspec do |c|
    c.syntax = :should
    # or
    c.syntax = :expect
    # or
    c.syntax = [:should, :expect]
  end
end

45
46
47
48
49
50
51
52
53
54
55
56
57

# File 'lib/rspec/expectations/configuration.rb', line 45
def syntax=(values)
  if Array(values).include?(:expect)
    Expectations::Syntax.enable_expect
  else
    Expectations::Syntax.disable_expect
  end
  if Array(values).include?(:should)
    Expectations::Syntax.enable_should
  else
    Expectations::Syntax.disable_should
  end
end

153
154
155
156
157
158
159
160
161

# File 'lib/rspec/expectations/configuration.rb', line 153
def warn_about_potential_false_positives=(boolean)
  if boolean
    self.on_potential_false_positives = :warn
  elsif warn_about_potential_false_positives?
    self.on_potential_false_positives = :nothing
  else
    # no-op, handler is something else
  end
end

182
183
184

# File 'lib/rspec/expectations/configuration.rb', line 182
def warn_about_potential_false_positives?
  on_potential_false_positives == :warn
end