module SimpleCov::ResultMerger

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

Public Class Methods

clear_resultset() click to toggle source

Clear out the previously cached .resultset

# File lib/simplecov/result_merger.rb, line 125
def clear_resultset
  @resultset = nil
end
merge_and_store(*results) click to toggle source
# File lib/simplecov/result_merger.rb, line 65
def merge_and_store(*results)
  result = merge_results(*results)
  store_result(result) if result
  result
end
merge_results(*results) click to toggle source

Merge two or more SimpleCov::Results into a new one with merged coverage data and the command_name for the result consisting of a join on all source result's names

# File lib/simplecov/result_merger.rb, line 74
def merge_results(*results)
  parsed_results = JSON.parse(JSON.dump(results.map(&:original_result)))
  combined_result = SimpleCov::Combine::ResultsCombiner.combine(*parsed_results)
  result = SimpleCov::Result.new(combined_result)
  # Specify the command name
  result.command_name = results.map(&:command_name).sort.join(", ")
  result
end
merged_result() click to toggle source

Gets all SimpleCov::Results from cache, merges them and produces a new SimpleCov::Result with merged coverage data and the command_name for the result consisting of a join on all source result's names

# File lib/simplecov/result_merger.rb, line 88
def merged_result
  merge_results(*results)
end
results() click to toggle source

Gets the resultset hash and re-creates all included instances of SimpleCov::Result from that. All results that are above the SimpleCov.merge_timeout will be dropped. Returns an array of SimpleCov::Result items.

# File lib/simplecov/result_merger.rb, line 55
def results
  results = []
  resultset.each do |command_name, data|
    result = SimpleCov::Result.from_hash(command_name => data)
    # Only add result if the timeout is above the configured threshold
    results << result if (Time.now - result.created_at) < SimpleCov.merge_timeout
  end
  results
end
resultset() click to toggle source

Loads the cached resultset from JSON and returns it as a Hash, caching it for subsequent accesses.

# File lib/simplecov/result_merger.rb, line 24
def resultset
  @resultset ||= begin
    data = stored_data
    if data
      begin
        JSON.parse(data) || {}
      rescue StandardError
        {}
      end
    else
      {}
    end
  end
end
resultset_path() click to toggle source

The path to the .resultset.json cache file

# File lib/simplecov/result_merger.rb, line 14
def resultset_path
  File.join(SimpleCov.coverage_path, ".resultset.json")
end
resultset_writelock() click to toggle source
# File lib/simplecov/result_merger.rb, line 18
def resultset_writelock
  File.join(SimpleCov.coverage_path, ".resultset.json.lock")
end
store_result(result) click to toggle source

Saves the given SimpleCov::Result in the resultset cache

# File lib/simplecov/result_merger.rb, line 93
def store_result(result)
  synchronize_resultset do
    # Ensure we have the latest, in case it was already cached
    clear_resultset
    new_set = resultset
    command_name, data = result.to_hash.first
    new_set[command_name] = data
    File.open(resultset_path, "w+") do |f_|
      f_.puts JSON.pretty_generate(new_set)
    end
  end
  true
end
stored_data() click to toggle source

Returns the contents of the resultset cache as a string or if the file is missing or empty nil

# File lib/simplecov/result_merger.rb, line 40
def stored_data
  synchronize_resultset do
    return unless File.exist?(resultset_path)

    data = File.read(resultset_path)
    return if data.nil? || data.length < 2

    data
  end
end
synchronize_resultset() { || ... } click to toggle source

Ensure only one process is reading or writing the resultset at any given time

# File lib/simplecov/result_merger.rb, line 109
def synchronize_resultset
  # make it reentrant
  return yield if defined?(@resultset_locked) && @resultset_locked

  begin
    @resultset_locked = true
    File.open(resultset_writelock, "w+") do |f|
      f.flock(File::LOCK_EX)
      yield
    end
  ensure
    @resultset_locked = false
  end
end