@private 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 Configuration#filter_run_including @see Configuration#filter_run_excluding
@api private
@param file_path [String] @param line_numbers [Array]
# File lib/rspec/core/filter_manager.rb, line 80 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.add_location(locations) end
# File lib/rspec/core/filter_manager.rb, line 89 def empty? inclusions.empty? && exclusions.empty? end
# File lib/rspec/core/filter_manager.rb, line 102 def exclude(*args) exclusions.add(args.last) end
# File lib/rspec/core/filter_manager.rb, line 114 def exclude?(example) exclusions.include_example?(example) end
# File lib/rspec/core/filter_manager.rb, line 106 def exclude_only(*args) exclusions.use_only(args.last) end
# File lib/rspec/core/filter_manager.rb, line 110 def exclude_with_low_priority(*args) exclusions.add_with_low_priority(args.last) end
# File lib/rspec/core/filter_manager.rb, line 118 def include(*args) inclusions.add(args.last) end
# File lib/rspec/core/filter_manager.rb, line 130 def include?(example) inclusions.include_example?(example) end
# File lib/rspec/core/filter_manager.rb, line 122 def include_only(*args) inclusions.use_only(args.last) end
# File lib/rspec/core/filter_manager.rb, line 126 def include_with_low_priority(*args) inclusions.add_with_low_priority(args.last) end
# File lib/rspec/core/filter_manager.rb, line 93 def prune(examples) if inclusions.standalone? base_exclusions = ExclusionRules.new examples.select {|e| !base_exclusions.include_example?(e) && include?(e) } else examples.select {|e| !exclude?(e) && include?(e)} end end
Generated with the Darkfish Rdoc Generator 2.