sspec-core 3.8.0

data/lib/rspec/core/formatters/fallback_message_formatter.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Core
+    module Formatters
+      # @api private
+      # Formatter for providing message output as a fallback when no other
+      # profiler implements #message
+      class FallbackMessageFormatter
+        Formatters.register self, :message
+
+        def initialize(output)
+          @output = output
+        end
+
+        # @private
+        attr_reader :output
+
+        # @api public
+        #
+        # Used by the reporter to send messages to the output stream.
+        #
+        # @param notification [MessageNotification] containing message
+        def message(notification)
+          output.puts notification.message
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/formatters/helpers.rb

@@ -0,0 +1,110 @@
+RSpec::Support.require_rspec_core "shell_escape"
+
+module RSpec
+  module Core
+    module Formatters
+      # Formatters helpers.
+      module Helpers
+        # @private
+        SUB_SECOND_PRECISION = 5
+
+        # @private
+        DEFAULT_PRECISION = 2
+
+        # @api private
+        #
+        # Formats seconds into a human-readable string.
+        #
+        # @param duration [Float, Fixnum] in seconds
+        # @return [String] human-readable time
+        #
+        # @example
+        #    format_duration(1) #=>  "1 minute 1 second"
+        #    format_duration(135.14) #=> "2 minutes 15.14 seconds"
+        def self.format_duration(duration)
+          precision = case
+                      when duration < 1 then    SUB_SECOND_PRECISION
+                      when duration < 120 then  DEFAULT_PRECISION
+                      when duration < 300 then  1
+                      else                  0
+                      end
+
+          if duration > 60
+            minutes = (duration.round / 60).to_i
+            seconds = (duration - minutes * 60)
+
+            "#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}"
+          else
+            pluralize(format_seconds(duration, precision), 'second')
+          end
+        end
+
+        # @api private
+        #
+        # Formats seconds to have 5 digits of precision with trailing zeros
+        # removed if the number is less than 1 or with 2 digits of precision if
+        # the number is greater than zero.
+        #
+        # @param float [Float]
+        # @return [String] formatted float
+        #
+        # @example
+        #    format_seconds(0.000006) #=> "0.00001"
+        #    format_seconds(0.020000) #=> "0.02"
+        #    format_seconds(1.00000000001) #=> "1"
+        #
+        # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and
+        # {Helpers::DEFAULT_PRECISION}.
+        #
+        # @see #strip_trailing_zeroes
+        def self.format_seconds(float, precision=nil)
+          return '0' if float < 0
+          precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION
+          formatted = "%.#{precision}f" % float
+          strip_trailing_zeroes(formatted)
+        end
+
+        # @api private
+        #
+        # Remove trailing zeros from a string.
+        #
+        # Only remove trailing zeros after a decimal place.
+        # see: http://rubular.com/r/ojtTydOgpn
+        #
+        # @param string [String] string with trailing zeros
+        # @return [String] string with trailing zeros removed
+        def self.strip_trailing_zeroes(string)
+          string.sub(/(?:(\..*[^0])0+|\.0+)$/, '\1')
+        end
+        private_class_method :strip_trailing_zeroes
+
+        # @api private
+        #
+        # Pluralize a word based on a count.
+        #
+        # @param count [Fixnum] number of objects
+        # @param string [String] word to be pluralized
+        # @return [String] pluralized word
+        def self.pluralize(count, string)
+          "#{count} #{string}#{'s' unless count.to_f == 1}"
+        end
+
+        # @api private
+        # Given a list of example ids, organizes them into a compact, ordered list.
+        def self.organize_ids(ids)
+          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|
+            file, id = Example.parse_id(id)
+            hash[file] << id
+            hash
+          end
+
+          grouped.sort_by(&:first).map do |file, grouped_ids|
+            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }
+            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))
+            ShellEscape.conditionally_quote(id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/formatters/html_formatter.rb

@@ -0,0 +1,153 @@
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+RSpec::Support.require_rspec_core "formatters/html_printer"
+
+module RSpec
+  module Core
+    module Formatters
+      # @private
+      class HtmlFormatter < BaseFormatter
+        Formatters.register self, :start, :example_group_started, :start_dump,
+                            :example_started, :example_passed, :example_failed,
+                            :example_pending, :dump_summary
+
+        def initialize(output)
+          super(output)
+          @failed_examples = []
+          @example_group_number = 0
+          @example_number = 0
+          @header_red = nil
+          @printer = HtmlPrinter.new(output)
+        end
+
+        def start(notification)
+          super
+          @printer.print_html_start
+          @printer.flush
+        end
+
+        def example_group_started(notification)
+          super
+          @example_group_red = false
+          @example_group_number += 1
+
+          @printer.print_example_group_end unless example_group_number == 1
+          @printer.print_example_group_start(example_group_number,
+                                             notification.group.description,
+                                             notification.group.parent_groups.size)
+          @printer.flush
+        end
+
+        def start_dump(_notification)
+          @printer.print_example_group_end
+          @printer.flush
+        end
+
+        def example_started(_notification)
+          @example_number += 1
+        end
+
+        def example_passed(passed)
+          @printer.move_progress(percent_done)
+          @printer.print_example_passed(passed.example.description, passed.example.execution_result.run_time)
+          @printer.flush
+        end
+
+        def example_failed(failure)
+          @failed_examples << failure.example
+          unless @header_red
+            @header_red = true
+            @printer.make_header_red
+          end
+
+          unless @example_group_red
+            @example_group_red = true
+            @printer.make_example_group_header_red(example_group_number)
+          end
+
+          @printer.move_progress(percent_done)
+
+          example = failure.example
+
+          exception = failure.exception
+          message_lines = failure.fully_formatted_lines(nil, RSpec::Core::Notifications::NullColorizer)
+          exception_details = if exception
+                                {
+                                  # drop 2 removes the description (regardless of newlines) and leading blank line
+                                  :message => message_lines.drop(2).join("\n"),
+                                  :backtrace => failure.formatted_backtrace.join("\n"),
+                                }
+                              end
+          extra = extra_failure_content(failure)
+
+          @printer.print_example_failed(
+            example.execution_result.pending_fixed,
+            example.description,
+            example.execution_result.run_time,
+            @failed_examples.size,
+            exception_details,
+            (extra == "") ? false : extra
+          )
+          @printer.flush
+        end
+
+        def example_pending(pending)
+          example = pending.example
+
+          @printer.make_header_yellow unless @header_red
+          @printer.make_example_group_header_yellow(example_group_number) unless @example_group_red
+          @printer.move_progress(percent_done)
+          @printer.print_example_pending(example.description, example.execution_result.pending_message)
+          @printer.flush
+        end
+
+        def dump_summary(summary)
+          @printer.print_summary(
+            summary.duration,
+            summary.example_count,
+            summary.failure_count,
+            summary.pending_count
+          )
+          @printer.flush
+        end
+
+      private
+
+        # If these methods are declared with attr_reader Ruby will issue a
+        # warning because they are private.
+        # rubocop:disable Style/TrivialAccessors
+
+        # The number of the currently running example_group.
+        def example_group_number
+          @example_group_number
+        end
+
+        # The number of the currently running example (a global counter).
+        def example_number
+          @example_number
+        end
+        # rubocop:enable Style/TrivialAccessors
+
+        def percent_done
+          result = 100.0
+          if @example_count > 0
+            result = (((example_number).to_f / @example_count.to_f * 1000).to_i / 10.0).to_f
+          end
+          result
+        end
+
+        # Override this method if you wish to output extra HTML for a failed
+        # spec. For example, you could output links to images or other files
+        # produced during the specs.
+        def extra_failure_content(failure)
+          RSpec::Support.require_rspec_core "formatters/html_snippet_extractor"
+          backtrace = (failure.exception.backtrace || []).map do |line|
+            RSpec.configuration.backtrace_formatter.backtrace_line(line)
+          end
+          backtrace.compact!
+          @snippet_extractor ||= HtmlSnippetExtractor.new
+          "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/formatters/html_printer.rb

@@ -0,0 +1,414 @@
+require 'erb'
+
+module RSpec
+  module Core
+    module Formatters
+      # @private
+      class HtmlPrinter
+        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 = "%.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
+
+        # rubocop:disable Metrics/ParameterLists
+        def print_example_failed(pending_fixed, description, run_time, failure_id,
+                                 exception, extra_content)
+          # rubocop:enable Metrics/ParameterLists
+          formatted_run_time = "%.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>#{h 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(duration, example_count, failure_count, pending_count)
+          totals = String.new(
+            "#{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
+
+          formatted_duration = "%.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>RSpec Code Examples</h1>
+  </div>
+
+  <div id="display-filters">
+    <input id="passed_checkbox"  name="passed_checkbox"  type="checkbox" checked="checked" onchange="apply_filters()" value="1" /> <label for="passed_checkbox">Passed</label>
+    <input id="failed_checkbox"  name="failed_checkbox"  type="checkbox" checked="checked" onchange="apply_filters()" value="2" /> <label for="failed_checkbox">Failed</label>
+    <input id="pending_checkbox" name="pending_checkbox" type="checkbox" checked="checked" onchange="apply_filters()" value="3" /> <label for="pending_checkbox">Pending</label>
+  </div>
+
+  <div id="summary">
+    <p id="totals">&#160;</p>
+    <p id="duration">&#160;</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
+        # rubocop:enable LineLength
+
+        GLOBAL_STYLES = <<-EOF
+#rspec-header {
+  background: #65C400; color: #fff; height: 4em;
+}
+
+.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 {
+  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.not_implemented {
+  border-left: 5px solid #FAF834;
+  border-bottom: 1px solid #FAF834;
+  background: #FCFB98; color: #131313;
+}
+
+dd.example.pending_fixed {
+  border-left: 5px solid #0000C2;
+  border-bottom: 1px solid #0000C2;
+  color: #0000C2; background: #D3FBFF;
+}
+
+dd.example.failed {
+  border-left: 5px solid #C20000;
+  border-bottom: 1px solid #C20000;
+  color: #C20000; background: #FFFBD3;
+}
+
+
+dt.not_implemented {
+  color: #000000; background: #FAF834;
+}
+
+dt.pending_fixed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+dt.failed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+
+#rspec-header.not_implemented {
+  color: #000000; background: #FAF834;
+}
+
+#rspec-header.pending_fixed {
+  color: #FFFFFF; background: #C40D0D;
+}
+
+#rspec-header.failed {
+  color: #FFFFFF; background: #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
+<!DOCTYPE html>
+<html 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
+    end
+  end
+end