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) ⇒ 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
# File 'lib/simplecov/result.rb', line 28

def initialize(original_result)
  result = adapt_result(original_result)
  @original_result = result.freeze
  @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_nameObject

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


59
60
61
# File 'lib/simplecov/result.rb', line 59

def command_name
  @command_name ||= SimpleCov.command_name
end

#created_atObject

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


53
54
55
# File 'lib/simplecov/result.rb', line 53

def created_at
  @created_at ||= Time.now
end

#filesObject (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_resultObject (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


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

def self.from_hash(hash)
  command_name, data = hash.first

  result = SimpleCov::Result.new(data["coverage"])

  result.command_name = command_name
  result.created_at = Time.at(data["timestamp"])
  result
end

Instance Method Details

#filenamesObject

Returns all filenames for source files contained in this result


38
39
40
# File 'lib/simplecov/result.rb', line 38

def filenames
  files.map(&:filename)
end

#format!Object

Applies the configured SimpleCov.formatter on this result


48
49
50
# File 'lib/simplecov/result.rb', line 48

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

#groupsObject

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


43
44
45
# File 'lib/simplecov/result.rb', line 43

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

#to_hashObject

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


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

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