Module: SimpleCov::Configuration

### Home Classes Methods

### In Files

- lib/simplecov/configuration.rb

### Methods

- #adapters
- #add_filter
- #add_group
- #at_exit
- #command_name
- #configure
- #coverage_dir
- #coverage_path
- #filters
- #formatter
- #formatters
- #formatters=
- #groups
- #maximum_coverage_drop
- #merge_timeout
- #minimum_coverage
- #nocov_token
- #profiles
- #project_name
- #refuse_coverage_drop
- #root
- #skip_token
- #use_merging

### Class/Module Index

Quicksearch

- SimpleCov
- SimpleCov::ArrayFilter
- SimpleCov::ArrayMergeHelper
- SimpleCov::BlockFilter
- SimpleCov::CommandGuesser
- SimpleCov::Configuration
- SimpleCov::ExitCodes
- SimpleCov::FileList
- SimpleCov::Filter
- SimpleCov::Formatter
- SimpleCov::Formatter::MultiFormatter
- SimpleCov::Formatter::SimpleFormatter
- SimpleCov::HashMergeHelper
- SimpleCov::LastRun
- SimpleCov::Profiles
- SimpleCov::Railtie
- SimpleCov::Result
- SimpleCov::ResultMerger
- SimpleCov::SourceFile
- SimpleCov::SourceFile::Line
- SimpleCov::StringFilter
- SimpleCov::VERSION
- Coverage

No matching classes.

# SimpleCov::Configuration

### Attributes

filters[W]
formatter[W]
groups[W]

### Public Instance Methods

adapters() click to toggle source

    # File lib/simplecov/configuration.rb, line 124
    def adapters
      warn "method adapters is deprecated. use profiles instead"
      profiles
    end

add_filter(filter_argument = nil, &filter_proc) click to toggle source

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

    # File lib/simplecov/configuration.rb, line 240
    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) click to toggle source

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).

    # File lib/simplecov/configuration.rb, line 249
    def add_group(group_name, filter_argument = nil, &filter_proc)
      groups[group_name] = parse_filter(filter_argument, &filter_proc)
    end

at_exit(&block) click to toggle source

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

    # File lib/simplecov/configuration.rb, line 156
    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) click to toggle source

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

    # File lib/simplecov/configuration.rb, line 61
    def command_name(name = nil)
      @name = name unless name.nil?
      @name ||= SimpleCov::CommandGuesser.guess
      @name
    end

configure(&block) click to toggle source

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.

    # File lib/simplecov/configuration.rb, line 140
    def configure(&block)
      return false unless SimpleCov.usable?
      Docile.dsl_eval(self, &block)
    end

coverage_dir(dir = nil) click to toggle source

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

Configure with SimpleCov.coverage_dir('cov')

    # File lib/simplecov/configuration.rb, line 29
    def coverage_dir(dir = nil)
      return @coverage_dir if defined?(@coverage_dir) && dir.nil?
      @coverage_dir = (dir || "coverage")
    end

coverage_path() click to toggle source

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

    # File lib/simplecov/configuration.rb, line 39
    def coverage_path
      coverage_path = File.expand_path(coverage_dir, root)
      FileUtils.mkdir_p coverage_path
      coverage_path
    end

filters() click to toggle source

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

    # File lib/simplecov/configuration.rb, line 48
    def filters
      @filters ||= []
    end

formatter(formatter = nil) click to toggle source

Gets or sets the configured formatter.

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

    # File lib/simplecov/configuration.rb, line 72
    def formatter(formatter = nil)
      return @formatter if defined?(@formatter) && formatter.nil?
      @formatter = formatter
      fail "No formatter configured. Please specify a formatter using SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter" unless @formatter
      @formatter
    end

formatters() click to toggle source

Gets the configured formatters.

    # File lib/simplecov/configuration.rb, line 89
    def formatters
      if @formatter.is_a?(SimpleCov::Formatter::MultiFormatter)
        @formatter.formatters
      else
        Array(formatter)
      end
    end

formatters=(formatters) click to toggle source

Sets the configured formatters.

    # File lib/simplecov/configuration.rb, line 82
    def formatters=(formatters)
      @formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
    end

groups() click to toggle source

Returns the configured groups. Add groups using SimpleCov.add_group

    # File lib/simplecov/configuration.rb, line 113
    def groups
      @groups ||= {}
    end

maximum_coverage_drop(coverage_drop = nil) click to toggle source

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)

    # File lib/simplecov/configuration.rb, line 214
    def maximum_coverage_drop(coverage_drop = nil)
      @maximum_coverage_drop ||= (coverage_drop || 100).to_f.round(2)
    end

merge_timeout(seconds = nil) click to toggle source

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

    # File lib/simplecov/configuration.rb, line 193
    def merge_timeout(seconds = nil)
      @merge_timeout = seconds if seconds.is_a?(Fixnum)
      @merge_timeout ||= 600
    end

minimum_coverage(coverage = nil) click to toggle source

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)

    # File lib/simplecov/configuration.rb, line 204
    def minimum_coverage(coverage = nil)
      @minimum_coverage ||= (coverage || 0).to_f.round(2)
    end

nocov_token(nocov_token = nil) click to toggle source

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')

    # File lib/simplecov/configuration.rb, line 104
    def nocov_token(nocov_token = nil)
      return @nocov_token if defined?(@nocov_token) && nocov_token.nil?
      @nocov_token = (nocov_token || "nocov")
    end

Also aliased as: skip_token
profiles() click to toggle source

Returns the hash of available profiles

    # File lib/simplecov/configuration.rb, line 120
    def profiles
      @profiles ||= SimpleCov::Profiles.new
    end

project_name(new_name = nil) click to toggle source

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

    # File lib/simplecov/configuration.rb, line 166
    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.gsub("_", " ")
    end

refuse_coverage_drop() click to toggle source

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

    # File lib/simplecov/configuration.rb, line 222
    def refuse_coverage_drop
      maximum_coverage_drop 0
    end

root(root = nil) click to toggle source

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

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

    # File lib/simplecov/configuration.rb, line 19
    def root(root = nil)
      return @root if defined?(@root) && root.nil?
      @root = File.expand_path(root || Dir.getwd)
    end

skip_token(nocov_token = nil) click to toggle source
Alias for: nocov_token
use_merging(use = nil) click to toggle source

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

    # File lib/simplecov/configuration.rb, line 176
    def use_merging(use = nil)
      @use_merging = use unless use.nil?
      @use_merging = true unless defined?(@use_merging) && @use_merging == false
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.