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

#initialize(configuration = RSpec.configuration) ⇒ World

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.

26
27
28
29
30
31
32
33
34
 
# 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

Instance Attribute Details

#wants_to_quit ⇒ void

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

#announce_exclusion_filter(announcements) ⇒ void

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.

226
227
228
229
230
 
# 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 ⇒ void

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.

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# 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) ⇒ void

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.

217
218
219
220
221
 
# File 'lib/rspec/core/world.rb', line 217
def announce_inclusion_filter(announcements)
  return if inclusion_filter.empty?
  announcements << "include #{inclusion_filter.description}"
end

#example_count(groups = example_groups) ⇒ void

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.

109
110
111
112
 
# 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

#ordered_example_groups ⇒ void

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.

52
53
54
55
 
# 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) ⇒ void

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.

140
141
142
143
144
145
146
 
# 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 ⇒ void

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.

43
44
45
46
47
 
# 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) ⇒ void

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.

81
82
83
84
 
# 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

#reset ⇒ void

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.

60
61
62
63
64
65
66
 
# 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