class Coverage

parameter　path　String

The source path.

parameter　options　Hash

Options forwarded to Covered::Source.for.

returns　Covered::Coverage

The coverage object for the source path.

def self.for(path, **options)
	self.new(Source.for(path, **options))
end

parameter　source　Covered::Source

The covered source metadata.

parameter　counts　Array(Integer | Nil)

Line execution counts indexed by line number.

parameter　annotations　Hash(Integer, Array(String))

Line annotations indexed by line number.

def initialize(source, counts = [], annotations = {})
	@source = source
	@counts = counts
	@annotations = annotations
end

attribute　Covered::Source

The covered source metadata.

attribute　Array(Integer | Nil)

Line execution counts indexed by line number.

attribute　Hash(Integer, Array(String))

Line annotations indexed by line number.

returns　Integer

The sum of all non-nil execution counts.

def total
	counts.sum{|count| count || 0}
end

returns　Covered::Coverage

Coverage with the same source and nil counts.

def empty
	self.class.new(@source, [nil] * @counts.size)
end

parameter　line_number　Integer

The line number to annotate.

parameter　annotation　String

The annotation text.

def annotate(line_number, annotation)
	@annotations[line_number] ||= []
	@annotations[line_number] << annotation
end

parameter　line_number　Integer

The first line number to mark.

parameter　value　Integer | Array(Integer)

The execution count or counts to add.

def mark(line_number, value = 1)
	Array(value).each_with_index do |value, index|
		offset = line_number + index
		next if offset < 1
		
		if @counts[offset]
			@counts[offset] += value
		else
			@counts[offset] = value
		end
	end
end

parameter　other　Covered::Coverage

The coverage object to merge.

def merge!(other)
	# If the counts are non-zero and don't match, that can indicate a problem.
	
	other.counts.each_with_index do |count, index|
		if count
			@counts[index] ||= 0
			@counts[index] += count
		end
	end
	
	@annotations.merge!(other.annotations) do |line_number, a, b|
		Array(a) + Array(b)
	end
end

parameter　line_numbers　Array(Integer)

The line numbers to include in the new coverage object.

returns　Covered::Coverage

A coverage object containing counts for the selected lines.

def for_lines(line_numbers)
	counts = [nil] * @counts.size
	line_numbers.each do |line_number|
		counts[line_number] = @counts[line_number]
	end
	
	self.class.new(@source, counts, @annotations)
end

returns　String

The covered source path.

def path
	@source.path
end

parameter　value　String

The new covered source path.

def path= value
	@source.path = value
end

returns　Boolean

Whether the source exists and its modification time is not newer than the recorded time.

def fresh?
	if @source.modified_time.nil?
		# We don't know when the file was last modified, so we assume it is stale:
		return false
	end
	
	unless File.exist?(@source.path)
		# The file no longer exists, so we assume it is stale:
		return false
	end
	
	if @source.modified_time >= File.mtime(@source.path)
		# The file has not been modified since we last processed it, so we assume it is fresh:
		return true
	end
	
	return false
end

yields　{|file| ...}

If a block is given, yields an open source file.

parameter　file　File

The open source file.

returns　String | Object

The source contents without a block, or the block result with a block.

def read(&block)
	@source.read(&block)
end

returns　Covered::Coverage

This frozen coverage object.

def freeze
	return self if frozen?
	
	@counts.freeze
	@annotations.freeze
	
	super
end

returns　Array(Integer | Nil)

The raw coverage counts.

def to_a
	@counts
end

returns　Boolean

Whether the total execution count is zero.

def zero?
	total.zero?
end

parameter　line_number　Integer

The line number to query.

returns　Integer | Nil

The execution count for the line.

def [] line_number
	@counts[line_number]
end

returns　Array(Integer)

Execution counts for executable lines.

def executable_lines
	@counts.compact
end

returns　Integer

The number of executable lines.

def executable_count
	executable_lines.count
end

returns　Array(Integer)

Non-zero execution counts for executable lines.

def executed_lines
	executable_lines.reject(&:zero?)
end

returns　Integer

The number of executed lines.

def executed_count
	executed_lines.count
end

returns　Integer

The number of missing executable lines.

def missing_count
	executable_count - executed_count
end

parameter　output　IO

The output stream.

def print(output)
	output.puts "** #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
end

returns　String

A summary including the source path and percentage.

def to_s
	"\#<#{self.class} path=#{self.path} #{self.percentage.to_f.round(2)}% covered>"
end

returns　Hash

The coverage counts and summary statistics.

def as_json
	{
		counts: counts,
		executable_count: executable_count,
		executed_count: executed_count,
		percentage: percentage.to_f.round(2),
	}
end

parameter　packer　Object

The MessagePack-compatible packer.

def serialize(packer)
	packer.write(@source)
	packer.write(@counts)
	packer.write(@annotations)
end

parameter　unpacker　Object

The MessagePack-compatible unpacker.

returns　Covered::Coverage

The deserialized coverage object.

def self.deserialize(unpacker)
	source = unpacker.read
	counts = unpacker.read
	annotations = unpacker.read
	
	self.new(source, counts, annotations)
end