covered 0.5.2 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2da5bcb0da1de420cf2833d1f2dfbc4ff26cf1eb85e1552d3b5e79902f09ff5c
-  data.tar.gz: 6bcbbd747726ac1ec443b97401058b85fce046abd5a777085288e105d0f2010d
+  metadata.gz: e0394e15e8b2b00303b22171cf122a90b0ca1172e1a2af3d7a5789cf69c08ad3
+  data.tar.gz: 4043a560028ca031e155c2a578995afd6a799b6119d5dbd40f8f342ed0d5a327
 SHA512:
-  metadata.gz: e733ded2af93f6c93cd77a09e43a9cdaf297880c518c834596382be8c4283a417f0720b2e942b85e4260470165c75f14b021637e0c9f8421c3e5816f4ab44463
-  data.tar.gz: 247193bd7021f51519cf39ee6d61e801bfd0bf9677dcf65b6c1f6e925c38dd62b17606a1d5546a19d6a2d09d56be69c942641161a58785adc820342c57e8b1e5
+  metadata.gz: fb55691abee0a0fc745591e17c206ccabaa88e7a66f496730c4a377b0777e2e44a30dc84b15f9ea885c336cd88713e320114894753779fe24ee11518bcde9725
+  data.tar.gz: 44a25c1e34d4546ce7a90dae4082f7236be2380d385ded731d648088ce99e4c6c3473022fedd3d80953a31ebdd499d522b1c38e28a0f65e4c9f34347058caf46

data/covered.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 	
 	spec.add_development_dependency "trenni", "~> 3.6"
 	
-	spec.add_development_dependency "bundler", "~> 2.0"
+	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rake", "~> 10.0"
 	spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/covered/capture.rb

@@ -20,20 +20,20 @@
 
 require_relative 'wrapper'
 
+require 'coverage'
+
 module Covered
 	class Capture < Wrapper
 		def initialize(output)
 			super(output)
 			
-			@trace = TracePoint.new(:line, :call) do |trace_point|
-				if path = trace_point.path
-					@output.mark(path, trace_point.lineno)
+			@trace = TracePoint.new(:line, :call) do |event|
+				if path = event.path
+					@output.mark(path, event.lineno)
 				end
 			end
 		end
 		
-		attr :paths
-		
 		def enable
 			super
 			
@@ -46,4 +46,55 @@ module Covered
 			super
 		end
 	end
+	
+	class Cache < Wrapper
+		def initialize(output)
+			super(output)
+			@marks = []
+		end
+		
+		def mark(path, lineno, count = 1)
+			@marks << path << lineno << count
+		end
+		
+		def enable
+			super
+		end
+		
+		def flush
+			@marks.each_slice(3) do |path, lineno, count|
+				@output.mark(path, lineno, count)
+			end
+			
+			@marks.clear
+		end
+		
+		def disable
+			super
+			
+			flush
+		end
+	end
+	
+	# class Capture < Wrapper
+	# 	def enable
+	# 		super
+	# 
+	# 		::Coverage.start
+	# 	end
+	# 
+	# 	def disable
+	# 		result = ::Coverage.result
+	# 
+	# 		puts result.inspect
+	# 
+	# 		result.each do |path, lines|
+	# 			lines.each_with_index do |lineno, count|
+	# 				@output.mark(path, lineno, count)
+	# 			end
+	# 		end
+	# 
+	# 		super
+	# 	end
+	# end
 end

data/lib/covered/coverage.rb

@@ -39,6 +39,9 @@ module Covered
 		def initialize(path, counts = [])
 			@path = path
 			@counts = counts
+			@total = 0
+			
+			@annotations = {}
 			
 			@executable_lines = nil
 			@executed_lines = nil
@@ -46,22 +49,38 @@ module Covered
 		
 		attr :path
 		attr :counts
+		attr :total
+		
+		attr :annotations
 		
 		def freeze
 			return if frozen?
 			
 			@counts.freeze
+			@annotations.freeze
+			
 			executable_lines
 			executed_lines
 			
 			super
 		end
 		
+		def zero?
+			@total.zero?
+		end
+		
 		def [] lineno
 			@counts[lineno]
 		end
 		
+		def annotate(lineno, annotation)
+			@annotations[lineno] ||= []
+			@annotations[lineno] << annotation
+		end
+		
 		def mark(lineno, value = 1)
+			@total += value
+			
 			if @counts[lineno]
 				@counts[lineno] += value
 			else
@@ -85,6 +104,10 @@ module Covered
 			executed_lines.count
 		end
 		
+		def missing_count
+			executable_count - executed_count
+		end
+		
 		include Ratio
 		
 		def print_summary(output)

data/lib/covered/policy.rb

@@ -37,13 +37,19 @@ module Covered
 	class Policy < Wrapper
 		def initialize
 			super(Files.new)
+			
+			@threshold = 1.0
+			@summary_class = PartialSummary
 		end
 		
+		attr_accessor :summary_class
+		attr_accessor :threshold
+		
 		def freeze
 			return if frozen?
 			
 			capture
-			summary
+			summary(threshold: @threshold)
 			
 			super
 		end
@@ -69,7 +75,7 @@ module Covered
 		end
 		
 		def capture
-			@capture ||= Capture.new(@output)
+			@capture ||= Capture.new(Cache.new(@output))
 		end
 		
 		def enable
@@ -81,11 +87,11 @@ module Covered
 		end
 		
 		def summary(*args)
-			@summary ||= Summary.new(@output, *args)
+			@summary ||= @summary_class.new(@output, *args)
 		end
 		
 		def print_summary(*args)
-			summary.print_partial_summary(*args)
+			summary.print_summary(*args)
 		end
 	end
 end

data/lib/covered/rspec.rb

@@ -32,6 +32,12 @@ $covered = Covered.policy do
 	include "lib/**/*.rb"
 	
 	source
+	
+	if coverage = ENV['COVERAGE']
+		self.summary_class = Covered.const_get(coverage)
+	else
+		self.summary_class = Covered::BriefSummary
+	end
 end
 
 module Covered
@@ -47,18 +53,31 @@ module Covered
 				$covered.print_summary(@output)
 			end
 		end
+		
+		module Policy
+			def load_spec_files
+				$covered.enable
+				
+				super
+			end
+			
+			def covered
+				$covered
+			end
+			
+			def covered= policy
+				$covered = policy
+			end
+		end
 	end
 end
 
+RSpec::Core::Configuration.prepend(Covered::RSpec::Policy)
+
 RSpec.configure do |config|
 	config.add_formatter(Covered::RSpec::Formatter)
 	
-	config.before(:suite) do
-	end
-	
 	config.after(:suite) do
 		$covered.disable
 	end
 end
-
-$covered.enable

data/lib/covered/source.rb

@@ -29,7 +29,7 @@ module Covered
 		EXECUTABLE = /(.?CALL|.VAR|.ASGN|DEFN)/.freeze
 		
 		# Deviate from the standard policy above, because all the files are already loaded, so we skip NODE_FCALL.
-		DOGFOOD = /([V]?CALL|.VAR|.ASGN|DEFN)/.freeze
+		DOGFOOD = /(^V?CALL|.VAR|.ASGN|DEFN)/.freeze
 		
 		# Ruby trace points don't trigger for argument execution.
 		# Constants are loaded when the file loads, so they are less interesting.
@@ -43,6 +43,8 @@ module Covered
 			
 			@executable = executable
 			@ignore = ignore
+			
+			@annotations = {}
 		end
 		
 		def enable
@@ -76,24 +78,30 @@ module Covered
 			node.nil? or node.type.to_s =~ @ignore
 		end
 		
-		def expand(node, counts, level = 0)
-			# puts "#{node.first_lineno}: #{node.inspect}"
-			
-			counts[node.first_lineno] ||= 0 if executable?(node)
-			
-			# puts "#{"\t"*level}#{node.type} (#{node.first_lineno})"
-			node.children.each do |child|
-				next unless child.is_a? RubyVM::AbstractSyntaxTree::Node
-				
-				next if ignore?(child)
-				
-				expand(child, counts, level + 1)
+		def expand(node, coverage, level = 0)
+			if node.is_a? RubyVM::AbstractSyntaxTree::Node
+				if ignore?(node)
+					coverage.annotate(node.first_lineno, "ignoring #{node.type}")
+				else
+					if executable?(node)
+						# coverage.annotate(node.first_lineno, "executable #{node.type}")
+						coverage.counts[node.first_lineno] ||= 0
+					else
+						# coverage.annotate(node.first_lineno, "not executable #{node.type}")
+					end
+					
+					expand(node.children, coverage, level + 1)
+				end
+			elsif node.is_a? Array
+				node.each do |child|
+					expand(child, coverage, level)
+				end
+			else
+				return false
 			end
 		end
 		
 		def parse(path)
-			# puts "Parse #{path}"
-			
 			if source = @paths[path]
 				RubyVM::AbstractSyntaxTree.parse(source)
 			elsif File.exist?(path)
@@ -107,7 +115,7 @@ module Covered
 			@output.each do |coverage|
 				# This is a little bit inefficient, perhaps add a cache layer?
 				if top = parse(coverage.path)
-					expand(top, coverage.counts)
+					self.expand(top, coverage)
 				end
 				
 				yield coverage.freeze

data/lib/covered/summary.rb

@@ -28,26 +28,38 @@ module Covered
 		def initialize(output, threshold: 1.0)
 			super(output)
 			
-			@statistics = nil
-			
 			@threshold = threshold
 		end
 		
 		def each
-			@statistics = Statistics.new
+			statistics = Statistics.new
 			
 			super do |coverage|
-				@statistics << coverage
+				statistics << coverage
 				
-				if coverage.ratio < @threshold
+				if @threshold.nil? or coverage.ratio < @threshold
 					yield coverage
 				end
 			end
+			
+			return statistics
+		end
+		
+		def print_annotations(output, coverage, line, line_offset)
+			if annotations = coverage.annotations[line_offset]
+				output.write("#{line_offset}|".rjust(8))
+				output.write("*|".rjust(8))
+				
+				output.write line.match(/^\s+/)
+				output.write '# '
+				
+				output.puts Rainbow(annotations.join(", ")).bright
+			end
 		end
 		
 		# A coverage array gives, for each line, the number of line execution by the interpreter. A nil value means coverage is disabled for this line (lines like else and end).
 		def print_summary(output = $stdout)
-			self.each do |coverage|
+			statistics = self.each do |coverage|
 				line_offset = 1
 				output.puts "", Rainbow(coverage.path).bold.underline
 				
@@ -57,8 +69,10 @@ module Covered
 					file.each_line do |line|
 						count = counts[line_offset]
 						
+						print_annotations(output, coverage, line, line_offset)
+						
 						output.write("#{line_offset}|".rjust(8))
-						output.write("#{count}:".rjust(8))
+						output.write("#{count}|".rjust(8))
 						
 						if count == nil
 							output.write Rainbow(line).faint
@@ -80,45 +94,79 @@ module Covered
 				coverage.print_summary(output)
 			end
 			
-			@statistics.print_summary(output)
+			statistics.print_summary(output)
 		end
-		
-		def print_partial_summary(output = $stdout, before: 4, after: 4)
-			statistics = Statistics.new
+	end
+	
+	class BriefSummary < Summary
+		def print_summary(output = $stdout, before: 4, after: 4)
+			ordered = []
+			
+			statistics = self.each do |coverage|
+				ordered << coverage unless coverage.complete?
+			end
 			
-			self.each do |coverage|
+			output.puts
+			statistics.print_summary(output)
+			
+			if ordered.any?
+				output.puts "", "Least Coverage:"
+				ordered.sort_by!(&:missing_count).reverse!
+				
+				ordered.first(5).each do |coverage|
+					output.write Rainbow(coverage.path).orange
+					output.puts ": #{coverage.missing_count} lines not executed!"
+				end
+			end
+		end
+	end
+	
+	class PartialSummary < Summary
+		def print_summary(output = $stdout, before: 4, after: 4)
+			statistics = self.each do |coverage|
 				line_offset = 1
 				output.puts "", Rainbow(coverage.path).bold.underline
 				
 				counts = coverage.counts
+				last_line = nil
 				
-				File.open(coverage.path, "r") do |file|
-					file.each_line do |line|
-						range = Range.new([line_offset - before, 0].max, line_offset+after)
-						
-						if counts[range]&.include?(0)
-							count = counts[line_offset]
-							
-							prefix = "#{line_offset} ".rjust(8) + "#{count} ".rjust(8)
+				unless coverage.zero?
+					File.open(coverage.path, "r") do |file|
+						file.each_line do |line|
+							range = Range.new([line_offset - before, 0].max, line_offset+after)
 							
-							if count == nil
-								output.write prefix
-								output.write Rainbow(line).faint
-							elsif count == 0
-								output.write Rainbow(prefix).background(:darkred)
-								output.write Rainbow(line).red
-							else
-								output.write Rainbow(prefix).background(:darkgreen)
-								output.write Rainbow(line).green
+							if counts[range]&.include?(0)
+								count = counts[line_offset]
+								
+								if last_line and last_line != line_offset-1
+									output.puts ":".rjust(16)
+								end
+								
+								print_annotations(output, coverage, line, line_offset)
+								
+								prefix = "#{line_offset}|".rjust(8) + "#{count}|".rjust(8)
+								
+								if count == nil
+									output.write prefix
+									output.write Rainbow(line).faint
+								elsif count == 0
+									output.write Rainbow(prefix).background(:darkred)
+									output.write Rainbow(line).red
+								else
+									output.write Rainbow(prefix).background(:darkgreen)
+									output.write Rainbow(line).green
+								end
+								
+								# If there was no newline at end of file, we add one:
+								unless line.end_with? $/
+									output.puts
+								end
+								
+								last_line = line_offset
 							end
 							
-							# If there was no newline at end of file, we add one:
-							unless line.end_with? $/
-								output.puts
-							end
+							line_offset += 1
 						end
-						
-						line_offset += 1
 					end
 				end
 				
@@ -126,7 +174,7 @@ module Covered
 			end
 			
 			output.puts
-			@statistics.print_summary(output)
+			statistics.print_summary(output)
 		end
 	end
 end

data/lib/covered/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Covered
-	VERSION = "0.5.2"
+	VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.2
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -125,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.0.beta3
 signing_key: 
 specification_version: 4
 summary: A modern approach to code coverage.