rspec-core 2.99.2 → 3.0.0.beta1

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

@@ -16,9 +16,7 @@ module RSpec
 
         def printer
           @printer ||= case deprecation_stream
-                       when File
-                         ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
-                       when RaiseErrorStream
+                       when File, RaiseErrorStream
                          ImmediatePrinter.new(deprecation_stream, summary_stream, self)
                        else
                          DelayedPrinter.new(deprecation_stream, summary_stream, self)
@@ -37,10 +35,6 @@ module RSpec
           printer.deprecation_summary
         end
 
-        def start(example_count=nil)
-          #no-op to fix #966
-        end
-
         def deprecation_message_for(data)
           if data[:message]
             SpecifiedDeprecationMessage.new(data)
@@ -57,9 +51,6 @@ 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]
@@ -67,23 +58,17 @@ module RSpec
           end
 
           def to_s
-            output_formatted @message
+            @message
           end
 
           def too_many_warnings_message
-            msg = "Too many similar deprecation messages reported, disregarding further reports. "
-            msg << DEPRECATION_STREAM_NOTICE
+            msg = "Too many similar deprecation messages reported, disregarding further reports."
+            msg << " Set config.deprecation_stream to a File for full output."
             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
@@ -92,7 +77,7 @@ module RSpec
         GeneratedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @data = data
-            super data.fetch(:type, data[:deprecated])
+            super data[:deprecated]
           end
 
           def to_s
@@ -103,18 +88,26 @@ module RSpec
           end
 
           def too_many_warnings_message
-            msg = "Too many uses of deprecated '#{type}'. "
-            msg << DEPRECATION_STREAM_NOTICE
+            msg = "Too many uses of deprecated '#{type}'."
+            msg << " Set config.deprecation_stream to a File for full output."
             msg
           end
         end
 
         class ImmediatePrinter
+          include ::RSpec::Core::Formatters::Helpers
+
           attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter
 
           def initialize(deprecation_stream, summary_stream, deprecation_formatter)
             @deprecation_stream = deprecation_stream
 
+            # In one of my test suites, I got lots of duplicate output in the
+            # deprecation file (e.g. 200 of the same deprecation, even though
+            # the `puts` below was only called 6 times). Setting `sync = true`
+            # fixes this (but we really have no idea why!).
+            @deprecation_stream.sync = true
+
             @summary_stream = summary_stream
             @deprecation_formatter = deprecation_formatter
           end
@@ -125,8 +118,10 @@ module RSpec
           end
 
           def deprecation_summary
-            return if deprecation_formatter.count.zero?
-            deprecation_stream.summarize(summary_stream, deprecation_formatter.count)
+            if deprecation_formatter.count > 0
+              summary_stream.puts "\n#{pluralize(deprecation_formatter.count, 'deprecation')} logged to #{deprecation_stream.path}"
+              deprecation_stream.puts RAISE_ERROR_CONFIG_NOTICE
+            end
           end
         end
 
@@ -181,38 +176,12 @@ module RSpec
 
         # Not really a stream, but is usable in place of one.
         class RaiseErrorStream
-          include ::RSpec::Core::Formatters::Helpers
-
           def puts(message)
             raise DeprecationError, message
           end
 
-          def summarize(summary_stream, deprecation_count)
-            summary_stream.puts "\n#{pluralize(deprecation_count, 'deprecation')} found."
-          end
-        end
-
-        # Wraps a File object and provides file-specific operations.
-        class FileStream
-          include ::RSpec::Core::Formatters::Helpers
-
-          def initialize(file)
-            @file = file
-
-            # In one of my test suites, I got lots of duplicate output in the
-            # deprecation file (e.g. 200 of the same deprecation, even though
-            # the `puts` below was only called 6 times). Setting `sync = true`
-            # fixes this (but we really have no idea why!).
-            @file.sync = true
-          end
-
-          def puts(*args)
-            @file.puts(*args)
-          end
-
-          def summarize(summary_stream, deprecation_count)
-            summary_stream.puts "\n#{pluralize(deprecation_count, 'deprecation')} logged to #{@file.path}"
-            puts RAISE_ERROR_CONFIG_NOTICE
+          def sync=(value)
+            # no-op
           end
         end
 

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

@@ -1,34 +1,7 @@
 module RSpec
   module Core
-    module BacktraceFormatter
-      extend self
-
-      def format_backtrace(backtrace, options = {})
-        return "" unless backtrace
-        return backtrace if options[:full_backtrace] == true
-
-        if at_exit_index = backtrace.index(RSpec::Core::Runner::AT_EXIT_HOOK_BACKTRACE_LINE)
-          backtrace = backtrace[0, at_exit_index]
-        end
-
-        cleansed = backtrace.map { |line| backtrace_line(line) }.compact
-        cleansed.empty? ? backtrace : cleansed
-      end
-
-    protected
-
-      def backtrace_line(line)
-        return nil if RSpec.configuration.backtrace_formatter.exclude?(line)
-        RSpec::Core::Metadata::relative_path(line)
-      rescue SecurityError
-        nil
-      end
-    end
-
     module Formatters
       module Helpers
-        include BacktraceFormatter
-
         SUB_SECOND_PRECISION = 5
         DEFAULT_PRECISION = 2
 
@@ -104,7 +77,6 @@ module RSpec
           "#{count} #{string}#{'s' unless count.to_f == 1}"
         end
       end
-
     end
   end
 end

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

@@ -119,7 +119,7 @@ module RSpec
         #
         def extra_failure_content(exception)
           require 'rspec/core/formatters/snippet_extractor'
-          backtrace = exception.backtrace.map {|line| backtrace_line(line)}
+          backtrace = exception.backtrace.map {|line| configuration.backtrace_formatter.backtrace_line(line)}
           backtrace.compact!
           @snippet_extractor ||= SnippetExtractor.new
           "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"

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

@@ -27,6 +27,8 @@ module RSpec
             :pending_count => pending_count
           }
           @output_hash[:summary_line] = summary_line(example_count, failure_count, pending_count)
+
+          dump_profile unless mute_profile_output?(failure_count)
         end
 
         def summary_line(example_count, failure_count, pending_count)
@@ -39,15 +41,7 @@ module RSpec
         def stop
           super
           @output_hash[:examples] = examples.map do |example|
-            {
-              :description => example.description,
-              :full_description => example.full_description,
-              :status => example.execution_result[:status],
-              # :example_group,
-              # :execution_result,
-              :file_path => example.metadata[:file_path],
-              :line_number  => example.metadata[:line_number],
-            }.tap do |hash|
+            format_example(example).tap do |hash|
               if e=example.exception
                 hash[:exception] =  {
                   :class => e.class.name,
@@ -64,6 +58,41 @@ module RSpec
           output.close if IO === output && output != $stdout
         end
 
+        def dump_profile
+          @output_hash[:profile] = {}
+          dump_profile_slowest_examples
+          dump_profile_slowest_example_groups
+        end
+
+        def dump_profile_slowest_examples
+          @output_hash[:profile] = {}
+          sorted_examples = slowest_examples
+          @output_hash[:profile][:examples] = sorted_examples[:examples].map do |example|
+            format_example(example).tap do |hash|
+              hash[:run_time] = example.execution_result[:run_time]
+            end
+          end
+          @output_hash[:profile][:slowest] = sorted_examples[:slows]
+          @output_hash[:profile][:total] = sorted_examples[:total]
+        end
+
+        def dump_profile_slowest_example_groups
+          @output_hash[:profile] ||= {}
+          @output_hash[:profile][:groups] = slowest_groups.map do |loc, hash|
+            hash.update(:location => loc)
+          end
+        end
+
+      private
+        def format_example(example)
+          {
+            :description => example.description,
+            :full_description => example.full_description,
+            :status => example.execution_result[:status],
+            :file_path => example.metadata[:file_path],
+            :line_number  => example.metadata[:line_number]
+          }
+        end
       end
     end
   end

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

@@ -5,11 +5,21 @@ 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
+        class NullConverter
+          def convert(code)
+            %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
+          end
+        end
+
+        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
@@ -24,8 +34,7 @@ module RSpec
         # @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
 

data/lib/rspec/core/hooks.rb

@@ -1,8 +1,6 @@
 module RSpec
   module Core
     module Hooks
-      include MetadataHashBuilder::WithConfigWarning
-
       class Hook
         attr_reader :block, :options
 
@@ -18,7 +16,7 @@ module RSpec
 
       class BeforeHook < Hook
         def run(example)
-          example.instance_eval_with_args(example, &block)
+          example.instance_exec(example, &block)
         end
 
         def display_name
@@ -28,7 +26,7 @@ module RSpec
 
       class AfterHook < Hook
         def run(example)
-          example.instance_eval_with_rescue("in an after hook", &block)
+          example.instance_exec_with_rescue("in an after hook", &block)
         end
 
         def display_name
@@ -61,18 +59,26 @@ EOS
         end
       end
 
-      module HookCollectionAliases
-        def self.included(host)
-          host.send :alias_method, :prepend, :unshift
-          host.send :alias_method, :append,  :push
+      class BaseHookCollection
+        Array.public_instance_methods(false).each do |name|
+          define_method(name) { |*a, &b| hooks.__send__(name, *a, &b) }
         end
-      end
 
-      class HookCollection < Array
-        include HookCollectionAliases
+        attr_reader :hooks
+        protected   :hooks
 
+        alias append push
+        alias prepend unshift
+
+        def initialize(hooks=[])
+          @hooks = hooks
+        end
+      end
+
+      class HookCollection < BaseHookCollection
         def for(example_or_group)
-          self.class.new(select {|hook| hook.options_apply?(example_or_group)}).
+          self.class.
+            new(hooks.select {|hook| hook.options_apply?(example_or_group)}).
             with(example_or_group)
         end
 
@@ -82,15 +88,13 @@ EOS
         end
 
         def run
-          each {|h| h.run(@example) } unless empty?
+          hooks.each {|h| h.run(@example)}
         end
       end
 
-      class AroundHookCollection < Array
-        include HookCollectionAliases
-
+      class AroundHookCollection < BaseHookCollection
         def for(example, initial_procsy=nil)
-          self.class.new(select {|hook| hook.options_apply?(example)}).
+          self.class.new(hooks.select {|hook| hook.options_apply?(example)}).
             with(example, initial_procsy)
         end
 
@@ -101,51 +105,61 @@ EOS
         end
 
         def run
-          inject(@initial_procsy) do |procsy, around_hook|
-            Example.procsy(procsy.metadata) do
-              @example.instance_eval_with_args(procsy, &around_hook.block)
+          hooks.reduce(@initial_procsy) do |procsy, around_hook|
+            procsy.wrap do
+              @example.instance_exec(procsy, &around_hook.block)
             end
           end.call
         end
       end
 
-      class GroupHookCollection < Array
+      class GroupHookCollection < BaseHookCollection
         def for(group)
           @group = group
           self
         end
 
         def run
-          shift.run(@group) until empty?
+          hooks.shift.run(@group) until hooks.empty?
         end
       end
 
-      module RegistersGlobals
-        def register_globals host, globals
-          [:before, :after, :around].each do |position|
-            process host, globals, position, :each
-            next if position == :around # no around(:all) hooks
-            process host, globals, position, :all
-          end
+      class HookCollections
+        def initialize(data)
+          @data = data
+        end
+
+        def [](key)
+          @data[key]
+        end
+
+        def register_globals(host, globals)
+          process(host, globals, :before, :each)
+          process(host, globals, :after,  :each)
+          process(host, globals, :around, :each)
+
+          process(host, globals, :before, :all)
+          process(host, globals, :after,  :all)
         end
 
         private
-        def process host, globals, position, scope
+
+        def process(host, globals, position, scope)
           globals[position][scope].each do |hook|
-            unless host.parent_groups.any? { |a| a.hooks[position][scope].include? hook }
-              self[position][scope] << hook if scope == :each || hook.options_apply?(host)
-            end
+            next unless scope == :each || hook.options_apply?(host)
+            next if host.parent_groups.any? {|a| a.hooks[position][scope].include?(hook)}
+            self[position][scope] << hook
           end
         end
       end
 
       # @private
       def hooks
-        @hooks ||= {
+        @hooks ||= HookCollections.new(
           :around => { :each => AroundHookCollection.new },
           :before => { :each => HookCollection.new, :all => HookCollection.new, :suite => HookCollection.new },
           :after =>  { :each => HookCollection.new, :all => HookCollection.new, :suite => HookCollection.new }
-        }.extend(RegistersGlobals)
+        )
       end
 
       # @api public
@@ -443,12 +457,14 @@ EOS
       # Runs all of the blocks stored with the hook in the context of the
       # example. If no example is provided, just calls the hook directly.
       def run_hook(hook, scope, example_or_group=ExampleGroup.new, initial_procsy=nil)
+        return if RSpec.configuration.dry_run?
+
         find_hook(hook, scope, example_or_group, initial_procsy).run
       end
 
       # @private
       def around_each_hooks_for(example, initial_procsy=nil)
-        AroundHookCollection.new(parent_groups.map {|a| a.hooks[:around][:each]}.flatten).for(example, initial_procsy)
+        AroundHookCollection.new(FlatMap.flat_map(parent_groups) {|a| a.hooks[:around][:each]}).for(example, initial_procsy)
       end
 
     private
@@ -472,11 +488,11 @@ EOS
       end
 
       def before_each_hooks_for(example)
-        HookCollection.new(parent_groups.reverse.map {|a| a.hooks[:before][:each]}.flatten).for(example)
+        HookCollection.new(FlatMap.flat_map(parent_groups.reverse) {|a| a.hooks[:before][:each]}).for(example)
       end
 
       def after_each_hooks_for(example)
-        HookCollection.new(parent_groups.map {|a| a.hooks[:after][:each]}.flatten).for(example)
+        HookCollection.new(FlatMap.flat_map(parent_groups) {|a| a.hooks[:after][:each]}).for(example)
       end
 
       def register_hook prepend_or_append, hook, *args, &block
@@ -502,7 +518,7 @@ EOS
       end
 
       def scope_and_options_from(*args)
-        return extract_scope_from(args), build_metadata_hash_from(args)
+        return extract_scope_from(args), Metadata.build_hash_from(args)
       end
 
       def extract_scope_from(args)