class RSpec::Core::World

@api private

Internal container for global non-configuration data.

Attributes

example_group_counts_by_spec_file[R]

@private

example_groups[R]

@private

filtered_examples[R]

@private

non_example_failure[RW]

Used internally to signal that a failure outside of an example has occurred, and that therefore the exit status should indicate the run failed. @private

rspec_is_quitting[RW]

Used internally to signify that a SystemExit occurred in ‘Configuration#load_file_handling_errors`, and thus examples cannot be counted accurately. Specifically, we cannot accurately report “No examples found”. @private

wants_to_quit[RW]

Used internally to determine what to do when a SIGINT is received.

Public Class Methods

new(configuration=RSpec.configuration) click to toggle source
# File lib/rspec/core/world.rb, line 26
def initialize(configuration=RSpec.configuration)
  @wants_to_quit = false
  @rspec_is_quitting = false
  @configuration = configuration
  configuration.world = self
  @example_groups = []
  @example_group_counts_by_spec_file = Hash.new(0)
  prepare_example_filtering
end

Public Instance Methods

all_example_groups() click to toggle source

@private

# File lib/rspec/core/world.rb, line 115
def all_example_groups
  FlatMap.flat_map(example_groups) { |g| g.descendants }
end
all_examples() click to toggle source

@private

# File lib/rspec/core/world.rb, line 120
def all_examples
  FlatMap.flat_map(all_example_groups) { |g| g.examples }
end
announce_exclusion_filter(announcements) click to toggle source

@api private

Add exclusion filters to announcement message.

# File lib/rspec/core/world.rb, line 226
def announce_exclusion_filter(announcements)
  return if exclusion_filter.empty?

  announcements << "exclude #{exclusion_filter.description}"
end
announce_filters() click to toggle source

@api private

Notify reporter of filters.

# File lib/rspec/core/world.rb, line 171
def announce_filters
  fail_if_config_and_cli_options_invalid
  filter_announcements = []

  announce_inclusion_filter filter_announcements
  announce_exclusion_filter filter_announcements

  unless filter_manager.empty?
    if filter_announcements.length == 1
      report_filter_message("Run options: #{filter_announcements[0]}")
    else
      report_filter_message("Run options:\n  #{filter_announcements.join("\n  ")}")
    end
  end

  if @configuration.run_all_when_everything_filtered? && example_count.zero? && !@configuration.only_failures?
    report_filter_message("#{everything_filtered_message}; ignoring #{inclusion_filter.description}")
    filtered_examples.clear
    inclusion_filter.clear
  end

  return unless example_count.zero?

  example_groups.clear
  unless rspec_is_quitting
    if filter_manager.empty?
      report_filter_message("No examples found.")
    elsif exclusion_filter.empty? || inclusion_filter.empty?
      report_filter_message(everything_filtered_message)
    end
  end
end
announce_inclusion_filter(announcements) click to toggle source

@api private

Add inclusion filters to announcement message.

# File lib/rspec/core/world.rb, line 217
def announce_inclusion_filter(announcements)
  return if inclusion_filter.empty?

  announcements << "include #{inclusion_filter.description}"
end
everything_filtered_message() click to toggle source

@private

# File lib/rspec/core/world.rb, line 210
def everything_filtered_message
  "\nAll examples were filtered out"
end
example_count(groups=example_groups) click to toggle source

@api private

Get count of examples to be run.

# File lib/rspec/core/world.rb, line 109
def example_count(groups=example_groups)
  FlatMap.flat_map(groups) { |g| g.descendants }.
    inject(0) { |a, e| a + e.filtered_examples.size }
end
exclusion_filter() click to toggle source

@private

# File lib/rspec/core/world.rb, line 102
def exclusion_filter
  @configuration.exclusion_filter
end
filter_manager() click to toggle source

@private

# File lib/rspec/core/world.rb, line 69
def filter_manager
  @configuration.filter_manager
end
inclusion_filter() click to toggle source

@private

# File lib/rspec/core/world.rb, line 97
def inclusion_filter
  @configuration.inclusion_filter
end
num_example_groups_defined_in(file) click to toggle source

@private

# File lib/rspec/core/world.rb, line 87
def num_example_groups_defined_in(file)
  @example_group_counts_by_spec_file[file]
end
ordered_example_groups() click to toggle source

@api private

Apply ordering strategy from configuration to example groups.

# File lib/rspec/core/world.rb, line 52
def ordered_example_groups
  ordering_strategy = @configuration.ordering_registry.fetch(:global)
  ordering_strategy.order(@example_groups)
end
preceding_declaration_line(absolute_file_name, filter_line) click to toggle source

@api private

Find line number of previous declaration.

# File lib/rspec/core/world.rb, line 140
def preceding_declaration_line(absolute_file_name, filter_line)
  line_numbers = descending_declaration_line_numbers_by_file.fetch(absolute_file_name) do
    return nil
  end

  line_numbers.find { |num| num <= filter_line }
end
prepare_example_filtering() click to toggle source

@api public

Prepares filters so that they apply to example groups when they run.

This is a separate method so that filters can be modified/replaced and examples refiltered during a process’s lifetime, which can be useful for a custom runner.

# File lib/rspec/core/world.rb, line 43
def prepare_example_filtering
  @filtered_examples = Hash.new do |hash, group|
    hash[group] = filter_manager.prune(group.examples)
  end
end
record(example_group) click to toggle source

@api private

Records an example group.

# File lib/rspec/core/world.rb, line 81
def record(example_group)
  @configuration.on_example_group_definition_callbacks.each { |block| block.call(example_group) }
  @example_group_counts_by_spec_file[example_group.metadata[:absolute_file_path]] += 1
end
registered_example_group_files() click to toggle source

@private

# File lib/rspec/core/world.rb, line 74
def registered_example_group_files
  @example_group_counts_by_spec_file.keys
end
report_filter_message(message) click to toggle source

@private

# File lib/rspec/core/world.rb, line 205
def report_filter_message(message)
  reporter.message(message) unless @configuration.silence_filter_announcements?
end
reporter() click to toggle source

@private

# File lib/rspec/core/world.rb, line 149
def reporter
  @configuration.reporter
end
reset() click to toggle source

@api private

Reset world to ‘scratch’ before running suite.

# File lib/rspec/core/world.rb, line 60
def reset
  RSpec::ExampleGroups.remove_all_constants
  example_groups.clear
  @sources_by_path.clear if defined?(@sources_by_path)
  @syntax_highlighter = nil
  @example_group_counts_by_spec_file = Hash.new(0)
end
shared_example_group_registry() click to toggle source

@private

# File lib/rspec/core/world.rb, line 92
def shared_example_group_registry
  @shared_example_group_registry ||= SharedExampleGroup::Registry.new
end
source_from_file(path) click to toggle source

@private

# File lib/rspec/core/world.rb, line 154
def source_from_file(path)
  unless defined?(@sources_by_path)
    RSpec::Support.require_rspec_support 'source'
    @sources_by_path = {}
  end

  @sources_by_path[path] ||= Support::Source.from_file(path)
end
syntax_highlighter() click to toggle source

@private

# File lib/rspec/core/world.rb, line 164
def syntax_highlighter
  @syntax_highlighter ||= Formatters::SyntaxHighlighter.new(@configuration)
end
traverse_example_group_trees_until(&block) click to toggle source

@private Traverses the tree of each top level group. For each it yields the group, then the children, recursively. Halts the traversal of a branch of the tree as soon as the passed block returns true. Note that siblings groups and their sub-trees will continue to be explored. This is intended to make it easy to find the top-most group that satisfies some condition.

# File lib/rspec/core/world.rb, line 131
def traverse_example_group_trees_until(&block)
  example_groups.each do |group|
    group.traverse_tree_until(&block)
  end
end

Private Instance Methods

descending_declaration_line_numbers_by_file() click to toggle source
# File lib/rspec/core/world.rb, line 234
def descending_declaration_line_numbers_by_file
  @descending_declaration_line_numbers_by_file ||= begin
    declaration_locations = FlatMap.flat_map(example_groups, &:declaration_locations)
    hash_of_arrays = Hash.new { |h, k| h[k] = [] }

    # TODO: change `inject` to `each_with_object` when we drop 1.8.7 support.
    line_nums_by_file = declaration_locations.inject(hash_of_arrays) do |hash, (file_name, line_number)|
      hash[file_name] << line_number
      hash
    end

    line_nums_by_file.each_value do |list|
      list.sort!
      list.reverse!
    end
  end
end
fail_if_config_and_cli_options_invalid() click to toggle source
# File lib/rspec/core/world.rb, line 252
def fail_if_config_and_cli_options_invalid
  return unless @configuration.only_failures_but_not_configured?

  reporter.abort_with(
    "\nTo use `--only-failures`, you must first set " \
    "`config.example_status_persistence_file_path`.",
    1 # exit code
  )
end