Module: SimpleCov::ResultMerger

Defined in:
lib/simplecov/result_merger.rb

Class Method Summary collapse

Class Method Details

.clear_resultset ⇒ Object

Clear out the previously cached .resultset



118
119
120
 
# File 'lib/simplecov/result_merger.rb', line 118

def clear_resultset
  @resultset = nil
end

.merge_results(*results) ⇒ Object

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



68
69
70
71
72
73
74
 
# File 'lib/simplecov/result_merger.rb', line 68

def merge_results(*results)
  merged = SimpleCov::RawCoverage.merge_results(*results.map(&:original_result))
  result = SimpleCov::Result.new(merged)
  # Specify the command name
  result.command_name = results.map(&:command_name).sort.join(", ")
  result
end

.merged_result ⇒ Object

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



81
82
83
 
# File 'lib/simplecov/result_merger.rb', line 81

def merged_result
  merge_results(*results)
end

.results ⇒ Object

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.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/simplecov/result_merger.rb', line 53

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
    if (Time.now - result.created_at) < SimpleCov.merge_timeout
      results << result
    end
  end
  results
end

.resultset ⇒ Object

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



24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/simplecov/result_merger.rb', line 24

def resultset
  @resultset ||= begin
    data = stored_data
    if data
      begin
        JSON.parse(data) || {}
      rescue
        {}
      end
    else
      {}
    end
  end
end

.resultset_path ⇒ Object

The path to the .resultset.json cache file



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

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

.resultset_writelock ⇒ Object 



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

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

.store_result(result) ⇒ Object

Saves the given SimpleCov::Result in the resultset cache



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/simplecov/result_merger.rb', line 86

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 ⇒ Object

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



40
41
42
43
44
45
46
47
 
# 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 ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/simplecov/result_merger.rb', line 102

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