simplecov-simple-html 0.2.0

data/assets/stylesheets/reset.css

@@ -0,0 +1,103 @@
+/* -----------------------------------------------------------------------
+
+
+ Blueprint CSS Framework 0.9
+ http://blueprintcss.org
+
+   * Copyright (c) 2007-Present. See LICENSE for more info.
+   * See README for instructions on how to use Blueprint.
+   * For credits and origins, see AUTHORS.
+   * This is a compressed file. See the sources in the 'src' directory.
+
+----------------------------------------------------------------------- */
+
+/* reset.css */
+html, body, div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, code, del, dfn, em, img, q, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, dialog, figure, footer, header, hgroup, nav, section {margin:0;padding:0;border:0;font-weight:inherit;font-style:inherit;font-size:100%;font-family:inherit;vertical-align:baseline;}
+article, aside, dialog, figure, footer, header, hgroup, nav, section {display:block;}
+body {line-height:1.5;}
+table {border-collapse:separate;border-spacing:0;}
+caption, th, td {text-align:left;font-weight:normal;}
+table, td, th {vertical-align:middle;}
+blockquote:before, blockquote:after, q:before, q:after {content:"";}
+blockquote, q {quotes:"" "";}
+a img {border:none;}
+
+/* typography.css */
+html {font-size:100.01%;}
+body {font-size:82%;color:#222;background:#fff;font-family:"Helvetica Neue", Arial, Helvetica, sans-serif;}
+h1, h2, h3, h4, h5, h6 {font-weight:normal;color:#111;}
+h1 {font-size:3em;line-height:1;margin-bottom:0.5em;}
+h2 {font-size:2em;margin-bottom:0.75em;}
+h3 {font-size:1.5em;line-height:1;margin-bottom:1em;}
+h4 {font-size:1.2em;line-height:1.25;margin-bottom:1.25em;}
+h5 {font-size:1em;font-weight:bold;margin-bottom:1.5em;}
+h6 {font-size:1em;font-weight:bold;}
+h1 img, h2 img, h3 img, h4 img, h5 img, h6 img {margin:0;}
+p {margin:0 0 1.5em;}
+p img.left {float:left;margin:1.5em 1.5em 1.5em 0;padding:0;}
+p img.right {float:right;margin:1.5em 0 1.5em 1.5em;}
+a:focus, a:hover {color:#000;}
+a {color:#009;text-decoration:underline;}
+blockquote {margin:1.5em;color:#666;font-style:italic;}
+strong {font-weight:bold;}
+em, dfn {font-style:italic;}
+dfn {font-weight:bold;}
+sup, sub {line-height:0;}
+abbr, acronym {border-bottom:1px dotted #666;}
+address {margin:0 0 1.5em;font-style:italic;}
+del {color:#666;}
+pre {margin:1.5em 0;white-space:pre;}
+pre, code, tt {font:1em 'andale mono', 'lucida console', monospace;line-height:1.5;}
+li ul, li ol {margin:0;}
+ul, ol {margin:0 1.5em 1.5em 0;padding-left:3.333em;}
+ul {list-style-type:disc;}
+ol {list-style-type:decimal;}
+dl {margin:0 0 1.5em 0;}
+dl dt {font-weight:bold;}
+dd {margin-left:1.5em;}
+table {margin-bottom:1.4em;width:100%;}
+th {font-weight:bold;}
+thead th {background:#c3d9ff;}
+th, td, caption {padding:4px 10px 4px 5px;}
+tr.even td {background:#efefef;}
+tfoot {font-style:italic;}
+caption {background:#eee;}
+.small {font-size:.8em;margin-bottom:1.875em;line-height:1.875em;}
+.large {font-size:1.2em;line-height:2.5em;margin-bottom:1.25em;}
+.hide {display:none;}
+.quiet {color:#666;}
+.loud {color:#000;}
+.highlight {background:#ff0;}
+.added {background:#060;color:#fff;}
+.removed {background:#900;color:#fff;}
+.first {margin-left:0;padding-left:0;}
+.last {margin-right:0;padding-right:0;}
+.top {margin-top:0;padding-top:0;}
+.bottom {margin-bottom:0;padding-bottom:0;}
+
+/* forms.css */
+label {font-weight:bold;}
+fieldset {padding:1.4em;margin:0 0 1.5em 0;border:1px solid #ccc;}
+legend {font-weight:bold;font-size:1.2em;}
+input[type=text], input[type=password], input.text, input.title, textarea, select {background-color:#fff;border:1px solid #bbb;}
+input[type=text]:focus, input[type=password]:focus, input.text:focus, input.title:focus, textarea:focus, select:focus {border-color:#666;}
+input[type=text], input[type=password], input.text, input.title, textarea, select {margin:0.5em 0;}
+input.text, input.title {width:300px;padding:5px;}
+input.title {font-size:1.5em;}
+textarea {width:390px;height:250px;padding:5px;}
+input[type=checkbox], input[type=radio], input.checkbox, input.radio {position:relative;top:.25em;}
+form.inline {line-height:3;}
+form.inline p {margin-bottom:0;}
+.error, .notice, .success {padding:.8em;margin-bottom:1em;border:2px solid #ddd;}
+.error {background:#FBE3E4;color:#8a1f11;border-color:#FBC2C4;}
+.notice {background:#FFF6BF;color:#514721;border-color:#FFD324;}
+.success {background:#E6EFC2;color:#264409;border-color:#C6D880;}
+.error a {color:#8a1f11;}
+.notice a {color:#514721;}
+.success a {color:#264409;}
+.box {padding:1.5em;margin-bottom:1.5em;background:#E5ECF9;}
+hr {background:#ddd;color:#ddd;clear:both;float:none;width:100%;height:.1em;margin:0 0 1.45em;border:none;}
+hr.space {background:#fff;color:#fff;visibility:hidden;}
+.clearfix:after, .container:after {content:"\0020";display:block;height:0;clear:both;visibility:hidden;overflow:hidden;}
+.clearfix, .container {display:block;}
+.clear {clear:both;}

data/assets/stylesheets/screen.css.sass

@@ -0,0 +1,220 @@
+#loading
+  position: fixed
+  left: 40%
+  top: 50%
+
+a
+  color: #333
+  text-decoration: none
+  &:hover
+    color: #000
+    text-decoration: underline
+
+body
+  font-family: "Lucida Grande", Helvetica, "Helvetica Neue", Arial, sans-serif
+  padding: 12px
+  background-color: #333
+
+h1, h2, h3, h4
+  color: #1C2324
+  margin: 0
+  padding: 0
+  margin-bottom: 12px
+
+table
+  width: 100%
+
+#content
+  clear: left
+  background-color: white
+  border: 2px solid #ddd
+  border-top: 8px solid #ddd
+  padding: 18px
+  -webkit-border-bottom-left-radius: 5px
+  -webkit-border-bottom-right-radius: 5px
+  -webkit-border-top-right-radius: 5px
+  -moz-border-radius-bottomleft: 5px
+  -moz-border-radius-bottomright: 5px
+  -moz-border-radius-topright: 5px
+  border-bottom-left-radius: 5px
+  border-bottom-right-radius: 5px
+  border-top-right-radius: 5px
+
+.dataTables_filter, .dataTables_info
+  padding: 2px 6px
+
+abbr.timeago
+  text-decoration: none
+  border: none
+  font-weight: bold
+
+.timestamp
+  float: right
+  color: #ddd
+
+.group_tabs
+  list-style: none
+  float: left
+  margin: 0
+  padding: 0
+  li
+    display: inline
+    float: left
+    a
+      font-family: Helvetica, Arial, sans-serif
+      display: block
+      float: left
+      text-decoration: none
+      padding: 4px 8px
+      background-color: #aaa
+      background: -webkit-gradient(linear, 0 0, 0 bottom, from(#dddddd), to(#aaaaaa))
+      background: -moz-linear-gradient(#dddddd, #aaaaaa)
+      background: linear-gradient(#dddddd, #aaaaaa)
+      text-shadow: #e5e5e5 1px 1px 0px
+      border-bottom: none
+      color: #333
+      font-weight: bold
+      margin-right: 8px
+      border-top: 1px solid #efefef
+      -webkit-border-top-left-radius: 2px
+      -webkit-border-top-right-radius: 2px
+      -moz-border-radius-topleft: 2px
+      -moz-border-radius-topright: 2px
+      border-top-left-radius: 2px
+      border-top-right-radius: 2px
+      &:hover
+        background-color: #ccc
+        background: -webkit-gradient(linear, 0 0, 0 bottom, from(#eeeeee), to(#aaaaaa))
+        background: -moz-linear-gradient(#eeeeee, #aaaaaa)
+        background: linear-gradient(#eeeeee, #aaaaaa)
+      &:active
+        padding-top: 5px
+        padding-bottom: 3px
+    &.active a
+      color: black
+      text-shadow: #fff 1px 1px 0px
+      background-color: #ddd
+      background: -webkit-gradient(linear, 0 0, 0 bottom, from(white), to(#dddddd))
+      background: -moz-linear-gradient(white, #dddddd)
+      background: linear-gradient(white, #dddddd)
+
+.file_list
+  margin-bottom: 18px
+
+a.src_link
+  background: url('./magnify.png') no-repeat left 50%
+  padding-left: 18px
+
+tr, td
+  margin: 0
+  padding: 0
+
+th
+  white-space: nowrap
+  &.ui-state-default
+    cursor: pointer
+  span.ui-icon
+    float: left
+
+td
+  padding: 4px 8px
+  &.strong
+    font-weight: bold
+
+.source_table
+  h3, h4
+    padding: 0
+    margin: 0
+    margin-bottom: 4px
+  .header
+    padding: 10px
+  pre
+    margin: 0
+    padding: 0
+    white-space: normal
+    color: #000
+    font-family: "Monaco", "Inconsolata", "Consolas", monospace
+  code
+    color: #000
+    font-family: "Monaco", "Inconsolata", "Consolas", monospace
+  pre
+    background-color: #333
+    ol
+      margin: 0px
+      padding: 0px
+      margin-left: 45px
+      font-size: 12px
+      color: white
+    li
+      margin: 0px
+      padding: 2px 6px
+      border-left: 5px solid white
+      code
+        white-space: pre
+        white-space: pre-wrap
+    .hits
+      float: right
+      margin-left: 10px
+      padding: 2px 4px
+      background-color: #444
+      background: -webkit-gradient(linear, 0 0, 0 bottom, from(#222222), to(#666666))
+      background: -moz-linear-gradient(#222222, #666666)
+      background: linear-gradient(#222222, #666666)
+      color: white
+      font-family: Helvetica, "Helvetica Neue", Arial, sans-serif
+      font-size: 10px
+      font-weight: bold
+      text-align: center
+      border-radius: 6px
+
+#footer
+  color: #ddd
+  font-size: 12px
+  font-weight: bold
+  margin-top: 12px
+  text-align: right
+  a
+    color: #eee
+    text-decoration: underline
+    &:hover
+      color: #fff
+      text-decoration: none
+
+.green
+  color: #090
+
+.red
+  color: #900
+
+.yellow
+  color: #da0
+
+.source_table
+  .covered
+    border-color: #090
+  .missed
+    border-color: #900
+  .never
+    border-color: black
+  .skipped
+    border-color: #fc0
+  .covered
+    &:nth-child(odd)
+      background-color: #CDF2CD
+    &:nth-child(even)
+      background-color: #DBF2DB
+  .missed
+    &:nth-child(odd)
+      background-color: #F7C0C0
+    &:nth-child(even)
+      background-color: #F7CFCF
+  .never
+    &:nth-child(odd)
+      background-color: #efefef
+    &:nth-child(even)
+      background-color: #f4f4f4
+  .skipped
+    &:nth-child(odd)
+      background-color: #FBF0C0
+    &:nth-child(even)
+      background-color: #FBFfCf

data/lib/simplecov-simple-html.rb

@@ -0,0 +1,324 @@
+# encodeing: utf-8
+require 'rexml/xpath'
+require 'rexml/document'
+require 'fileutils'
+
+require 'simplecov-simple-html/version'
+
+# Ensure we are using a compatible version of SimpleCov
+if Gem::Version.new(SimpleCov::VERSION) < Gem::Version.new("0.7.1")
+  raise RuntimeError, "The version of SimpleCov you are using is too old. Please update with `gem install simplecov` or `bundle update simplecov`"
+end
+
+# A simple HTML formater for SimpleCov
+# There a coverage file created for each ruby file tested
+class SimpleCov::Formatter::SimpleHTMLFormatter
+  include REXML
+  # fixup the path
+  # @param [REXML::Document] source_doc 
+  # @return [void]
+  def fixup_path(source_doc)
+    source_doc.each_element('//link') do |e|
+      e.add_attribute('href', e.attribute('href').to_s.sub('VERSION', SimpleCov::Formatter::SimpleHTMLFormatter::VERSION))
+    end
+    source_doc.each_element('//script') do |e|
+      e.add_attribute('src', e.attribute('src').to_s.sub('VERSION', SimpleCov::Formatter::SimpleHTMLFormatter::VERSION))
+    end
+    nil
+  end
+  # Format the coverage results
+  # @param [SimpleCov::Result] result The SimpleCov::Result
+  # @return [void]
+  # @note Creates a directory and serveral files
+  def format(result)
+    Dir[File.join(File.dirname(__FILE__), '../public/*')].each do |path|
+      FileUtils.cp_r(path, asset_output_path)
+    end
+    File.open(File.join(File.dirname(__FILE__), '../views/source.html.in'), "r") do |ifile|
+      source_doc = REXML::Document.new ifile
+      fixup_path(source_doc)
+      result.source_files.each do |source_file|
+        doc = source_doc.deep_clone
+        doc.each_recursive do |e|
+          case e.attribute('class').to_s
+          when 'filename'
+            e.text = shortened_filename source_file.filename
+          when 'covered_percent'
+            e.text = source_file.covered_percent.round(2).to_s
+            e.parent.attributes['style'] = "color: #{ coverage_css_class(source_file.covered_percent) };"
+          when 'lines_of_code'
+            e.text = source_file.lines_of_code
+          when 'covered_lines'
+            e.text = source_file.covered_lines.size
+          when 'missed_lines'
+            e.text = source_file.missed_lines.size
+          end
+        end
+        ol = doc.get_elements('//div/pre/ol')[0]
+        li = doc.get_elements('//div/pre/ol/li')[0]
+        ol.delete_element(li)
+        source_file.lines.each_with_index do |line|
+          nli = li.deep_clone
+          nli.add_attribute("class", line.status)
+          nli.add_attribute("data-linenumber", line.number)
+          nli.add_attribute("data-hits", line.coverage ? line.coverage : '')
+
+          nli.get_elements('code')[0].text = line.src
+          if line.covered?
+            nli.get_elements('span')[0].text = line.coverage
+          elsif line.skipped?
+            nli.get_elements('span')[0].text = line.coverage
+          else
+            nli.delete_element(nli.get_elements('span')[0])
+          end
+          ol << nli
+        end
+        filename = File.join(output_path, shortened_filename(source_file.filename).gsub('/', '_') + '.html')
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename, 'w') do |ofile|
+          ofile.puts doc.to_s
+        end
+      end
+    end
+    groups = [ "All Files" ] +  result.groups.each_key.to_a
+    a = Array.new
+    a = a.push [ "All Files", result.source_files ]
+    a += result.groups.to_a
+    groups_hash = Hash[ a ]
+
+    File.open(File.join(File.dirname(__FILE__), '../views/index.html.in'), "r") do |ifile|
+      data = ifile.read
+      groups.each_with_index do |name, i|
+        doc = REXML::Document.new data
+        source_files = groups_hash[name]
+        fixup_path(doc)
+        doc.xpath
+        body = doc.root.elements['body/div']
+        XPath.each(body, '//*[@class="source_files_covered_percent"]') do |element|  
+          element.text = source_files.covered_percent.round(2)
+          element.parent.attributes['class'] = coverage_css_class(source_files.covered_percent)
+        end
+        XPath.each(body, '//*/span[@class="covered_strength_value"]') do |x|  
+          x.text = source_files.covered_strength.round(2)
+          x.parent.attributes['class'] =  strength_css_class(source_files.covered_strength)
+        end
+        XPath.each(body, '//*/span[@class="files_total"]') do |x|  
+	  x.text = source_files.size
+	end
+        XPath.each(body, '//*/span[@class="file_lines"]') do |x|  
+	  x.text = source_files.lines_of_code
+	end
+        XPath.each(body, '//*/span[@class="covered_lines"]') do |x|  
+	  x.text = source_files.covered_lines
+	end
+        XPath.each(body, '//*/span[@class="missed_lines"]') do |x|  
+	  x.text = source_files.missed_lines
+	end
+        XPath.each(body, '//*/ul[@class="group_tabs"]').each do |x|  
+#p x.to_s
+	end
+        body.each_element do |body_element|
+          if body_element.attribute('class')
+            case body_element.attribute('class').to_s
+            when 'timestamp'
+              body_element.each_element do |e2|
+                case e2.name.to_s
+                when 'abbr'
+                  time = Time.now
+                  e2.add_attribute('title', time.iso8601)
+                  e2.text = time.iso8601
+                end
+              end
+            when 'group_tabs'
+	      fli = nil
+              body_element.to_a.each do |li|
+                case li
+		when REXML::Element
+	          fli = li.dup unless fli
+                  body_element.delete_element li
+		when REXML::Text
+                  body_element.delete li
+		else
+                  raise 'unknown'
+		end
+              end
+	      groups.each_with_index do |g, gi|
+		g_source_files = groups_hash[g]
+		nli = fli.deep_clone
+		if g == name
+		  nli.attributes['class'] = 'active'
+		end
+		nli.each_element('a/span[@class="tab_group_name"]') do |x|
+		  x.text = g
+		end
+		nli.each_element('a/span[@class="color"]') do |x|
+		  x.attributes['class'] = coverage_css_class(g_source_files.covered_percent)
+		end
+		nli.each_element('a/span/span[@class="tab_coverage"]') do |x|
+		  x.text = g_source_files.covered_percent.round(2)
+		end
+		nli.each_element('a') do |x|
+		  if gi > 0
+		    x.attributes['href'] = 'index%d.html' % gi
+		  else
+		    x.attributes['href'] = 'index.html'
+		  end
+		end
+		body_element.add_element nli
+	      end
+            end
+          end
+          if body_element.attribute('id')
+            case body_element.attribute('id').to_s
+            when 'content'
+              file_list_container = body_element.get_elements("//div[@class='file_list_container']")[0]
+              file_list_container.add_attribute('id', 'AllFiles')
+  #           x = file_list_container.deep_clone
+              x = file_list_container
+              x.each_element do |e1|
+                case e1.name
+                when 'h2'
+                  e1.each_recursive do |e2|
+                    case e2.attribute('class').to_s
+                    when 'group_name'
+                      e2.text = name
+                    end
+                  end
+                when 'table'
+                  tbody = e1.get_elements('//tbody')[0]
+                  body_element.each_element('//tbody/tr') do |tr|
+                    tbody.delete_element tr
+                    source_files.each do |source_file|
+                      ntr = tr.deep_clone
+                      x = ntr.get_elements('//td')
+                      filename = x[0].get_elements('a')[0]
+                      filename.text = shortened_filename source_file.filename
+                      filename.add_attribute('href', shortened_filename(source_file.filename).gsub('/', '_') + '.html')
+                      x[1].add_attribute('class', coverage_css_class(source_file.covered_percent))
+                      x[1].text = source_file.covered_percent.round(2)
+                      x[2].text = source_file.lines.count
+                      x[3].text = source_file.covered_lines.size + source_file.missed_lines.count
+                      x[4].text = source_file.covered_lines.size
+                      x[5].text = source_file.missed_lines.size
+                      x[6].text = source_file.covered_strength
+                      tbody << ntr
+                    end
+                  end
+                else
+  #puts e
+                end
+              end
+            when 'footer'
+              body_element.each_element do |e|
+                case body_element.attribute('id').to_s
+                when 'simplecov_version'
+                  body_element.text = SimpleCov::VERSION
+                when 'result.command_name'
+                  body_element.text = result.command_name
+                else 
+  #puts body_element
+                end
+              end
+            else
+  puts "Id #{ body_element.attribute('id').to_s }"
+            end
+          end
+        end
+        if i == 0
+          ofilename = 'index.html'
+        else
+          ofilename = "index#{i}.html"
+        end
+        File.open(File.join(output_path, ofilename), "w+") do |ofile|
+          ofile.puts doc.to_s
+        end
+      end
+    end
+    puts output_message(result)
+    nil
+  end
+
+  # Generate the coverage report text
+  # @param [SimpleCov::Result] result The SimpleCov::Result
+  # @return [String] the coverage report
+  def output_message(result)
+    "Coverage report generated for #{result.command_name} to #{output_path}. #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered."
+  end
+
+private
+
+  # Returns the an erb instance for the template of given name
+  # @deprecated
+  def template(name)
+    raise "template(#{name})"
+  end
+
+  # @return [String] the path where the coverage report will be generated
+  def output_path
+    SimpleCov.coverage_path
+  end
+
+  # @return [String] the path where the assests are stored
+  def asset_output_path
+    return @asset_output_path if defined? @asset_output_path and @asset_output_path
+    @asset_output_path = File.join(output_path, 'assets', SimpleCov::Formatter::SimpleHTMLFormatter::VERSION)
+    FileUtils.mkdir_p(@asset_output_path)
+    @asset_output_path
+  end
+
+  # @return [String] the path to a particular asset
+  def assets_path(name)
+    File.join('./assets', SimpleCov::Formatter::SimpleHTMLFormatter::VERSION, name)
+  end
+
+  # Returns the html for the given source_file
+  def formatted_source_file(source_file)
+    template('source_file').result(binding)
+  end
+
+  # Returns a table containing the given source files
+  def formatted_file_list(title, source_files)
+    title_id = title.gsub(/^[^a-zA-Z]+/, '').gsub(/[^a-zA-Z0-9\-\_]/, '')
+    title_id # Ruby will give a warning when we do not use this except via the binding :( FIXME
+    template('file_list').result(binding)
+  end
+
+  def coverage_css_class(covered_percent)
+    if covered_percent > 90
+      'green'
+    elsif covered_percent > 80
+      'yellow'
+    else
+      'red'
+    end
+  end
+
+  def strength_css_class(covered_strength)
+    if covered_strength > 1
+      'green'
+    elsif covered_strength == 1
+      'yellow'
+    else
+      'red'
+    end
+  end
+
+  # Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
+  # @return [String] Digest::SHA1.hexdigest of the source_file
+  def id(source_file)
+    Digest::SHA1.hexdigest(source_file.filename)
+  end
+
+  def timeago(time)
+    "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
+  end
+
+  def shortened_filename(source_file_name)
+    source_file_name.gsub(SimpleCov.root, '.').gsub(/^\.\//, '')
+  end
+
+  def link_to_source_file(source_file)
+    %Q(<a href="##{id source_file}" class="src_link" title="#{shortened_filename source_file}">#{shortened_filename source_file}</a>)
+  end
+end
+