Class: RSpec::Core::Configuration

Inherits:

Object

• Object
• RSpec::Core::Configuration

Includes:

Module.new, Hooks

Defined in:

lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb

Overview

Stores runtime configuration information.

Configuration options are loaded from multiple files and joined together with command-line switches and the ‘SPEC_OPTS` environment variable.

Precedence order (where later entries overwrite earlier entries on conflicts):

* Global (`$XDG_CONFIG_HOME/rspec/options`, or `~/.rspec` if it does
  not exist)
* Project-specific (`./.rspec`)
* Local (`./.rspec-local`)
* Command-line options
* `SPEC_OPTS`

For example, an option set in the local file will override an option set in your global file.

The global, project-specific and local files can all be overridden with a separate custom file using the –options command-line parameter.

Examples:

Standard settings

RSpec.configure do |c|
  c.drb          = true
  c.drb_port     = 1234
  c.default_path = 'behavior'
end

Hooks

RSpec.configure do |c|
  c.before(:suite)   { establish_connection }
  c.before(:example) { log_in_as :authorized }
  c.around(:example) { |ex| Database.transaction(&ex) }
end

See Also:

• RSpec.configure
• Hooks

Defined Under Namespace

Modules: ExposeCurrentExample Classes: DeprecationReporterBuffer, MustBeConfiguredBeforeExampleGroupsError

Constant Summary

Readers =

Module that holds ‘attr_reader` declarations. It’s in a separate module to allow us to override those methods and use ‘super`.

Module.new

MOCKING_ADAPTERS =

{
  :rspec    => :RSpec,
  :flexmock => :Flexmock,
  :rr       => :RR,
  :mocha    => :Mocha,
  :nothing  => :Null
}

UNKNOWN_STATUS =

"unknown".freeze

FAILED_STATUS =

"failed".freeze

PASSED_STATUS =

"passed".freeze

PENDING_STATUS =

"pending".freeze

VALID_STATUSES =

[UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]

DEFAULT_FORMATTER =

lambda { |string| string }

RAISE_ERROR_WARNING_NOTIFIER =

lambda { |message| raise message }

Instance Attribute Summary

• #backtrace_formatter ⇒ Object readonly
• #bisect_runner ⇒ Symbol

  Determines which bisect runner implementation gets used to run subsets of the suite during a bisection.

• #color ⇒ Boolean deprecated Deprecated.

  No longer recommended because of complex behavior. Instead, rely on the fact that TTYs will display color by default, or set #color_mode to :on to display color on a non-TTY output.

• #color_mode ⇒ Boolean

  The mode for determining whether to display output in color.

• #default_color ⇒ Symbol

  The default output color.

• #default_path ⇒ String

  Path to use if no path is provided to the ‘rspec` command (default: `“spec”`).

• #detail_color ⇒ Symbol

  Color used to print details.

• #disable_monkey_patching ⇒ Object
• #drb ⇒ Boolean

  Run examples over DRb (default: ‘false`).

• #drb_port ⇒ Object

  The drb_port (default: nil).

• #dry_run ⇒ Object

  Prints the formatter output of your suite without running any examples or hooks.

• #error_exit_code ⇒ Integer

  The exit code to return if there are any errors outside examples (default: failure_exit_code).

• #error_stream ⇒ Object

  Default: ‘$stderr`.

• #example_status_persistence_file_path ⇒ Object

  The file path to use for persisting example statuses.

• #exclude_pattern ⇒ String

  Exclude files matching this pattern.

• #fail_fast ⇒ Object

  If specified, indicates the number of failures required before cleaning up and exit (default: ‘nil`).

• #fail_if_no_examples ⇒ Boolean

  Whether or not to fail when there are no RSpec examples (default: false).

• #failure_color ⇒ Symbol

  Color to use to indicate failure.

• #failure_exit_code ⇒ Integer

  The exit code to return if there are any failures (default: 1).

• #files_to_run ⇒ Array

  The spec files RSpec will run.

• #filter_manager ⇒ Object
• #fixed_color ⇒ Symbol

  Color used when a pending example is fixed.

• #libs ⇒ Array<String>

  Returns dirs that have been prepended to the load path by the ‘-I` command line option.

• #loaded_spec_files ⇒ Object readonly
• #max_displayed_failure_line_count ⇒ Object

  Maximum count of failed source lines to display in the failure reports.

• #only_failures ⇒ Object (also: #only_failures?) readonly

  Indicates if the ‘–only-failures` (or `–next-failure`) flag is being used.

• #ordering_manager ⇒ Object readonly
• #output_stream ⇒ IO, String

  Determines where RSpec will send its output.

• #pattern ⇒ String

  Load files matching this pattern (default: ‘’**,/<strong>/*</strong>/*_spec.rb’‘).

• #pending_color ⇒ Symbol

  Color to use to print pending examples.

• #profile_examples ⇒ Object private

  Defaults ‘profile_examples` to 10 examples when `@profile_examples` is `true`.

• #project_source_dirs ⇒ Array<String>

  Specifies which directories contain the source code for your project.

• #requires ⇒ Array<String>

  Indicates files configured to be required.

• #run_all_when_everything_filtered ⇒ Object deprecated Deprecated.

  Use #filter_run_when_matching instead for the specific filters that you want to be ignored if none match.

• #shared_context_metadata_behavior ⇒ Object

  Configures how RSpec treats metadata passed as part of a shared example group definition.

• #silence_filter_announcements ⇒ Object

  Don’t print filter info i.e.

• #static_config_filter_manager ⇒ Object
• #success_color ⇒ Symbol

  Color to use to indicate success.

• #threadsafe ⇒ Object

  Use threadsafe options where available.

• #world ⇒ Object

Class Method Summary

• .add_read_only_setting(name, opts = {}) ⇒ Object

  As ‘add_setting` but only add the reader.

• .add_setting(name, opts = {}) ⇒ Object

  Invoked by the ‘add_setting` instance method.

• .define_alias(name, alias_name) ⇒ Object
• .define_predicate(name) ⇒ Object
• .define_reader(name) ⇒ Object
• .delegate_to_ordering_manager(*methods) ⇒ Object

Instance Method Summary

• #add_formatter(formatter, output = output_wrapper) ⇒ Object (also: #formatter=)

  Adds a formatter to the set RSpec will use for this run.

• #add_setting(name, opts = {}) ⇒ Object

  Adds a custom setting to the RSpec.configuration object.

• #after(scope = nil, *meta, &block) ⇒ Object (also: #prepend_after)

  Defines a ‘after` hook.

• #alias_example_group_to(new_name, *args) ⇒ Object

  Creates a method that defines an example group with the provided metadata.

• #alias_example_to(name, *args) ⇒ Object

  Creates a method that delegates to ‘example` including the submitted `args`.

• #alias_it_behaves_like_to(new_name, report_label = '') ⇒ Object (also: #alias_it_should_behave_like_to)

  Define an alias for it_should_behave_like that allows different language (like “it_has_behavior” or “it_behaves_like”) to be employed when including shared examples.

• #append_after(scope = nil, *meta, &block) ⇒ Object

  Adds ‘block` to the end of the list of `after` blocks in the same scope (`:example`, `:context`, or `:suite`), in contrast to #after, which adds the hook to the start of the list.

• #apply_derived_metadata_to(metadata) ⇒ Object
• #around(scope = nil, *meta, &block) ⇒ Object

  Registers ‘block` as an `around` hook.

• #backtrace_exclusion_patterns ⇒ Array<Regexp>

  Regexps used to exclude lines from backtraces.

• #backtrace_exclusion_patterns=(patterns) ⇒ Object

  Set regular expressions used to exclude lines in backtrace.

• #backtrace_inclusion_patterns ⇒ Array<Regexp>

  Regexps used to include lines in backtraces.

• #backtrace_inclusion_patterns=(patterns) ⇒ Object

  Set regular expressions used to include lines in backtrace.

• #before(scope = nil, *meta, &block) ⇒ Object (also: #append_before)

  Defines a ‘before` hook.

• #bisect_runner_class ⇒ Object
• #color_enabled?(output = output_stream) ⇒ Boolean

  Check if color is enabled for a particular output.

• #configure_example(example, example_hooks) ⇒ Object

  Used internally to extend the singleton class of a single example’s example group instance with modules using ‘include` and/or `extend`.

• #configure_expectation_framework ⇒ Object
• #configure_group(group) ⇒ Object

  Used internally to extend a group with modules using ‘include`, `prepend` and/or `extend`.

• #configure_mock_framework ⇒ Object
• #default_formatter ⇒ Object

  The formatter that will be used if no formatter has been set.

• #default_formatter=(value) ⇒ Object

  Sets a fallback formatter to use if none other has been set.

• #define_derived_metadata(*filters) {|metadata| ... } ⇒ Object

  Defines a callback that can assign derived metadata values.

• #deprecation_stream ⇒ IO, String

  Determines where deprecation warnings are printed.

• #deprecation_stream=(value) ⇒ Object

  Determines where deprecation warnings are printed.

• #disable_monkey_patching! ⇒ Object

  Enables zero monkey patching mode for RSpec.

• #exclusion_filter ⇒ Object

  Returns the ‘exclusion_filter`.

• #exclusion_filter=(filter) ⇒ Object

  Clears and reassigns the ‘exclusion_filter`.

• #expect_with(*frameworks) ⇒ Object

  Sets the expectation framework module(s) to be included in each example group.

• #expectation_framework=(framework) ⇒ Object

  Delegates to expect_with(framework).

• #expectation_frameworks ⇒ Object

  Returns the configured expectation framework adapter module(s).

• #expose_current_running_example_as(method_name) ⇒ Object

  Exposes the current running example via the named helper method.

• #expose_dsl_globally=(value) ⇒ Object

  Use this to expose the core RSpec DSL via ‘Module` and the `main` object.

• #expose_dsl_globally? ⇒ Boolean

  Indicates if the DSL has been exposed off of modules and ‘main`.

• #extend(mod, *filters) ⇒ Object

  Tells RSpec to extend example groups with ‘mod`.

• #files_or_directories_to_run=(*files) ⇒ Object
• #filter_gems_from_backtrace(*gem_names) ⇒ Object

  Adds #backtrace_exclusion_patterns that will filter lines from the named gems from backtraces.

• #filter_run_excluding(*args) ⇒ Object

  Adds key/value pairs to the ‘exclusion_filter`.

• #filter_run_including(*args) ⇒ Object (also: #filter_run)

  Adds key/value pairs to the ‘inclusion_filter`.

• #filter_run_when_matching(*args) ⇒ Object

  Applies the provided filter only if any of examples match, in constrast to #filter_run, which always applies even if no examples match, in which case no examples will be run.

• #force(hash) ⇒ Object

  Used to set higher priority option values from the command line.

• #format_docstrings(&block) ⇒ Object

  Formats the docstring output using the block provided.

• #format_docstrings_block ⇒ Object
• #formatter_loader ⇒ Object
• #formatters ⇒ Array

  Returns a duplicate of the formatters currently loaded in the ‘FormatterLoader` for introspection.

• #full_backtrace=(true_or_false) ⇒ Object

  Toggle full backtrace.

• #full_backtrace? ⇒ Boolean

  Check if full backtrace is enabled.

• #full_description ⇒ Array

  Full description filter.

• #full_description=(description) ⇒ Object

  Run examples matching on ‘description` in all files to run.

• #hooks ⇒ Object

  Holds the various registered hooks.

• #in_project_source_dir_regex ⇒ Object
• #include(mod, *filters) ⇒ Object

  Tells RSpec to include ‘mod` in example groups.

• #include_context(shared_group_name, *filters) ⇒ Object

  Tells RSpec to include the named shared example group in example groups.

• #inclusion_filter ⇒ Object (also: #filter)

  Returns the ‘inclusion_filter`.

• #inclusion_filter=(filter) ⇒ Object (also: #filter=)

  Clears and reassigns the ‘inclusion_filter`.

• #initialize ⇒ Configuration constructor

  Build an object to store runtime configuration options and set defaults.

• #last_run_statuses ⇒ Object
• #load_spec_files ⇒ Object
• #mock_framework ⇒ Symbol

  Returns the configured mock framework adapter module.

• #mock_framework=(framework) ⇒ Object

  Delegates to mock_framework=(framework).

• #mock_with(framework) ⇒ Object

  Sets the mock framework adapter module.

• #on_example_group_definition(&block) ⇒ Object

  Invokes block before defining an example group.

• #on_example_group_definition_callbacks ⇒ Object private

  Returns an array of blocks to call before defining an example group.

• #only_failures_but_not_configured? ⇒ Boolean
• #order=(value) ⇒ Object

  Sets the default global ordering strategy.

• #prepend(mod, *filters) ⇒ Object

  Tells RSpec to prepend example groups with ‘mod`.

• #prepend_before(scope = nil, *meta, &block) ⇒ Object

  Adds ‘block` to the start of the list of `before` blocks in the same scope (`:example`, `:context`, or `:suite`), in contrast to #before, which adds the hook to the end of the list.

• #raise_errors_for_deprecations! ⇒ Object

  Turns deprecation warnings into errors, in order to surface the full backtrace of the call site.

• #raise_on_warning=(value) ⇒ Object

  Turns warnings into errors.

• #register_ordering(name) {|list| ... } ⇒ Object

  Registers a named ordering strategy that can later be used to order an example group’s subgroups by adding ‘:order => <name>` metadata to the example group.

• #reporter ⇒ RSpec::Core::Reporter

  The currently configured reporter.

• #reset ⇒ Object
• #reset_filters ⇒ Object
• #reset_reporter ⇒ Object
• #seed ⇒ Object

  Seed for random ordering (default: generated randomly each run).

• #seed=(value) ⇒ Object

  Sets the seed value and sets the default global ordering to random.

• #spec_files_with_failures ⇒ Object
• #treat_symbols_as_metadata_keys_with_true_values=(_value) ⇒ Object deprecated Deprecated.

  This config option was added in RSpec 2 to pave the way for this being the default behavior in RSpec 3. Now this option is a no-op.

• #warnings=(value) ⇒ Object

  Set Ruby warnings on or off.

• #warnings? ⇒ Boolean

  Whether or not ruby warnings are enabled.

• #when_first_matching_example_defined(*filters) ⇒ Object

  Defines a callback that runs after the first example with matching metadata is defined.

• #with_suite_hooks ⇒ Object

Constructor Details

#initialize ⇒ Configuration

Build an object to store runtime configuration options and set defaults

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 509

def initialize
  # rubocop:disable Style/GlobalVars
  @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now
  # rubocop:enable Style/GlobalVars
  @expectation_frameworks = []
  @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)
  @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)
  @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)

  @bisect_runner = RSpec::Support::RubyFeatures.fork_supported? ? :fork : :shell
  @bisect_runner_class = nil

  @before_suite_hooks = []
  @after_suite_hooks  = []

  @mock_framework = nil
  @files_or_directories_to_run = []
  @loaded_spec_files = Set.new
  @color = false
  @color_mode = :automatic
  @pattern = '**{,/*/**}/*_spec.rb'
  @exclude_pattern = ''
  @failure_exit_code = 1
  @error_exit_code = nil # so it can be overridden by failure exit code
  @fail_if_no_examples = false
  @spec_files_loaded = false

  @backtrace_formatter = BacktraceFormatter.new

  @default_path = 'spec'
  @project_source_dirs = %w[ spec lib app ]
  @deprecation_stream = $stderr
  @output_stream = $stdout
  @reporter = nil
  @reporter_buffer = nil
  @filter_manager = FilterManager.new
  @static_config_filter_manager = FilterManager.new
  @ordering_manager = Ordering::ConfigurationManager.new
  @preferred_options = {}
  @failure_color = :red
  @success_color = :green
  @pending_color = :yellow
  @default_color = :white
  @fixed_color = :blue
  @detail_color = :cyan
  @profile_examples = false
  @requires = []
  @libs = []
  @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)
  @threadsafe = true
  @max_displayed_failure_line_count = 10
  @world = World::Null
  @shared_context_metadata_behavior = :trigger_inclusion

  define_built_in_hooks
end

Instance Attribute Details

#backtrace_formatter ⇒ Object (readonly)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 503

def backtrace_formatter
  @backtrace_formatter
end

#bisect_runner ⇒ Symbol

Note:

This option will only be used by ‘–bisect` if you set it in a file loaded via `–require`.

Determines which bisect runner implementation gets used to run subsets of the suite during a bisection. Your choices are:

- `:shell`: Performs a spec run by shelling out, booting RSpec and your
  application environment each time. This runner is the most widely
  compatible runner, but is not as fast. On platforms that do not
  support forking, this is the default.
- `:fork`: Pre-boots RSpec and your application environment in a parent
  process, and then forks a child process for each spec run. This runner
  tends to be significantly faster than the `:shell` runner but cannot
  be used in some situations. On platforms that support forking, this
  is the default. If you use this runner, you should ensure that all
  of your one-time setup logic goes in a `before(:suite)` hook instead
  of getting run at the top-level of a file loaded by `--require`.

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 480

def bisect_runner
  @bisect_runner
end

#color ⇒ Boolean

Deprecated.

No longer recommended because of complex behavior. Instead, rely on the fact that TTYs will display color by default, or set #color_mode to :on to display color on a non-TTY output.

Enables color output if the output is a TTY. As of RSpec 3.6, this is the default behavior and this option is retained only for backwards compatibility.

Returns:

• (Boolean)

See Also:

• #color_mode
• #color_enabled?

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 901

def color
  value_for(:color) { @color }
end

#color_mode ⇒ Boolean

The mode for determining whether to display output in color. One of:

• :automatic - the output will be in color if the output is a TTY (the default)

• :on - the output will be in color, whether or not the output is a TTY

• :off - the output will not be in color

Returns:

• (Boolean)

See Also:

• #color_enabled?

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 914

def color_mode
  value_for(:color_mode) { @color_mode }
end

#default_color ⇒ Symbol

The default output color. Defaults to ‘:white` but can be set to one of the following: `[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]`

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 358

add_setting :default_color

#default_path ⇒ String

Note:

Other scripts invoking ‘rspec` indirectly will ignore this setting.

Path to use if no path is provided to the ‘rspec` command (default: `“spec”`). Allows you to just type `rspec` instead of `rspec spec` to run all the examples in the `spec` directory.

Returns:

• (String)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 120

add_read_only_setting :default_path

#detail_color ⇒ Symbol

Color used to print details. Defaults to ‘:cyan` but can be set to one of the following: `[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]`

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 372

add_setting :detail_color

#disable_monkey_patching ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1854

def disable_monkey_patching
  @disable_monkey_patching
end

#drb ⇒ Boolean

Run examples over DRb (default: ‘false`). RSpec doesn’t supply the DRb server, but you can use tools like spork.

Returns:

• (Boolean)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 130

add_setting :drb

#drb_port ⇒ Object

The drb_port (default: nil).

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 134

add_setting :drb_port

#dry_run ⇒ Object

Prints the formatter output of your suite without running any examples or hooks.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 238

add_setting :dry_run

#error_exit_code ⇒ Integer

The exit code to return if there are any errors outside examples (default: failure_exit_code)

Returns:

• (Integer)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 248

add_setting :error_exit_code

#error_stream ⇒ Object

Default: ‘$stderr`.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 138

add_setting :error_stream

#example_status_persistence_file_path ⇒ String #example_status_persistence_file_path=(value) ⇒ Object

The file path to use for persisting example statuses. Necessary for the ‘–only-failures` and `–next-failure` CLI options.

Overloads:

• #example_status_persistence_file_path ⇒ String

  Returns the file path.

  Returns:

  • (String) —

    the file path

• #example_status_persistence_file_path=(value) ⇒ Object

  Parameters:

  • value (String) —

    the file path

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 188

define_reader :example_status_persistence_file_path

#exclude_pattern ⇒ String

Exclude files matching this pattern.

Returns:

• (String)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 300

define_reader :exclude_pattern

#fail_fast ⇒ Object

If specified, indicates the number of failures required before cleaning up and exit (default: ‘nil`). Can also be `true` to fail and exit on first failure

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 211

define_reader :fail_fast

#fail_if_no_examples ⇒ Boolean

Whether or not to fail when there are no RSpec examples (default: false).

Returns:

• (Boolean)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 253

add_setting :fail_if_no_examples

#failure_color ⇒ Symbol

Color to use to indicate failure. Defaults to ‘:red` but can be set to one of the following: `[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]`

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 351

add_setting :failure_color

#failure_exit_code ⇒ Integer

The exit code to return if there are any failures (default: 1).

Returns:

• (Integer)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 243

add_setting :failure_exit_code

#files_to_run ⇒ Array

The spec files RSpec will run.

Returns:

• (Array) —

  specified files about to run

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1075

def files_to_run
  @files_to_run ||= get_files_to_run(@files_or_directories_to_run)
end

#filter_manager ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 499

def filter_manager
  @filter_manager
end

#fixed_color ⇒ Symbol

Color used when a pending example is fixed. Defaults to ‘:blue` but can be set to one of the following: `[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]`

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 365

add_setting :fixed_color

#libs ⇒ Array<String>

Returns dirs that have been prepended to the load path by the ‘-I` command line option.

Returns:

• (Array<String>)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 264

define_reader :libs

#loaded_spec_files ⇒ Object (readonly)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 503

def loaded_spec_files
  @loaded_spec_files
end

#max_displayed_failure_line_count ⇒ Object

Maximum count of failed source lines to display in the failure reports. (default ‘10`). return [Integer]

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 459

add_setting :max_displayed_failure_line_count

#only_failures ⇒ Object (readonly) Also known as: only_failures?

Indicates if the ‘–only-failures` (or `–next-failure`) flag is being used.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 199

define_reader :only_failures

#ordering_manager ⇒ Object (readonly)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 503

def ordering_manager
  @ordering_manager
end

#output_stream ⇒ IO, String

Determines where RSpec will send its output. Default: ‘$stdout`.

Returns:

• (IO, String)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 270

define_reader :output_stream

#pattern ⇒ String

Load files matching this pattern (default: ‘’**,/<strong>/*</strong>/*_spec.rb’‘).

Returns:

• (String)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 289

define_reader :pattern

#pending_color ⇒ Symbol

Color to use to print pending examples. Defaults to ‘:yellow` but can be set to one of the following: `[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]`

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 344

add_setting :pending_color

#profile_examples ⇒ Object

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.

Defaults ‘profile_examples` to 10 examples when `@profile_examples` is `true`.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 322

attr_writer :profile_examples

#project_source_dirs ⇒ Array<String>

Specifies which directories contain the source code for your project. When a failure occurs, RSpec looks through the backtrace to find a a line of source to print. It first looks for a line coming from one of the project source directories so that, for example, it prints the expectation or assertion call rather than the source code from the expectation or assertion framework.

Returns:

• (Array<String>)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 316

add_setting :project_source_dirs

#requires ⇒ Array<String>

Indicates files configured to be required.

Returns:

• (Array<String>)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 258

define_reader :requires

#run_all_when_everything_filtered ⇒ Object

Deprecated.

Use #filter_run_when_matching instead for the specific filters that you want to be ignored if none match.

Run all examples if none match the configured filters (default: ‘false`).

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 330

add_setting :run_all_when_everything_filtered

#shared_context_metadata_behavior ⇒ :trigger_inclusion, :apply_to_host_groups #shared_context_metadata_behavior=(value) ⇒ Object

Configures how RSpec treats metadata passed as part of a shared example group definition. For example, given this shared example group definition:

RSpec.shared_context "uses DB", :db => true do
  around(:example) do |ex|
    MyORM.transaction(:rollback => true, &ex)
  end
end

…there are two ways RSpec can treat the ‘:db => true` metadata, each of which has a corresponding config option:

1. ‘:trigger_inclusion`: this shared context will be implicitly included in any groups (or examples) that have `:db => true` metadata.

2. ‘:apply_to_host_groups`: the metadata will be inherited by the metadata hash of all host groups and examples.

‘:trigger_inclusion` is the legacy behavior from before RSpec 3.5 but should be considered deprecated. Instead, you can explicitly include a group with `include_context`:

RSpec.describe "My model" do
  include_context "uses DB"
end

…or you can configure RSpec to include the context based on matching metadata using an API that mirrors configured module inclusion:

RSpec.configure do |rspec|
  rspec.include_context "uses DB", :db => true
end

‘:apply_to_host_groups` is a new feature of RSpec 3.5 and will be the only supported behavior in RSpec 4.

Overloads:

• #shared_context_metadata_behavior ⇒ :trigger_inclusion, :apply_to_host_groups

  Returns the configured behavior.

  Returns:

  • (:trigger_inclusion, :apply_to_host_groups) —

    the configured behavior

• #shared_context_metadata_behavior=(value) ⇒ Object

  Parameters:

  • value (:trigger_inclusion, :apply_to_host_groups) —

    sets the configured behavior

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 432

define_reader :shared_context_metadata_behavior

#silence_filter_announcements ⇒ Object

Don’t print filter info i.e. “Run options: include :focus=>true” (default ‘false`). return [Boolean]

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 378

add_setting :silence_filter_announcements

#static_config_filter_manager ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 501

def static_config_filter_manager
  @static_config_filter_manager
end

#success_color ⇒ Symbol

Color to use to indicate success. Defaults to ‘:green` but can be set to one of the following: `[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]`

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 337

add_setting :success_color

#threadsafe ⇒ Object

Use threadsafe options where available. Currently this will place a mutex around memoized values such as let blocks. return [Boolean]

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 453

add_setting :threadsafe

#world ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 499

def world
  @world
end

Class Method Details

.add_read_only_setting(name, opts = {}) ⇒ Object

As ‘add_setting` but only add the reader.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 100

def self.add_read_only_setting(name, opts={})
  raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
  define_reader name
  define_predicate name
end

.add_setting(name, opts = {}) ⇒ Object

Invoked by the ‘add_setting` instance method. Use that method on a `Configuration` instance rather than this class method.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 87

def self.add_setting(name, opts={})
  raise "Use the instance add_setting method if you want to set a default" if opts.key?(:default)
  attr_writer name
  add_read_only_setting name

  Array(opts[:alias_with]).each do |alias_name|
    define_alias(name, alias_name)
  end
end

.define_alias(name, alias_name) ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 70

def self.define_alias(name, alias_name)
  alias_method alias_name, name
  alias_method "#{alias_name}=", "#{name}="
  define_predicate alias_name
end

.define_predicate(name) ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 77

def self.define_predicate(name)
  define_method "#{name}?" do
    !!send(name)
  end
end

.define_reader(name) ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 60

def self.define_reader(name)
  Readers.class_eval do
    remove_method name if method_defined?(name)
    attr_reader name
  end

  define_method(name) { value_for(name) { super() } }
end

.delegate_to_ordering_manager(*methods) ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1645

def self.delegate_to_ordering_manager(*methods)
  methods.each do |method|
    define_method method do |*args, &block|
      ordering_manager.__send__(method, *args, &block)
    end
  end
end

Instance Method Details

#add_formatter(formatter) ⇒ Object #add_formatter(formatter, output) ⇒ Object Also known as: formatter=

Adds a formatter to the set RSpec will use for this run.

Parameters:

• formatter (Class, String, Object) —

  formatter to use. Can be any of the string values supported from the CLI (‘p`/`progress`, `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`), any class that implements the formatter protocol and has registered itself with RSpec as a formatter, or a formatter instance.

• output (String, IO) (defaults to: output_wrapper) —

  where the formatter will write its output. Can be an IO object or a string path to a file. If not provided, the configured ‘output_stream` (`$stdout`, by default) will be used.

See Also:

• Formatters::Protocol

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 975

def add_formatter(formatter, output=output_wrapper)
  formatter_loader.add(formatter, output)
end

#add_setting(name) ⇒ Object #add_setting(name, opts) ⇒ Object

Adds a custom setting to the RSpec.configuration object.

RSpec.configuration.add_setting :foo

Used internally and by extension frameworks like rspec-rails, so they can add config settings that are domain specific. For example:

RSpec.configure do |c|
  c.add_setting :use_transactional_fixtures,
    :default => true,
    :alias_with => :use_transactional_examples
end

‘add_setting` creates three methods on the configuration object, a setter, a getter, and a predicate:

RSpec.configuration.foo=(value)
RSpec.configuration.foo
RSpec.configuration.foo? # Returns true if foo returns anything but nil or false.

Parameters:

• opts (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (opts):

• :default (Symbol) —

  Set a default value for the generated getter and predicate methods:

  add_setting(:foo, :default => "default value")
  

• :alias_with (Symbol) —

  Use ‘:alias_with` to alias the setter, getter, and predicate to another name, or names:

  add_setting(:foo, :alias_with => :bar)
  add_setting(:foo, :alias_with => [:bar, :baz])
  

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 638

def add_setting(name, opts={})
  default = opts.delete(:default)
  (class << self; self; end).class_exec do
    add_setting(name, opts)
  end
  __send__("#{name}=", default) if default
end

#after(scope = nil, *meta, &block) ⇒ Object Also known as: prepend_after

Defines a ‘after` hook. See Hooks#after for full docs.

This method differs from Hooks#after in only one way: it supports the ‘:suite` scope. Hooks with the `:suite` scope will be run once after the last example of the entire suite is executed. Conditions passed along with `:suite` are effectively ignored.

See Also:

• #append_after
• #before
• #prepend_before

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2004

def after(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})
  end || begin
    # defeat Ruby 2.5 lazy proc allocation to ensure
    # the methods below are passed the same proc instances
    # so `Hook` equality is preserved. For more info, see:
    # https://bugs.ruby-lang.org/issues/14045#note-5
    block.__id__

    add_hook_to_existing_matching_groups(meta, scope) { |g| g.after(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

#alias_example_group_to(new_name, *args) ⇒ Object

Note:

The defined aliased will also be added to the top level (e.g. ‘main` and from within modules) if `expose_dsl_globally` is set to true.

Creates a method that defines an example group with the provided metadata. Can be used to define example group/metadata shortcuts.

Examples:

RSpec.configure do |config|
  config.alias_example_group_to :describe_model, :type => :model
end

shared_context_for "model tests", :type => :model do
  # define common model test helper methods, `let` declarations, etc
end

# This lets you do this:

RSpec.describe_model User do
end

# ... which is the equivalent of

RSpec.describe User, :type => :model do
end

See Also:

• #alias_example_to
• #expose_dsl_globally=

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1188

def alias_example_group_to(new_name, *args)
  extra_options = Metadata.build_hash_from(args)
  RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)
end

#alias_example_to(name, *args) ⇒ Object

Note:

The specific example alias below (‘pending`) is already defined for you.

Note:

Use with caution. This extends the language used in your specs, but does not add any additional documentation. We use this in RSpec to define methods like ‘focus` and `xit`, but we also add docs for those methods.

Creates a method that delegates to ‘example` including the submitted `args`. Used internally to add variants of `example` like `pending`:

Examples:

RSpec.configure do |config|
  config.alias_example_to :pending, :pending => true
end

# This lets you do this:

RSpec.describe Thing do
  pending "does something" do
    thing = Thing.new
  end
end

# ... which is the equivalent of

RSpec.describe Thing do
  it "does something", :pending => true do
    thing = Thing.new
  end
end

Parameters:

• name (String) —

  example name alias

• args (Array<Symbol>, Hash) —

  metadata for the generated example

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1156

def alias_example_to(name, *args)
  extra_options = Metadata.build_hash_from(args)
  RSpec::Core::ExampleGroup.define_example_method(name, extra_options)
end

#alias_it_behaves_like_to(new_name, report_label = '') ⇒ Object Also known as: alias_it_should_behave_like_to

Note:

Use with caution. This extends the language used in your specs, but does not add any additional documentation. We use this in RSpec to define ‘it_should_behave_like` (for backward compatibility), but we also add docs for that method.

Define an alias for it_should_behave_like that allows different language (like “it_has_behavior” or “it_behaves_like”) to be employed when including shared examples.

Examples:

RSpec.configure do |config|
  config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')
end

# allows the user to include a shared example group like:

RSpec.describe Entity do
  it_has_behavior 'sortability' do
    let(:sortable) { Entity.new }
  end
end

# which is reported in the output as:
# Entity
#   has behavior: sortability
#     ...sortability examples here

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1219

def alias_it_behaves_like_to(new_name, report_label='')
  RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)
end

#append_after(scope = nil, *meta, &block) ⇒ Object

Adds ‘block` to the end of the list of `after` blocks in the same scope (`:example`, `:context`, or `:suite`), in contrast to #after, which adds the hook to the start of the list.

See Hooks#after for full ‘after` hook docs.

This method differs from Hooks#append_after in only one way: it supports the ‘:suite` scope. Hooks with the `:suite` scope will be run once after the last example of the entire suite is executed. Conditions passed along with `:suite` are effectively ignored.

See Also:

• #append_after
• #before
• #prepend_before

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2034

def append_after(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @after_suite_hooks << Hooks::AfterHook.new(block, {})
  end || begin
    # defeat Ruby 2.5 lazy proc allocation to ensure
    # the methods below are passed the same proc instances
    # so `Hook` equality is preserved. For more info, see:
    # https://bugs.ruby-lang.org/issues/14045#note-5
    block.__id__

    add_hook_to_existing_matching_groups(meta, scope) { |g| g.append_after(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

#apply_derived_metadata_to(metadata) ⇒ Object

Raises:

• (SystemStackError)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1914

def apply_derived_metadata_to(metadata)
  already_run_blocks = Set.new

  # We loop and attempt to re-apply metadata blocks to support cascades
  # (e.g. where a derived bit of metadata triggers the application of
  # another piece of derived metadata, etc)
  #
  # We limit our looping to 200 times as a way to detect infinitely recursing derived metadata blocks.
  # It's hard to imagine a valid use case for a derived metadata cascade greater than 200 iterations.
  200.times do
    return if @derived_metadata_blocks.items_for(metadata).all? do |block|
      already_run_blocks.include?(block).tap do |skip_block|
        block.call(metadata) unless skip_block
        already_run_blocks << block
      end
    end
  end

  # If we got here, then `@derived_metadata_blocks.items_for(metadata).all?` never returned
  # `true` above and we treat this as an attempt to recurse infinitely. It's better to fail
  # with a clear # error than hang indefinitely, which is what would happen if we didn't limit
  # the looping above.
  raise SystemStackError, "Attempted to recursively derive metadata indefinitely."
end

#around(scope = nil, *meta, &block) ⇒ Object

Registers ‘block` as an `around` hook.

See Hooks#around for full ‘around` hook docs.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2052

def around(scope=nil, *meta, &block)
  # defeat Ruby 2.5 lazy proc allocation to ensure
  # the methods below are passed the same proc instances
  # so `Hook` equality is preserved. For more info, see:
  # https://bugs.ruby-lang.org/issues/14045#note-5
  block.__id__

  add_hook_to_existing_matching_groups(meta, scope) { |g| g.around(scope, *meta, &block) }
  super(scope, *meta, &block)
end

#backtrace_exclusion_patterns ⇒ Array<Regexp>

Regexps used to exclude lines from backtraces.

Excludes lines from ruby (and jruby) source, installed gems, anything in any “bin” directory, and any of the RSpec libs (outside gem installs) by default.

You can modify the list via the getter, or replace it with the setter.

To override this behaviour and display a full backtrace, use ‘–backtrace` on the command line, in a `.rspec` file, or in the `rspec_options` attribute of RSpec’s rake task.

Returns:

• (Array<Regexp>)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 676

def backtrace_exclusion_patterns
  @backtrace_formatter.exclusion_patterns
end

#backtrace_exclusion_patterns=(patterns) ⇒ Object

Set regular expressions used to exclude lines in backtrace.

Parameters:

• patterns (Array<Regexp>) —

  set backtrace_formatter exlusion_patterns

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 682

def backtrace_exclusion_patterns=(patterns)
  @backtrace_formatter.exclusion_patterns = patterns
end

#backtrace_inclusion_patterns ⇒ Array<Regexp>

Regexps used to include lines in backtraces.

Defaults to [Regexp.new Dir.getwd].

Lines that match an exclusion and an inclusion pattern will be included.

You can modify the list via the getter, or replace it with the setter.

Returns:

• (Array<Regexp>)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 695

def backtrace_inclusion_patterns
  @backtrace_formatter.inclusion_patterns
end

#backtrace_inclusion_patterns=(patterns) ⇒ Object

Set regular expressions used to include lines in backtrace.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 701

def backtrace_inclusion_patterns=(patterns)
  @backtrace_formatter.inclusion_patterns = patterns
end

#before(scope = nil, *meta, &block) ⇒ Object Also known as: append_before

Defines a ‘before` hook. See Hooks#before for full docs.

This method differs from Hooks#before in only one way: it supports the ‘:suite` scope. Hooks with the `:suite` scope will be run once before the first example of the entire suite is executed. Conditions passed along with `:suite` are effectively ignored.

See Also:

• #prepend_before
• #after
• #append_after

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1949

def before(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @before_suite_hooks << Hooks::BeforeHook.new(block, {})
  end || begin
    # defeat Ruby 2.5 lazy proc allocation to ensure
    # the methods below are passed the same proc instances
    # so `Hook` equality is preserved. For more info, see:
    # https://bugs.ruby-lang.org/issues/14045#note-5
    block.__id__

    add_hook_to_existing_matching_groups(meta, scope) { |g| g.before(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

#bisect_runner_class ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2098

def bisect_runner_class
  @bisect_runner_class ||= begin
    case bisect_runner
    when :fork
      RSpec::Support.require_rspec_core 'bisect/fork_runner'
      Bisect::ForkRunner
    when :shell
      RSpec::Support.require_rspec_core 'bisect/shell_runner'
      Bisect::ShellRunner
    else
      raise "Unsupported value for `bisect_runner` (#{bisect_runner.inspect}). " \
            "Only `:fork` and `:shell` are supported."
    end
  end
end

#color_enabled?(output = output_stream) ⇒ Boolean

Check if color is enabled for a particular output.

Parameters:

• output (IO) (defaults to: output_stream) —

  an output stream to use, defaults to the current ‘output_stream`

Returns:

• (Boolean)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 922

def color_enabled?(output=output_stream)
  case color_mode
  when :on then true
  when :off then false
  else # automatic
    output_to_tty?(output) || (color && tty?)
  end
end

#configure_example(example, example_hooks) ⇒ Object

Used internally to extend the singleton class of a single example’s example group instance with modules using ‘include` and/or `extend`.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1556

def configure_example(example, example_hooks)
  example_hooks.register_global_singleton_context_hooks(example, hooks)
  singleton_group = example.example_group_instance.singleton_class

  # We replace the metadata so that SharedExampleGroupModule#included
  # has access to the example's metadata[:location].
  singleton_group.with_replaced_metadata(example.metadata) do
    modules = @include_modules.items_for(example.metadata)
    modules.each do |mod|
      safe_include(mod, example.example_group_instance.singleton_class)
    end

    MemoizedHelpers.define_helpers_on(singleton_group) unless modules.empty?
  end
end

#configure_expectation_framework ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1596

def configure_expectation_framework
  expectation_frameworks.each do |framework|
    RSpec::Core::ExampleGroup.__send__(:include, framework)
  end
  conditionally_disable_expectations_monkey_patching
end

#configure_group(group) ⇒ Object

Used internally to extend a group with modules using ‘include`, `prepend` and/or `extend`.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1544

def configure_group(group)
  group.hooks.register_globals(group, hooks)

  configure_group_with group, @include_modules, :safe_include
  configure_group_with group, @extend_modules,  :safe_extend
  configure_group_with group, @prepend_modules, :safe_prepend
end

#configure_mock_framework ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1590

def configure_mock_framework
  RSpec::Core::ExampleGroup.__send__(:include, mock_framework)
  conditionally_disable_mocks_monkey_patching
end

#default_formatter ⇒ Object

The formatter that will be used if no formatter has been set. Defaults to ‘progress’.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 982

def default_formatter
  formatter_loader.default_formatter
end

#default_formatter=(value) ⇒ Object

Sets a fallback formatter to use if none other has been set.

Examples:

RSpec.configure do |rspec|
  rspec.default_formatter = 'doc'
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 993

def default_formatter=(value)
  formatter_loader.default_formatter = value
end

#define_derived_metadata(*filters) {|metadata| ... } ⇒ Object

Defines a callback that can assign derived metadata values.

Examples:

RSpec.configure do |config|
  # Tag all groups and examples in the spec/unit directory with
  # :type => :unit
  config.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|
    metadata[:type] = :unit
  end
end

Parameters:

• filters (Array<Symbol>, Hash) —

  metadata filters that determine which example or group metadata hashes the callback will be triggered for. If none are given, the callback will be run against the metadata hashes of all groups and examples.

Yield Parameters:

• metadata (Hash) —

  original metadata hash from an example or group. Mutate this in your block as needed.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1873

def define_derived_metadata(*filters, &block)
  meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  @derived_metadata_blocks.append(block, meta)
end

#deprecation_stream ⇒ IO, String

Determines where deprecation warnings are printed. Defaults to ‘$stderr`.

Returns:

• (IO, String) —

  IO or filename to write to

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 164

define_reader :deprecation_stream

#deprecation_stream=(value) ⇒ Object

Determines where deprecation warnings are printed.

Parameters:

• value (IO, String) —

  IO to write to or filename to write to

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 168

def deprecation_stream=(value)
  if @reporter && !value.equal?(@deprecation_stream)
    warn "RSpec's reporter has already been initialized with " \
      "#{deprecation_stream.inspect} as the deprecation stream, so your change to "\
      "`deprecation_stream` will be ignored. You should configure it earlier for " \
      "it to take effect, or use the `--deprecation-out` CLI option. " \
      "(Called from #{CallerFilter.first_non_rspec_line})"
  else
    @deprecation_stream = value
  end
end

#disable_monkey_patching! ⇒ Object

Note:

It configures rspec-mocks and rspec-expectations only if the user is using those (either explicitly or implicitly by not setting ‘mock_with` or `expect_with` to anything else).

Note:

If the user uses this options with ‘mock_with :mocha` (or similiar) they will still have monkey patching active in their test environment from mocha.

Enables zero monkey patching mode for RSpec. It removes monkey patching of the top-level DSL methods (‘describe`, `shared_examples_for`, etc) onto `main` and `Module`, instead requiring you to prefix these methods with `RSpec.`. It enables expect-only syntax for rspec-mocks and rspec-expectations. It simply disables monkey patching on whatever pieces of RSpec the user is using.

Examples:

# It disables all monkey patching.
RSpec.configure do |config|
  config.disable_monkey_patching!
end

# Is an equivalent to
RSpec.configure do |config|
  config.expose_dsl_globally = false

  config.mock_with :rspec do |mocks|
    mocks.syntax = :expect
    mocks.patch_marshal_to_support_partial_doubles = false
  end

  config.expect_with :rspec do |expectations|
    expectations.syntax = :expect
  end
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1846

def disable_monkey_patching!
  self.expose_dsl_globally = false
  self.disable_monkey_patching = true
  conditionally_disable_mocks_monkey_patching
  conditionally_disable_expectations_monkey_patching
end

#exclusion_filter ⇒ Object

Returns the ‘exclusion_filter`. If none has been set, returns an empty hash.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1348

def exclusion_filter
  filter_manager.exclusions
end

#exclusion_filter=(filter) ⇒ Object

Clears and reassigns the ‘exclusion_filter`. Set to `nil` if you don’t want any exclusion filter at all.

### Warning

This overrides any exclusion filters/tags set on the command line or in configuration files.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1341

def exclusion_filter=(filter)
  meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)
  filter_manager.exclude_only meta
end

#expect_with(*frameworks) ⇒ Object

Sets the expectation framework module(s) to be included in each example group.

‘frameworks` can be `:rspec`, `:test_unit`, `:minitest`, a custom module, or any combination thereof:

config.expect_with :rspec
config.expect_with :test_unit
config.expect_with :minitest
config.expect_with :rspec, :minitest
config.expect_with OtherExpectationFramework

RSpec will translate ‘:rspec`, `:minitest`, and `:test_unit` into the appropriate modules.

## Configuration

If the module responds to ‘configuration`, `expect_with` will yield the `configuration` object if given a block:

config.expect_with OtherExpectationFramework do |custom_config|
  custom_config.custom_setting = true
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 837

def expect_with(*frameworks)
  modules = frameworks.map do |framework|
    case framework
    when Module
      framework
    when :rspec
      require 'rspec/expectations'

      # Tag this exception class so our exception formatting logic knows
      # that it satisfies the `MultipleExceptionError` interface.
      ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(
        :include, MultipleExceptionError::InterfaceTag
      )

      ::RSpec::Matchers
    when :test_unit
      require 'rspec/core/test_unit_assertions_adapter'
      ::RSpec::Core::TestUnitAssertionsAdapter
    when :minitest
      require 'rspec/core/minitest_assertions_adapter'
      ::RSpec::Core::MinitestAssertionsAdapter
    else
      raise ArgumentError, "#{framework.inspect} is not supported"
    end
  end

  if (modules - @expectation_frameworks).any?
    assert_no_example_groups_defined(:expect_with)
  end

  if block_given?
    raise "expect_with only accepts a block with a single argument. " \
          "Call expect_with #{modules.length} times, " \
          "once with each argument, instead." if modules.length > 1
    raise "#{modules.first} must respond to `configuration` so that " \
          "expect_with can yield it." unless modules.first.respond_to?(:configuration)
    yield modules.first.configuration
  end

  @expectation_frameworks.push(*modules)
end

#expectation_framework=(framework) ⇒ Object

Delegates to expect_with(framework).

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 810

def expectation_framework=(framework)
  expect_with(framework)
end

#expectation_frameworks ⇒ Object

Returns the configured expectation framework adapter module(s)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 798

def expectation_frameworks
  if @expectation_frameworks.empty?
    begin
      expect_with :rspec
    rescue LoadError
      expect_with Module.new
    end
  end
  @expectation_frameworks
end

#expose_current_running_example_as(method_name) ⇒ Object

Exposes the current running example via the named helper method. RSpec 2.x exposed this via ‘example`, but in RSpec 3.0, the example is instead exposed via an arg yielded to `it`, `before`, `let`, etc. However, some extension gems (such as Capybara) depend on the RSpec 2.x’s ‘example` method, so this config option can be used to maintain compatibility.

Examples:

RSpec.configure do |rspec|
  rspec.expose_current_running_example_as :example
end

RSpec.describe MyClass do
  before do
    # `example` can be used here because of the above config.
    do_something if example.metadata[:type] == "foo"
  end
end

Parameters:

• method_name (Symbol) —

  the name of the helper method

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1784

def expose_current_running_example_as(method_name)
  ExposeCurrentExample.module_exec do
    extend RSpec::SharedContext
    let(method_name) { |ex| ex }
  end

  include ExposeCurrentExample
end

#expose_dsl_globally=(value) ⇒ Object

Use this to expose the core RSpec DSL via ‘Module` and the `main` object. It will be set automatically but you can override it to remove the DSL. Default: true

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 151

def expose_dsl_globally=(value)
  if value
    Core::DSL.expose_globally!
    Core::SharedExampleGroup::TopLevelDSL.expose_globally!
  else
    Core::DSL.remove_globally!
    Core::SharedExampleGroup::TopLevelDSL.remove_globally!
  end
end

#expose_dsl_globally? ⇒ Boolean

Indicates if the DSL has been exposed off of modules and ‘main`. Default: true

Returns:

• (Boolean)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 143

def expose_dsl_globally?
  Core::DSL.exposed_globally?
end

#extend(mod, *filters) ⇒ Object

Tells RSpec to extend example groups with ‘mod`. Methods defined in `mod` are exposed to example groups (not examples). Use `filters` to constrain the groups to extend.

Similar to ‘include`, but behavior is added to example groups, which are classes, rather than the examples, which are instances of those classes.

Examples:

module UiHelpers
  def run_in_browser
    # ...
  end
end

module PermissionHelpers
  def define_permissions
    # ...
  end
end

RSpec.configure do |config|
  config.extend(UiHelpers, :type => :request)
  config.extend(PermissionHelpers, :with_permissions, :type => :request)
end

describe "edit profile", :with_permissions, :type => :request do
  run_in_browser
  define_permissions

  it "does stuff in the client" do
    # ...
  end
end

See Also:

• #include
• #prepend

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1494

def extend(mod, *filters)
  define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|
    safe_extend(mod, group)
  end
end

#files_or_directories_to_run=(*files) ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1062

def files_or_directories_to_run=(*files)
  files = files.flatten

  if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?
    files << default_path
  end

  @files_or_directories_to_run = files
  @files_to_run = nil
end

#filter_gems_from_backtrace(*gem_names) ⇒ Object

Note:

The patterns this adds will match the named gems in their common locations (e.g. system gems, vendored with bundler, installed as a :git dependency with bundler, etc) but is not guaranteed to work for all possible gem locations. For example, if you have the gem source in a directory with a completely unrelated name, and use bundler’s :path option, this will not filter it.

Adds #backtrace_exclusion_patterns that will filter lines from the named gems from backtraces.

Examples:

RSpec.configure do |config|
  config.filter_gems_from_backtrace "rack", "rake"
end

Parameters:

• gem_names (Array<String>) —

  Names of the gems to filter

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 721

def filter_gems_from_backtrace(*gem_names)
  gem_names.each do |name|
    @backtrace_formatter.filter_gem(name)
  end
end

#filter_run_excluding(*args) ⇒ Object

Adds key/value pairs to the ‘exclusion_filter`. If `args` includes any symbols that are not part of the hash, each symbol is treated as a key in the hash with the value `true`.

### Note

Filters set using this method can be overridden from the command line or config files (e.g. ‘.rspec`).

Examples:

# Given this declaration.
describe "something", :foo => 'bar' do
  # ...
end

# Any of the following will exclude that group.
config.filter_run_excluding :foo => 'bar'
config.filter_run_excluding :foo => /^ba/
config.filter_run_excluding :foo => lambda {|v| v == 'bar'}
config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}

# Given a proc with an arity of 1, the lambda is passed the value
# related to the key, e.g.
config.filter_run_excluding :foo => lambda {|v| v == 'bar'}

# Given a proc with an arity of 2, the lambda is passed the value
# related to the key, and the metadata itself e.g.
config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}

filter_run_excluding :foo # same as filter_run_excluding :foo => true

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1328

def filter_run_excluding(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.exclude_with_low_priority meta
  static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(meta)
end

#filter_run_including(*args) ⇒ Object Also known as: filter_run

Adds key/value pairs to the ‘inclusion_filter`. If `args` includes any symbols that are not part of the hash, each symbol is treated as a key in the hash with the value `true`.

### Note

Filters set using this method can be overridden from the command line or config files (e.g. ‘.rspec`).

Examples:

# Given this declaration.
describe "something", :foo => 'bar' do
  # ...
end

# Any of the following will include that group.
config.filter_run_including :foo => 'bar'
config.filter_run_including :foo => /^ba/
config.filter_run_including :foo => lambda {|v| v == 'bar'}
config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}

# Given a proc with an arity of 1, the lambda is passed the value
# related to the key, e.g.
config.filter_run_including :foo => lambda {|v| v == 'bar'}

# Given a proc with an arity of 2, the lambda is passed the value
# related to the key, and the metadata itself e.g.
config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}

filter_run_including :foo # same as filter_run_including :foo => true

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1254

def filter_run_including(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.include_with_low_priority meta
  static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)
end

#filter_run_when_matching(*args) ⇒ Object

Applies the provided filter only if any of examples match, in constrast to #filter_run, which always applies even if no examples match, in which case no examples will be run. This allows you to leave configured filters in place that are intended only for temporary use. The most common example is focus filtering: ‘config.filter_run_when_matching :focus`. With that configured, you can temporarily focus an example or group by tagging it with `:focus` metadata, or prefixing it with an `f` (as in `fdescribe`, `fcontext` and `fit`) since those are aliases for `describe`/`context`/`it` with `:focus` metadata.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1270

def filter_run_when_matching(*args)
  when_first_matching_example_defined(*args) do
    filter_run(*args)
  end
end

#force(hash) ⇒ Object

Used to set higher priority option values from the command line.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 571

def force(hash)
  ordering_manager.force(hash)
  @preferred_options.merge!(hash)

  return unless hash.key?(:example_status_persistence_file_path)
  clear_values_derived_from_example_status_persistence_file_path
end

#format_docstrings(&block) ⇒ Object

Formats the docstring output using the block provided.

Examples:

# This will strip the descriptions of both examples and example
# groups.
RSpec.configure do |config|
  config.format_docstrings { |s| s.strip }
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1635

def format_docstrings(&block)
  @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER
end

#format_docstrings_block ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1640

def format_docstrings_block
  @format_docstrings_block ||= DEFAULT_FORMATTER
end

#formatter_loader ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1008

def formatter_loader
  @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))
end

#formatters ⇒ Array

Returns a duplicate of the formatters currently loaded in the ‘FormatterLoader` for introspection.

Note as this is a duplicate, any mutations will be disregarded.

Returns:

• (Array) —

  the formatters currently loaded

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1003

def formatters
  formatter_loader.formatters.dup
end

#full_backtrace=(true_or_false) ⇒ Object

Toggle full backtrace.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 887

def full_backtrace=(true_or_false)
  @backtrace_formatter.full_backtrace = true_or_false
end

#full_backtrace? ⇒ Boolean

Check if full backtrace is enabled.

Returns:

• (Boolean) —

  is full backtrace enabled

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 881

def full_backtrace?
  @backtrace_formatter.full_backtrace?
end

#full_description ⇒ Array

Returns full description filter.

Returns:

• (Array) —

  full description filter

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 956

def full_description
  filter.fetch :full_description, nil
end

#full_description=(description) ⇒ Object

Run examples matching on ‘description` in all files to run.

Parameters:

• description (String, Regexp) —

  the pattern to filter on

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 951

def full_description=(description)
  filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })
end

#hooks ⇒ Object

Holds the various registered hooks. Here we use a FilterableItemRepository implementation that is specifically optimized for the read/write patterns of the config object.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2082

def hooks
  @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)
end

#in_project_source_dir_regex ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1581

def in_project_source_dir_regex
  regexes = project_source_dirs.map do |dir|
    /\A#{Regexp.escape(File.expand_path(dir))}\//
  end

  Regexp.union(regexes)
end

#include(mod, *filters) ⇒ Object

Note:

Filtered module inclusions can also be applied to individual examples that have matching metadata. Just like Ruby’s object model is that every object has a singleton class which has only a single instance, RSpec’s model is that every example has a singleton example group containing just the one example.

Tells RSpec to include ‘mod` in example groups. Methods defined in `mod` are exposed to examples (not example groups). Use `filters` to constrain the groups or examples in which to include the module.

Examples:

module AuthenticationHelpers
  def login_as(user)
    # ...
  end
end

module PreferencesHelpers
  def preferences(user, preferences = {})
    # ...
  end
end

module UserHelpers
  def users(username)
    # ...
  end
end

RSpec.configure do |config|
  config.include(UserHelpers) # included in all groups

  # included in examples with `:preferences` metadata
  config.include(PreferenceHelpers, :preferences)

  # included in examples with `:type => :request` metadata
  config.include(AuthenticationHelpers, :type => :request)
end

describe "edit profile", :preferences, :type => :request do
  it "can be viewed by owning user" do
    login_as preferences(users(:jdoe), :lang => 'es')
    get "/profiles/jdoe"
    assert_select ".username", :text => 'jdoe'
  end
end

See Also:

• #include_context
• #extend
• #prepend

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1404

def include(mod, *filters)
  define_mixed_in_module(mod, filters, @include_modules, :include) do |group|
    safe_include(mod, group)
  end
end

#include_context(shared_group_name, *filters) ⇒ Object

Note:

Filtered context inclusions can also be applied to individual examples that have matching metadata. Just like Ruby’s object model is that every object has a singleton class which has only a single instance, RSpec’s model is that every example has a singleton example group containing just the one example.

Tells RSpec to include the named shared example group in example groups. Use ‘filters` to constrain the groups or examples in which to include the example group.

Examples:

RSpec.shared_context "example admin user" do
  let(:admin_user) { create_user(:admin) }
end

RSpec.shared_context "example guest user" do
  let(:guest_user) { create_user(:guest) }
end

RSpec.configure do |config|
  config.include_context "example guest user", :type => :request
  config.include_context "example admin user", :admin, :type => :request
end

RSpec.describe "The admin page", :type => :request do
  it "can be viewed by admins", :admin do
    login_with admin_user
    get "/admin"
    expect(response).to be_ok
  end

  it "cannot be viewed by guests" do
    login_with guest_user
    get "/admin"
    expect(response).to be_forbidden
  end
end

See Also:

• #include

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1451

def include_context(shared_group_name, *filters)
  shared_module = world.shared_example_group_registry.find([:main], shared_group_name)
  include shared_module, *filters
end

#inclusion_filter ⇒ Object Also known as: filter

Returns the ‘inclusion_filter`. If none has been set, returns an empty hash.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1292

def inclusion_filter
  filter_manager.inclusions
end

#inclusion_filter=(filter) ⇒ Object Also known as: filter=

Clears and reassigns the ‘inclusion_filter`. Set to `nil` if you don’t want any inclusion filter at all.

### Warning

This overrides any inclusion filters/tags set on the command line or in configuration files.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1283

def inclusion_filter=(filter)
  meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)
  filter_manager.include_only meta
end

#last_run_statuses ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1080

def last_run_statuses
  @last_run_statuses ||= Hash.new(UNKNOWN_STATUS).tap do |statuses|
    if (path = example_status_persistence_file_path)
      begin
        ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|
          status = example[:status]
          status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)
          hash[example.fetch(:example_id)] = status
          hash
        end
      rescue SystemCallError => e
        RSpec.warning "Could not read from #{path.inspect} (configured as " \
                      "`config.example_status_persistence_file_path`) due " \
                      "to a system error: #{e.inspect}. Please check that " \
                      "the config option is set to an accessible, valid " \
                      "file path", :call_site => nil
      end
    end
  end
end

#load_spec_files ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1604

def load_spec_files
  # Note which spec files world is already aware of.
  # This is generally only needed for when the user runs
  # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --
  # in that case, the spec file was loaded by `ruby` and
  # isn't loaded by us here so we only know about it because
  # of an example group being registered in it.
  world.registered_example_group_files.each do |f|
    loaded_spec_files << f # the registered files are already expended absolute paths
  end

  files_to_run.uniq.each do |f|
    file = File.expand_path(f)
    load_file_handling_errors(:load, file)
    loaded_spec_files << file
  end

  @spec_files_loaded = true
end

#mock_framework ⇒ Symbol

Returns the configured mock framework adapter module.

Returns:

• (Symbol)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 648

def mock_framework
  if @mock_framework.nil?
    begin
      mock_with :rspec
    rescue LoadError
      mock_with :nothing
    end
  end
  @mock_framework
end

#mock_framework=(framework) ⇒ Object

Delegates to mock_framework=(framework).

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 660

def mock_framework=(framework)
  mock_with framework
end

#mock_with(framework) ⇒ Object

Sets the mock framework adapter module.

‘framework` can be a Symbol or a Module.

Given any of ‘:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the named framework.

Given ‘:nothing`, configures no framework. Use this if you don’t use any mocking framework to save a little bit of overhead.

Given a Module, includes that module in every example group. The module should adhere to RSpec’s mock framework adapter API:

setup_mocks_for_rspec
  - called before each example

verify_mocks_for_rspec
  - called after each example if the example hasn't yet failed.
    Framework should raise an exception when expectations fail

teardown_mocks_for_rspec
  - called after verify_mocks_for_rspec (even if there are errors)

If the module responds to ‘configuration` and `mock_with` receives a block, it will yield the configuration object to the block e.g.

config.mock_with OtherMockFrameworkAdapter do |mod_config|
  mod_config.custom_setting = true
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 765

def mock_with(framework)
  framework_module =
    if framework.is_a?(Module)
      framework
    else
      const_name = MOCKING_ADAPTERS.fetch(framework) do
        raise ArgumentError,
              "Unknown mocking framework: #{framework.inspect}. " \
              "Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}"
      end

      RSpec::Support.require_rspec_core "mocking_adapters/#{const_name.to_s.downcase}"
      RSpec::Core::MockingAdapters.const_get(const_name)
    end

  new_name, old_name = [framework_module, @mock_framework].map do |mod|
    mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed
  end

  unless new_name == old_name
    assert_no_example_groups_defined(:mock_framework)
  end

  if block_given?
    raise "#{framework_module} must respond to `configuration` so that " \
          "mock_with can yield it." unless framework_module.respond_to?(:configuration)
    yield framework_module.configuration
  end

  @mock_framework = framework_module
end

#on_example_group_definition(&block) ⇒ Object

Invokes block before defining an example group

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2087

def on_example_group_definition(&block)
  on_example_group_definition_callbacks << block
end

#on_example_group_definition_callbacks ⇒ Object

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 an array of blocks to call before defining an example group

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2093

def on_example_group_definition_callbacks
  @on_example_group_definition_callbacks ||= []
end

#only_failures_but_not_configured? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 203

def only_failures_but_not_configured?
  only_failures? && !example_status_persistence_file_path
end

#order=(value) ⇒ Object

Sets the default global ordering strategy. By default this can be one of ‘:defined`, `:random`, but is customizable through the `register_ordering` API. If order is set to `’rand:<seed>‘`, the seed will also be set.

See Also:

• #register_ordering

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1680

delegate_to_ordering_manager :order=

#prepend(mod, *filters) ⇒ Object

Tells RSpec to prepend example groups with ‘mod`. Methods defined in `mod` are exposed to examples (not example groups). Use `filters` to constrain the groups in which to prepend the module.

Similar to ‘include`, but module is included before the example group’s class in the ancestor chain.

Examples:

module OverrideMod
  def override_me
    "overridden"
  end
end

RSpec.configure do |config|
  config.prepend(OverrideMod, :method => :prepend)
end

describe "overriding example's class", :method => :prepend do
  it "finds the user" do
    self.class.class_eval do
      def override_me
      end
    end
    override_me # => "overridden"
    # ...
  end
end

See Also:

• #include
• #extend

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1533

def prepend(mod, *filters)
  define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|
    safe_prepend(mod, group)
  end
end

#prepend_before(scope = nil, *meta, &block) ⇒ Object

Adds ‘block` to the start of the list of `before` blocks in the same scope (`:example`, `:context`, or `:suite`), in contrast to #before, which adds the hook to the end of the list.

See Hooks#before for full ‘before` hook docs.

This method differs from Hooks#prepend_before in only one way: it supports the ‘:suite` scope. Hooks with the `:suite` scope will be run once before the first example of the entire suite is executed. Conditions passed along with `:suite` are effectively ignored.

See Also:

• #before
• #after
• #append_after

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1979

def prepend_before(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})
  end || begin
    # defeat Ruby 2.5 lazy proc allocation to ensure
    # the methods below are passed the same proc instances
    # so `Hook` equality is preserved. For more info, see:
    # https://bugs.ruby-lang.org/issues/14045#note-5
    block.__id__

    add_hook_to_existing_matching_groups(meta, scope) { |g| g.prepend_before(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

#raise_errors_for_deprecations! ⇒ Object

Turns deprecation warnings into errors, in order to surface the full backtrace of the call site. This can be useful when you need more context to address a deprecation than the single-line call site normally provided.

Examples:

RSpec.configure do |rspec|
  rspec.raise_errors_for_deprecations!
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1806

def raise_errors_for_deprecations!
  self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new
end

#raise_on_warning=(value) ⇒ Object

Turns warnings into errors. This can be useful when you want RSpec to run in a ‘strict’ no warning situation.

Examples:

RSpec.configure do |rspec|
  rspec.raise_on_warning = true
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1754

def raise_on_warning=(value)
  if value
    RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER
  else
    RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER
  end
end

#register_ordering(name) {|list| ... } ⇒ Object

Note:

Pass the symbol ‘:global` to set the ordering strategy that will be used to order the top-level example groups and any example groups that do not have declared `:order` metadata.

Registers a named ordering strategy that can later be used to order an example group’s subgroups by adding ‘:order => <name>` metadata to the example group.

Examples:

RSpec.configure do |rspec|
  rspec.register_ordering :reverse do |list|
    list.reverse
  end
end

RSpec.describe 'MyClass', :order => :reverse do
  # ...
end

RSpec.configure do |rspec|
  rspec.register_ordering :global do |examples|
    acceptance, other = examples.partition do |example|
      example.metadata[:type] == :acceptance
    end
    other + acceptance
  end
end

RSpec.describe 'MyClass', :type => :acceptance do
  # will run last
end

RSpec.describe 'MyClass' do
  # will run first
end

Parameters:

• name (Symbol) —

  The name of the ordering.

Yields:

• Block that will order the given examples or example groups

Yield Parameters:

• list (Array<RSpec::Core::Example>, Array<RSpec::Core::ExampleGroup>) —

  The examples or groups to order

Yield Returns:

• (Array<RSpec::Core::Example>, Array<RSpec::Core::ExampleGroup>) —

  The re-ordered examples or groups

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1728

delegate_to_ordering_manager :register_ordering

#reporter ⇒ RSpec::Core::Reporter

Returns the currently configured reporter.

Returns:

• (RSpec::Core::Reporter) —

  the currently configured reporter

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1035

def reporter
  # @reporter_buffer should only ever be set in this method to cover
  # initialization of @reporter.
  @reporter_buffer || @reporter ||=
    begin
      @reporter_buffer = DeprecationReporterBuffer.new
      formatter_loader.prepare_default output_wrapper, deprecation_stream
      @reporter_buffer.play_onto(formatter_loader.reporter)
      @reporter_buffer = nil
      formatter_loader.reporter
    end
end

#reset ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 580

def reset
  @spec_files_loaded = false
  reset_reporter
end

#reset_filters ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 593

def reset_filters
  self.filter_manager = FilterManager.new
  filter_manager.include_only(
    Metadata.deep_hash_dup(static_config_filter_manager.inclusions.rules)
  )
  filter_manager.exclude_only(
    Metadata.deep_hash_dup(static_config_filter_manager.exclusions.rules)
  )
end

#reset_reporter ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 586

def reset_reporter
  @reporter = nil
  @formatter_loader = nil
  @output_wrapper = nil
end

#seed ⇒ Object

Seed for random ordering (default: generated randomly each run).

When you run specs with ‘–order random`, RSpec generates a random seed for the randomization and prints it to the `output_stream` (assuming you’re using RSpec’s built-in formatters). If you discover an ordering dependency (i.e. examples fail intermittently depending on order), set this (on Configuration or on the command line with ‘–seed`) to run using the same seed while you debug the issue.

We recommend, actually, that you use the command line approach so you don’t accidentally leave the seed encoded.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1670

delegate_to_ordering_manager :seed

#seed=(value) ⇒ Object

Sets the seed value and sets the default global ordering to random.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1656

delegate_to_ordering_manager :seed=

#spec_files_with_failures ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1117

def spec_files_with_failures
  @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|
    files << Example.parse_id(id).first if status == FAILED_STATUS
    files
  end.to_a
end

#treat_symbols_as_metadata_keys_with_true_values=(_value) ⇒ Object

Deprecated.

This config option was added in RSpec 2 to pave the way for this being the default behavior in RSpec 3. Now this option is a no-op.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 383

def treat_symbols_as_metadata_keys_with_true_values=(_value)
  RSpec.deprecate(
    "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=",
    :message => "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= " \
                "is deprecated, it is now set to true as default and " \
                "setting it to false has no effect."
  )
end

#warnings=(value) ⇒ Object

Set Ruby warnings on or off.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1734

def warnings=(value)
  $VERBOSE = !!value
end

#warnings? ⇒ Boolean

Returns Whether or not ruby warnings are enabled.

Returns:

• (Boolean) —

  Whether or not ruby warnings are enabled.

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1739

def warnings?
  $VERBOSE
end

#when_first_matching_example_defined(*filters) ⇒ Object

Defines a callback that runs after the first example with matching metadata is defined. If no examples are defined with matching metadata, it will not get called at all.

This can be used to ensure some setup is performed (such as bootstrapping a DB or loading a specific file that adds significantly to the boot time) if needed (as indicated by the presence of an example with matching metadata) but avoided otherwise.

Examples:

RSpec.configure do |config|
  config.when_first_matching_example_defined(:db) do
    # Load a support file that does some heavyweight setup,
    # including bootstrapping the DB, but only if we have loaded
    # any examples tagged with `:db`.
    require 'support/db'
  end
end

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 1896

def when_first_matching_example_defined(*filters)
  specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)

  callback = lambda do |example_or_group_meta|
    # Example groups do not have `:example_group` metadata
    # (instead they have `:parent_example_group` metadata).
    return unless example_or_group_meta.key?(:example_group)

    # Ensure the callback only fires once.
    @derived_metadata_blocks.delete(callback, specified_meta)

    yield
  end

  @derived_metadata_blocks.append(callback, specified_meta)
end

#with_suite_hooks ⇒ Object

# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rspec-core-3.12.0/lib/rspec/core/configuration.rb', line 2064

def with_suite_hooks
  return yield if dry_run?

  begin
    RSpec.current_scope = :before_suite_hook
    run_suite_hooks("a `before(:suite)` hook", @before_suite_hooks)
    yield
  ensure
    RSpec.current_scope = :after_suite_hook
    run_suite_hooks("an `after(:suite)` hook", @after_suite_hooks)
    RSpec.current_scope = :suite
  end
end