Module: SimpleCov::Configuration

Defined in:
lib/simplecov/configuration.rb

Overview

Bundles the configuration options used for SimpleCov. All methods defined here are usable from SimpleCov directly. Please check out SimpleCov documentation for further info.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Instance Attribute Details

- (Object) filters

Returns the list of configured filters. Add filters using SimpleCov.add_filter.



46
47
48
# File 'lib/simplecov/configuration.rb', line 46

def filters
  @filters ||= []
end

- (Object) formatter(formatter = nil)

Gets or sets the configured formatter.

Configure with: SimpleCov.formatter(SimpleCov::Formatter::SimpleFormatter)



70
71
72
73
74
75
# File 'lib/simplecov/configuration.rb', line 70

def formatter(formatter=nil)
  return @formatter if defined? @formatter and formatter.nil?
  @formatter = formatter
  raise "No formatter configured. Please specify a formatter using SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter" unless @formatter
  @formatter
end

- (Object) groups

Returns the configured groups. Add groups using SimpleCov.add_group



93
94
95
# File 'lib/simplecov/configuration.rb', line 93

def groups
  @groups ||= {}
end

Instance Method Details

- (Object) adapters



104
105
106
107
# File 'lib/simplecov/configuration.rb', line 104

def adapters
  warn "method adapters is deprecated. use profiles instead"
  profiles
end

- (Object) add_filter(filter_argument = nil, &filter_proc)

Add a filter to the processing chain. There are three ways to define a filter:

  • as a String that will then be matched against all source files' file paths, SimpleCov.add_filter 'app/models' # will reject all your models

  • as a block which will be passed the source file in question and should either return a true or false value, depending on whether the file should be removed SimpleCov.add_filter do |src_file|

    File.basename(src_file.filename) == 'environment.rb'

    end # Will exclude environment.rb files from the results

  • as an instance of a subclass of SimpleCov::Filter. See the documentation there on how to define your own filter classes



220
221
222
# File 'lib/simplecov/configuration.rb', line 220

def add_filter(filter_argument=nil, &filter_proc)
  filters << parse_filter(filter_argument, &filter_proc)
end

- (Object) add_group(group_name, filter_argument = nil, &filter_proc)

Define a group for files. Works similar to add_filter, only that the first argument is the desired group name and files PASSING the filter end up in the group (while filters exclude when the filter is applicable).



229
230
231
# File 'lib/simplecov/configuration.rb', line 229

def add_group(group_name, filter_argument=nil, &filter_proc)
  groups[group_name] = parse_filter(filter_argument, &filter_proc)
end

- (Object) at_exit(&block)

Gets or sets the behavior to process coverage results.

By default, it will call SimpleCov.result.format!

Configure with:

SimpleCov.at_exit do
  puts "Coverage done"
  SimpleCov.result.format!
end


136
137
138
139
140
# File 'lib/simplecov/configuration.rb', line 136

def at_exit(&block)
  return Proc.new {} unless running or block_given?
  @at_exit = block if block_given?
  @at_exit ||= Proc.new { SimpleCov.result.format! }
end

- (Object) command_name(name = nil)

The name of the command (a.k.a. Test Suite) currently running. Used for result merging and caching. It first tries to make a guess based upon the command line arguments the current test suite is running on and should automatically detect unit tests, functional tests, integration tests, rpsec and cucumber and label them properly. If it fails to recognize the current command, the command name is set to the shell command that the current suite is running on.

You can specify it manually with SimpleCov.command_name(“test:units”) - please also check out the corresponding section in README.rdoc



59
60
61
62
63
# File 'lib/simplecov/configuration.rb', line 59

def command_name(name=nil)
  @name = name unless name.nil?
  @name ||= SimpleCov::CommandGuesser.guess
  @name
end

- (Object) configure(&block)

Allows you to configure simplecov in a block instead of prepending SimpleCov to all config methods you're calling.

SimpleCov.configure do

add_filter 'foobar'

end

This is equivalent to SimpleCov.add_filter 'foobar' and thus makes it easier to set a bunch of configure options at once.



120
121
122
123
# File 'lib/simplecov/configuration.rb', line 120

def configure(&block)
  return false unless SimpleCov.usable?
  Docile.dsl_eval(self, &block)
end

- (Object) coverage_dir(dir = nil)

The name of the output and cache directory. Defaults to 'coverage'

Configure with SimpleCov.coverage_dir('cov')



27
28
29
30
# File 'lib/simplecov/configuration.rb', line 27

def coverage_dir(dir=nil)
  return @coverage_dir if defined? @coverage_dir and dir.nil?
  @coverage_dir = (dir || 'coverage')
end

- (Object) coverage_path

Returns the full path to the output directory using SimpleCov.root and SimpleCov.coverage_dir, so you can adjust this by configuring those values. Will create the directory if it's missing



37
38
39
40
41
# File 'lib/simplecov/configuration.rb', line 37

def coverage_path
  coverage_path = File.expand_path(coverage_dir, root)
  FileUtils.mkdir_p coverage_path
  coverage_path
end

- (Object) maximum_coverage_drop(coverage_drop = nil)

Defines the maximum coverage drop at once allowed for the testsuite to pass. SimpleCov will return non-zero if the coverage decreases by more than this threshold.

Default is 100% (disabled)



194
195
196
# File 'lib/simplecov/configuration.rb', line 194

def maximum_coverage_drop(coverage_drop=nil)
  @maximum_coverage_drop ||= (coverage_drop || 100).to_f.round(2)
end

- (Object) merge_timeout(seconds = nil)

Defines them maximum age (in seconds) of a resultset to still be included in merged results. i.e. If you run cucumber features, then later rake test, if the stored cucumber resultset is more seconds ago than specified here, it won't be taken into account when merging (and is also purged from the resultset cache)

Of course, this only applies when merging is active (e.g. SimpleCov.use_merging is not false!)

Default is 600 seconds (10 minutes)

Configure with SimpleCov.merge_timeout(3600) # 1hr



173
174
175
176
# File 'lib/simplecov/configuration.rb', line 173

def merge_timeout(seconds=nil)
  @merge_timeout = seconds if seconds.kind_of?(Fixnum)
  @merge_timeout ||= 600
end

- (Object) minimum_coverage(coverage = nil)

Defines the minimum overall coverage required for the testsuite to pass. SimpleCov will return non-zero if the current coverage is below this threshold.

Default is 0% (disabled)



184
185
186
# File 'lib/simplecov/configuration.rb', line 184

def minimum_coverage(coverage=nil)
  @minimum_coverage ||= (coverage || 0).to_f.round(2)
end

- (Object) nocov_token(nocov_token = nil) Also known as: skip_token

Certain code blocks (i.e. Ruby-implementation specific code) can be excluded from the coverage metrics by wrapping it inside # :nocov: comment blocks. The nocov token can be configured to be any other string using this.

Configure with SimpleCov.nocov_token('skip') or it's alias SimpleCov.skip_token('skip')



84
85
86
87
# File 'lib/simplecov/configuration.rb', line 84

def nocov_token(nocov_token=nil)
  return @nocov_token if defined? @nocov_token and nocov_token.nil?
  @nocov_token = (nocov_token || 'nocov')
end

- (Object) profiles

Returns the hash of available profiles



100
101
102
# File 'lib/simplecov/configuration.rb', line 100

def profiles
  @profiles ||= SimpleCov::Profiles.new
end

- (Object) project_name(new_name = nil)

Returns the project name - currently assuming the last dirname in the SimpleCov.root is this.



146
147
148
149
150
# File 'lib/simplecov/configuration.rb', line 146

def project_name(new_name=nil)
  return @project_name if defined? @project_name and @project_name and new_name.nil?
  @project_name = new_name if new_name.kind_of?(String)
  @project_name ||= File.basename(root.split('/').last).capitalize.gsub('_', ' ')
end

- (Object) refuse_coverage_drop

Refuses any coverage drop. That is, coverage is only allowed to increase. SimpleCov will return non-zero if the coverage decreases.



202
203
204
# File 'lib/simplecov/configuration.rb', line 202

def refuse_coverage_drop
  maximum_coverage_drop 0
end

- (Object) root(root = nil)

The root for the project. This defaults to the current working directory.

Configure with SimpleCov.root('/my/project/path')



17
18
19
20
# File 'lib/simplecov/configuration.rb', line 17

def root(root=nil)
  return @root if defined? @root and root.nil?
  @root = File.expand_path(root || Dir.getwd)
end

- (Object) use_merging(use = nil)

Defines whether to use result merging so all your test suites (test:units, test:functionals, cucumber, …) are joined and combined into a single coverage report



156
157
158
159
# File 'lib/simplecov/configuration.rb', line 156

def use_merging(use=nil)
  @use_merging = use unless use.nil?
  @use_merging = true unless defined? @use_merging and @use_merging == false
end