rspec-core 3.2.3 → 3.3.0

data/lib/rspec/core/metadata_filter.rb

@@ -17,6 +17,7 @@ module RSpec
           silence_metadata_example_group_deprecations do
             return filter_applies_to_any_value?(key, value, metadata) if Array === metadata[key] && !(Proc === value)
             return location_filter_applies?(value, metadata)          if key == :locations
+            return id_filter_applies?(value, metadata)                if key == :ids
             return filters_apply?(key, value, metadata)               if Hash === value
 
             return false unless metadata.key?(key)
@@ -42,9 +43,17 @@ module RSpec
           metadata[key].any? { |v| filter_applies?(key, v,  key => value) }
         end
 
+        def id_filter_applies?(rerun_paths_to_scoped_ids, metadata)
+          scoped_ids = rerun_paths_to_scoped_ids.fetch(metadata[:rerun_file_path]) { return false }
+
+          Metadata.ascend(metadata).any? do |meta|
+            scoped_ids.include?(meta[:scoped_id])
+          end
+        end
+
         def location_filter_applies?(locations, metadata)
           line_numbers = example_group_declaration_lines(locations, metadata)
-          line_numbers.empty? || line_number_filter_applies?(line_numbers, metadata)
+          line_number_filter_applies?(line_numbers, metadata)
         end
 
         def line_number_filter_applies?(line_numbers, metadata)
@@ -69,10 +78,10 @@ module RSpec
         end
 
         def silence_metadata_example_group_deprecations
-          RSpec.thread_local_metadata[:silence_metadata_example_group_deprecations] = true
+          RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations] = true
           yield
         ensure
-          RSpec.thread_local_metadata.delete(:silence_metadata_example_group_deprecations)
+          RSpec::Support.thread_local_data.delete(:silence_metadata_example_group_deprecations)
         end
       end
     end
@@ -118,6 +127,7 @@ module RSpec
         end
 
         unless [].respond_to?(:each_with_object) # For 1.8.7
+          # :nocov:
           undef items_for
           def items_for(request_meta)
             @items_and_filters.inject([]) do |to_return, (item, item_meta)|
@@ -126,6 +136,7 @@ module RSpec
               to_return
             end
           end
+          # :nocov:
         end
       end
 
@@ -208,6 +219,7 @@ module RSpec
         end
 
         unless [].respond_to?(:each_with_object) # For 1.8.7
+          # :nocov:
           undef proc_keys_from
           def proc_keys_from(metadata)
             metadata.inject([]) do |to_return, (key, value)|
@@ -215,6 +227,7 @@ module RSpec
               to_return
             end
           end
+          # :nocov:
         end
       end
     end

data/lib/rspec/core/mutex.rb

@@ -0,0 +1,63 @@
+module RSpec
+  module Core
+    # On 1.8.7, it's in the stdlib.
+    # We don't want to load the stdlib, b/c this is a test tool, and can affect the test environment,
+    # causing tests to pass where they should fail.
+    #
+    # So we're transcribing/modifying it from https://github.com/ruby/ruby/blob/v1_8_7_374/lib/thread.rb#L56
+    # Some methods we don't need are deleted.
+    # Anything I don't understand (there's quite a bit, actually) is left in.
+    # Some formating changes are made to appease the robot overlord:
+    #   https://travis-ci.org/rspec/rspec-core/jobs/54410874
+    # @private
+    class Mutex
+      def initialize
+        @waiting = []
+        @locked = false
+        @waiting.taint
+        taint
+      end
+
+      # @private
+      def lock
+        while Thread.critical = true && @locked
+          @waiting.push Thread.current
+          Thread.stop
+        end
+        @locked = true
+        Thread.critical = false
+        self
+      end
+
+      # @private
+      def unlock
+        return unless @locked
+        Thread.critical = true
+        @locked = false
+        begin
+          t = @waiting.shift
+          t.wakeup if t
+        rescue ThreadError
+          retry
+        end
+        Thread.critical = false
+        begin
+          t.run if t
+        rescue ThreadError
+          :noop
+        end
+        self
+      end
+
+      # @private
+      def synchronize
+        lock
+        begin
+          yield
+        ensure
+          unlock
+        end
+      end
+    end unless defined?(::RSpec::Core::Mutex) # Avoid warnings for library wide checks spec
+  end
+end

data/lib/rspec/core/notifications.rb

@@ -1,4 +1,6 @@
+RSpec::Support.require_rspec_core "formatters/exception_presenter"
 RSpec::Support.require_rspec_core "formatters/helpers"
+RSpec::Support.require_rspec_core "shell_escape"
 RSpec::Support.require_rspec_support "encoded_string"
 
 module RSpec::Core
@@ -38,17 +40,19 @@ module RSpec::Core
       def self.for(example)
         execution_result = example.execution_result
 
-        if execution_result.pending_fixed?
-          PendingExampleFixedNotification.new(example)
-        elsif execution_result.example_skipped?
-          SkippedExampleNotification.new(example)
-        elsif execution_result.status == :pending
-          PendingExampleFailedAsExpectedNotification.new(example)
-        elsif execution_result.status == :failed
-          FailedExampleNotification.new(example)
-        else
-          new(example)
-        end
+        return SkippedExampleNotification.new(example) if execution_result.example_skipped?
+        return new(example) unless execution_result.status == :pending || execution_result.status == :failed
+
+        klass = if execution_result.pending_fixed?
+                  PendingExampleFixedNotification
+                elsif execution_result.status == :pending
+                  PendingExampleFailedAsExpectedNotification
+                else
+                  FailedExampleNotification
+                end
+
+        exception_presenter = Formatters::ExceptionPresenter::Factory.new(example).build
+        klass.new(example, exception_presenter)
       end
 
       private_class_method :new
@@ -135,7 +139,8 @@ module RSpec::Core
     end
 
     # The `FailedExampleNotification` extends `ExampleNotification` with
-    # things useful for failed specs.
+    # things useful for examples that have failure info -- typically a
+    # failed or pending spec.
     #
     # @example
     #   def example_failed(notification)
@@ -151,19 +156,19 @@ module RSpec::Core
 
       # @return [Exception] The example failure
       def exception
-        example.execution_result.exception
+        @exception_presenter.exception
       end
 
       # @return [String] The example description
       def description
-        example.full_description
+        @exception_presenter.description
       end
 
       # Returns the message generated for this failure line by line.
       #
       # @return [Array<String>] The example failure message
       def message_lines
-        add_shared_group_lines(failure_lines, NullColorizer)
+        @exception_presenter.message_lines
       end
 
       # Returns the message generated for this failure colorized line by line.
@@ -171,16 +176,14 @@ module RSpec::Core
       # @param colorizer [#wrap] An object to colorize the message_lines by
       # @return [Array<String>] The example failure message colorized
       def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        add_shared_group_lines(failure_lines, colorizer).map do |line|
-          colorizer.wrap line, message_color
-        end
+        @exception_presenter.colorized_message_lines(colorizer)
       end
 
       # Returns the failures formatted backtrace.
       #
       # @return [Array<String>] the examples backtrace lines
       def formatted_backtrace
-        backtrace_formatter.format_backtrace(exception.backtrace, example.metadata)
+        @exception_presenter.formatted_backtrace
       end
 
       # Returns the failures colorized formatted backtrace.
@@ -188,170 +191,28 @@ module RSpec::Core
       # @param colorizer [#wrap] An object to colorize the message_lines by
       # @return [Array<String>] the examples colorized backtrace lines
       def colorized_formatted_backtrace(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        formatted_backtrace.map do |backtrace_info|
-          colorizer.wrap "# #{backtrace_info}", RSpec.configuration.detail_color
-        end
+        @exception_presenter.colorized_formatted_backtrace(colorizer)
       end
 
       # @return [String] The failure information fully formatted in the way that
       #   RSpec's built-in formatters emit.
       def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        "\n  #{failure_number}) #{description}\n#{formatted_message_and_backtrace(colorizer)}"
-      end
-
-    private
-
-      if String.method_defined?(:encoding)
-        def encoding_of(string)
-          string.encoding
-        end
-      else
-        def encoding_of(_string)
-        end
-      end
-
-      def backtrace_formatter
-        RSpec.configuration.backtrace_formatter
-      end
-
-      def exception_class_name
-        name = exception.class.name.to_s
-        name = "(anonymous error class)" if name == ''
-        name
-      end
-
-      def failure_lines
-        @failure_lines ||=
-          begin
-            lines = ["Failure/Error: #{read_failed_line.strip}"]
-            lines << "#{exception_class_name}:" unless exception_class_name =~ /RSpec/
-            exception.message.to_s.split("\n").each do |line|
-              lines << "  #{line}" if exception.message
-            end
-            lines
-          end
-      end
-
-      def add_shared_group_lines(lines, colorizer)
-        example.metadata[:shared_group_inclusion_backtrace].each do |frame|
-          lines << colorizer.wrap(frame.description, RSpec.configuration.default_color)
-        end
-
-        lines
-      end
-
-      def read_failed_line
-        matching_line = find_failed_line
-        unless matching_line
-          return "Unable to find matching line from backtrace"
-        end
-
-        file_path, line_number = matching_line.match(/(.+?):(\d+)(|:\d+)/)[1..2]
-
-        if File.exist?(file_path)
-          File.readlines(file_path)[line_number.to_i - 1] ||
-            "Unable to find matching line in #{file_path}"
-        else
-          "Unable to find #{file_path} to read failed line"
-        end
-      rescue SecurityError
-        "Unable to read failed line"
-      end
-
-      def find_failed_line
-        example_path = example.metadata[:absolute_file_path].downcase
-        exception.backtrace.find do |line|
-          next unless (line_path = line[/(.+?):(\d+)(|:\d+)/, 1])
-          File.expand_path(line_path).downcase == example_path
-        end
-      end
-
-      def formatted_message_and_backtrace(colorizer)
-        formatted = ""
-
-        colorized_message_lines(colorizer).each do |line|
-          formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
-        end
-
-        colorized_formatted_backtrace(colorizer).each do |line|
-          formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
-        end
-
-        formatted
-      end
-
-      def message_color
-        RSpec.configuration.failure_color
-      end
-    end
-
-    # The `PendingExampleFixedNotification` extends `ExampleNotification` with
-    # things useful for specs that pass when they are expected to fail.
-    #
-    # @attr [RSpec::Core::Example] example the current example
-    # @see ExampleNotification
-    class PendingExampleFixedNotification < FailedExampleNotification
-      public_class_method :new
-
-      # Returns the examples description.
-      #
-      # @return [String] The example description
-      def description
-        "#{example.full_description} FIXED"
-      end
-
-      # Returns the message generated for this failure line by line.
-      #
-      # @return [Array<String>] The example failure message
-      def message_lines
-        ["Expected pending '#{example.execution_result.pending_message}' to fail. No Error was raised."]
+        @exception_presenter.fully_formatted(failure_number, colorizer)
       end
 
-      # Returns the message generated for this failure colorized line by line.
-      #
-      # @param colorizer [#wrap] An object to colorize the message_lines by
-      # @return [Array<String>] The example failure message colorized
-      def colorized_message_lines(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        message_lines.map { |line| colorizer.wrap(line, RSpec.configuration.fixed_color) }
-      end
-    end
-
-    # @private
-    module PendingExampleNotificationMethods
     private
 
-      def fully_formatted_header(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        colorizer.wrap("\n  #{pending_number}) #{example.full_description}\n", :pending) <<
-        colorizer.wrap("     # #{example.execution_result.pending_message}\n", :detail)
+      def initialize(example, exception_presenter=Formatters::ExceptionPresenter.new(example.execution_result.exception, example))
+        @exception_presenter = exception_presenter
+        super(example)
       end
     end
 
-    # The `PendingExampleFailedAsExpectedNotification` extends `FailedExampleNotification` with
-    # things useful for pending specs that fail as expected.
-    #
-    # @attr [RSpec::Core::Example] example the current example
-    # @see ExampleNotification
-    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification
-      include PendingExampleNotificationMethods
-      public_class_method :new
-
-      # @return [Exception] The exception that occurred while the pending example was executed
-      def exception
-        example.execution_result.pending_exception
-      end
-
-      # @return [String] The pending detail fully formatted in the way that
-      #   RSpec's built-in formatters emit.
-      def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        fully_formatted_header(pending_number, colorizer) << formatted_message_and_backtrace(colorizer)
-      end
-
-    private
+    # @deprecated Use {FailedExampleNotification} instead.
+    class PendingExampleFixedNotification < FailedExampleNotification; end
 
-      def message_color
-        RSpec.configuration.pending_color
-      end
-    end
+    # @deprecated Use {FailedExampleNotification} instead.
+    class PendingExampleFailedAsExpectedNotification < FailedExampleNotification; end
 
     # The `SkippedExampleNotification` extends `ExampleNotification` with
     # things useful for specs that are skipped.
@@ -359,14 +220,15 @@ module RSpec::Core
     # @attr [RSpec::Core::Example] example the current example
     # @see ExampleNotification
     class SkippedExampleNotification < ExampleNotification
-      include PendingExampleNotificationMethods
       public_class_method :new
 
       # @return [String] The pending detail fully formatted in the way that
       #   RSpec's built-in formatters emit.
       def fully_formatted(pending_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)
-        fully_formatted_header(pending_number, colorizer) << colorizer.wrap("     # #{formatted_caller}\n", :detail)
+        colorizer.wrap("\n  #{pending_number}) #{example.full_description}", :pending) << "\n     " <<
+          Formatters::ExceptionPresenter::PENDING_DETAIL_FORMATTER.call(example, colorizer) <<
+          "\n" << colorizer.wrap("     # #{formatted_caller}\n", :detail)
       end
     end
 
@@ -477,7 +339,7 @@ module RSpec::Core
       def colorized_rerun_commands(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
         "\nFailed examples:\n\n" +
         failed_examples.map do |example|
-          colorizer.wrap("rspec #{example.rerun_argument}", RSpec.configuration.failure_color) + " " +
+          colorizer.wrap("rspec #{rerun_argument_for(example)}", RSpec.configuration.failure_color) + " " +
           colorizer.wrap("# #{example.full_description}",   RSpec.configuration.detail_color)
         end.join("\n")
       end
@@ -507,6 +369,28 @@ module RSpec::Core
 
         formatted
       end
+
+    private
+
+      include RSpec::Core::ShellEscape
+
+      def rerun_argument_for(example)
+        location = example.location_rerun_argument
+        return location unless duplicate_rerun_locations.include?(location)
+        conditionally_quote(example.id)
+      end
+
+      def duplicate_rerun_locations
+        @duplicate_rerun_locations ||= begin
+          locations = RSpec.world.all_examples.map(&:location_rerun_argument)
+
+          Set.new.tap do |s|
+            locations.group_by { |l| l }.each do |l, ls|
+              s << l if ls.count > 1
+            end
+          end
+        end
+      end
     end
 
     # The `ProfileNotification` holds information about the results of running a
@@ -516,8 +400,16 @@ module RSpec::Core
     # @attr duration [Float] the time taken (in seconds) to run the suite
     # @attr examples [Array<RSpec::Core::Example>] the examples run
     # @attr number_of_examples [Fixnum] the number of examples to profile
-    ProfileNotification = Struct.new(:duration, :examples, :number_of_examples)
+    # @attr example_groups [Array<RSpec::Core::Profiler>] example groups run
     class ProfileNotification
+      def initialize(duration, examples, number_of_examples, example_groups)
+        @duration = duration
+        @examples = examples
+        @number_of_examples = number_of_examples
+        @example_groups = example_groups
+      end
+      attr_reader :duration, :examples, :number_of_examples
+
       # @return [Array<RSpec::Core::Example>] the slowest examples
       def slowest_examples
         @slowest_examples ||=
@@ -551,26 +443,15 @@ module RSpec::Core
     private
 
       def calculate_slowest_groups
-        example_groups = {}
-
-        examples.each do |example|
-          location = example.example_group.parent_groups.last.metadata[:location]
-
-          location_hash = example_groups[location] ||= Hash.new(0)
-          location_hash[:total_time]  += example.execution_result.run_time
-          location_hash[:count]       += 1
-          next if location_hash.key?(:description)
-          location_hash[:description] = example.example_group.top_level_description
-        end
-
         # stop if we've only one example group
-        return {} if example_groups.keys.length <= 1
+        return {} if @example_groups.keys.length <= 1
 
-        example_groups.each_value do |hash|
+        @example_groups.each_value do |hash|
           hash[:average] = hash[:total_time].to_f / hash[:count]
         end
 
-        example_groups.sort_by { |_, hash| -hash[:average] }.first(number_of_examples)
+        groups = @example_groups.sort_by { |_, hash| -hash[:average] }.first(number_of_examples)
+        groups.map { |group, data| [group.location, data] }
       end
     end
 
@@ -599,5 +480,19 @@ module RSpec::Core
     # currently require no information, but we may wish to extend in future.
     class NullNotification
     end
+
+    # `CustomNotification` is used when sending custom events to formatters /
+    # other registered listeners, it creates attributes based on supplied hash
+    # of options.
+    class CustomNotification < Struct
+      # @param options [Hash] A hash of method / value pairs to create on this notification
+      # @return [CustomNotification]
+      #
+      # Build a custom notification based on the supplied option key / values.
+      def self.for(options={})
+        return NullNotification if options.keys.empty?
+        new(*options.keys).new(*options.values)
+      end
+    end
   end
 end