covered 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201e73d2bc612e802b0e41f05944bf7ba7b293d9d4e2672140eea2bdbee1f639
-  data.tar.gz: d9f3b4eaf2d53d6fe394753c3a5c0945854239cf0f19c8148464aa5b76e52478
+  metadata.gz: d4f302d30603afbab7530590d0977348f223cf38968ef55e718f0a247ed1d943
+  data.tar.gz: 8ccad0a37ce4b92d624c91b31d5d20b4dd4de741eb22870ca7b5950efb472378
 SHA512:
-  metadata.gz: d9760ff45293a83ed132c467919871926a01f477e84d2627ab656bb752aeb57ec707e992941f66cc37a119378da51c1cca2b671d5783b2a8e77d9b335e0dea12
-  data.tar.gz: e1774282c354fad33bbe7e5317eedb18ff3d5f7d8ce58eafe3d1d20ac69d6002127adcf72414b953376e4fc32de7301d6a214c79d25bf98d31b14d236780098a
+  metadata.gz: 1cd42253ea62751005d0a5971300cc04a7795744cd47b648112569257d0e81ebec0c25da3766ace5a439a919f39a2746a265b4aa8bcbd9d4058a07738a9ebaa5
+  data.tar.gz: ab4ee6d0b138747335951c5bc45e9da5f326f2118845c3523b8b45f1b37bd615cb0bd0c83d0957d705ffc8b5b9ad8412632977a090a771d1e75d08518d95d65b

data/README.md

@@ -1,9 +1,15 @@
 # Covered [![Build Status](https://travis-ci.com/ioquatix/covered.svg)](hhttps://travis-ci.com/ioquatix/covered)
 
-Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled into Ruby.
+Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled into Ruby. **This only works with Ruby 2.6 and it's experimental support for RubyVM::AST**
 
 ![Screenshot](media/example.png)
 
+## Motivation
+
+Existing Ruby coverage tools are unable to handle `eval`ed code. This is because the `coverage` module built into Ruby doesn't expose the necessary hooks to capture it. With Ruby 2.6, `RubyVM::AST.parse(source)` came in to existance, which gives us a fine grained tool for computing initial source coverage (i.e. what lines are executable), and thus making it possible to compute coverage for "templates".
+
+It's still tricky to do it correctly, but it is feasible now to compute coverage of web application "views" by using this technique. This gem is an exploration to see what is possible.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/covered/coverage.rb

@@ -0,0 +1,94 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Covered
+	module Ratio
+		def ratio
+			return 1 if executable_count.zero?
+			
+			Rational(executed_count, executable_count)
+		end
+		
+		def complete?
+			executed_count == executable_count
+		end
+		
+		def percentage
+			ratio * 100
+		end
+	end
+	
+	class Coverage
+		def initialize(path, counts = [])
+			@path = path
+			@counts = counts
+			
+			@executable_lines = nil
+			@executed_lines = nil
+		end
+		
+		attr :path
+		attr :counts
+		
+		def freeze
+			return if frozen?
+			
+			@counts.freeze
+			executable_lines
+			executed_lines
+			
+			super
+		end
+		
+		def [] lineno
+			@counts[lineno]
+		end
+		
+		def mark(lineno, value = 1)
+			if @counts[lineno]
+				@counts[lineno] += value
+			else
+				@counts[lineno] = value
+			end
+		end
+		
+		def executable_lines
+			@executable_lines ||= @counts.compact
+		end
+		
+		def executable_count
+			executable_lines.count
+		end
+		
+		def executed_lines
+			@executed_lines ||= executable_lines.reject(&:zero?)
+		end
+		
+		def executed_count
+			executed_lines.count
+		end
+		
+		include Ratio
+		
+		def print_summary(output)
+			output.puts "** #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
+		end
+	end
+end

data/lib/covered/files.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'coverage'
+
 require 'set'
 
 module Covered
@@ -34,18 +36,20 @@ module Covered
 			@paths.empty?
 		end
 		
-		def mark(path, lineno)
-			file = @paths[path] ||= []
+		def mark(path, *args)
+			coverage = (@paths[path] ||= Coverage.new(path))
 			
-			if file[lineno]
-				file[lineno] += 1
-			else
-				file[lineno] = 1
-			end
+			coverage.mark(*args)
+			
+			return coverage
 		end
 		
-		def each(&block)
-			@paths.each(&block)
+		def each
+			return to_enum unless block_given?
+			
+			@paths.each do |path, coverage|
+				yield coverage
+			end
 		end
 	end
 	
@@ -73,14 +77,14 @@ module Covered
 		def each(&block)
 			paths = glob
 			
-			super do |path, lines|
-				paths.delete(path)
+			super do |coverage|
+				paths.delete(coverage.path)
 				
-				yield path, lines
+				yield coverage
 			end
 			
 			paths.each do |path|
-				yield path, []
+				yield Coverage.new(path)
 			end
 		end
 	end
@@ -90,13 +94,13 @@ module Covered
 			true
 		end
 		
-		def mark(path, lineno)
+		def mark(path, *args)
 			super if accept?(path)
 		end
 		
 		def each(&block)
-			super do |path, counts|
-				yield path, counts if accept?(path)
+			super do |coverage|
+				yield coverage if accept?(coverage.path)
 			end
 		end
 	end

data/lib/covered/policy.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative "report"
+require_relative "summary"
 require_relative "files"
 require_relative "source"
 require_relative "capture"
@@ -43,7 +43,7 @@ module Covered
 			return if frozen?
 			
 			capture
-			report
+			summary
 			
 			super
 		end
@@ -80,12 +80,12 @@ module Covered
 			capture.disable
 		end
 		
-		def report
-			@report ||= Report.new(@output)
+		def summary(*args)
+			@summary ||= Summary.new(@output, *args)
 		end
 		
 		def print_summary(*args)
-			report.print_partial_summary(*args)
+			summary.print_partial_summary(*args)
 		end
 	end
 end

data/lib/covered/rspec.rb

@@ -18,8 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'pry'
 require_relative '../covered'
+require 'rspec/core/formatters'
 
 $covered = Covered.policy do
 	root Dir.pwd
@@ -29,15 +29,30 @@ $covered = Covered.policy do
 	source
 end
 
+module Covered
+	module RSpec
+		class Formatter
+			::RSpec::Core::Formatters.register self, :dump_summary
+			
+			def initialize(output)
+				@output = output
+			end
+			
+			def dump_summary notification
+				$covered.print_summary(@output)
+			end
+		end
+	end
+end
+
 RSpec.configure do |config|
+	config.add_formatter(Covered::RSpec::Formatter)
+	
 	config.before(:suite) do
 		$covered.enable
 	end
 	
-	config.after(:suite) do |context|
+	config.after(:suite) do
 		$covered.disable
-		
-		statistics = $covered.print_summary
-		expect(statistics).to be_complete
 	end
 end

data/lib/covered/source.rb

@@ -77,15 +77,15 @@ module Covered
 			node.type =~ @ignore
 		end
 		
-		def expand(node, lines)
+		def expand(node, counts)
 			# puts "#{node.first_lineno}: #{node.inspect}"
 			
-			lines[node.first_lineno] ||= 0 if executable?(node)
+			counts[node.first_lineno] ||= 0 if executable?(node)
 			
 			node.children.each do |child|
 				next if child.nil? or ignore?(child)
 				
-				expand(child, lines)
+				expand(child, counts)
 			end
 		end
 		
@@ -102,14 +102,13 @@ module Covered
 		end
 		
 		def each(&block)
-			@output.each do |path, lines|
-				lines = lines.dup
-				
-				if top = parse(path)
-					expand(top, lines)
+			@output.each do |coverage|
+				# This is a little bit inefficient, perhaps add a cache layer?
+				if top = parse(coverage.path)
+					expand(top, coverage.counts)
 				end
 				
-				yield path, lines
+				yield coverage.freeze
 			end
 		end
 	end

data/lib/covered/statistics.rb

@@ -18,8 +18,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require_relative 'wrapper'
+require_relative 'coverage'
+
 module Covered
-	class Statistics
+	class Statistics < Wrapper
 		def initialize
 			@count = 0
 			@executable_count = 0
@@ -41,60 +44,10 @@ module Covered
 			@executed_count += coverage.executed_count
 		end
 		
-		def percentage
-			return nil if executable_count.zero?
-			
-			Rational(executed_count, executable_count) * 100
-		end
-		
-		def complete?
-			executed_count == executable_count
-		end
+		include Ratio
 		
 		def print_summary(output)
 			output.puts "* #{count} files checked; #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
 		end
 	end
-	
-	class Coverage
-		def initialize(path, lines)
-			@path = path
-			@lines = lines
-			
-			@executable_lines = nil
-			@executed_lines = nil
-		end
-		
-		attr :lines
-		
-		def executable_lines
-			@executable_lines ||= @lines.compact
-		end
-		
-		def executable_count
-			executable_lines.count
-		end
-		
-		def executed_lines
-			@executed_lines ||= executable_lines.reject(&:zero?)
-		end
-		
-		def executed_count
-			executed_lines.count
-		end
-		
-		def complete?
-			executed_count == executable_count
-		end
-		
-		def percentage
-			return nil if executable_count.zero?
-			
-			Rational(executed_count, executable_count) * 100
-		end
-		
-		def print_summary(output)
-			output.puts "** #{executed_count}/#{executable_count} lines executed; #{percentage.to_f.round(2)}% covered."
-		end
-	end
 end

data/lib/covered/{report.rb → summary.rb}

@@ -24,21 +24,36 @@ require_relative 'wrapper'
 require 'rainbow'
 
 module Covered
-	class Report < Wrapper
-		# 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)
-			statistics = Statistics.new
+	class Summary < Wrapper
+		def initialize(output, threshold: 1.0)
+			super(output)
 			
-			@output.each do |path, counts|
-				coverage = Coverage.new(path, counts)
-				statistics << coverage
-				
-				next if coverage.complete?
+			@statistics = nil
+			
+			@threshold = threshold
+		end
+		
+		def each
+			@statistics = Statistics.new
+			
+			super do |coverage|
+				@statistics << coverage
 				
+				if coverage.ratio < @threshold
+					yield coverage
+				end
+			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|
 				line_offset = 1
-				output.puts Rainbow(path).bold.underline
+				output.puts "", Rainbow(coverage.path).bold.underline
+				
+				counts = coverage.counts
 				
-				File.open(path, "r") do |file|
+				File.open(coverage.path, "r") do |file|
 					file.each_line do |line|
 						count = counts[line_offset]
 						
@@ -65,40 +80,35 @@ module Covered
 				coverage.print_summary(output)
 			end
 			
-			statistics.print_summary(output)
-			
-			return statistics
+			@statistics.print_summary(output)
 		end
 		
 		def print_partial_summary(output = $stdout, before: 4, after: 4)
 			statistics = Statistics.new
 			
-			@output.each do |path, counts|
-				coverage = Coverage.new(path, counts)
-				statistics << coverage
-				
-				next if coverage.complete?
-				
+			self.each do |coverage|
 				line_offset = 1
-				output.puts Rainbow(path).bold.underline
+				output.puts "", Rainbow(coverage.path).bold.underline
 				
-				printing = false
+				counts = coverage.counts
 				
-				File.open(path, "r") do |file|
+				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]
 							
-							output.write("#{line_offset}|".rjust(8))
-							output.write("#{count}:".rjust(8))
+							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
 							
@@ -115,9 +125,8 @@ module Covered
 				coverage.print_summary(output)
 			end
 			
-			statistics.print_summary(output)
-			
-			return statistics
+			output.puts
+			@statistics.print_summary(output)
 		end
 	end
 end

data/lib/covered/version.rb

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

data/lib/covered/wrapper.rb

@@ -20,14 +20,16 @@
 
 module Covered
 	class Wrapper
+		include Enumerable
+		
 		def initialize(output = nil)
 			@output = output
 		end
 		
 		attr :output
 		
-		def mark(path, lineno)
-			@output.mark(path, lineno) if @output
+		def mark(*args)
+			@output.mark(*args) if @output
 		end
 		
 		def enable
@@ -38,9 +40,13 @@ module Covered
 			@output.disable if @output
 		end
 		
-		# @yield [path, counts] the path to the file, and the execution counts.
+		# @yield [Coverage] the path to the file, and the execution counts.
 		def each(&block)
 			@output.each(&block)
 		end
+		
+		def to_h
+			collect{|coverage| [coverage.path, coverage]}.to_h
+		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: covered
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -96,13 +96,14 @@ files:
 - covered.gemspec
 - lib/covered.rb
 - lib/covered/capture.rb
+- lib/covered/coverage.rb
 - lib/covered/eval.rb
 - lib/covered/files.rb
 - lib/covered/policy.rb
-- lib/covered/report.rb
 - lib/covered/rspec.rb
 - lib/covered/source.rb
 - lib/covered/statistics.rb
+- lib/covered/summary.rb
 - lib/covered/version.rb
 - lib/covered/wrapper.rb
 - media/example.png