RubyGems - jahtml_formatter - Versions diffs - 1.0.0 → 1.0.1 - Mend

jahtml_formatter 1.0.0 → 1.0.1

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 (6) hide show

data/Gemfile +0 -0
data/jahtml_formatter.gemspec +1 -1
data/lib/iso_example_group_methods.rb +14 -0
data/lib/jahtml_formatter.rb +9 -225
data/lib/jahtml_printer.rb +402 -0
metadata +4 -2

data/Gemfile CHANGED Viewed

File without changes

data/jahtml_formatter.gemspec CHANGED Viewed

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.name        = "jahtml_formatter"
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Martin Westin"]
   s.email       = ["martin@eimermusic.com"]

data/lib/iso_example_group_methods.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# coding: UTF-8
+module IsoExampleGroupMethods
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+  module ClassMethods
+    def description
+      if iso_id = metadata.delete(:iso_id)
+        metadata[:example_group][:description] = "#{iso_id} #{metadata[:example_group][:description]}"
+      end
+      super
+    end
+  end
+end

data/lib/jahtml_formatter.rb CHANGED Viewed

@@ -1,231 +1,15 @@
 require 'erb'
 require 'rspec/core/formatters/html_formatter'
+require 'jahtml_printer'
+require 'iso_example_group_methods'
 class JahtmlFormatter < RSpec::Core::Formatters::HtmlFormatter
-  def html_header
-          <<-EOF
-<?xml version="1.0" encoding="UTF-8"?>
-<!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" xml:lang="en" lang="en">
-<head>
-  <title>RSpec results</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <meta http-equiv="Expires" content="-1" />
-  <meta http-equiv="Pragma" content="no-cache" />
-  <style type="text/css">
-  body {
-    margin: 0;
-    padding: 0;
-    background: #fff;
-    font-size: 80%;
-  }
-  </style>
-  <script type="text/javascript">
-    // <![CDATA[
-#{global_scripts}
-    // ]]>
-  </script>
-  <style type="text/css">
-#{global_styles}
-  </style>
-</head>
-<body>
-EOF
-  end
-  def report_header
-          <<-EOF
-<div class="rspec-report">
-<div id="rspec-header">
-  <div id="label">
-    <h1>Automated Software Test Report</h1>
-  </div>
-  <div id="summary">
-    <p id="totals">&nbsp;</p>
-    <p id="duration">&nbsp;</p>
-  </div>
-</div>
-<div class="results">
-EOF
-  end
-  def global_styles
-          <<-EOF
-#rspec-header {
-  color: #000; height: 4em; border-top: 1em solid #65C400;
-}
-.rspec-report h1 {
-  margin: 0px 10px 0px 10px;
-  padding: 10px;
-  font-family: "Lucida Grande", Helvetica, sans-serif;
-  font-size: 1.8em;
-  position: absolute;
-}
-#label {
-  float:left;
-}
-#display-filters {
-  float:left;
-  padding: 28px 0 0 40%;
-  font-family: "Lucida Grande", Helvetica, sans-serif;
-}
-#summary {
-  float:right;
-  padding: 5px 10px;
-  font-family: "Lucida Grande", Helvetica, sans-serif;
-  text-align: right;
-}
-#summary p {
-  margin: 0 0 0 2px;
-}
-#summary #totals {
-  font-size: 1.2em;
-}
-.example_group {
-  margin: 0 10px 5px;
-  background: #fff;
-}
-dl {
-  margin: 0; padding: 0 0 5px;
-  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
-}
-dt {
-  color: #000;
-  font-weight: bold;
-  padding:3px;
-}
-dd {
-  margin: 5px 0 5px 5px;
-  padding: 3px 3px 3px 18px;
-}
-dd .duration {
-  padding-left: 5px;
-  text-align: right;
-  right: 0px;
-  float:right;
-}
-dd.example.passed {
-  border-left: 5px solid #65C400;
-  border-bottom: 1px solid #65C400;
-  color: #000;
-}
-dd.example.not_implemented {
-  border-left: 5px solid #FAF834;
-  border-bottom: 1px solid #FAF834;
-  color: #000;
-}
-dd.example.pending_fixed {
-  border-left: 5px solid #0000C2;
-  border-bottom: 1px solid #0000C2;
-  color: #000;
-}
-dd.example.failed {
-  border-left: 5px solid #C20000;
-  border-bottom: 1px solid #C20000;
-  color: #000;
-}
-dd.example.passed:after {
-  content: " PASSED, ";
-  float:right;
-  white-space: nowrap;
-  border-left: 1em solid #65C400;
-  padding-left: .5em;
-}
-dt.not_implemented {
-  color: #000000; background: #FAF834;
-}
-dt.pending_fixed {
-  color: #FFFFFF; background: #C40D0D;
-}
-dt.failed {
-  border-left: 5px solid #C20000;
-}
-#rspec-header.not_implemented {
-  border-top: 1em solid #FAF834;
-}
-#rspec-header.pending_fixed {
-  border-top: 1em solid #C40D0D;
-}
-#rspec-header.failed {
-  border-top: 1em solid #C40D0D;
-}
-.backtrace {
-  color: #000;
-  font-size: 12px;
-}
-a {
-  color: #BE5C00;
-}
-/* Ruby code, style similar to vibrant ink */
-.ruby {
-  font-size: 12px;
-  font-family: monospace;
-  color: white;
-  background-color: black;
-  padding: 0.1em 0 0.2em 0;
-}
-.ruby .keyword { color: #FF6600; }
-.ruby .constant { color: #339999; }
-.ruby .attribute { color: white; }
-.ruby .global { color: white; }
-.ruby .module { color: white; }
-.ruby .class { color: white; }
-.ruby .string { color: #66FF00; }
-.ruby .ident { color: white; }
-.ruby .method { color: #FFCC00; }
-.ruby .number { color: white; }
-.ruby .char { color: white; }
-.ruby .comment { color: #9933CC; }
-.ruby .symbol { color: white; }
-.ruby .regex { color: #44B4CC; }
-.ruby .punct { color: white; }
-.ruby .escape { color: white; }
-.ruby .interp { color: white; }
-.ruby .expr { color: white; }
-.ruby .offending { background-color: gray; }
-.ruby .linenum {
-  width: 75px;
-  padding: 0.1em 1em 0.2em 0;
-  color: #000000;
-  background-color: #FFFBD3;
-}
-EOF
+  def initialize(output)
+    super(output)
+    @printer = JahtmlPrinter.new(output)
   end
 end
+RSpec.configure do |config|
+  config.include IsoExampleGroupMethods
+end

data/lib/jahtml_printer.rb ADDED Viewed

@@ -0,0 +1,402 @@
+require 'erb'
+      class JahtmlPrinter
+        include ERB::Util # for the #h method
+        def initialize(output)
+          @output = output
+        end
+        def print_html_start
+          @output.puts HTML_HEADER
+          @output.puts REPORT_HEADER
+        end
+        def print_example_group_end
+          @output.puts "  </dl>"
+          @output.puts "</div>"
+        end
+        def print_example_group_start( group_id, description, number_of_parents  )
+          @output.puts "<div id=\"div_group_#{group_id}\" class=\"example_group passed\">"
+          @output.puts "  <dl #{indentation_style(number_of_parents)}>"
+          @output.puts "  <dt id=\"example_group_#{group_id}\" class=\"passed\">#{h(description)}</dt>"
+        end
+        def print_example_passed( description, run_time )
+          formatted_run_time = sprintf("%.5f", run_time)
+          @output.puts "    <dd class=\"example passed\"><span class=\"passed_spec_name\">#{h(description)}</span><span class='duration'>#{formatted_run_time}s</span></dd>"
+        end
+        def print_example_failed( pending_fixed, description, run_time, failure_id, exception, extra_content )
+          formatted_run_time = sprintf("%.5f", run_time)
+          @output.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
+          @output.puts "      <span class=\"failed_spec_name\">#{h(description)}</span>"
+          @output.puts "      <span class=\"duration\">#{formatted_run_time}s</span>"
+          @output.puts "      <div class=\"failure\" id=\"failure_#{failure_id}\">"
+          if exception
+            @output.puts "        <div class=\"message\"><pre>#{h(exception[:message])}</pre></div>"
+            @output.puts "        <div class=\"backtrace\"><pre>#{exception[:backtrace]}</pre></div>"
+          end
+          @output.puts extra_content if extra_content
+          @output.puts "      </div>"
+          @output.puts "    </dd>"
+        end
+        def print_example_pending( description, pending_message )
+          @output.puts "    <dd class=\"example not_implemented\"><span class=\"not_implemented_spec_name\">#{h(description)} (PENDING: #{h(pending_message)})</span></dd>"
+        end
+        def print_summary( was_dry_run, duration, example_count, failure_count, pending_count )
+          # TODO - kill dry_run?
+          if was_dry_run
+            totals = "This was a dry-run"
+          else
+            totals =  "#{example_count} example#{'s' unless example_count == 1}, "
+            totals << "#{failure_count} failure#{'s' unless failure_count == 1}"
+            totals << ", #{pending_count} pending" if pending_count > 0
+          end
+          formatted_duration = sprintf("%.5f", duration)
+          @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{formatted_duration} seconds</strong>\";</script>"
+          @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
+          @output.puts "</div>"
+          @output.puts "</div>"
+          @output.puts "</body>"
+          @output.puts "</html>"
+        end
+        def flush
+          @output.flush
+        end
+        def move_progress( percent_done )
+          @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
+          @output.flush
+        end
+        def make_header_red
+          @output.puts "    <script type=\"text/javascript\">makeRed('rspec-header');</script>"
+        end
+        def make_header_yellow
+          @output.puts "    <script type=\"text/javascript\">makeYellow('rspec-header');</script>"
+        end
+        def make_example_group_header_red(group_id)
+          @output.puts "    <script type=\"text/javascript\">makeRed('div_group_#{group_id}');</script>"
+          @output.puts "    <script type=\"text/javascript\">makeRed('example_group_#{group_id}');</script>"
+        end
+        def make_example_group_header_yellow(group_id)
+          @output.puts "    <script type=\"text/javascript\">makeYellow('div_group_#{group_id}');</script>"
+          @output.puts "    <script type=\"text/javascript\">makeYellow('example_group_#{group_id}');</script>"
+        end
+        private
+        def indentation_style( number_of_parents )
+          "style=\"margin-left: #{(number_of_parents - 1) * 15}px;\""
+        end
+        REPORT_HEADER = <<-EOF
+<div class="rspec-report">
+<div id="rspec-header">
+  <div id="label">
+    <h1>Automated Software Test Report</h1>
+  </div>
+  <div id="summary">
+    <p id="totals">&nbsp;</p>
+    <p id="duration">&nbsp;</p>
+  </div>
+</div>
+<div class="results">
+EOF
+        GLOBAL_SCRIPTS = <<-EOF
+function addClass(element_id, classname) {
+  document.getElementById(element_id).className += (" " + classname);
+}
+function removeClass(element_id, classname) {
+  var elem = document.getElementById(element_id);
+  var classlist = elem.className.replace(classname,'');
+  elem.className = classlist;
+}
+function moveProgressBar(percentDone) {
+  document.getElementById("rspec-header").style.width = percentDone +"%";
+}
+function makeRed(element_id) {
+  removeClass(element_id, 'passed');
+  removeClass(element_id, 'not_implemented');
+  addClass(element_id,'failed');
+}
+function makeYellow(element_id) {
+  var elem = document.getElementById(element_id);
+  if (elem.className.indexOf("failed") == -1) {  // class doesn't includes failed
+    if (elem.className.indexOf("not_implemented") == -1) { // class doesn't include not_implemented
+      removeClass(element_id, 'passed');
+      addClass(element_id,'not_implemented');
+    }
+  }
+}
+function apply_filters() {
+  var passed_filter = document.getElementById('passed_checkbox').checked;
+  var failed_filter = document.getElementById('failed_checkbox').checked;
+  var pending_filter = document.getElementById('pending_checkbox').checked;
+  assign_display_style("example passed", passed_filter);
+  assign_display_style("example failed", failed_filter);
+  assign_display_style("example not_implemented", pending_filter);
+  assign_display_style_for_group("example_group passed", passed_filter);
+  assign_display_style_for_group("example_group not_implemented", pending_filter, pending_filter || passed_filter);
+  assign_display_style_for_group("example_group failed", failed_filter, failed_filter || pending_filter || passed_filter);
+}
+function get_display_style(display_flag) {
+  var style_mode = 'none';
+  if (display_flag == true) {
+    style_mode = 'block';
+  }
+  return style_mode;
+}
+function assign_display_style(classname, display_flag) {
+  var style_mode = get_display_style(display_flag);
+  var elems = document.getElementsByClassName(classname)
+  for (var i=0; i<elems.length;i++) {
+    elems[i].style.display = style_mode;
+  }
+}
+function assign_display_style_for_group(classname, display_flag, subgroup_flag) {
+  var display_style_mode = get_display_style(display_flag);
+  var subgroup_style_mode = get_display_style(subgroup_flag);
+  var elems = document.getElementsByClassName(classname)
+  for (var i=0; i<elems.length;i++) {
+    var style_mode = display_style_mode;
+    if ((display_flag != subgroup_flag) && (elems[i].getElementsByTagName('dt')[0].innerHTML.indexOf(", ") != -1)) {
+      elems[i].style.display = subgroup_style_mode;
+    } else {
+      elems[i].style.display = display_style_mode;
+    }
+  }
+}
+EOF
+        GLOBAL_STYLES = <<-EOF
+#rspec-header {
+  color: #000; height: 4em; border-top: 1em solid #65C400;
+}
+.rspec-report h1 {
+  margin: 0px 10px 0px 10px;
+  padding: 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  font-size: 1.8em;
+  position: absolute;
+}
+#label {
+  float:left;
+}
+#display-filters {
+  float:left;
+  padding: 28px 0 0 40%;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+}
+#summary {
+  float:right;
+  padding: 5px 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  text-align: right;
+}
+#summary p {
+  margin: 0 0 0 2px;
+}
+#summary #totals {
+  font-size: 1.2em;
+}
+.example_group {
+  margin: 0 10px 5px;
+  background: #fff;
+}
+dl {
+  margin: 0; padding: 0 0 5px;
+  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
+}
+dt {
+  color: #000;
+  font-weight: bold;
+  padding:3px;
+}
+dd {
+  margin: 5px 0 5px 5px;
+  padding: 3px 3px 3px 18px;
+}
+dd .duration {
+  padding-left: 5px;
+  text-align: right;
+  right: 0px;
+  float:right;
+}
+dd.example.passed {
+  border-left: 5px solid #65C400;
+  border-bottom: 1px solid #65C400;
+  color: #000;
+}
+dd.example.not_implemented {
+  border-left: 5px solid #FAF834;
+  border-bottom: 1px solid #FAF834;
+  color: #000;
+}
+dd.example.pending_fixed {
+  border-left: 5px solid #0000C2;
+  border-bottom: 1px solid #0000C2;
+  color: #000;
+}
+dd.example.failed {
+  border-left: 5px solid #C20000;
+  border-bottom: 1px solid #C20000;
+  color: #000;
+}
+dd.passed:after {
+  content: " PASSED, ";
+  float:right;
+  white-space: nowrap;
+  border-left: 1em solid #65C400;
+  padding-left: .5em;
+}
+dt.not_implemented {
+  color: #000000; background: #FAF834;
+}
+dt.pending_fixed {
+  color: #FFFFFF; background: #C40D0D;
+}
+dt.failed {
+  border-left: 5px solid #C20000;
+}
+#rspec-header.not_implemented {
+  border-top: 1em solid #FAF834;
+}
+#rspec-header.pending_fixed {
+  border-top: 1em solid #C40D0D;
+}
+#rspec-header.failed {
+  border-top: 1em solid #C40D0D;
+}
+.backtrace {
+  color: #000;
+  font-size: 12px;
+}
+a {
+  color: #BE5C00;
+}
+/* Ruby code, style similar to vibrant ink */
+.ruby {
+  font-size: 12px;
+  font-family: monospace;
+  color: white;
+  background-color: black;
+  padding: 0.1em 0 0.2em 0;
+}
+.ruby .keyword { color: #FF6600; }
+.ruby .constant { color: #339999; }
+.ruby .attribute { color: white; }
+.ruby .global { color: white; }
+.ruby .module { color: white; }
+.ruby .class { color: white; }
+.ruby .string { color: #66FF00; }
+.ruby .ident { color: white; }
+.ruby .method { color: #FFCC00; }
+.ruby .number { color: white; }
+.ruby .char { color: white; }
+.ruby .comment { color: #9933CC; }
+.ruby .symbol { color: white; }
+.ruby .regex { color: #44B4CC; }
+.ruby .punct { color: white; }
+.ruby .escape { color: white; }
+.ruby .interp { color: white; }
+.ruby .expr { color: white; }
+.ruby .offending { background-color: gray; }
+.ruby .linenum {
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: #000000;
+  background-color: #FFFBD3;
+}
+EOF
+        HTML_HEADER = <<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<!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" xml:lang="en" lang="en">
+<head>
+  <title>Automated Software Test Report</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Expires" content="-1" />
+  <meta http-equiv="Pragma" content="no-cache" />
+  <style type="text/css">
+  body {
+    margin: 0;
+    padding: 0;
+    background: #fff;
+    font-size: 80%;
+  }
+  </style>
+  <script type="text/javascript">
+    // <![CDATA[
+#{GLOBAL_SCRIPTS}
+    // ]]>
+  </script>
+  <style type="text/css">
+#{GLOBAL_STYLES}
+  </style>
+</head>
+<body>
+EOF
+      end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jahtml_formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -41,7 +41,9 @@ files:
 - LICENSE
 - README.md
 - jahtml_formatter.gemspec
+- lib/iso_example_group_methods.rb
 - lib/jahtml_formatter.rb
+- lib/jahtml_printer.rb
 homepage: https://github.com/eimermusic/jahtml_formatter
 licenses: []
 post_install_message: