rspec-core 2.99.0.beta2 → 2.99.0.rc1

data/lib/rspec/core/formatters.rb

@@ -52,4 +52,141 @@
 # @see RSpec::Core::Formatters::BaseTextFormatter
 # @see RSpec::Core::Reporter
 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 :JsonFormatter,          'rspec/core/formatters/json_formatter'
+  autoload :TextMateFormatter,      'rspec/core/formatters/text_mate_formatter'
+
+  # @api private
+  #
+  # `RSpec::Core::Formatters::Loader` is an internal class for
+  # managing formatters used by a particular configuration. It is
+  # not expected to be used directly, but only through the configuration
+  # interface.
+  class Loader
+
+    # @api private
+    def initialize(reporter)
+      @formatters = []
+      @reporter = reporter
+      @setup = false
+      @default_formatter = 'progress'
+    end
+
+    # @return [Array] the loaded formatters
+    attr_reader :formatters
+
+    # @return [Reporter] the reporter
+    attr_reader :reporter
+
+    # @private
+    def setup_default(output_stream, deprecation_stream)
+      if @formatters.empty?
+        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
+      end
+      @setup = true
+    end
+
+    # @private
+    def add(formatter_to_use, *paths)
+      formatter_class = find_formatter(formatter_to_use)
+
+      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
+      end
+      @formatters << formatter unless duplicate_formatter_exists?(formatter)
+
+      formatter
+    end
+
+  private
+
+    def find_formatter(formatter_to_use)
+      built_in_formatter(formatter_to_use) ||
+      custom_formatter(formatter_to_use)   ||
+      (raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?.")
+    end
+
+    def duplicate_formatter_exists?(new_formatter)
+      @formatters.any? do |formatter|
+        formatter.class === new_formatter && formatter.output == new_formatter.output
+      end
+    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 custom_formatter(formatter_ref)
+      if Class === formatter_ref
+        formatter_ref
+      elsif string_const?(formatter_ref)
+        begin
+          formatter_ref.gsub(/^::/,'').split('::').inject(Object) { |const,string| const.const_get string }
+        rescue NameError
+          require( path_for(formatter_ref) ) ? retry : raise
+        end
+      end
+    end
+
+    def string_const?(str)
+      str.is_a?(String) && /\A[A-Z][a-zA-Z0-9_:]*\z/ =~ str
+    end
+
+    def path_for(const_ref)
+      underscore_with_fix_for_non_standard_rspec_naming(const_ref)
+    end
+
+    def underscore_with_fix_for_non_standard_rspec_naming(string)
+      underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\1rspec\\2')
+    end
+
+    # activesupport/lib/active_support/inflector/methods.rb, line 48
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+    def file_at(path)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.new(path, 'w')
+    end
+  end
 end

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

@@ -1,5 +1,5 @@
 require 'rspec/core/formatters/base_formatter'
-require 'set'
+require 'rspec/core/formatters/console_codes'
 
 module RSpec
   module Core
@@ -68,12 +68,12 @@ module RSpec
         # @api public
         #
         # Outputs the slowest examples and example groups in a report when using `--profile COUNT` (default 10).
-        # 
+        #
         def dump_profile
           dump_profile_slowest_examples
           dump_profile_slowest_example_groups
         end
-        
+
         def dump_profile_slowest_examples
           number_of_examples = RSpec.configuration.profile_examples
           sorted_examples = examples.sort_by {|example|
@@ -95,7 +95,7 @@ module RSpec
 
         def dump_profile_slowest_example_groups
           number_of_examples = RSpec.configuration.profile_examples
-          example_groups = {} 
+          example_groups = {}
 
           examples.each do |example|
             location = example.example_group.parent_groups.last.metadata[:example_group][:location]
@@ -108,15 +108,15 @@ module RSpec
 
           # stop if we've only one example group
           return if example_groups.keys.length <= 1
-          
+
           example_groups.each do |loc, hash|
             hash[:average] = hash[:total_time].to_f / hash[:count]
           end
-          
+
           sorted_groups = example_groups.sort_by {|_, hash| -hash[:average]}.first(number_of_examples)
 
           output.puts "\nTop #{sorted_groups.size} slowest example groups:"
-          sorted_groups.each do |loc, hash| 
+          sorted_groups.each do |loc, hash|
             average = "#{failure_color(format_seconds(hash[:average]))} #{failure_color("seconds")} average"
             total   = "#{format_seconds(hash[:total_time])} seconds"
             count   = pluralize(hash[:count], "example")
@@ -165,41 +165,37 @@ module RSpec
           output.close if IO === output && output != $stdout
         end
 
-        VT100_COLORS = {
-          :black => 30,
-          :red => 31,
-          :green => 32,
-          :yellow => 33,
-          :blue => 34,
-          :magenta => 35,
-          :cyan => 36,
-          :white => 37
-        }
-
-        VT100_COLOR_CODES = VT100_COLORS.values.to_set
-
-        def color_code_for(code_or_symbol)
-          if VT100_COLOR_CODES.include?(code_or_symbol)
-            code_or_symbol
+        def self.const_missing(name)
+          base = "RSpec::Core::Formatters::"
+          case name
+            when :VT100_COLORS then
+              RSpec.deprecate("#{base}#{name}", :replacement => "#{base}ConsoleCodes::VT100_CODES")
+              RSpec::Core::Formatters::ConsoleCodes::VT100_CODES
+            when :VT100_COLOR_CODES then
+              RSpec.deprecate("#{base}#{name}", :replacement => "#{base}ConsoleCodes::VT100_CODE_VALUES")
+              require 'set'
+              RSpec::Core::Formatters::ConsoleCodes::VT100_CODES.to_set
           else
-            VT100_COLORS.fetch(code_or_symbol) do
-              color_code_for(:white)
-            end
+            super
           end
         end
 
+        def color_code_for(code_or_symbol)
+          ConsoleCodes.console_code_for(code_or_symbol)
+        end
+
         def colorize(text, code_or_symbol)
-          "\e[#{color_code_for(code_or_symbol)}m#{text}\e[0m"
+          ConsoleCodes.wrap(text, code_or_symbol)
         end
 
       protected
 
         def bold(text)
-          color_enabled? ? "\e[1m#{text}\e[0m" : text
+          ConsoleCodes.wrap(text, :bold)
         end
 
         def color(text, color_code)
-          color_enabled? ? colorize(text, color_code) : text
+          ConsoleCodes.wrap(text, color_code)
         end
 
         def failure_color(text)

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

@@ -0,0 +1,42 @@
+module RSpec
+  module Core
+    module Formatters
+      module ConsoleCodes
+        VT100_CODES =
+          {
+            :black   => 30,
+            :red     => 31,
+            :green   => 32,
+            :yellow  => 33,
+            :blue    => 34,
+            :magenta => 35,
+            :cyan    => 36,
+            :white   => 37,
+            :bold    => 1,
+          }
+        VT100_CODE_VALUES = VT100_CODES.invert
+
+        module_function
+
+        def console_code_for(code_or_symbol)
+          if VT100_CODE_VALUES.has_key?(code_or_symbol)
+            code_or_symbol
+          else
+            VT100_CODES.fetch(code_or_symbol) do
+              console_code_for(:white)
+            end
+          end
+        end
+
+        def wrap(text, code_or_symbol)
+          if RSpec.configuration.color_enabled?
+            "\e[#{console_code_for(code_or_symbol)}m#{text}\e[0m"
+          else
+            text
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -57,6 +57,9 @@ module RSpec
           |deprecation warnings into errors, giving you the full backtrace.
         EOS
 
+        DEPRECATION_STREAM_NOTICE = "Pass `--deprecation-out` or set " +
+          "`config.deprecation_stream` to a file for full output."
+
         SpecifiedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @message = data[:message]
@@ -64,17 +67,23 @@ module RSpec
           end
 
           def to_s
-            @message
+            output_formatted @message
           end
 
           def too_many_warnings_message
-            msg = "Too many similar deprecation messages reported, disregarding further reports."
-            msg << " Set config.deprecation_stream to a File for full output."
+            msg = "Too many similar deprecation messages reported, disregarding further reports. "
+            msg << DEPRECATION_STREAM_NOTICE
             msg
           end
 
           private
 
+          def output_formatted(str)
+            return str unless str.lines.count > 1
+            separator = "#{'-' * 80}"
+            "#{separator}\n#{str.chomp}\n#{separator}"
+          end
+
           def deprecation_type_for(data)
             data[:message].gsub(/(\w+\/)+\w+\.rb:\d+/, '')
           end
@@ -94,8 +103,8 @@ module RSpec
           end
 
           def too_many_warnings_message
-            msg = "Too many uses of deprecated '#{type}'."
-            msg << " Set config.deprecation_stream to a File for full output."
+            msg = "Too many uses of deprecated '#{type}'. "
+            msg << DEPRECATION_STREAM_NOTICE
             msg
           end
         end

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

@@ -18,7 +18,7 @@ module RSpec
     protected
 
       def backtrace_line(line)
-        return nil if RSpec.configuration.backtrace_cleaner.exclude?(line)
+        return nil if RSpec.configuration.backtrace_formatter.exclude?(line)
         RSpec::Core::Metadata::relative_path(line)
       rescue SecurityError
         nil

data/lib/rspec/core/memoized_helpers.rb

@@ -490,7 +490,8 @@ EOS
         #   end
         def its(attribute, &block)
           RSpec.deprecate("Use of rspec-core's `its` method", :replacement => 'the rspec-its gem')
-          describe(attribute) do
+
+          describe(attribute.to_s) do
             if Array === attribute
               let(:__its_subject) { subject[*attribute] }
             else

data/lib/rspec/core/metadata.rb

@@ -25,6 +25,9 @@ module RSpec
     # @see Configuration#filter_run_including
     # @see Configuration#filter_run_excluding
     class Metadata < Hash
+      class << self
+        attr_accessor :line_number_filter_deprecation_issued
+      end
 
       def self.relative_path(line)
         line = line.sub(File.expand_path("."), ".")
@@ -127,6 +130,30 @@ module RSpec
         include MetadataHash
 
         def described_class
+          warn_about_first_description_arg_behavioral_change_in_rspec_3
+
+          value_for_rspec_2 = described_class_for_rspec_2
+          value_for_rspec_3 = described_class_for_rspec_3
+
+          if value_for_rspec_2 != value_for_rspec_3
+            RSpec.warn_deprecation(<<-EOS.gsub(/^\s+\|/, ''))
+              |The semantics of `described_class` in a nested `describe <SomeClass>`
+              |example group are changing in RSpec 3. In RSpec 2.x, `described_class`
+              |would return the outermost described class (#{value_for_rspec_2.inspect}).
+              |In RSpec 3, it will return the innermost described class (#{value_for_rspec_3.inspect}).
+              |In general, we recommend not describing multiple classes or objects in a
+              |nested manner as it creates confusion.
+              |
+              |To make your code compatible with RSpec 3, change from `described_class` to a reference
+              |to `#{value_for_rspec_3.inspect}`, or change the arg of the inner `describe` to a string.
+              |(Called from #{CallerFilter.first_non_rspec_line})
+            EOS
+          end
+
+          value_for_rspec_2
+        end
+
+        def described_class_for_rspec_2
           container_stack.each do |g|
             [:described_class, :describes].each do |key|
               if g.has_key?(key)
@@ -144,6 +171,31 @@ module RSpec
           nil
         end
 
+        def described_class_for_rspec_3
+          container_stack.each do |g|
+            [:described_class, :describes].each do |key|
+              if g.has_key?(key)
+                value = g[key]
+                return value unless value.nil?
+              end
+            end
+
+            candidate = g[:description_args].first
+            return candidate unless NilClass === candidate || String === candidate || Symbol === candidate
+          end
+
+          nil
+        end
+
+        def warn_about_first_description_arg_behavioral_change_in_rspec_3
+          return unless behavior_change = self[:description_arg_behavior_changing_in_rspec_3]
+          RSpec.warn_deprecation(behavior_change.warning)
+        end
+
+        def first_description_arg
+          self[:description_args].first
+        end
+
         def full_description
           build_description_from(*container_stack.reverse.map {|a| a[:description_args]}.flatten)
         end
@@ -178,6 +230,7 @@ module RSpec
 
         self[:example_group].store(:description_args, args)
         self[:example_group].store(:caller, user_metadata.delete(:caller) || caller)
+        self[:example_group][:description_arg_behavior_changing_in_rspec_3] = user_metadata.delete(:description_arg_behavior_changing_in_rspec_3)
 
         update(user_metadata)
       end
@@ -200,7 +253,16 @@ module RSpec
       # @private
       def filter_applies?(key, value, metadata=self)
         return metadata.filter_applies_to_any_value?(key, value) if Array === metadata[key] && !(Proc === value)
-        return metadata.line_number_filter_applies?(value)       if key == :line_numbers
+
+        if key == :line_numbers
+          unless Metadata.line_number_filter_deprecation_issued
+            RSpec.deprecate("Filtering by `:line_numbers`",
+                            :replacement => "filtering by `:locations`")
+          end
+
+          return metadata.line_number_filter_applies?(value)
+        end
+
         return metadata.location_filter_applies?(value)          if key == :locations
         return metadata.filters_apply?(key, value)               if Hash === value