opal-rspec 0.8.0 → 1.0.0.alpha1

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

@@ -31,7 +31,9 @@ module RSpec
           @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.print_example_group_start(example_group_number,
+                                             notification.group.description,
+                                             notification.group.parent_groups.size)
           @printer.flush
         end
 
@@ -67,13 +69,13 @@ module RSpec
           example = failure.example
 
           exception = failure.exception
+          message_lines = failure.fully_formatted_lines(nil, RSpec::Core::Notifications::NullColorizer)
           exception_details = if exception
                                 {
-                                  :message => exception.message,
-                                  :backtrace => failure.formatted_backtrace.join("\n")
+                                  # 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"),
                                 }
-                              else
-                                false
                               end
           extra = extra_failure_content(failure)
 
@@ -83,8 +85,7 @@ module RSpec
             example.execution_result.run_time,
             @failed_examples.size,
             exception_details,
-            (extra == "") ? false : extra,
-            true
+            (extra == "") ? false : extra
           )
           @printer.flush
         end
@@ -111,15 +112,16 @@ module RSpec
 
       private
 
-        # If these methods are declared with attr_reader Ruby will issue a warning because they are 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
+        # 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)
+        # The number of the currently running example (a global counter).
         def example_number
           @example_number
         end
@@ -133,14 +135,16 @@ module RSpec
           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.
-        #
+        # 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/snippet_extractor"
-          backtrace = failure.exception.backtrace.map { |line| RSpec.configuration.backtrace_formatter.backtrace_line(line) }
+          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 ||= SnippetExtractor.new
+          @snippet_extractor ||= HtmlSnippetExtractor.new
           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
         end
       end

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

@@ -5,7 +5,7 @@ module RSpec
     module Formatters
       # @private
       class HtmlPrinter
-        include ERB::Util # for the #h method
+        include ERB::Util # For the #h method.
         def initialize(output)
           @output = output
         end
@@ -28,12 +28,13 @@ module RSpec
 
         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>"
+          @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 Style/ParameterLists
-        def print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace=false)
-          # rubocop:enable Style/ParameterLists
+        def print_example_failed(pending_fixed, description, run_time, failure_id,
+                                 exception, extra_content)
           formatted_run_time = "%.5f" % run_time
 
           @output.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
@@ -42,11 +43,7 @@ module RSpec
           @output.puts "      <div class=\"failure\" id=\"failure_#{failure_id}\">"
           if exception
             @output.puts "        <div class=\"message\"><pre>#{h(exception[:message])}</pre></div>"
-            if escape_backtrace
-              @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
-            else
-              @output.puts "        <div class=\"backtrace\"><pre>#{exception[:backtrace]}</pre></div>"
-            end
+            @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
           end
           @output.puts extra_content if extra_content
           @output.puts "      </div>"
@@ -54,18 +51,25 @@ module RSpec
         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>"
+          @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 =  "#{example_count} example#{'s' unless example_count == 1}, "
+          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 "<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>"
@@ -90,13 +94,17 @@ module RSpec
         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>"
+          @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>"
+          @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
@@ -205,6 +213,7 @@ function assign_display_style_for_group(classname, display_flag, subgroup_flag)
   }
 }
 EOF
+        # rubocop:enable Layout/LineLength
 
         GLOBAL_STYLES = <<-EOF
 #rspec-header {

data/rspec-core/upstream/lib/rspec/core/formatters/html_snippet_extractor.rb

@@ -0,0 +1,120 @@
+module RSpec
+  module Core
+    module Formatters
+      # @api private
+      #
+      # Extracts code snippets by looking at the backtrace of the passed error
+      # and applies synax highlighting and line numbers using html.
+      class HtmlSnippetExtractor
+        # @private
+        module NullConverter
+          def self.convert(code)
+            %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
+          end
+        end
+
+        # @private
+        module CoderayConverter
+          def self.convert(code)
+            CodeRay.scan(code, :ruby).html(:line_numbers => false)
+          end
+        end
+
+        # rubocop:disable Style/ClassVars
+        # @private
+        @@converter = NullConverter
+
+        begin
+          require 'coderay'
+          RSpec::Support.require_rspec_core 'formatters/syntax_highlighter'
+          RSpec::Core::Formatters::SyntaxHighlighter.attempt_to_add_rspec_terms_to_coderay_keywords
+          @@converter = CoderayConverter
+          # rubocop:disable Lint/HandleExceptions
+        rescue LoadError
+          # it'll fall back to the NullConverter assigned above
+          # rubocop:enable Lint/HandleExceptions
+        end
+
+        # rubocop:enable Style/ClassVars
+
+        # @api private
+        #
+        # Extract lines of code corresponding to  a backtrace.
+        #
+        # @param backtrace [String] the backtrace from a test failure
+        # @return [String] highlighted code snippet indicating where the test
+        #   failure occured
+        #
+        # @see #post_process
+        def snippet(backtrace)
+          raw_code, line = snippet_for(backtrace[0])
+          highlighted = @@converter.convert(raw_code)
+          post_process(highlighted, line)
+        end
+        # rubocop:enable Style/ClassVars
+
+        # @api private
+        #
+        # Create a snippet from a line of code.
+        #
+        # @param error_line [String] file name with line number (i.e.
+        #   'foo_spec.rb:12')
+        # @return [String] lines around the target line within the file
+        #
+        # @see #lines_around
+        def snippet_for(error_line)
+          if error_line =~ /(.*):(\d+)/
+            file = Regexp.last_match[1]
+            line = Regexp.last_match[2].to_i
+            [lines_around(file, line), line]
+          else
+            ["# Couldn't get snippet for #{error_line}", 1]
+          end
+        end
+
+        # @api private
+        #
+        # Extract lines of code centered around a particular line within a
+        # source file.
+        #
+        # @param file [String] filename
+        # @param line [Fixnum] line number
+        # @return [String] lines around the target line within the file (2 above
+        #   and 1 below).
+        def lines_around(file, line)
+          if File.file?(file)
+            lines = File.read(file).split("\n")
+            min = [0, line - 3].max
+            max = [line + 1, lines.length - 1].min
+            selected_lines = []
+            selected_lines.join("\n")
+            lines[min..max].join("\n")
+          else
+            "# Couldn't get snippet for #{file}"
+          end
+        rescue SecurityError
+          "# Couldn't get snippet for #{file}"
+        end
+
+        # @api private
+        #
+        # Adds line numbers to all lines and highlights the line where the
+        # failure occurred using html `span` tags.
+        #
+        # @param highlighted [String] syntax-highlighted snippet surrounding the
+        #   offending line of code
+        # @param offending_line [Fixnum] line where failure occured
+        # @return [String] completed snippet
+        def post_process(highlighted, offending_line)
+          new_lines = []
+          highlighted.split("\n").each_with_index do |line, i|
+            new_line = "<span class=\"linenum\">#{offending_line + i - 2}</span>#{line}"
+            new_line = "<span class=\"offending\">#{new_line}</span>" if i == 2
+            new_lines << new_line
+          end
+          new_lines.join("\n")
+        end
+      end
+    end
+  end
+end

data/rspec-core/upstream/lib/rspec/core/formatters/json_formatter.rb

@@ -6,13 +6,15 @@ module RSpec
     module Formatters
       # @private
       class JsonFormatter < BaseFormatter
-        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :close
+        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
 
         attr_reader :output_hash
 
         def initialize(output)
           super
-          @output_hash = {}
+          @output_hash = {
+            :version => RSpec::Core::Version::STRING
+          }
         end
 
         def message(notification)
@@ -24,7 +26,8 @@ module RSpec
             :duration => summary.duration,
             :example_count => summary.example_count,
             :failure_count => summary.failure_count,
-            :pending_count => summary.pending_count
+            :pending_count => summary.pending_count,
+            :errors_outside_of_examples_count => summary.errors_outside_of_examples_count
           }
           @output_hash[:summary_line] = summary.totals_line
         end
@@ -44,9 +47,13 @@ module RSpec
           end
         end
 
+        def seed(notification)
+          return unless notification.seed_used?
+          @output_hash[:seed] = notification.seed
+        end
+
         def close(_notification)
           output.write @output_hash.to_json
-          output.close if IO === output && output != $stdout
         end
 
         def dump_profile(profile)
@@ -58,8 +65,7 @@ module RSpec
         # @api private
         def dump_profile_slowest_examples(profile)
           @output_hash[:profile] = {}
-          sorted_examples = profile.slowest_examples
-          @output_hash[:profile][:examples] = sorted_examples.map do |example|
+          @output_hash[:profile][:examples] = profile.slowest_examples.map do |example|
             format_example(example).tap do |hash|
               hash[:run_time] = example.execution_result.run_time
             end
@@ -80,12 +86,14 @@ module RSpec
 
         def format_example(example)
           {
+            :id => example.id,
             :description => example.description,
             :full_description => example.full_description,
             :status => example.execution_result.status.to_s,
             :file_path => example.metadata[:file_path],
             :line_number  => example.metadata[:line_number],
-            :run_time => example.execution_result.run_time
+            :run_time => example.execution_result.run_time,
+            :pending_message => example.execution_result.pending_message,
           }
         end
       end

data/rspec-core/upstream/lib/rspec/core/formatters/profile_formatter.rb

@@ -4,7 +4,7 @@ module RSpec
   module Core
     module Formatters
       # @api private
-      # Formatter for providing profile output
+      # Formatter for providing profile output.
       class ProfileFormatter
         Formatters.register self, :dump_profile
 
@@ -15,14 +15,13 @@ module RSpec
         # @private
         attr_reader :output
 
-        # @method dump_profile
         # @api public
         #
         # This method is invoked after the dumping the summary if profiling is
         # enabled.
         #
-        # @param profile [ProfileNotification] containing duration, slowest_examples
-        #                                      and slowest_example_groups
+        # @param profile [ProfileNotification] containing duration,
+        #   slowest_examples and slowest_example_groups
         def dump_profile(profile)
           dump_profile_slowest_examples(profile)
           dump_profile_slowest_example_groups(profile)
@@ -31,11 +30,14 @@ module RSpec
       private
 
         def dump_profile_slowest_examples(profile)
-          @output.puts "\nTop #{profile.slowest_examples.size} slowest examples (#{Helpers.format_seconds(profile.slow_duration)} seconds, #{profile.percentage}% of total time):\n"
+          @output.puts "\nTop #{profile.slowest_examples.size} slowest " \
+            "examples (#{Helpers.format_seconds(profile.slow_duration)} " \
+            "seconds, #{profile.percentage}% of total time):\n"
 
           profile.slowest_examples.each do |example|
             @output.puts "  #{example.full_description}"
-            @output.puts "    #{bold(Helpers.format_seconds(example.execution_result.run_time))} #{bold("seconds")} #{format_caller(example.location)}"
+            @output.puts "    #{bold(Helpers.format_seconds(example.execution_result.run_time))} " \
+                         "#{bold("seconds")} #{format_caller(example.location)}"
           end
         end
 
@@ -53,7 +55,8 @@ module RSpec
         end
 
         def format_caller(caller_info)
-          RSpec.configuration.backtrace_formatter.backtrace_line(caller_info.to_s.split(':in `block').first)
+          RSpec.configuration.backtrace_formatter.backtrace_line(
+            caller_info.to_s.split(':in `block').first)
         end
 
         def bold(text)

data/rspec-core/upstream/lib/rspec/core/formatters/progress_formatter.rb

@@ -1,4 +1,5 @@
 RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+RSpec::Support.require_rspec_core "formatters/console_codes"
 
 module RSpec
   module Core

data/rspec-core/upstream/lib/rspec/core/formatters/protocol.rb

@@ -17,12 +17,12 @@ module RSpec
       # @see RSpec::Core::Formatters::BaseTextFormatter
       # @see RSpec::Core::Reporter
       class Protocol
-        # @method initialize
+        # @method initialize(output)
         # @api public
         #
         # @param output [IO] the formatter output
 
-        # @method start
+        # @method start(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -33,130 +33,149 @@ module RSpec
         # This will only be invoked once, and the next one to be invoked
         # is {#example_group_started}.
         #
-        # @param notification [StartNotification]
+        # @param notification [Notifications::StartNotification]
 
-        # @method example_group_started
+        # @method example_group_started(notification)
         # @api public
         # @group Group Notifications
         #
-        # This method is invoked at the beginning of the execution of each example group.
+        # This method is invoked at the beginning of the execution of each
+        # example group.
         #
         # The next method to be invoked after this is {#example_passed},
         # {#example_pending}, or {#example_group_finished}.
         #
-        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
+        # @param notification [Notifications::GroupNotification] containing example_group
+        #   subclass of {ExampleGroup}
 
-        # @method example_group_finished
+        # @method example_group_finished(notification)
         # @api public
         # @group Group Notifications
         #
         # Invoked at the end of the execution of each example group.
         #
-        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
+        # @param notification [Notifications::GroupNotification] containing example_group
+        #   subclass of {ExampleGroup}
 
-        # @method example_started
+        # @method example_started(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked at the beginning of the execution of each example.
         #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_passed
+        # @method example_finished(notification)
+        # @api public
+        # @group Example Notifications
+        #
+        # Invoked at the end of the execution of each example.
+        #
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
+
+        # @method example_passed(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked when an example passes.
         #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_pending
+        # @method example_pending(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked when an example is pending.
         #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_failed
+        # @method example_failed(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked when an example fails.
         #
-        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method message
+        # @method message(notification)
         # @api public
         # @group Suite Notifications
         #
         # Used by the reporter to send messages to the output stream.
         #
-        # @param notification [MessageNotification] containing message
+        # @param notification [Notifications::MessageNotification] containing message
 
-        # @method stop
+        # @method stop(notification)
         # @api public
         # @group Suite Notifications
         #
-        # Invoked after all examples have executed, before dumping post-run reports.
+        # Invoked after all examples have executed, before dumping post-run
+        # reports.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method start_dump
+        # @method start_dump(notification)
         # @api public
         # @group Suite Notifications
         #
-        # This method is invoked after all of the examples have executed. The next method
-        # to be invoked after this one is {#dump_failures}
-        # (BaseTextFormatter then calls {#dump_failure} once for each failed example.)
+        # This method is invoked after all of the examples have executed. The
+        # next method to be invoked after this one is {#dump_failures}
+        # (BaseTextFormatter then calls {#dump_failures} once for each failed
+        # example).
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method dump_failures
+        # @method dump_failures(notification)
         # @api public
         # @group Suite Notifications
         #
         # Dumps detailed information about each example failure.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method dump_summary
+        # @method dump_summary(summary)
         # @api public
         # @group Suite Notifications
         #
-        # This method is invoked after the dumping of examples and failures. Each parameter
-        # is assigned to a corresponding attribute.
+        # This method is invoked after the dumping of examples and failures.
+        # Each parameter is assigned to a corresponding attribute.
         #
-        # @param summary [SummaryNotification] containing duration, example_count,
-        #                                      failure_count and pending_count
+        # @param summary [Notifications::SummaryNotification] containing duration,
+        #   example_count, failure_count and pending_count
 
-        # @method dump_profile
+        # @method dump_profile(profile)
         # @api public
         # @group Suite Notifications
         #
         # This method is invoked after the dumping the summary if profiling is
         # enabled.
         #
-        # @param profile [ProfileNotification] containing duration, slowest_examples
-        #                                      and slowest_example_groups
+        # @param profile [Notifications::ProfileNotification] containing duration,
+        #   slowest_examples and slowest_example_groups
 
-        # @method dump_pending
+        # @method dump_pending(notification)
         # @api public
         # @group Suite Notifications
         #
-        # Outputs a report of pending examples.  This gets invoked
+        # Outputs a report of pending examples. This gets invoked
         # after the summary if option is set to do so.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method close
+        # @method close(notification)
         # @api public
         # @group Suite Notifications
         #
-        # Invoked at the very end, `close` allows the formatter to clean
-        # up resources, e.g. open streams, etc.
+        # Invoked at the end of a suite run. Allows the formatter to do any
+        # tidying up, but be aware that formatter output streams may be used
+        # elsewhere so don't actually close them.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
       end
     end
   end