Class: SimpleCov::Result

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/simplecov/result.rb

Overview

A simplecov code coverage result, initialized from the Hash Ruby’s built-in coverage library generates (Coverage.result).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(original_result, command_name: nil, created_at: nil) ⇒ Result

Initialize a new SimpleCov::Result from given Coverage.result (a Hash of filenames each containing an array of coverage data)



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/simplecov/result.rb', line 28

def initialize(original_result, command_name: nil, created_at: nil)
  result = original_result
  @original_result = result.freeze
  @command_name = command_name
  @created_at = created_at
  @files = SimpleCov::FileList.new(result.map do |filename, coverage|
    SimpleCov::SourceFile.new(filename, JSON.parse(JSON.dump(coverage))) if File.file?(filename)
  end.compact.sort_by(&:filename))
  filter!
end

Instance Attribute Details

#command_name ⇒ Object

The command name that launched this result. Delegated to SimpleCov.command_name if not set manually



61
62
63
 
# File 'lib/simplecov/result.rb', line 61

def command_name
  @command_name ||= SimpleCov.command_name
end

#created_at ⇒ Object

Defines when this result has been created. Defaults to Time.now



55
56
57
 
# File 'lib/simplecov/result.rb', line 55

def created_at
  @created_at ||= Time.now
end

#files ⇒ Object (readonly) Also known as: source_files

Returns all files that are applicable to this result (sans filters!) as instances of SimpleCov::SourceFile. Aliased as :source_files



16
17
18
 
# File 'lib/simplecov/result.rb', line 16

def files
  @files
end

#original_result ⇒ Object (readonly)

Returns the original Coverage.result used for this instance of SimpleCov::Result



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

def original_result
  @original_result
end

Class Method Details

.from_hash(hash) ⇒ Object

Loads a SimpleCov::Result#to_hash dump



76
77
78
79
80
 
# File 'lib/simplecov/result.rb', line 76

def self.from_hash(hash)
  hash.map do |command_name, data|
    new(data.fetch("coverage"), command_name: command_name, created_at: Time.at(data["timestamp"]))
  end
end

Instance Method Details

#filenames ⇒ Object

Returns all filenames for source files contained in this result



40
41
42
 
# File 'lib/simplecov/result.rb', line 40

def filenames
  files.map(&:filename)
end

#format! ⇒ Object

Applies the configured SimpleCov.formatter on this result



50
51
52
 
# File 'lib/simplecov/result.rb', line 50

def format!
  SimpleCov.formatter.new.format(self)
end

#groups ⇒ Object

Returns a Hash of groups for this result. Define groups using SimpleCov.add_group ‘Models’, ‘app/models’



45
46
47
 
# File 'lib/simplecov/result.rb', line 45

def groups
  @groups ||= SimpleCov.grouped(files)
end

#to_hash ⇒ Object

Returns a hash representation of this Result that can be used for marshalling it into JSON



66
67
68
69
70
71
72
73
 
# File 'lib/simplecov/result.rb', line 66

def to_hash
  {
    command_name => {
      "coverage" => coverage,
      "timestamp" => created_at.to_i
    }
  }
end