class RSpec::Core::FilterManager
Manages the filtering of examples and groups by matching tags declared on the command line or options files, or filters declared via `RSpec.configure`, with hash key/values submitted within example group and/or example declarations. For example, given this declaration:
describe Thing, :awesome => true do it "does something" do # ... end end
That group (or any other with `:awesome => true`) would be filtered in with any of the following commands:
rspec --tag awesome:true rspec --tag awesome rspec -t awesome:true rspec -t awesome
Prefixing the tag names with `~` negates the tags, thus excluding this group with any of:
rspec --tag ~awesome:true rspec --tag ~awesome rspec -t ~awesome:true rspec -t ~awesome
## Options files and command line overrides
Tag declarations can be stored in `.rspec`, `~/.rspec`, or a custom options file. This is useful for storing defaults. For example, let's say you've got some slow specs that you want to suppress most of the time. You can tag them like this:
describe Something, :slow => true do
And then store this in `.rspec`:
--tag ~slow:true
Now when you run `rspec`, that group will be excluded.
## Overriding
Of course, you probably want to run them sometimes, so you can override this tag on the command line like this:
rspec --tag slow:true
You can also store default tags with `RSpec.configure`. We use `tag` on the command line (and in options files like `.rspec`), but for historical reasons we use the term `filter` in `RSpec.configure:
RSpec.configure do |c| c.filter_run_including :foo => :bar c.filter_run_excluding :foo => :bar end
These declarations can also be overridden from the command line.
@see RSpec.configure @see RSpec::Core::Configuration#filter_run_including @see RSpec::Core::Configuration#filter_run_excluding
Constants
- DEFAULT_EXCLUSIONS
- STANDALONE_FILTERS
Attributes
Public Class Methods
# File lib/rspec/core/filter_manager.rb, line 117 def initialize @exclusions = DEFAULT_EXCLUSIONS.dup.extend(Describable) @inclusions = {}.extend(Describable) extend(BackwardCompatibility) end
Public Instance Methods
# File lib/rspec/core/filter_manager.rb, line 123 def add_location(file_path, line_numbers) # locations is a hash of expanded paths to arrays of line # numbers to match against. e.g. # { "path/to/file.rb" => [37, 42] } locations = @inclusions.delete(:locations) || Hash.new {|h,k| h[k] = []} locations[File.expand_path(file_path)].push(*line_numbers) @inclusions.replace(:locations => locations) @exclusions.clear end
# File lib/rspec/core/filter_manager.rb, line 133 def empty? inclusions.empty? && exclusions.empty_without_conditional_filters? end
# File lib/rspec/core/filter_manager.rb, line 141 def exclude(*args) merge(@exclusions, @inclusions, *args) end
# File lib/rspec/core/filter_manager.rb, line 145 def exclude!(*args) replace(@exclusions, @inclusions, *args) end
# File lib/rspec/core/filter_manager.rb, line 153 def exclude?(example) @exclusions.empty? ? false : example.any_apply?(@exclusions) end
# File lib/rspec/core/filter_manager.rb, line 149 def exclude_with_low_priority(*args) reverse_merge(@exclusions, @inclusions, *args) end
# File lib/rspec/core/filter_manager.rb, line 157 def include(*args) unless_standalone(*args) { merge(@inclusions, @exclusions, *args) } end
# File lib/rspec/core/filter_manager.rb, line 161 def include!(*args) unless_standalone(*args) { replace(@inclusions, @exclusions, *args) } end
# File lib/rspec/core/filter_manager.rb, line 169 def include?(example) @inclusions.empty? ? true : example.any_apply?(@inclusions) end
# File lib/rspec/core/filter_manager.rb, line 165 def include_with_low_priority(*args) unless_standalone(*args) { reverse_merge(@inclusions, @exclusions, *args) } end
# File lib/rspec/core/filter_manager.rb, line 137 def prune(examples) examples.select {|e| !exclude?(e) && include?(e)} end
Private Instance Methods
# File lib/rspec/core/filter_manager.rb, line 194 def already_set_standalone_filter? is_standalone_filter?(inclusions) end
# File lib/rspec/core/filter_manager.rb, line 198 def is_standalone_filter?(filter) STANDALONE_FILTERS.any? {|key| filter.has_key?(key)} end
# File lib/rspec/core/filter_manager.rb, line 179 def merge(orig, opposite, *updates) orig.merge!(updates.last).each_key {|k| opposite.delete(k)} end
# File lib/rspec/core/filter_manager.rb, line 183 def replace(orig, opposite, *updates) updates.last.each_key {|k| opposite.delete(k)} orig.replace(updates.last) end
# File lib/rspec/core/filter_manager.rb, line 188 def reverse_merge(orig, opposite, *updates) updated = updates.last.merge(orig) opposite.each_pair {|k,v| updated.delete(k) if updated[k] == v} orig.replace(updated) end
# File lib/rspec/core/filter_manager.rb, line 175 def unless_standalone(*args) is_standalone_filter?(args.last) ? @inclusions.replace(args.last) : yield unless already_set_standalone_filter? end