rspec-core 2.13.1 → 2.14.0.rc1

data/lib/rspec/core/configuration_options.rb

@@ -19,15 +19,12 @@ module RSpec
       end
 
       def configure(config)
-        formatters = options.delete(:formatters)
-
         config.filter_manager = filter_manager
+        process_options_into config
 
-        order(options.keys, :libs, :requires, :default_path, :pattern).each do |key|
-          force?(key) ? config.force(key => options[key]) : config.send("#{key}=", options[key])
-        end
+        config.setup_load_path_and_require(options[:requires] || [])
 
-        formatters.each {|pair| config.add_formatter(*pair) } if formatters
+        load_formatters_into config
       end
 
       def parse_options
@@ -55,6 +52,8 @@ module RSpec
 
       MERGED_OPTIONS = [:requires, :libs].to_set
 
+      UNPROCESSABLE_OPTIONS = [:formatters, :requires].to_set
+
       def force?(key)
         !NON_FORCED_OPTIONS.include?(key)
       end
@@ -66,6 +65,18 @@ module RSpec
         keys
       end
 
+      def process_options_into(config)
+        opts = options.reject { |k, _| UNPROCESSABLE_OPTIONS.include? k }
+
+        order(opts.keys, :libs, :default_path, :pattern).each do |key|
+          force?(key) ? config.force(key => opts[key]) : config.send("#{key}=", opts[key])
+        end
+      end
+
+      def load_formatters_into(config)
+        options[:formatters].each { |pair| config.add_formatter(*pair) } if options[:formatters]
+      end
+
       def extract_filters_from(*configs)
         configs.compact.each do |config|
           filter_manager.include config.delete(:inclusion_filter) if config.has_key?(:inclusion_filter)
@@ -112,11 +123,11 @@ module RSpec
       def args_from_options_file(path)
         return [] unless path && File.exist?(path)
         config_string = options_file_as_erb_string(path)
-        config_string.split(/\n+/).map {|l| l.shellsplit}.flatten
+        config_string.split(/\n+/).map {|l| Shellwords.shellwords(l) }.flatten
       end
 
       def options_file_as_erb_string(path)
-        ERB.new(File.read(path)).result(binding)
+        ERB.new(File.read(path), nil, '-').result(binding)
       end
 
       def custom_options_file

data/lib/rspec/core/deprecation.rb

@@ -1,36 +1,24 @@
 module RSpec
-  class << self
-    # @private
-    #
-    # Used internally to print deprecation warnings
-    def deprecate(method, alternate_method=nil, version=nil)
-      version_string = version ? "rspec-#{version}" : "a future version of RSpec"
-
-      message = <<-NOTICE
-
-*****************************************************************
-DEPRECATION WARNING: you are using deprecated behaviour that will
-be removed from #{version_string}.
-
-#{caller(0)[2]}
-
-* #{method} is deprecated.
-NOTICE
-      if alternate_method
-        message << <<-ADDITIONAL
-* please use #{alternate_method} instead.
-ADDITIONAL
+  module Core
+    module Deprecation
+      # @private
+      #
+      # Used internally to print deprecation warnings
+      def deprecate(deprecated, replacement_or_hash={}, ignore_version=nil)
+        # Temporarily support old and new APIs while we transition the other
+        # rspec libs to use a hash for the 2nd arg and no version arg
+        data = Hash === replacement_or_hash ? replacement_or_hash : { :replacement => replacement_or_hash }
+        RSpec.configuration.reporter.deprecation data.merge(:deprecated => deprecated, :call_site => caller(0)[2])
       end
 
-      message << "*****************************************************************"
-      warn_deprecation(message)
-    end
-
-    # @private
-    #
-    # Used internally to print deprecation warnings
-    def warn_deprecation(message)
-      warn message
+      # @private
+      #
+      # Used internally to print deprecation warnings
+      def warn_deprecation(message)
+        RSpec.configuration.reporter.deprecation :message => message
+      end
     end
   end
+
+  extend(Core::Deprecation)
 end

data/lib/rspec/core/example.rb

@@ -79,7 +79,7 @@ module RSpec
       def initialize(example_group_class, description, metadata, example_block=nil)
         @example_group_class, @options, @example_block = example_group_class, metadata, example_block
         @metadata  = @example_group_class.metadata.for_example(description, metadata)
-        @exception = nil
+        @example_group_instance = @exception = nil
         @pending_declared_in_example = false
       end
 
@@ -317,8 +317,8 @@ An error occurred #{context}
 
       def assign_generated_description
         return unless RSpec.configuration.expecting_with_rspec?
-        if metadata[:description].empty? and !pending?
-          metadata[:description] = RSpec::Matchers.generated_description
+        if metadata[:description_args].empty? and !pending?
+          metadata[:description_args] << RSpec::Matchers.generated_description
         end
         RSpec::Matchers.clear_generated_description
       end

data/lib/rspec/core/example_group.rb

@@ -162,7 +162,7 @@ module RSpec
       # @private
       def self.find_and_eval_shared(label, name, *args, &customization_block)
         raise ArgumentError, "Could not find shared #{label} #{name.inspect}" unless
-        shared_block = world.shared_example_groups[name]
+        shared_block = shared_example_groups[name]
 
         module_eval_with_args(*args, &shared_block)
         module_eval(&customization_block) if customization_block
@@ -287,8 +287,8 @@ module RSpec
         args << build_metadata_hash_from(args)
         args.unshift(symbol_description) if symbol_description
         @metadata = RSpec::Core::Metadata.new(superclass_metadata).process(*args)
-        world.configure_group(self)
         hooks.register_globals(self, RSpec.configuration.hooks)
+        world.configure_group(self)
       end
 
       # @private
@@ -444,7 +444,8 @@ An error occurred in an after(:all) hook.
 
       # @deprecated use {ExampleGroup#example}
       def running_example
-        RSpec.deprecate("running_example", "example")
+        RSpec.deprecate("running_example",
+                        :replacement => "example")
         example
       end
 

data/lib/rspec/core/extensions/kernel.rb

@@ -4,6 +4,6 @@ module Kernel
     # message to STDERR when ruby-debug is not loaded.
     def debugger(*args)
       (RSpec.configuration.error_stream || $stderr).puts "\n***** debugger statement ignored, use -d or --debug option to enable debugging\n#{caller(0)[1]}"
-    end 
+    end
   end
 end

data/lib/rspec/core/filter_manager.rb

@@ -107,7 +107,7 @@ module RSpec
         # Emits a deprecation warning for keys that will not be supported in
         # the future.
         def _warn_deprecated_key(key, updates)
-          RSpec.warn_deprecation("\nDEPRECATION NOTICE: FilterManager#exclude(#{key.inspect} => #{updates[key].inspect}) is deprecated with no replacement, and will be removed from rspec-3.0.")
+          RSpec.deprecate("FilterManager#exclude(#{key.inspect} => #{updates[key].inspect})")
           @exclusions[key] = updates.delete(key)
         end
       end

data/lib/rspec/core/formatters.rb

@@ -16,7 +16,7 @@
 #
 #     rspec --format documentation --format html --out results.html
 #
-# This example sends the output of the documentation formatter to `STDOUT`, and
+# This example sends the output of the documentation formatter to `$stdout`, and
 # the output of the html formatter to results.html.
 #
 # ## Custom Formatters

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

@@ -105,7 +105,7 @@ module RSpec
         # @api public
         #
         # Used by the reporter to send messages to the output stream.
-        # 
+        #
         # @param [String] message
         def message(message)
         end
@@ -228,9 +228,18 @@ module RSpec
           configuration.profile_examples
         end
 
+        def fail_fast?
+          configuration.fail_fast
+        end
+
         def color_enabled?
           configuration.color_enabled?(output)
         end
+
+        def mute_profile_output?(failure_count)
+          # Don't print out profiled info if there are failures and `--fail-fast` is used, it just clutters the output
+          !profile_examples? || (fail_fast? && failure_count != 0)
+        end
       end
     end
   end

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

@@ -44,7 +44,7 @@ module RSpec
 
         def dump_summary(duration, example_count, failure_count, pending_count)
           super(duration, example_count, failure_count, pending_count)
-          dump_profile if profile_examples?
+          dump_profile unless mute_profile_output?(failure_count)
           output.puts "\nFinished in #{format_duration(duration)}\n"
           output.puts colorise_summary(summary_line(example_count, failure_count, pending_count))
           dump_commands_to_rerun_failed_examples
@@ -67,9 +67,14 @@ module RSpec
 
         # @api public
         #
-        # Outputs the slowest examples in a report when using `--profile COUNT` (default 10).
-        #
+        # 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|
             example.execution_result[:run_time] }.reverse.first(number_of_examples)
@@ -88,6 +93,38 @@ module RSpec
           end
         end
 
+        def dump_profile_slowest_example_groups
+          number_of_examples = RSpec.configuration.profile_examples
+          example_groups = {} 
+
+          examples.each do |example|
+            location = example.example_group.parent_groups.last.metadata[:example_group][:location]
+
+            example_groups[location] ||= Hash.new(0)
+            example_groups[location][:total_time]  += example.execution_result[:run_time]
+            example_groups[location][:count]       += 1
+            example_groups[location][:description] = example.example_group.top_level_description unless example_groups[location].has_key?(:description)
+          end
+
+          # 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| 
+            average = "#{failure_color(format_seconds(hash[:average]))} #{failure_color("seconds")} average"
+            total   = "#{format_seconds(hash[:total_time])} seconds"
+            count   = pluralize(hash[:count], "example")
+            output.puts "  #{hash[:description]}"
+            output.puts detail_color("    #{average} (#{total} / #{count}) #{loc}")
+          end
+        end
+
         # @api public
         #
         # Outputs summary with number of examples, failures and pending.
@@ -188,37 +225,37 @@ module RSpec
         end
 
         def red(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#red", "#failure_color", "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#red", :replacement => "#failure_color")
           color(text, :red)
         end
 
         def green(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#green", "#success_color", "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#green", :replacement => "#success_color")
           color(text, :green)
         end
 
         def yellow(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#yellow", "#pending_color", "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#yellow", :replacement => "#pending_color")
           color(text, :yellow)
         end
 
         def blue(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#blue", "#fixed_color", "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#blue", :replacement => "#fixed_color")
           color(text, :blue)
         end
 
         def magenta(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#magenta", nil, "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#magenta")
           color(text, :magenta)
         end
 
         def cyan(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#cyan", "#detail_color", "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#cyan", :replacement => "#detail_color")
           color(text, :cyan)
         end
 
         def white(text)
-          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#white", "#default_color", "3.0")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#white", :replacement => "#default_color")
           color(text, :white)
         end
 

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

@@ -0,0 +1,35 @@
+module RSpec
+  module Core
+    module Formatters
+      class DeprecationFormatter
+        def initialize(deprecation_stream=$stderr, summary_stream=$stdout)
+          @deprecation_stream = deprecation_stream
+          @summary_stream = summary_stream
+          @count = 0
+        end
+
+        def deprecation(data)
+          @count += 1
+          if data[:message]
+            @deprecation_stream.print data[:message]
+          else
+            @deprecation_stream.print "DEPRECATION: " unless File === @deprecation_stream
+            @deprecation_stream.print "#{data[:deprecated]} is deprecated."
+            @deprecation_stream.print " Use #{data[:replacement]} instead." if data[:replacement]
+            @deprecation_stream.print " Called from #{data[:call_site]}." if data[:call_site]
+            @deprecation_stream.puts
+          end
+        end
+
+        def deprecation_summary
+          if @count > 0 && File === @deprecation_stream
+            @summary_stream.print "\n#{@count} deprecation"
+            @summary_stream.print "s" if @count > 1
+            @summary_stream.print " logged to "
+            @summary_stream.puts @deprecation_stream.path
+          end
+        end
+      end
+    end
+  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.cleaned_from_backtrace?(line)
+        return nil if RSpec.configuration.backtrace_cleaner.exclude?(line)
         RSpec::Core::Metadata::relative_path(line)
       rescue SecurityError
         nil
@@ -43,20 +43,27 @@ module RSpec
         #    format_duration(1) #=>  "1 minute 1 second"
         #    format_duration(135.14) #=> "2 minutes 15.14 seconds"
         def format_duration(duration)
+          precision = case
+                      when duration < 1;    SUB_SECOND_PRECISION
+                      when duration < 120;  DEFAULT_PRECISION
+                      when duration < 300;  1
+                      else                  0
+                      end
+
           if duration > 60
             minutes = duration.to_i / 60
             seconds = duration - minutes * 60
 
-            "#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds), 'second')}"
+            "#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}"
           else
-            pluralize(format_seconds(duration), 'second')
+            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
-        # if less than 1 or with 2 digits of precision if the number is greater than zero.
+        # is less than 1 or with 2 digits of precision if the number is greater than zero.
         #
         # @param [Float] float
         # @return [String] formatted float
@@ -69,7 +76,7 @@ module RSpec
         # The precision used is set in {Helpers::SUB_SECOND_PRECISION} and {Helpers::DEFAULT_PRECISION}.
         #
         # @see #strip_trailing_zeroes
-        def format_seconds(float)
+        def format_seconds(float, precision = nil)
           precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION
           formatted = sprintf("%.#{precision}f", float)
           strip_trailing_zeroes(formatted)

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

@@ -72,7 +72,7 @@ module RSpec
 
           unless @header_red
             @header_red = true
-            @printer.make_header_red 
+            @printer.make_header_red
           end
 
           unless @example_group_red
@@ -84,22 +84,23 @@ module RSpec
 
           exception = example.metadata[:execution_result][:exception]
           exception_details = if exception
-            { 
-              :message => exception.message, 
+            {
+              :message => exception.message,
               :backtrace => format_backtrace(exception.backtrace, example).join("\n")
             }
           else
-            false 
+            false
           end
           extra = extra_failure_content(exception)
 
-          @printer.print_example_failed( 
+          @printer.print_example_failed(
             exception.pending_fixed?,
             example.description,
             example.execution_result[:run_time],
             @failed_examples.size,
             exception_details,
-            (extra == "") ? false : extra
+            (extra == "") ? false : extra,
+            true
           )
           @printer.flush
         end