teaspoon 0.8.0 → 0.9.0

data/lib/teaspoon/formatters/base.rb

@@ -1,28 +1,40 @@
+require "set"
+require "teaspoon/formatters/description"
+
 module Teaspoon
   module Formatters
+    @@known_formatters = SortedSet.new
+
+    def self.known_formatters
+      @@known_formatters
+    end
+
+    def self.register(name, details)
+      description = Description.new(name, details)
+      @@known_formatters << description
+      autoload description.class_name, description.require_path
+    end
 
     # CONTRIBUTORS:
     # If you add a formatter you should do the following before it will be considered for merging.
     # - add it to this list so it can be autoloaded
     # - write specs for it
     # - add it to the readme so it's documented
-    # - add it to the list in command_line.rb so others know it's available
-    # - add it to the initializers in /lib/generators/install/templates so it's documented there as well
-
-    autoload :CleanFormatter,         "teaspoon/formatters/clean_formatter"
-    autoload :DocumentationFormatter, "teaspoon/formatters/documentation_formatter"
-    autoload :DotFormatter,           "teaspoon/formatters/dot_formatter"
-    autoload :JsonFormatter,          "teaspoon/formatters/json_formatter"
-    autoload :JunitFormatter,         "teaspoon/formatters/junit_formatter"
-    autoload :PrideFormatter,         "teaspoon/formatters/pride_formatter"
-    autoload :SnowdayFormatter,       "teaspoon/formatters/snowday_formatter"
-    autoload :SwayzeOrOprahFormatter, "teaspoon/formatters/swayze_or_oprah_formatter"
-    autoload :TapFormatter,           "teaspoon/formatters/tap_formatter"
-    autoload :TapYFormatter,          "teaspoon/formatters/tap_y_formatter"
-    autoload :TeamcityFormatter,      "teaspoon/formatters/teamcity_formatter"
 
-    class Base
+    register :clean,           description: "like dots but doesn't log re-run commands"
+    register :documentation,   description: "descriptive documentation"
+    register :dot,             description: "dots", default: true
+    register :json,            description: "json formatter (raw teaspoon)"
+    register :junit,           description: "junit compatible formatter"
+    register :pride,           description: "yay rainbows!"
+    register :rspec_html,      description: "RSpec inspired HTML format"
+    register :snowday,         description: "makes you feel warm inside"
+    register :swayze_or_oprah, description: "quote from either Patrick Swayze or Oprah Winfrey"
+    register :tap,             description: "test anything protocol formatter"
+    register :tap_y,           description: "tap_yaml, format used by tapout"
+    register :teamcity,        description: "teamcity compatible formatter"
 
+    class Base
       attr_accessor :total_count, :run_count, :passes, :pendings, :failures, :errors
 
       def initialize(suite_name = :default, output_file = nil)
@@ -106,9 +118,9 @@ module Teaspoon
 
       protected
 
-      def log_runner(result); end
+      def log_runner(_result); end
 
-      def log_suite(result); end
+      def log_suite(_result); end
 
       def log_spec(result)
         return log_passing_spec(result) if result.passing?
@@ -116,25 +128,25 @@ module Teaspoon
         log_failing_spec(result)
       end
 
-      def log_passing_spec(result); end
+      def log_passing_spec(_result); end
 
-      def log_pending_spec(result); end
+      def log_pending_spec(_result); end
 
-      def log_failing_spec(result); end
+      def log_failing_spec(_result); end
 
-      def log_error(result); end
+      def log_error(_result); end
 
-      def log_exception(result); end
+      def log_exception(_result); end
 
-      def log_console(message); end
+      def log_console(_message); end
 
-      def log_result(result); end
+      def log_result(_result); end
 
-      def log_coverage(message); end
+      def log_coverage(_message); end
 
-      def log_threshold_failure(message); end
+      def log_threshold_failure(_message); end
 
-      def log_complete(failure_count); end
+      def log_complete(_failure_count); end
 
       private
 

data/lib/teaspoon/formatters/clean_formatter.rb

@@ -1,7 +1,6 @@
 module Teaspoon
   module Formatters
     class CleanFormatter < DotFormatter
-
       private
 
       def log_failed_examples

data/lib/teaspoon/formatters/description.rb

@@ -0,0 +1,36 @@
+require "active_support/core_ext/string"
+require "active_support/inflector"
+
+module Teaspoon
+  module Formatters
+    class Description
+      attr_reader :name, :description
+
+      def initialize(name, details)
+        @name = name
+        @description = details[:description]
+        @default = details[:default]
+      end
+
+      def default?
+        @default
+      end
+
+      def cli_help
+        "  #{name}#{' (default)' if default?} - #{description}"
+      end
+
+      def class_name
+        "#{name.to_s.camelize}Formatter"
+      end
+
+      def require_path
+        "teaspoon/formatters/#{name}_formatter"
+      end
+
+      def <=>(other)
+        name <=> other.name
+      end
+    end
+  end
+end

data/lib/teaspoon/formatters/documentation_formatter.rb

@@ -43,7 +43,7 @@ module Teaspoon
 
       def log_intent_stdout(level)
         return if @stdout.blank?
-        log_indent_line("# #{@stdout.gsub(/\n$/, "").gsub("\n", "\n# ")}", level, CYAN)
+        log_indent_line("# #{@stdout.gsub(/\n$/, '').gsub("\n", "\n# ")}", level, CYAN)
       end
 
       def log_indent_line(str = "", level = nil, color = nil)
@@ -51,7 +51,7 @@ module Teaspoon
       end
 
       def indent(str = "", level = nil)
-        indent = "#{"  " * level}"
+        indent = " " * (level * 2)
         str.gsub!("\n", "\n#{indent}")
         "#{indent}#{str}"
       end

data/lib/teaspoon/formatters/json_formatter.rb

@@ -1,7 +1,6 @@
 module Teaspoon
   module Formatters
     class JsonFormatter < Base
-
       protected
 
       def log_runner(result)
@@ -25,7 +24,7 @@ module Teaspoon
       end
 
       def log_console(message)
-        log_line(%Q{{"type":"console","log":"#{message.gsub(/\n$/, "").gsub("\n", "\\n")}"}})
+        log_line(%{{"type":"console","log":"#{message.gsub(/\n$/, '').gsub('\n', '\\n')}"}})
       end
 
       def log_result(result)

data/lib/teaspoon/formatters/junit_formatter.rb

@@ -3,18 +3,17 @@ require "cgi"
 module Teaspoon
   module Formatters
     class JunitFormatter < Base
-
       protected
 
       def log_runner(result)
-        log_line(%Q{<?xml version="1.0" encoding="UTF-8"?>})
-        log_line(%Q{<testsuites name="Teaspoon">})
-        log_line(%Q{<testsuite name="#{@suite_name}" tests="#{@total_count}" time="#{result.start}">})
+        log_line(%{<?xml version="1.0" encoding="UTF-8"?>})
+        log_line(%{<testsuites name="Teaspoon">})
+        log_line(%{<testsuite name="#{escape(@suite_name)}" tests="#{@total_count}" time="#{result.start}">})
       end
 
       def log_suite(result)
         log_end_suite
-        log_line(%Q{<testsuite name="#{result.label}">})
+        log_line(%{<testsuite name="#{escape(result.label)}">})
       end
 
       def log_passing_spec(result)
@@ -23,47 +22,48 @@ module Teaspoon
 
       def log_pending_spec(result)
         log_junit_spec(suite: result.suite, label: result.label) do
-          log_line(%Q{  <skipped/>})
+          log_line(%{  <skipped/>})
         end
       end
 
       def log_failing_spec(result)
         log_junit_spec(suite: result.suite, label: result.label) do
-          log_line(%Q{  <failure type="AssertionFailed">#{cdata(result.message)}</failure>})
+          log_line(%{  <failure type="AssertionFailed">#{cdata(result.message)}</failure>})
         end
       end
 
-      def log_result(result)
+      def log_result(_result)
         log_end_suite
       end
 
       def log_coverage(message)
-        log_line(%Q{<testsuite name="Coverage summary" tests="0">\n<properties>#{cdata(message)}<properties>\n</testsuite>})
+        properties = "<properties>#{cdata(message)}</properties>"
+        log_line(%{<testsuite name="Coverage summary" tests="0">\n#{properties}\n</testsuite>})
       end
 
       def log_threshold_failure(message)
-        log_line(%Q{<testsuite name="Coverage thresholds" tests="1">})
+        log_line(%{<testsuite name="Coverage thresholds" tests="1">})
         log_junit_spec(suite: "Coverage thresholds", label: "were not met") do
-          log_line(%Q{  <failure type="AssertionFailed">#{cdata(message)}</failure>})
+          log_line(%{  <failure type="AssertionFailed">#{cdata(message)}</failure>})
         end
-        log_line(%Q{</testsuite>})
+        log_line(%{</testsuite>})
       end
 
-      def log_complete(failure_count)
-        log_line(%Q{</testsuite>\n</testsuites>})
+      def log_complete(_failure_count)
+        log_line(%{</testsuite>\n</testsuites>})
       end
 
       private
 
       def log_end_suite
-        log_line(%Q{</testsuite>}) if @last_suite
+        log_line(%{</testsuite>}) if @last_suite
       end
 
-      def log_junit_spec(opts, &block)
-        log_line(%Q{<testcase classname="#{escape(opts[:suite])}" name="#{escape(opts[:label])}">})
+      def log_junit_spec(opts, &_block)
+        log_line(%{<testcase classname="#{escape(opts[:suite])}" name="#{escape(opts[:label])}">})
         yield if block_given?
-        log_line(%Q{<system-out>#{cdata(@stdout)}</system-out>}) unless @stdout.blank?
-        log_line(%Q{</testcase>})
+        log_line(%{<system-out>#{cdata(@stdout)}</system-out>}) unless @stdout.blank?
+        log_line(%{</testcase>})
       end
 
       def escape(str)
@@ -71,7 +71,7 @@ module Teaspoon
       end
 
       def cdata(str)
-        "\n<![CDATA[\n#{str.gsub(/\n$/, "")}\n]]>\n"
+        "\n<![CDATA[\n#{str.gsub(/\n$/, '')}\n]]>\n"
       end
     end
   end

data/lib/teaspoon/formatters/modules/report_module.rb

@@ -1,7 +1,6 @@
 module Teaspoon
   module Formatters
     module ReportModule
-
       RED = 31
       GREEN = 32
       YELLOW = 33
@@ -9,8 +8,9 @@ module Teaspoon
 
       def log_error(result)
         log_line(result.message, RED)
-        for trace in result.trace || []
-          log_line("  # #{filename(trace["file"])}:#{trace["line"]}#{trace["function"].present? ? " -- #{trace["function"]}" : ""}", CYAN)
+        (result.trace || []).each do |trace|
+          function = trace["function"].present? ? " -- #{trace['function']}" : ""
+          log_line("  # #{filename(trace['file'])}:#{trace['line']}#{function}", CYAN)
         end
         log_line
       end
@@ -54,7 +54,7 @@ module Teaspoon
 
       def log_stats(result)
         log_line("Finished in #{result.elapsed} seconds")
-        stats = "#{pluralize("example", run_count)}, #{pluralize("failure", failures.size)}"
+        stats = "#{pluralize('example', run_count)}, #{pluralize('failure', failures.size)}"
         stats << ", #{pendings.size} pending" if pendings.size > 0
         log_line(stats, stats_color)
       end

data/lib/teaspoon/formatters/pride_formatter.rb

@@ -1,7 +1,6 @@
 module Teaspoon
   module Formatters
     class PrideFormatter < DotFormatter
-
       PI_3 = Math::PI / 3
 
       def initialize(*args)

data/lib/teaspoon/formatters/rspec_html_formatter.rb

@@ -0,0 +1,463 @@
+require "erb"
+
+module Teaspoon
+  module Formatters
+    class RspecHtmlFormatter < Base
+      def initialize(*args)
+        super
+        @suite_start_template = template Templates::SUITE_START
+        @suite_end_template = template Templates::SUITE_END
+        @spec_template = template Templates::SPEC
+        @current_suite = []
+      end
+
+      def log_runner(result)
+        log_template template(Templates::HEADER), result
+      end
+
+      def log_suite(result)
+        while !@current_suite.empty? && @current_suite.size > result.level
+          log_suite_end
+        end
+
+        log_suite_start result
+      end
+
+      def log_spec(result)
+        log_template @spec_template, result
+      end
+
+      def log_result(result)
+        while !@current_suite.empty?
+          log_suite_end
+        end
+
+        log_template template(Templates::FOOTER), result
+      end
+
+      private
+
+      def log_suite_start(result)
+        @current_suite << result.label
+        log_template @suite_start_template, result
+      end
+
+      def log_suite_end
+        log_template @suite_end_template, @current_suite.pop
+      end
+
+      def template(contents)
+        Template.new contents
+      end
+
+      def log_template(template, object)
+        log_str template.render(object)
+      end
+
+      class Template
+        include ERB::Util
+
+        def initialize(contents)
+          @template = contents
+        end
+
+        def render(obj)
+          @o = obj
+          ERB.new(@template).result binding
+        end
+      end
+
+      module Templates
+        CSS = <<-CSS.strip_heredoc
+        body {
+          margin: 0;
+          padding: 0;
+          background: #fff;
+          font-size: 80%;
+        }
+
+        #teaspoon-header {
+          background: #65C400;
+          color: #fff;
+          height: 4em;
+        }
+
+        .teaspoon-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 {
+          background: #fff;
+        }
+
+        .results > .example_group {
+          margin: 0 10px 5px;
+        }
+
+        dl {
+          font: normal 11px "Lucida Grande", Helvetica, sans-serif;
+        }
+
+        .results > .example_group > dl {
+          margin: 0;
+          padding: 0 0 5px;
+        }
+
+        .results > .example_group > dl dl {
+          margin-left: 15px;
+        }
+
+        dt {
+          padding: 3px;
+          background: #65C400;
+          color: #fff;
+          font-weight: bold;
+        }
+
+        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;
+          background: #DBFFB4; color: #3D7700;
+        }
+
+        dd.example.pending {
+          border-left: 5px solid #FAF834;
+          border-bottom: 1px solid #FAF834;
+          background: #FCFB98; color: #131313;
+        }
+
+        dd.example.failed {
+          border-left: 5px solid #C20000;
+          border-bottom: 1px solid #C20000;
+          color: #C20000; background: #FFFBD3;
+        }
+
+        dt.pending {
+          color: #000000; background: #FAF834;
+        }
+
+        dt.failed {
+          color: #FFFFFF; background: #C40D0D;
+        }
+
+        #teaspoon-header.pending {
+          color: #000000; background: #FAF834;
+        }
+
+        #teaspoon-header.failed {
+          color: #FFFFFF; background: #C40D0D;
+        }
+        CSS
+
+        JAVASCRIPT = <<-JAVASCRIPT.strip_heredoc
+        (function() {
+          "use strict";
+
+          if (!document.querySelectorAll) {
+            alert("Warning: Your browser does not support document.querySelectorAll. Your report may not work properly.");
+            return;
+          }
+
+          function get(id) {
+            return document.getElementById(id);
+          }
+
+          function getAll(scope, selector) {
+            if (arguments.length === 1) {
+              selector = scope;
+              scope = document;
+            }
+
+            return scope.querySelectorAll(selector);
+          }
+
+          function show(element) {
+            if (element.oldDisplayValue) {
+              element.style.display = element.oldDisplayValue;
+            } else {
+              element.style.display = "";
+            }
+          }
+
+          function hide(element) {
+            if (element.style.display === "none") {
+              return;
+            }
+
+            if (element.oldDisplayValue === undefined) {
+              element.oldDisplayValue = element.style.display;
+            }
+
+            element.style.display = "none";
+          }
+
+          function showAll(elements) {
+            for (var i = 0; i < elements.length; i++) {
+              show(elements[i]);
+            }
+          }
+
+          function hideAll(elements) {
+            for (var i = 0; i < elements.length; i++) {
+              hide(elements[i]);
+            }
+          }
+
+          function toggleAll(elements, display) {
+            if (display) {
+              showAll(elements);
+            } else {
+              hideAll(elements);
+            }
+          }
+
+          function isHidden(element) {
+            return element.style.display === "none";
+          }
+
+          function isAllHidden(elements) {
+            var allHidden = true;
+
+            for (var i = 0; i < elements.length; i++) {
+              if (!isHidden(elements[i])) {
+                allHidden = false;
+                break;
+              }
+            }
+
+            return allHidden;
+          }
+
+          function setText(element, text) {
+            while (element.firstChild !== null) {
+              element.removeChild(element.firstChild);
+            }
+
+            element.appendChild(document.createTextNode(text));
+          }
+
+          function addClass(element, className) {
+            element.className += " " + className;
+          }
+
+          function addClassAll(elements, className) {
+            for (var i = 0; i < elements.length; i++) {
+              addClass(elements[i], className);
+            }
+          }
+
+          function hasClass(element, className) {
+            return (" " + element.className + " ").replace(/[\\t\\r\\n\\f]/g, " ").indexOf(" " + className + " ") >= 0;
+          }
+
+          function isTag(element, tagName) {
+            return element.tagName && element.tagName.toLowerCase() === tagName;
+          }
+
+          function parents(elements, predicate) {
+            var results = [];
+
+            for (var i = 0; i < elements.length; i++) {
+              var parent = elements[i].parentNode;
+
+              while (parent) {
+                if (predicate(parent)) {
+                  results.push(parent);
+                }
+
+                parent = parent.parentNode;
+              }
+            }
+
+            return results;
+          }
+
+          function children(elements, predicate) {
+            var results = [];
+
+            for (var i = 0; i < elements.length; i++) {
+              if (!elements[i].hasChildNodes()) {
+                continue;
+              }
+
+              for (var j = 0; j < elements[i].childNodes.length; j++) {
+                if (predicate(elements[i].childNodes[j])) {
+                  results.push(elements[i].childNodes[j]);
+                }
+              }
+            }
+
+            return results;
+          }
+
+          var elements = getAll("input[data-class-filter]");
+
+          function handleClassFilterChange(e) {
+            var element = e.target || e.srcElement;
+            showAll(getAll(".example_group"));
+            toggleAll(getAll(".example." + element.getAttribute("data-type")), element.checked);
+
+            var groups = getAll(".example_group");
+
+            for (var i = 0; i < groups.length; i++) {
+              if (isAllHidden(getAll(groups[i], ".example"))) {
+                hide(groups[i]);
+              }
+            }
+          }
+
+          for (var i = 0; i < elements.length; i++) {
+            elements[i].onchange = handleClassFilterChange;
+          }
+
+          get("duration").innerHTML = "Finished in <strong></strong>";
+          setText(getAll("#duration strong")[0], get("duration-value").value + " seconds");
+          get("totals").innerHTML = '<span class="total-amount"></span> examples, <span class="failure-amount"></span> failures, <span class="pending-amount"></span> pending';
+          var failureAmount = getAll(".example.failed").length;
+          var pendingAmount = getAll(".example.pending").length;
+          setText(getAll("#totals .total-amount")[0], getAll(".example").length);
+          setText(getAll("#totals .failure-amount")[0], failureAmount);
+          setText(getAll("#totals .pending-amount")[0], pendingAmount);
+
+          if (failureAmount > 0) {
+            addClass(get("teaspoon-header"), "failed");
+          } else if (pendingAmount > 0) {
+            addClass(get("teaspoon-header"), "pending");
+          }
+
+          function propagateClass(exampleSelector, groupPredicate, classToAdd) {
+            var exampleElements = getAll(exampleSelector);
+
+            var groupElements = parents(exampleElements, function(p) {
+              return hasClass(p, "example_group") && groupPredicate(p);
+            });
+
+            addClassAll(groupElements, classToAdd);
+            var dlChildren = children(groupElements, function(c) { return isTag(c, "dl"); });
+            var dtChildren = children(dlChildren, function(c) { return isTag(c, "dt"); });
+            addClassAll(dtChildren, classToAdd);
+          }
+
+          propagateClass(".example.failed", function() { return true; }, "failed");
+          propagateClass(".example.pending", function(p) { return !hasClass(p, "failed"); }, "pending");
+          propagateClass(".example", function(p) { return !hasClass(p, "failed") && !hasClass(p, "pending"); }, "passed");
+        })();
+        JAVASCRIPT
+
+        HEADER = <<-HTML.strip_heredoc
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <title>Teaspoon results</title>
+
+            <style type="text/css">
+              #{CSS}
+            </style>
+          </head>
+
+          <body>
+            <div class="teaspoon-report">
+              <div id="teaspoon-header">
+                <div id="label">
+                  <h1>Teaspoon Code Examples</h1>
+                </div>
+
+                <div id="display-filters">
+                  <input id="passed-checkbox" data-class-filter data-type="passed" type="checkbox" checked="checked">
+                  <label for="passed-checkbox">Passed</label>
+                  <input id="failed-checkbox" data-class-filter data-type="failed" type="checkbox" checked="checked">
+                  <label for="failed-checkbox">Failed</label>
+                  <input id="pending-checkbox" data-class-filter data-type="pending" type="checkbox" checked="checked">
+                  <label for="pending-checkbox">Pending</label>
+                </div>
+
+                <div id="summary">
+                  <p id="totals">&nbsp;</p>
+                  <p id="duration">&nbsp;</p>
+                </div>
+              </div>
+
+              <div class="results">
+        HTML
+
+        SUITE_START = <<-HTML.strip_heredoc
+        <div class="example_group">
+          <dl>
+            <dt><%= h @o.label %></dt>
+        HTML
+
+        SPEC = <<-HTML.strip_heredoc
+        <dd class="example <%= h @o.status %>">
+          <span class="spec-name"><%= h @o.label %></span>
+          <span class="duration"><%= h "\#{@o.elapsed}s" if @o.elapsed %></span>
+
+          <% if @o.failing? %>
+            <div class="message">
+              <pre><%= h @o.trace %></pre>
+            </div>
+          <% end %>
+        </dd>
+        HTML
+
+        SUITE_END = <<-HTML.strip_heredoc
+          </dl>
+        </div>
+        HTML
+
+        FOOTER = <<-HTML.strip_heredoc
+              </div>
+            </div>
+
+            <input type="hidden" id="duration-value" value="<%= h @o.elapsed %>" />
+
+            <script type="text/javascript">
+              #{JAVASCRIPT}
+            </script>
+          </body>
+        </html>
+        HTML
+      end
+    end
+  end
+end