class RSpec::Matchers::Configuration
Provides configuration options for rspec-expectations.
Constants
- NullBacktraceFormatter
@api private
Attributes
Sets or gets the backtrace formatter. The backtrace formatter should implement `#format_backtrace(Array<String>)`. This is used to format backtraces of errors handled by the `raise_error` matcher.
If you are using rspec-core, rspec-core's backtrace formatting will be used (including respecting the presence or absence of the `–backtrace` option).
@overload #backtrace_formatter
@return [#format_backtrace] the backtrace formatter
@overload #backtrace_formatter=
@param value [#format_backtrace] sets the backtrace formatter
Public Instance Methods
Adds `should` and `should_not` to the given classes or modules. This can be used to ensure `should` works properly on things like proxy objects (particular `Delegator`-subclassed objects on 1.8).
@param [Array<Module>] modules the list of classes or modules
to add `should` and `should_not` to.
# File lib/rspec/matchers/configuration.rb, line 62 def add_should_and_should_not_to(*modules) modules.each do |mod| Expectations::Syntax.enable_should(mod) end end
# File lib/rspec/matchers/configuration.rb, line 82 def backtrace_formatter @backtrace_formatter ||= if defined?(::RSpec::Core::BacktraceFormatter) ::RSpec::Core::BacktraceFormatter else NullBacktraceFormatter end end
# File lib/rspec/matchers/configuration.rb, line 45 def color? ::RSpec.configuration.color_enabled? end
The list of configured syntaxes. @return [Array<Symbol>] the list of configured syntaxes.
# File lib/rspec/matchers/configuration.rb, line 35 def syntax syntaxes = [] syntaxes << :should if Expectations::Syntax.should_enabled? syntaxes << :expect if Expectations::Syntax.expect_enabled? syntaxes end
Configures the supported syntax. @param [Array<Symbol>, Symbol] values the syntaxes to enable @example
RSpec.configure do |rspec| rspec.expect_with :rspec do |c| c.syntax = :should # or c.syntax = :expect # or c.syntax = [:should, :expect] end end
# File lib/rspec/matchers/configuration.rb, line 19 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