Class: RSpec::Core::World Private

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/world.rb

Overview

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

Internal container for global non-configuration data.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (World) initialize(configuration = RSpec.configuration)

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 a new instance of World

13
14
15
16
17
18
19
20
21
 
# File 'lib/rspec/core/world.rb', line 13
def initialize(configuration=RSpec.configuration)
  @configuration = configuration
  configuration.world = self
  @example_groups = []
  @example_group_counts_by_spec_file = Hash.new(0)
  @filtered_examples = Hash.new do |hash, group|
    hash[group] = filter_manager.prune(group.examples)
  end
end

Instance Attribute Details

- (void) wants_to_quit

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.

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

11
12
13
 
# File 'lib/rspec/core/world.rb', line 11
def wants_to_quit
  @wants_to_quit
end

Instance Method Details

- (void) announce_exclusion_filter(announcements)

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.

Add exclusion filters to announcement message.

175
176
177
178
179
 
# File 'lib/rspec/core/world.rb', line 175
def announce_exclusion_filter(announcements)
  return if exclusion_filter.empty?
  announcements << "exclude #{exclusion_filter.description}"
end

- (void) announce_filters

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.

Notify reporter of filters.

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/rspec/core/world.rb', line 122
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
  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

- (void) announce_inclusion_filter(announcements)

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.

Add inclusion filters to announcement message.

166
167
168
169
170
 
# File 'lib/rspec/core/world.rb', line 166
def announce_inclusion_filter(announcements)
  return if inclusion_filter.empty?
  announcements << "include #{inclusion_filter.description}"
end

- (void) example_count(groups = example_groups)

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.

Get count of examples to be run.

80
81
82
83
 
# File 'lib/rspec/core/world.rb', line 80
def example_count(groups=example_groups)
  FlatMap.flat_map(groups) { |g| g.descendants }.
    inject(0) { |a, e| a + e.filtered_examples.size }
end

- (void) ordered_example_groups

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.

Apply ordering strategy from configuration to example groups.

26
27
28
29
 
# File 'lib/rspec/core/world.rb', line 26
def ordered_example_groups
  ordering_strategy = @configuration.ordering_registry.fetch(:global)
  ordering_strategy.order(@example_groups)
end

- (void) preceding_declaration_line(absolute_file_name, filter_line)

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.

Find line number of previous declaration.

98
99
100
101
102
103
104
 
# File 'lib/rspec/core/world.rb', line 98
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

- (void) record(example_group)

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.

Records an example group.

52
53
54
55
 
# File 'lib/rspec/core/world.rb', line 52
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

- (void) reset

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.

Reset world to 'scratch' before running suite.

34
35
36
37
 
# File 'lib/rspec/core/world.rb', line 34
def reset
  example_groups.clear
  @shared_example_group_registry = nil
end