module SimpleCov

Helper that tries to find out what test suite is running (for SimpleCov.command_name)

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

An array of SimpleCov SourceFile instances with additional collection helper methods for calculating coverage across them etc.

A ridiculously simple formatter for SimpleCov results.

Profiles are SimpleCov configuration procs that can be easily loaded using ::start :rails and defined using

SimpleCov.profiles.define :foo do
  # SimpleCov configuration here, same as in  SimpleCov.configure
end

Singleton that is responsible for caching, loading and merging SimpleCov::Results into a single result for coverage analysis based upon multiple test suites.

Constants

VERSION

Attributes

pid[RW]
running[RW]

Public Class Methods

add_not_loaded_files(result) click to toggle source

Finds files that were to be tracked but were not loaded and initializes their coverage to zero.

# File lib/simplecov.rb, line 59
def add_not_loaded_files(result)
  if track_files
    result = result.dup
    Dir[track_files].each do |file|
      absolute = File.expand_path(file)

      result[absolute] ||= [0] * File.foreach(absolute).count
    end
  end

  result
end
filtered(files) click to toggle source

Applies the configured filters to the given array of SimpleCov::SourceFile items

# File lib/simplecov.rb, line 109
def filtered(files)
  result = files.clone
  filters.each do |filter|
    result = result.reject { |source_file| filter.matches?(source_file) }
  end
  SimpleCov::FileList.new result
end
grouped(files) click to toggle source

Applies the configured groups to the given array of SimpleCov::SourceFile items

# File lib/simplecov.rb, line 120
def grouped(files)
  grouped = {}
  grouped_files = []
  groups.each do |name, filter|
    grouped[name] = SimpleCov::FileList.new(files.select { |source_file| filter.matches?(source_file) })
    grouped_files += grouped[name]
  end
  if groups.length > 0 && (other_files = files.reject { |source_file| grouped_files.include?(source_file) }).length > 0
    grouped["Ungrouped"] = SimpleCov::FileList.new(other_files)
  end
  grouped
end
load_adapter(name) click to toggle source
# File lib/simplecov.rb, line 140
def load_adapter(name)
  warn "#{Kernel.caller.first}: [DEPRECATION] #load_adapter is deprecated. Use #load_profile instead."
  load_profile(name)
end
load_profile(name) click to toggle source

Applies the profile of given name on SimpleCov configuration

# File lib/simplecov.rb, line 136
def load_profile(name)
  profiles.load(name)
end
result() click to toggle source

Returns the result for the current coverage run, merging it across test suites from cache using SimpleCov::ResultMerger if use_merging is activated (default)

# File lib/simplecov.rb, line 76
def result
  # Ensure the variable is defined to avoid ruby warnings
  @result = nil unless defined?(@result)

  # Collect our coverage result
  if running && !result?
    @result = SimpleCov::Result.new add_not_loaded_files(Coverage.result)
  end

  # If we're using merging of results, store the current result
  # first, then merge the results and return those
  if use_merging
    SimpleCov::ResultMerger.store_result(@result) if result?

    SimpleCov::ResultMerger.merged_result
  else
    @result
  end
ensure
  self.running = false
end
result?() click to toggle source

Returns nil if the result has not been computed Otherwise, returns the result

# File lib/simplecov.rb, line 102
def result?
  defined?(@result) && @result
end
start(profile = nil, &block) click to toggle source

Sets up SimpleCov to run against your project. You can optionally specify a profile to use as well as configuration with a block:

SimpleCov.start
 OR
SimpleCov.start 'rails' # using rails profile
 OR
SimpleCov.start do
  add_filter 'test'
end
  OR
SimpleCov.start 'rails' do
  add_filter 'test'
end

Please check out the RDoc for SimpleCov::Configuration to find about available config options

# File lib/simplecov.rb, line 40
def start(profile = nil, &block)
  if SimpleCov.usable?
    load_profile(profile) if profile
    configure(&block) if block_given?
    @result = nil
    self.running = true
    self.pid = Process.pid
    Coverage.start
  else
    warn "WARNING: SimpleCov is activated, but you're not running Ruby 1.9+ - no coverage analysis will happen"
    warn "Starting with SimpleCov 1.0.0, even no-op compatibility with Ruby <= 1.8 will be entirely dropped."
    false
  end
end
usable?() click to toggle source

Checks whether we're on a proper version of Ruby (likely 1.9+) which provides coverage support

# File lib/simplecov.rb, line 149
def usable?
  return @usable if defined?(@usable) && !@usable.nil?

  @usable = begin
    require "coverage"
    require "simplecov/jruby_fix"
    true
  rescue LoadError
    false
  end
end