covered 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a79659c74af1e795823f64d18c4829240e5be7cdcf03b3f719680b9d29f9522
-  data.tar.gz: f0d8ad9bb7330adf479b0a028bc7a03e73ff35f091d79c4308f461f984f65f77
+  metadata.gz: 6101920cc470784c2969e8d78252c81678104f6cd882038a306e633f3ec34267
+  data.tar.gz: 213bc88224aba333120b869360a663f02355ace3f1dcb4106c5fcdbebd61cd7e
 SHA512:
-  metadata.gz: d205944455af6959144bc22e7456ed165d308fde5989b5e6b781458aead3ded563fc7efcea3fa3ede628e85d0b678dcad82f0caa4ce851c3fa02ebd2f3432a08
-  data.tar.gz: 5f1d51e92917387f004e38e4e7ad0754ff1063ea348a7a4a36d52b27703fc1bb66ecd8dbc8a5815aeeaeaf71663e49c6faf072e7e7fec984c5c7c368d0035719
+  metadata.gz: aabfd2999173af2de001ce8a4718483c9801497bb064b27c6892d8c6cb80dc8b2207db0de41a0eb8e4116deac5a2eaf8f68cc2febe8acbea84c4795b666992c1
+  data.tar.gz: 302d49b96fcad976a40bc86422976e1526d0b410ed72112190787a8c1ea75309015fe0c6c2fa8359b8d3cf60f9b93f63b021dab063b8e3c1a08d24cb9b79fb59

data/bake/covered/policy.rb

@@ -29,3 +29,20 @@ def current(paths: nil)
 	
 	return policy
 end
+
+# Validate the coverage of multiple test runs.
+# @parameter paths [Array(String)] The coverage database paths.
+# @parameter minimum [Float] The minimum required coverage in order to pass.
+# @parameter input [Covered::Policy] The input policy to validate.
+def statistics(paths: nil, minimum: 1.0, input:)
+	policy ||= context.lookup("covered:policy:current").call(paths: paths)
+	
+	# Calculate statistics:
+	statistics = Covered::Statistics.new
+	
+	policy.each do |coverage|
+		statistics << coverage
+	end
+	
+	return statistics
+end

data/lib/covered/coverage.rb

@@ -8,7 +8,7 @@ require_relative 'source'
 module Covered
 	module Ratio
 		def ratio
-			return 0 if executable_count.zero?
+			return 1.0 if executable_count.zero?
 			
 			Rational(executed_count, executable_count)
 		end
@@ -29,22 +29,65 @@ module Covered
 			self.new(Source.for(path, **options))
 		end
 		
-		def initialize(source, counts = [], annotations = {}, total = nil)
+		def initialize(source, counts = [], annotations = {})
 			@source = source
 			@counts = counts
 			@annotations = annotations
+		end
+		
+		attr_accessor :source
+		attr :counts
+		attr :annotations
+		
+		def total
+			counts.sum{|count| count || 0}
+		end
+		
+		# Create an empty coverage with the same source.
+		def empty
+			self.class.new(@source, [nil] * @counts.size)
+		end
+		
+		def annotate(line_number, annotation)
+			@annotations[line_number] ||= []
+			@annotations[line_number] << annotation
+		end
+		
+		def mark(line_number, value = 1)
+			# As currently implemented, @counts is base-zero rather than base-one.
+			# Line numbers generally start at line 1, so the first line, line 1, is at index 1. This means that index[0] is usually nil.
+			Array(value).each_with_index do |value, index|
+				offset = line_number + index
+				if @counts[offset]
+					@counts[offset] += value
+				else
+					@counts[offset] = value
+				end
+			end
+		end
+		
+		def merge!(other)
+			other.counts.each_with_index do |count, index|
+				if count
+					@counts[index] ||= 0
+					@counts[index] += count
+				end
+			end
 			
-			@total = total || counts.sum{|count| count || 0}
-			
-			# Memoized metrics:
-			@executable_lines = nil
-			@executed_lines = nil
+			@annotations.merge!(other.annotations) do |line_number, a, b|
+				Array(a) + Array(b)
+			end
 		end
 		
 		# Construct a new coverage object for the given line numbers. Only the given line numbers will be considered for the purposes of computing coverage.
 		# @parameter line_numbers [Array(Integer)] The line numbers to include in the new coverage object.
 		def for_lines(line_numbers)
-			self.class.new(@source, @counts.values_at(*line_numbers), @annotations)
+			counts = [nil] * @counts.size
+			line_numbers.each do |line_number|
+				counts[line_number] = @counts[line_number]
+			end
+			
+			self.class.new(@source, counts, @annotations)
 		end
 		
 		def path
@@ -74,13 +117,6 @@ module Covered
 			return false
 		end
 		
-		attr_accessor :source
-		
-		attr :counts
-		attr :total
-		
-		attr :annotations
-		
 		def read(&block)
 			@source.read(&block)
 		end
@@ -99,15 +135,15 @@ module Covered
 		end
 		
 		def zero?
-			@total.zero?
+			total.zero?
 		end
 		
-		def [] lineno
-			@counts[lineno]
+		def [] line_number
+			@counts[line_number]
 		end
 		
 		def executable_lines
-			@executable_lines ||= @counts.compact
+			@counts.compact
 		end
 		
 		def executable_count
@@ -115,7 +151,7 @@ module Covered
 		end
 		
 		def executed_lines
-			@executed_lines ||= executable_lines.reject(&:zero?)
+			executable_lines.reject(&:zero?)
 		end
 		
 		def executed_count
@@ -131,23 +167,30 @@ module Covered
 		end
 		
 		def to_s
-			"\#<#{self.class} path=#{self.path} #{self.summary.percentage.to_f.round(2)}% covered>"
+			"\#<#{self.class} path=#{self.path} #{self.percentage.to_f.round(2)}% covered>"
+		end
+		
+		def as_json
+			{
+				counts: counts,
+				executable_count: executable_count,
+				executed_count: executed_count,
+				percentage: percentage.to_f.round(2),
+			}
 		end
 		
 		def serialize(packer)
 			packer.write(@source)
 			packer.write(@counts)
 			packer.write(@annotations)
-			packer.write(@total)
 		end
 		
 		def self.deserialize(unpacker)
 			source = unpacker.read
 			counts = unpacker.read
 			annotations = unpacker.read
-			total = unpacker.read
 			
-			self.new(source, counts, annotations, total)
+			self.new(source, counts, annotations)
 		end
 	end
 end

data/lib/covered/files.rb

@@ -10,60 +10,6 @@ require 'set'
 
 module Covered
 	class Files < Base
-		class State
-			def self.for(path, **options)
-				self.new(Source.for(path, **options))
-			end
-			
-			def initialize(source)
-				@source = source
-				@counts = []
-				@annotations = {}
-			end
-			
-			def [](lineno)
-				@counts[lineno]
-			end
-			
-			attr :counts
-			attr :annotations
-			
-			def annotate(lineno, annotation)
-				@annotations[lineno] ||= []
-				@annotations[lineno] << annotation
-			end
-			
-			def mark(lineno, value = 1)
-				# As currently implemented, @counts is base-zero rather than base-one.
-				# Line numbers generally start at line 1, so the first line, line 1, is at index 1. This means that index[0] is usually nil.
-				Array(value).each_with_index do |value, index|
-					offset = lineno + index
-					if @counts[offset]
-						@counts[offset] += value
-					else
-						@counts[offset] = value
-					end
-				end
-			end
-			
-			def merge!(coverage)
-				coverage.counts.each_with_index do |count, index|
-					if count
-						@counts[index] ||= 0
-						@counts[index] += count
-					end
-				end
-				
-				@annotations.merge!(coverage.annotations) do |lineno, a, b|
-					Array(a) + Array(b)
-				end
-			end
-			
-			def coverage
-				Coverage.new(@source, @counts, @annotations)
-			end
-		end
-		
 		def initialize(*)
 			super
 			
@@ -73,19 +19,19 @@ module Covered
 		attr_accessor :paths
 		
 		def [](path)
-			@paths[path] ||= State.for(path)
+			@paths[path] ||= Coverage.for(path)
 		end
 		
 		def empty?
 			@paths.empty?
 		end
 		
-		def mark(path, lineno, value)
-			self[path].mark(lineno, value)
+		def mark(path, line_number, value)
+			self[path].mark(line_number, value)
 		end
 		
-		def annotate(path, lineno, value)
-			self[path].annotate(lineno, value)
+		def annotate(path, line_number, value)
+			self[path].annotate(line_number, value)
 		end
 		
 		def add(coverage)
@@ -95,8 +41,8 @@ module Covered
 		def each
 			return to_enum unless block_given?
 			
-			@paths.each_value do |state|
-				yield state.coverage
+			@paths.each_value do |coverage|
+				yield coverage
 			end
 		end
 		

data/lib/covered/statistics.rb

@@ -10,34 +10,86 @@ module Covered
 	class CoverageError < StandardError
 	end
 	
-	class Statistics < Wrapper
+	class Statistics
+		include Ratio
+		
 		def self.for(coverage)
 			self.new.tap do |statistics|
 				statistics << coverage
 			end
 		end
 		
+		class Aggregate
+			include Ratio
+			
+			def initialize
+				@count = 0
+				@executable_count = 0
+				@executed_count = 0
+			end
+			
+			# Total number of files added.
+			attr :count
+			
+			# The number of lines which could have been executed.
+			attr :executable_count
+			
+			# The number of lines that were executed.
+			attr :executed_count
+			
+			def as_json
+				{
+					count: count,
+					executable_count: executable_count,
+					executed_count: executed_count,
+					percentage: percentage.to_f.round(2),
+				}
+			end
+			
+			def to_json(options)
+				as_json.to_json(options)
+			end
+			
+			def << coverage
+				@count += 1
+				
+				@executable_count += coverage.executable_count
+				@executed_count += coverage.executed_count
+			end
+		end
+		
 		def initialize
-			@count = 0
-			@executable_count = 0
-			@executed_count = 0
+			@total = Aggregate.new
+			@paths = Hash.new
 		end
 		
-		# Total number of files added.
-		attr :count
+		def count
+			@paths.size
+		end
+		
+		def executable_count
+			@total.executable_count
+		end
+		
+		def executed_count
+			@total.executed_count
+		end
 		
-		# The number of lines which could have been executed.
-		attr :executable_count
+		def << coverage
+			@total << coverage
+			(@paths[coverage.path] ||= coverage.empty).merge!(coverage)
+		end
 		
-		# The number of lines that were executed.
-		attr :executed_count
+		attr :total
+		
+		def [](path)
+			@paths[path]
+		end
 		
 		def as_json
 			{
-				count: count,
-				executable_count: executable_count,
-				executed_count: executed_count,
-				percentage: percentage.to_f.round(2),
+				total: total.as_json,
+				paths: @paths.map{|path, coverage| [path, coverage.as_json]}.to_h,
 			}
 		end
 		
@@ -45,23 +97,29 @@ module Covered
 			as_json.to_json(options)
 		end
 		
-		def << coverage
-			@count += 1
-			
-			@executable_count += coverage.executable_count
-			@executed_count += coverage.executed_count
-		end
-		
-		include Ratio
+		COMPLETE = [
+			"Enter the code dojo: 100% coverage attained, bugs defeated with one swift strike.",
+			"Nirvana reached: 100% code coverage, where bugs meditate and vanish like a passing cloud.",
+			"With 100% coverage, your code has unlocked the path to enlightenment – bugs have no place to hide.",
+			"In the realm of code serenity, 100% coverage is your ticket to coding enlightenment.",
+			"100% coverage, where code and bugs coexist in perfect harmony, like Yin and Yang.",
+			"Achieving the Zen of code coverage, your code is a peaceful garden where bugs find no shelter.",
+			"Congratulations on coding enlightenment! 100% coverage means your code is one with the universe.",
+			"With 100% coverage, your code is a tranquil pond where bugs cause no ripples.",
+			"At the peak of code mastery: 100% coverage, where bugs bow down before the wisdom of your code.",
+			"100% code coverage: Zen achieved! Bugs in harmony, code at peace.",
+		]
 		
 		def print(output)
-			output.puts "* #{count} files checked; #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
+			output.puts "#{count} files checked; #{@total.executed_count}/#{@total.executable_count} lines executed; #{@total.percentage.to_f.round(2)}% covered."
 			
-			# Could output funny message here, especially for 100% coverage.
+			if self.complete?
+				output.puts "🧘 #{COMPLETE.sample}"
+			end
 		end
 		
 		def validate!(minimum = 1.0)
-			if self.ratio < minimum
+			if total.ratio < minimum
 				raise CoverageError, "Coverage of #{self.percentage.to_f.round(2)}% is less than required minimum of #{(minimum * 100.0).round(2)}%!"
 			end
 		end

data/lib/covered/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2018-2023, by Samuel Williams.
 
 module Covered
-	VERSION = "0.23.0"
+	VERSION = "0.24.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Samuel Williams