RubyGems - coverage - Versions diffs - 0.3 - Mend

coverage 0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

data/CHANGES +23 -0
data/README +76 -0
data/TODO +13 -0
data/lib/coverage.rb +275 -0
metadata +45 -0

data/CHANGES ADDED

@@ -0,0 +1,23 @@
+29-december-2005 Neoneye
+*  Alex Pooley posted a patch to eliminate a warning.
+14-april-2004 Neoneye
+*	post-install notice added.
+30-march-2004 Neoneye
+*	better way to substitute into heredoc, while preserving whitespace.
+22-march-2004 Neoneye
+*	version 0.2 released.
+*	sidebar can be specified, by creating a file
+	named 'coverage.sidebar'.
+*	avoid absolute names.
+*	output to the local dir 'coverage'.
+*	XHTML1.0 strict.
+21-march-2004 Neoneye
+*	version 0.1 released.
+*	prepared to make a release of 'coverage.rb'
+*	While reading on the rubygems mailinglist I saw that batsman had
+	a patch to coverage. I have committed it.  Thanks batsman.
+	It can now show percentages in the index.html file.

data/README ADDED

@@ -0,0 +1,76 @@
+Ruby - Coverage
+Purpose
+=======
+>> this package is outdated, rcov is way better <<
+This tool helps identify those lines of code in your
+program which didn't got executed while running.
+NaHi is the author of the original 'coverage.rb',
+47 lines of Ruby code. Today it outputs nice HTML.
+License
+=======
+Ruby's license
+Install
+=======
+Follow these 3 steps in order to install
+    ruby install.rb config
+    ruby install.rb setup
+    ruby install.rb install
+Usage
+=====
+Insert '-rcoverage' when you wish to make coverage output.
+For instance:
+    ruby -rcoverage test_all.rb
+It should generage an 'index.html' file, containing coverage info.
+Credits
+=======
+NAKAMURA Hiroshi (NaHi) for the original coverage code.
+Mauricio Julio Fern�ndez Pradier, lots of improvements.
+Robert Feldt, for suggestions.
+Alex Pooley, for eliminating warning(s).
+Bugs reports (rubyforge account required)
+=========================================
+If you find any misbehavier, then please submit it here:
+http://rubyforge.org/tracker/?atid=149&group_id=18&func=browse
+Feature requests (rubyforge account required)
+=============================================
+If there is something you wish, then tell it so we can figure out
+how to make 'coverage' capable of it.
+http://rubyforge.org/tracker/?atid=152&group_id=18&func=browse
+end of document

data/TODO ADDED

@@ -0,0 +1,13 @@
+What needs to be done:
+*	'end' statements isn't detected correct. I (Simon) has
+	only little insight how the original 'coverage.rb' works.
+	I don't know how to accomplish this. Please contribute
+	in case you know it.
+*	Have a Look at 'profiler.rb', how does it count which
+	pieces of code that has be executed.
+	When we have this information available, then produce
+	some nice HTML, so that you can browse that information.
+*	nicer html output.

data/lib/coverage.rb ADDED

@@ -0,0 +1,275 @@
+# module COVERAGE__ originally (c) NAKAMURA Hiroshi, under Ruby's license
+# module PrettyCoverage originally (c) Simon Strandgaard, under Ruby's license
+# minor modifications by Mauricio Julio Fern�ndez Pradier
+require 'fileutils'
+require 'rbconfig'
+include Config
+module PrettyCoverage
+class HTML
+	def write_page(body, title, css, filename)
+		html = <<-EOHTML.gsub(/^\s*/, '') % [title, css, body]
+		<?xml version="1.0" encoding="ISO-8859-1"?>
+		<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+		  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+		<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+		<head><title>%s</title>
+		<style type="text/css">%s</style></head>
+		<body>%s</body></html>
+		EOHTML
+		File.open(filename, "w+") {|f| f.write(html) }
+	end
+	def escape(text)
+		text.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
+	end
+	def initialize
+		@files = {}
+		@files_codeonly = {}
+		@filenames = {}
+		@sidebar = ""
+	end
+	def output_dir(&block)
+		dir = "coverage"
+		if FileTest.directory?(dir)
+			FileUtils.rm_rf(dir)
+		end
+		FileUtils.mkdir(dir)
+		FileUtils.cd(dir) { block.call(dir) }
+	end
+	def load_sidebar
+		return unless FileTest.file?("coverage.sidebar")
+		data = nil
+		File.open("coverage.sidebar", "r") {|f| data = f.read}
+		@sidebar = "<div class=\"sidebar\">#{data}</div>"
+	end
+	def build_filenames
+		duplicates = Hash.new(0)
+		@files.keys.each do |filename, marked|
+			base = File.basename(filename)
+			absolute = File.expand_path(filename)
+			n = duplicates[base]
+			duplicates[base] += 1
+			if n > 0
+				base += n.to_s
+			end
+			@filenames[filename] = [base, absolute]
+		end
+		#p @filenames
+	end
+	def execute
+		puts "execute"
+		build_filenames
+		load_sidebar
+		output_dir do
+			create_file_index
+			@files.each do |file, line_marked|
+				create_file(file, line_marked, @files_codeonly[file])
+			end
+		end
+	end
+	def mk_filename(name)
+		base_absolute = @filenames[name]
+		raise "should not happen" unless base_absolute
+		base, absolute = base_absolute
+		return nil if absolute =~ /\A#{Regexp.escape(CONFIG["libdir"])}/
+		return nil if base =~ /test_/
+		[base + ".html", base, absolute]
+	end
+	def create_file_index
+		output_filename = "index.html"
+		rows = []
+		filestats = {}
+		filestats_code = {}
+		@files.sort_by{|k,v| k}.each do|file, line_marked|
+			url_filename = mk_filename(file)
+			next unless url_filename
+			percent = "%02.1f" % calc_coverage(line_marked)
+			percent2 = "%02.1f" % calc_coverage(@files_codeonly[file])
+			numlines = line_marked.transpose[1].size
+			filestats[file] = [calc_coverage(line_marked), numlines]
+			filestats_code[file] = [calc_coverage(@files_codeonly[file]),
+			                        numlines]
+			url, filename, abspath = url_filename
+			cells = [
+				"<a href=\"#{url}\">#{filename}</a>",
+				"<tt>#{numlines}</tt>",
+				"&nbsp;", "&nbsp;", "&nbsp;",
+				"<tt>#{percent}%</tt>",
+				"&nbsp;", "&nbsp;", "&nbsp;",
+				"<tt>#{percent2}%</tt>"
+			]
+			rows << cells.map{|cell| "<td>#{cell}</td>"}
+		end
+		rows.map!{|row| "<tr>#{row}</tr>"}
+		table = "<table>#{rows.join}</table>"
+		total_cov = 1.0 *
+			filestats.inject(0){|a,(k,v)| a + v[0] * v[1]} /
+			filestats.inject(0){|a,(k,v)| a + v[1]}
+		total_code_cov = 1.0 *
+			filestats_code.inject(0) {|a,(k,v)| a + v[0] * v[1]} /
+			filestats_code.inject(0){|a,(k,v)| a + v[1]}
+		body = "<h1>Average (with comments): %02.1f%%</h1>" % total_cov
+		body << "<h1>Average (code only): %02.1f%%</h1>" % total_code_cov
+		body << @sidebar
+		body << table
+		title = "coverage"
+		css = <<-EOCSS.gsub(/^\s*/, '')
+		body {
+		  background-color: rgb(180, 180, 180);
+		}
+		span.marked {
+		  background-color: rgb(185, 200, 200);
+		  display: block;
+		}
+		div.overview {
+		  border-bottom: 8px solid black;
+		}
+		div.sidebar {
+		  float: right;
+		  width: 300px;
+		  border: 2px solid black;
+		  margin-left: 10px;
+		  padding-left: 10px;
+		  padding-right: 10px;
+		  margin-right: -10px;
+		  background-color: rgb(185, 200, 200);
+		}
+		EOCSS
+		write_page(body, title, css, output_filename)
+	end
+	def add_file(file, line_marked)
+		percent = calc_coverage(line_marked)
+		path = File.expand_path(file)
+		return nil if path =~ /\A#{Regexp.escape(CONFIG["rubylibdir"])}/
+		return nil if path =~ /\A#{Regexp.escape(CONFIG["sitelibdir"])}/
+		#printf("file #{file} coverage=%02.1f%\n", percent)
+		# comments and empty lines.. we must
+		# propagate marked-value backwards
+		line_marked << ["", false]
+		(line_marked.size).downto(1) do |index|
+			line, marked = line_marked[index-1]
+			next_line, next_marked = line_marked[index]
+			if line =~ /^\s*(#|$)/ and marked == false
+				marked = next_marked
+				line_marked[index-1] = [line, marked]
+			end
+		end
+		line_marked.pop
+		@files[file] = line_marked
+		@files_codeonly[file] = line_marked.select do |(line, marked)|
+			line !~ /^\s*(#|$)/
+		end
+	end
+	def calc_coverage(line_marked)
+		marked = line_marked.transpose[1]
+		n = marked.inject(0) {|r, i| (i) ? (r+1) : r }
+		percent = n.to_f * 100 / marked.size
+	end
+	def format_overview(file, line_marked, code_marked)
+		percent = "%02.1f" % calc_coverage(line_marked)
+		percent2 = "%02.1f" % calc_coverage(code_marked)
+		html = <<-EOHTML.gsub(/^\s*/, '')
+		<div class="overview">
+		<table>
+		<tr><td>filename</td><td><tt>#{file}</tt></td></tr>
+		<tr><td>total coverage</td><td>#{percent}%</td></tr>
+		<tr><td>code coverage</td><td>#{percent2}%</td></tr>
+		</table>
+		</div>
+		EOHTML
+		html
+	end
+	def format_lines(line_marked)
+		result = ""
+		last = nil
+		end_of_span = ""
+		format_line = "%#{line_marked.size.to_s.size}d"
+		line_no = 1
+		line_marked.each do |(line, marked)|
+			if marked != last
+				result += end_of_span
+				case marked
+				when true
+					result += "<span class=\"marked\">"
+					end_of_span = "</span>"
+				when false
+					end_of_span = ""
+				end
+			end
+			result += (format_line % line_no) + " " + escape(line) + "\n"
+			last = marked
+			line_no += 1
+		end
+		result += end_of_span
+		"<pre>#{result}</pre>"
+	end
+	def create_file(file, line_marked, code_marked)
+		url_filename = mk_filename(file)
+		return unless url_filename
+		output_filename, filename, abspath = url_filename
+		puts "outputting #{output_filename.inspect}"
+		body = format_overview(abspath, line_marked, code_marked) +
+			format_lines(line_marked)
+		title = filename + " - coverage"
+		css = <<-EOCSS.gsub(/^\s*/, '')
+		body {
+		  background-color: rgb(180, 180, 180);
+		}
+		span.marked {
+		  background-color: rgb(185, 200, 200);
+		  display: block;
+		}
+		div.overview {
+		  border-bottom: 8px solid black;
+		}
+		EOCSS
+		write_page(body, title, css, output_filename)
+	end
+end # class HTML
+end # module PrettyCoverage
+SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
+module COVERAGE__
+	COVER = {}
+	def self.trace_func(event, file, line, id, binding, klass)
+		case event
+		when 'c-call', 'c-return', 'class'
+			return
+		end
+		COVER[file] ||= []
+		COVER[file][line] ||= 0
+		COVER[file][line] += 1
+	end
+	END {
+		set_trace_func(nil)
+		printer = PrettyCoverage::HTML.new
+		COVER.each do |file, lines|
+			next if SCRIPT_LINES__.has_key?(file) == false
+			lines = SCRIPT_LINES__[file]
+			covers = COVER[file]
+			line_status = []
+			0.upto(lines.size - 1) do |c|
+				line = lines[c].chomp
+				marked = false
+				if covers[c + 1]
+					marked = true
+				elsif /^\s*(?:begin\s*(?:#.*)?|ensure\s*(?:#.*)?|else\s*(?:#.*)?)$/ =~ line and covers[c + 1 + 1]
+					covers[c + 1] = covers[c + 1 + 1]
+					marked = true
+				elsif /^\s*(?:end|\})\s*$/ =~ line && covers[c + 1 - 1]
+					covers[c + 1] = covers[c + 1 - 1]
+					marked = true
+				end
+				line_status << [line, marked]
+			end
+			printer.add_file(file, line_status)
+		end
+		printer.execute
+	} # END
+	set_trace_func(COVERAGE__.method(:trace_func).to_proc)
+end # module COVERAGE__

metadata ADDED

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+rubygems_version: 0.8.11
+specification_version: 1
+name: coverage
+version: !ruby/object:Gem::Version
+  version: "0.3"
+date: 2005-12-29 00:00:00 +01:00
+summary: identifies inactive code
+require_paths:
+  - lib
+email: neoneye@gmail.com
+homepage: http://aeditor.rubyforge.org
+rubyforge_project: aeditor
+description: "output-format is XHTML1.0 strict  credit goes to NAKAMURA Hiroshi, which made
+  the original coverage in 47 lines of code! Mauricio Julio Fern�ndez Pradier,
+  lots of improvements. Robert Feldt, for suggestions. Alex Pooley, for
+  eliminating warnings."
+autorequire: coverage
+default_executable:
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement
+  requirements:
+    -
+      - ">"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  version:
+platform: ruby
+signing_key:
+cert_chain:
+authors:
+  - Simon Strandgaard
+files:
+  - CHANGES
+  - README
+  - TODO
+  - lib/coverage.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []