Module: SimpleCov::Configuration
- Defined in:
- lib/simplecov/configuration.rb
Overview
rubocop:disable ModuleLength
Instance Attribute Summary collapse
-
#filters ⇒ Object
Returns the list of configured filters.
-
#formatter(formatter = nil) ⇒ Object
Gets or sets the configured formatter.
-
#groups ⇒ Object
Returns the configured groups.
Instance Method Summary collapse
- #adapters ⇒ Object
-
#add_filter(filter_argument = nil, &filter_proc) ⇒ Object
Add a filter to the processing chain.
-
#add_group(group_name, filter_argument = nil, &filter_proc) ⇒ Object
Define a group for files.
-
#at_exit(&block) ⇒ Object
Gets or sets the behavior to process coverage results.
-
#command_name(name = nil) ⇒ Object
The name of the command (a.k.a. Test Suite) currently running.
-
#configure(&block) ⇒ Object
Allows you to configure simplecov in a block instead of prepending SimpleCov to all config methods you’re calling.
-
#coverage_dir(dir = nil) ⇒ Object
The name of the output and cache directory.
-
#coverage_path ⇒ Object
Returns the full path to the output directory using SimpleCov.root and SimpleCov.coverage_dir, so you can adjust this by configuring those values.
-
#formatters ⇒ Object
Gets the configured formatters.
-
#formatters=(formatters) ⇒ Object
Sets the configured formatters.
-
#maximum_coverage_drop(coverage_drop = nil) ⇒ Object
Defines the maximum coverage drop at once allowed for the testsuite to pass.
-
#merge_timeout(seconds = nil) ⇒ Object
Defines the maximum age (in seconds) of a resultset to still be included in merged results.
-
#minimum_coverage(coverage = nil) ⇒ Object
Defines the minimum overall coverage required for the testsuite to pass.
-
#minimum_coverage_by_file(coverage = nil) ⇒ Object
Defines the minimum coverage per file required for the testsuite to pass.
-
#nocov_token(nocov_token = nil) ⇒ Object
(also: #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.
-
#profiles ⇒ Object
Returns the hash of available profiles.
-
#project_name(new_name = nil) ⇒ Object
Returns the project name - currently assuming the last dirname in the SimpleCov.root is this.
-
#refuse_coverage_drop ⇒ Object
Refuses any coverage drop.
-
#root(root = nil) ⇒ Object
The root for the project.
-
#track_files(glob) ⇒ Object
Coverage results will always include files matched by this glob, whether or not they were explicitly required.
-
#tracked_files ⇒ Object
Returns the glob that will be used to include files that were not explicitly required.
-
#use_merging(use = nil) ⇒ Object
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.
Instance Attribute Details
#filters ⇒ Object
Returns the list of configured filters. Add filters using SimpleCov.add_filter.
70 71 72 |
# File 'lib/simplecov/configuration.rb', line 70 def filters @filters ||= [] end |
#formatter(formatter = nil) ⇒ Object
Gets or sets the configured formatter.
Configure with: SimpleCov.formatter(SimpleCov::Formatter::SimpleFormatter)
94 95 96 97 98 99 |
# File 'lib/simplecov/configuration.rb', line 94 def formatter(formatter = nil) return @formatter if defined?(@formatter) && formatter.nil? @formatter = formatter raise "No formatter configured. Please specify a formatter using SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter" unless @formatter @formatter end |
#groups ⇒ Object
Returns the configured groups. Add groups using SimpleCov.add_group
135 136 137 |
# File 'lib/simplecov/configuration.rb', line 135 def groups @groups ||= {} end |
Instance Method Details
#adapters ⇒ Object
146 147 148 149 |
# File 'lib/simplecov/configuration.rb', line 146 def adapters warn "#{Kernel.caller.first}: [DEPRECATION] #adapters is deprecated. Use #profiles instead." profiles end |
#add_filter(filter_argument = nil, &filter_proc) ⇒ Object
Add a filter to the processing chain. There are four 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 array of strings that are matched against all sorce files’ file paths and then ignored (basically string filter multiple times)
SimpleCov.add_filter ['app/models', 'app/helpers'] # ignores both dirs
-
as an instance of a subclass of SimpleCov::Filter. See the documentation there on how to define your own filter classes
277 278 279 |
# File 'lib/simplecov/configuration.rb', line 277 def add_filter(filter_argument = nil, &filter_proc) filters << parse_filter(filter_argument, &filter_proc) end |
#add_group(group_name, filter_argument = nil, &filter_proc) ⇒ Object
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).
286 287 288 |
# File 'lib/simplecov/configuration.rb', line 286 def add_group(group_name, filter_argument = nil, &filter_proc) groups[group_name] = parse_filter(filter_argument, &filter_proc) end |
#at_exit(&block) ⇒ Object
179 180 181 182 183 |
# File 'lib/simplecov/configuration.rb', line 179 def at_exit(&block) return proc {} unless running || block_given? @at_exit = block if block_given? @at_exit ||= proc { SimpleCov.result.format! } end |
#command_name(name = nil) ⇒ Object
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
83 84 85 86 87 |
# File 'lib/simplecov/configuration.rb', line 83 def command_name(name = nil) @name = name unless name.nil? @name ||= SimpleCov::CommandGuesser.guess @name end |
#configure(&block) ⇒ Object
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.
162 163 164 165 |
# File 'lib/simplecov/configuration.rb', line 162 def configure(&block) return false unless SimpleCov.usable? Docile.dsl_eval(self, &block) end |
#coverage_dir(dir = nil) ⇒ Object
The name of the output and cache directory. Defaults to ‘coverage’
Configure with SimpleCov.coverage_dir(‘cov’)
31 32 33 34 35 |
# File 'lib/simplecov/configuration.rb', line 31 def coverage_dir(dir = nil) return @coverage_dir if defined?(@coverage_dir) && dir.nil? @coverage_path = nil # invalidate cache @coverage_dir = (dir || "coverage") end |
#coverage_path ⇒ Object
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
42 43 44 45 46 47 48 |
# File 'lib/simplecov/configuration.rb', line 42 def coverage_path @coverage_path ||= begin coverage_path = File.(coverage_dir, root) FileUtils.mkdir_p coverage_path coverage_path end end |
#formatters ⇒ Object
Gets the configured formatters.
111 112 113 114 115 116 117 |
# File 'lib/simplecov/configuration.rb', line 111 def formatters if @formatter.is_a?(SimpleCov::Formatter::MultiFormatter) @formatter.formatters else Array(formatter) end end |
#formatters=(formatters) ⇒ Object
Sets the configured formatters.
104 105 106 |
# File 'lib/simplecov/configuration.rb', line 104 def formatters=(formatters) @formatter = SimpleCov::Formatter::MultiFormatter.new(formatters) end |
#maximum_coverage_drop(coverage_drop = nil) ⇒ Object
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)
237 238 239 |
# File 'lib/simplecov/configuration.rb', line 237 def maximum_coverage_drop(coverage_drop = nil) @maximum_coverage_drop ||= (coverage_drop || 100).to_f.round(2) end |
#merge_timeout(seconds = nil) ⇒ Object
Defines the 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
216 217 218 219 |
# File 'lib/simplecov/configuration.rb', line 216 def merge_timeout(seconds = nil) @merge_timeout = seconds if seconds.is_a?(Integer) @merge_timeout ||= 600 end |
#minimum_coverage(coverage = nil) ⇒ Object
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)
227 228 229 |
# File 'lib/simplecov/configuration.rb', line 227 def minimum_coverage(coverage = nil) @minimum_coverage ||= (coverage || 0).to_f.round(2) end |
#minimum_coverage_by_file(coverage = nil) ⇒ Object
Defines the minimum coverage per file required for the testsuite to pass. SimpleCov will return non-zero if the current coverage of the least covered file is below this threshold.
Default is 0% (disabled)
248 249 250 |
# File 'lib/simplecov/configuration.rb', line 248 def minimum_coverage_by_file(coverage = nil) @minimum_coverage_by_file ||= (coverage || 0).to_f.round(2) end |
#nocov_token(nocov_token = nil) ⇒ Object 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’)
126 127 128 129 |
# File 'lib/simplecov/configuration.rb', line 126 def nocov_token(nocov_token = nil) return @nocov_token if defined?(@nocov_token) && nocov_token.nil? @nocov_token = (nocov_token || "nocov") end |
#profiles ⇒ Object
Returns the hash of available profiles
142 143 144 |
# File 'lib/simplecov/configuration.rb', line 142 def profiles @profiles ||= SimpleCov::Profiles.new end |
#project_name(new_name = nil) ⇒ Object
Returns the project name - currently assuming the last dirname in the SimpleCov.root is this.
189 190 191 192 193 |
# File 'lib/simplecov/configuration.rb', line 189 def project_name(new_name = nil) return @project_name if defined?(@project_name) && @project_name && new_name.nil? @project_name = new_name if new_name.is_a?(String) @project_name ||= File.basename(root.split("/").last).capitalize.tr("_", " ") end |
#refuse_coverage_drop ⇒ Object
Refuses any coverage drop. That is, coverage is only allowed to increase. SimpleCov will return non-zero if the coverage decreases.
256 257 258 |
# File 'lib/simplecov/configuration.rb', line 256 def refuse_coverage_drop maximum_coverage_drop 0 end |
#root(root = nil) ⇒ Object
The root for the project. This defaults to the current working directory.
Configure with SimpleCov.root(‘/my/project/path’)
21 22 23 24 |
# File 'lib/simplecov/configuration.rb', line 21 def root(root = nil) return @root if defined?(@root) && root.nil? @root = File.(root || Dir.getwd) end |
#track_files(glob) ⇒ Object
Coverage results will always include files matched by this glob, whether or not they were explicitly required. Without this, un-required files will not be present in the final report.
55 56 57 |
# File 'lib/simplecov/configuration.rb', line 55 def track_files(glob) @tracked_files = glob end |
#tracked_files ⇒ Object
Returns the glob that will be used to include files that were not explicitly required.
63 64 65 |
# File 'lib/simplecov/configuration.rb', line 63 def tracked_files @tracked_files if defined?(@tracked_files) end |
#use_merging(use = nil) ⇒ Object
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
199 200 201 202 |
# File 'lib/simplecov/configuration.rb', line 199 def use_merging(use = nil) @use_merging = use unless use.nil? @use_merging = true unless defined?(@use_merging) && @use_merging == false end |