Module: SimpleCov::ResultMerger

# File 'lib/simplecov/result_merger.rb', line 172

def adapt_result(result)
  if pre_simplecov_0_18_result?(result)
    adapt_pre_simplecov_0_18_result(result)
  else
    result
  end
end

# File 'lib/simplecov/result_merger.rb', line 93

def create_result(command_names, coverage)
  return nil unless coverage

  command_name = command_names.reject(&:empty?).sort.join(", ")
  SimpleCov::Result.new(coverage, command_name: command_name)
end

# File 'lib/simplecov/result_merger.rb', line 22

def merge_and_store(*file_paths, ignore_timeout: false)
  result = merge_results(*file_paths, ignore_timeout: ignore_timeout)
  store_result(result) if result
  result
end

# File 'lib/simplecov/result_merger.rb', line 100

def merge_coverage(*results)
  return [[""], nil] if results.empty?
  return results.first if results.size == 1

  results.reduce do |(memo_command, memo_coverage), (command, coverage)|
    # timestamp is dropped here, which is intentional (we merge it, it gets a new time stamp as of now)
    merged_coverage = Combine.combine(Combine::ResultsCombiner, memo_coverage, coverage)
    merged_command = memo_command + command

    [merged_command, merged_coverage]
  end
end

# File 'lib/simplecov/result_merger.rb', line 28

def merge_results(*file_paths, ignore_timeout: false)
  # It is intentional here that files are only read in and parsed one at a time.
  #
  # In big CI setups you might deal with 100s of CI jobs and each one producing Megabytes
  # of data. Reading them all in easily produces Gigabytes of memory consumption which
  # we want to avoid.
  #
  # For similar reasons a SimpleCov::Result is only created in the end as that'd create
  # even more data especially when it also reads in all source files.
  initial_memo = valid_results(file_paths.shift, ignore_timeout: ignore_timeout)

  command_names, coverage = file_paths.reduce(initial_memo) do |memo, file_path|
    merge_coverage(memo, valid_results(file_path, ignore_timeout: ignore_timeout))
  end

  create_result(command_names, coverage)
end

# File 'lib/simplecov/result_merger.rb', line 74

def merge_valid_results(results, ignore_timeout: false)
  results = results.select { |_command_name, data| within_merge_timeout?(data) } unless ignore_timeout

  command_plus_coverage = results.map do |command_name, data|
    [[command_name], adapt_result(data.fetch("coverage"))]
  end

  # one file itself _might_ include multiple test runs
  merge_coverage(*command_plus_coverage)
end

# File 'lib/simplecov/result_merger.rb', line 117

def merged_result
  # conceptually this is just doing `merge_results(resultset_path)`
  # it's more involved to make syre `synchronize_resultset` is only used around reading
  resultset_hash = read_resultset
  command_names, coverage = merge_valid_results(resultset_hash)

  create_result(command_names, coverage)
end

# File 'lib/simplecov/result_merger.rb', line 51

def parse_file(path)
  data = read_file(path)
  parse_json(data)
end

# File 'lib/simplecov/result_merger.rb', line 65

def parse_json(content)
  return {} unless content

  JSON.parse(content) || {}
rescue StandardError
  warn "[SimpleCov]: Warning! Parsing JSON content of resultset file failed"
  {}
end

# File 'lib/simplecov/result_merger.rb', line 181

def pre_simplecov_0_18_result?(result)
  _key, data = result.first

  data.is_a?(Array)
end

# File 'lib/simplecov/result_merger.rb', line 56

def read_file(path)
  return unless File.exist?(path)

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

  data
end

# File 'lib/simplecov/result_merger.rb', line 126

def read_resultset
  resultset_content =
    synchronize_resultset do
      read_file(resultset_path)
    end

  parse_json(resultset_content)
end

# File 'lib/simplecov/result_merger.rb', line 14

def resultset_path
  File.join(SimpleCov.coverage_path, ".resultset.json")
end

# File 'lib/simplecov/result_merger.rb', line 18

def resultset_writelock
  File.join(SimpleCov.coverage_path, ".resultset.json.lock")
end

# File 'lib/simplecov/result_merger.rb', line 136

def store_result(result)
  synchronize_resultset do
    # Ensure we have the latest, in case it was already cached
    new_resultset = read_resultset

    # A single result only ever has one command_name, see `SimpleCov::Result#to_hash`
    command_name, data = result.to_hash.first
    new_resultset[command_name] = data
    File.open(resultset_path, "w+") do |f_|
      f_.puts JSON.pretty_generate(new_resultset)
    end
  end
  true
end

# File 'lib/simplecov/result_merger.rb', line 153

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

# File 'lib/simplecov/result_merger.rb', line 89

def time_since_result_creation(data)
  Time.now - Time.at(data.fetch("timestamp"))
end

# File 'lib/simplecov/result_merger.rb', line 46

def valid_results(file_path, ignore_timeout: false)
  results = parse_file(file_path)
  merge_valid_results(results, ignore_timeout: ignore_timeout)
end

# File 'lib/simplecov/result_merger.rb', line 85

def within_merge_timeout?(data)
  time_since_result_creation(data) < SimpleCov.merge_timeout
end