rspec-core 2.99.0 → 3.0.0

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

@@ -5,11 +5,23 @@ module RSpec
       #
       # Extracts code snippets by looking at the backtrace of the passed error and applies synax highlighting and line numbers using html.
       class SnippetExtractor
-        class NullConverter; def convert(code, pre); code; end; end
+        # @private
+        class NullConverter
+          def convert(code)
+            %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
+          end
+        end
+
+        # @private
+        class CoderayConverter
+          def convert(code)
+            CodeRay.scan(code, :ruby).html(:line_numbers => false)
+          end
+        end
 
         begin
-          require 'syntax/convertors/html'
-          @@converter = Syntax::Convertors::HTML.for_syntax "ruby"
+          require 'coderay'
+          @@converter = CoderayConverter.new
         rescue LoadError
           @@converter = NullConverter.new
         end
@@ -18,14 +30,13 @@ module RSpec
         #
         # Extract lines of code corresponding to  a backtrace.
         #
-        # @param [String] backtrace the backtrace from a test failure
+        # @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, false)
-          highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
+          highlighted = @@converter.convert(raw_code)
           post_process(highlighted, line)
         end
 
@@ -33,7 +44,7 @@ module RSpec
         #
         # Create a snippet from a line of code.
         #
-        # @param [String] error_line file name with line number (i.e. 'foo_spec.rb:12')
+        # @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
@@ -51,8 +62,8 @@ module RSpec
         #
         # Extract lines of code centered around a particular line within a source file.
         #
-        # @param [String] file filename
-        # @param [Fixnum] line line number
+        # @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)
@@ -73,8 +84,8 @@ module RSpec
         #
         # Adds line numbers to all lines and highlights the line where the failure occurred using html `span` tags.
         #
-        # @param [String] highlighted syntax-highlighted snippet surrounding the offending line of code
-        # @param [Fixnum] offending_line line where failure occured
+        # @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 = []

data/lib/rspec/core/formatters.rb

@@ -3,7 +3,6 @@
 # * progress (default) - prints dots for passing examples, `F` for failures, `*` for pending
 # * documentation - prints the docstrings passed to `describe` and `it` methods (and their aliases)
 # * html
-# * textmate - html plus links to editor
 # * json - useful for archiving data for subsequent analysis
 #
 # The progress formatter is the default, but you can choose any one or more of
@@ -29,25 +28,37 @@
 #
 # The reporter calls every formatter with this protocol:
 #
-# * `start(expected_example_count)`
-# * zero or more of the following
-#   * `example_group_started(group)`
-#   * `example_started(example)`
-#   * `example_passed(example)`
-#   * `example_failed(example)`
-#   * `example_pending(example)`
-#   * `message(string)`
-# * `stop`
-# * `start_dump`
-# * `dump_pending`
-# * `dump_failures`
-# * `dump_summary(duration, example_count, failure_count, pending_count)`
-# * `seed(value)`
-# * `close`
+# * To start
+#   * `start(StartNotification)`
+# * Once per example group
+#   * `example_group_started(GroupNotification)`
+# * Once per example
+#   * `example_started(ExampleNotification)`
+# * One of these per example, depending on outcome
+#   * `example_passed(ExampleNotification)`
+#   * `example_failed(FailedExampleNotification)`
+#   * `example_pending(ExampleNotification)`
+# * Optionally at any time
+#   * `message(MessageNotification)`
+# * At the end of the suite
+#   * `stop(ExamplesNotification)`
+#   * `start_dump(NullNotification)`
+#   * `dump_pending(ExamplesNotification)`
+#   * `dump_failures(ExamplesNotification)`
+#   * `dump_summary(SummaryNotification)`
+#   * `seed(SeedNotification)`
+#   * `close(NullNotification)`
 #
-# You can either implement all of those methods or subclass
-# `RSpec::Core::Formatters::BaseTextFormatter` and override the methods you want
-# to enhance.
+# Only the notifications to which you subscribe your formatter will be called
+# on your formatter. To subscribe your formatter use:
+# `RSpec::Core::Formatters#register` e.g.
+#
+# `RSpec::Core::Formatters.register FormatterClassName, :example_passed, :example_failed`
+#
+# We recommend you implement the methods yourself; for simplicity we provide the
+# default formatter output via our notification objects but if you prefer you
+# can subclass `RSpec::Core::Formatters::BaseTextFormatter` and override the
+# methods you wish to enhance.
 #
 # @see RSpec::Core::Formatters::BaseTextFormatter
 # @see RSpec::Core::Reporter
@@ -55,8 +66,17 @@ module RSpec::Core::Formatters
   autoload :DocumentationFormatter, 'rspec/core/formatters/documentation_formatter'
   autoload :HtmlFormatter,          'rspec/core/formatters/html_formatter'
   autoload :ProgressFormatter,      'rspec/core/formatters/progress_formatter'
+  autoload :ProfileFormatter,       'rspec/core/formatters/profile_formatter'
   autoload :JsonFormatter,          'rspec/core/formatters/json_formatter'
-  autoload :TextMateFormatter,      'rspec/core/formatters/text_mate_formatter'
+
+  # Register the formatter class
+  # @param formatter_class [Class] formatter class to register
+  # @param notifications [Symbol, ...] one or more notifications to be registered to the specified formatter
+  #
+  # @see RSpec::Core::Formatters::BaseFormatter
+  def self.register(formatter_class, *notifications)
+    Loader.formatters[formatter_class] = notifications
+  end
 
   # @api private
   #
@@ -65,13 +85,18 @@ module RSpec::Core::Formatters
   # not expected to be used directly, but only through the configuration
   # interface.
   class Loader
+    # @api private
+    #
+    # Internal formatters are stored here when loaded
+    def self.formatters
+      @formatters ||= {}
+    end
 
     # @api private
     def initialize(reporter)
       @formatters = []
       @reporter = reporter
-      @setup = false
-      @default_formatter = 'progress'
+      self.default_formatter = 'progress'
     end
 
     # @return [Array] the loaded formatters
@@ -80,18 +105,20 @@ module RSpec::Core::Formatters
     # @return [Reporter] the reporter
     attr_reader :reporter
 
+    # @return [String] the default formatter to setup, defaults to `progress`
+    attr_accessor :default_formatter
+
     # @private
     def setup_default(output_stream, deprecation_stream)
       if @formatters.empty?
-        add @default_formatter, output_stream
+        add default_formatter, output_stream
       end
       unless @formatters.any? { |formatter| DeprecationFormatter === formatter }
         add DeprecationFormatter, deprecation_stream, output_stream
       end
-      @formatters.each do |formatter|
-        @reporter.register_listener formatter, *RSpec::Core::Reporter::NOTIFICATIONS
+      if RSpec.configuration.profile_examples? && !existing_formatter_implements?(:dump_profile)
+        add RSpec::Core::Formatters::ProfileFormatter, output_stream
       end
-      @setup = true
     end
 
     # @private
@@ -100,12 +127,35 @@ module RSpec::Core::Formatters
 
       args = paths.map { |p| p.respond_to?(:puts) ? p : file_at(p) }
 
-      formatter = formatter_class.new(*args)
-      if @setup
-        @reporter.register_listener formatter, *RSpec::Core::Reporter::NOTIFICATIONS
+      if !Loader.formatters[formatter_class].nil?
+        formatter = formatter_class.new(*args)
+        @reporter.register_listener formatter, *notifications_for(formatter_class)
+      elsif defined?(RSpec::LegacyFormatters)
+        formatter = RSpec::LegacyFormatters.load_formatter formatter_class, *args
+        @reporter.register_listener formatter, *formatter.notifications
+      else
+        line = ::RSpec::CallerFilter.first_non_rspec_line
+        if line
+          call_site = "Formatter added at: #{line}"
+        else
+          call_site = "The formatter was added via command line flag or your "+
+                      "`.rspec` file."
+        end
+
+        RSpec.warn_deprecation <<-WARNING.gsub(/\s*\|/,' ')
+          |The #{formatter_class} formatter uses the deprecated formatter
+          |interface not supported directly by RSpec 3.
+          |
+          |To continue to use this formatter you must install the
+          |`rspec-legacy_formatters` gem, which provides support
+          |for legacy formatters or upgrade the formatter to a
+          |compatible version.
+          |
+          |#{call_site}
+        WARNING
+        return
       end
       @formatters << formatter unless duplicate_formatter_exists?(formatter)
-
       formatter
     end
 
@@ -123,29 +173,26 @@ module RSpec::Core::Formatters
       end
     end
 
+    def existing_formatter_implements?(notification)
+      @reporter.registered_listeners(notification).any?
+    end
+
     def built_in_formatter(key)
       case key.to_s
       when 'd', 'doc', 'documentation'
         DocumentationFormatter
-      when 's', 'n', 'spec', 'nested'
-        RSpec.deprecate "Using `#{key.to_s}` as a shortcut for the DocumentationFormatter",
-          :replacement => "`d`, `doc`, or `documentation`"
-        DocumentationFormatter
       when 'h', 'html'
         HtmlFormatter
       when 'p', 'progress'
         ProgressFormatter
       when 'j', 'json'
         JsonFormatter
-      when 't', 'textmate'
-        if defined?(::RSpec::Mate::Formatters::TextMateFormatter)
-          RSpec.deprecate "Using the text`#{key.to_s}` as a shortcut for the TextMateFormatter",
-          :replacement => "`::RSpec::Mate::Formatters::TextMateFormatter`"
-        else
-          RSpec.deprecate "Using rspec-core's `::RSpec::Core::TextMateFormatter`",
-          :replacement => "the `rspec-tmbundle` gem and it's `::RSpec::Mate::Formatters::TextMateFormatter`"
-        end
-        TextMateFormatter
+      end
+    end
+
+    def notifications_for(formatter_class)
+      formatter_class.ancestors.inject(Set.new) do |notifications, klass|
+        notifications + Loader.formatters.fetch(klass) { Set.new }
       end
     end