Class: SimpleCov::Filter

Inherits:
Object
  • Object
show all
Defined in:
lib/simplecov/filter.rb

Overview

Base filter class. Inherit from this to create custom filters, and overwrite the passes?(source_file) instance method

# A sample class that rejects all source files. class StupidFilter < SimpleCov::Filter

def passes?(source_file)
  false
end

end

Direct Known Subclasses

BlockFilter, StringFilter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filter_argument) ⇒ Filter

Returns a new instance of Filter.


15
16
17
# File 'lib/simplecov/filter.rb', line 15

def initialize(filter_argument)
  @filter_argument = filter_argument
end

Instance Attribute Details

#filter_argumentObject (readonly)

Returns the value of attribute filter_argument


14
15
16
# File 'lib/simplecov/filter.rb', line 14

def filter_argument
  @filter_argument
end

Instance Method Details

#matches?(source_file) ⇒ Boolean

Returns:

  • (Boolean)

19
20
21
# File 'lib/simplecov/filter.rb', line 19

def matches?(source_file)
  raise "The base filter class is not intended for direct use"
end

#passes?(source_file) ⇒ Boolean

Returns:

  • (Boolean)

23
24
25
26
# File 'lib/simplecov/filter.rb', line 23

def passes?(source_file)
  warn "DEPRECATION: SimpleCov::Filter#passes?(x) has been renamed to #matches?. Please update your custom filters accordingly!"
  matches?(source_file)
end