rspec-expectations 2.14.0 → 3.13.0

data/lib/rspec/matchers/built_in/output.rb

@@ -0,0 +1,207 @@
+require 'stringio'
+
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Provides the implementation for `output`.
+      # Not intended to be instantiated directly.
+      class Output < BaseMatcher
+        def initialize(expected)
+          @expected        = expected
+          @actual          = ""
+          @block           = nil
+          @stream_capturer = NullCapture
+        end
+
+        def matches?(block)
+          @block = block
+          return false unless Proc === block
+          @actual = @stream_capturer.capture(block)
+          @expected ? values_match?(@expected, @actual) : captured?
+        end
+
+        def does_not_match?(block)
+          !matches?(block) && Proc === block
+        end
+
+        # @api public
+        # Tells the matcher to match against stdout.
+        # Works only when the main Ruby process prints to stdout
+        def to_stdout
+          @stream_capturer = CaptureStdout
+          self
+        end
+
+        # @api public
+        # Tells the matcher to match against stderr.
+        # Works only when the main Ruby process prints to stderr
+        def to_stderr
+          @stream_capturer = CaptureStderr
+          self
+        end
+
+        # @api public
+        # Tells the matcher to match against stdout.
+        # Works when subprocesses print to stdout as well.
+        # This is significantly (~30x) slower than `to_stdout`
+        def to_stdout_from_any_process
+          @stream_capturer = CaptureStreamToTempfile.new("stdout", $stdout)
+          self
+        end
+
+        # @api public
+        # Tells the matcher to match against stderr.
+        # Works when subprocesses print to stderr as well.
+        # This is significantly (~30x) slower than `to_stderr`
+        def to_stderr_from_any_process
+          @stream_capturer = CaptureStreamToTempfile.new("stderr", $stderr)
+          self
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          "expected block to #{description}, but #{positive_failure_reason}"
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "expected block to not #{description}, but #{negative_failure_reason}"
+        end
+
+        # @api private
+        # @return [String]
+        def description
+          if @expected
+            "output #{description_of @expected} to #{@stream_capturer.name}"
+          else
+            "output to #{@stream_capturer.name}"
+          end
+        end
+
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          true
+        end
+
+        # @api private
+        # Indicates this matcher matches against a block.
+        # @return [True]
+        def supports_block_expectations?
+          true
+        end
+
+        # @api private
+        # Indicates this matcher matches against a block only.
+        # @return [False]
+        def supports_value_expectations?
+          false
+        end
+
+      private
+
+        def captured?
+          @actual.length > 0
+        end
+
+        def positive_failure_reason
+          return "was not a block" unless Proc === @block
+          return "output #{actual_output_description}" if @expected
+          "did not"
+        end
+
+        def negative_failure_reason
+          return "was not a block" unless Proc === @block
+          "output #{actual_output_description}"
+        end
+
+        def actual_output_description
+          return "nothing" unless captured?
+          actual_formatted
+        end
+      end
+
+      # @private
+      module NullCapture
+        def self.name
+          "some stream"
+        end
+
+        def self.capture(_block)
+          raise "You must chain `to_stdout` or `to_stderr` off of the `output(...)` matcher."
+        end
+      end
+
+      # @private
+      module CaptureStdout
+        def self.name
+          'stdout'
+        end
+
+        def self.capture(block)
+          captured_stream = StringIO.new
+
+          original_stream = $stdout
+          $stdout = captured_stream
+
+          block.call
+
+          captured_stream.string
+        ensure
+          $stdout = original_stream
+        end
+      end
+
+      # @private
+      module CaptureStderr
+        def self.name
+          'stderr'
+        end
+
+        def self.capture(block)
+          captured_stream = StringIO.new
+
+          original_stream = $stderr
+          $stderr = captured_stream
+
+          block.call
+
+          captured_stream.string
+        ensure
+          $stderr = original_stream
+        end
+      end
+
+      # @private
+      class CaptureStreamToTempfile < Struct.new(:name, :stream)
+        def capture(block)
+          # We delay loading tempfile until it is actually needed because
+          # we want to minimize stdlibs loaded so that users who use a
+          # portion of the stdlib can't have passing specs while forgetting
+          # to load it themselves. `CaptureStreamToTempfile` is rarely used
+          # and `tempfile` pulls in a bunch of things (delegate, tmpdir,
+          # thread, fileutils, etc), so it's worth delaying it until this point.
+          require 'tempfile'
+
+          original_stream = stream.clone
+          captured_stream = Tempfile.new(name)
+
+          begin
+            captured_stream.sync = true
+            stream.reopen(captured_stream)
+            block.call
+            captured_stream.rewind
+            captured_stream.read
+          ensure
+            stream.reopen(original_stream)
+            captured_stream.close
+            captured_stream.unlink
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/matchers/built_in/raise_error.rb

@@ -1,56 +1,141 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `raise_error`.
+      # Not intended to be instantiated directly.
+      # rubocop:disable Metrics/ClassLength
+      # rubocop:disable Lint/RescueException
       class RaiseError
-        def initialize(expected_error_or_message=Exception, expected_message=nil, &block)
+        include Composable
+
+        # Used as a sentinel value to be able to tell when the user did not pass an
+        # argument. We can't use `nil` for that because we need to warn when `nil` is
+        # passed in a different way. It's an Object, not a Module, since Module's `===`
+        # does not evaluate to true when compared to itself.
+        UndefinedValue = Object.new.freeze
+
+        def initialize(expected_error_or_message, expected_message, &block)
           @block = block
           @actual_error = nil
+          @warn_about_bare_error = UndefinedValue === expected_error_or_message
+          @warn_about_nil_error = expected_error_or_message.nil?
+
           case expected_error_or_message
-          when String, Regexp
-            @expected_error, @expected_message = Exception, expected_error_or_message
+          when nil, UndefinedValue
+            @expected_error = Exception
+            @expected_message = expected_message
+          when String
+            @expected_error = Exception
+            @expected_message = expected_error_or_message
           else
-            @expected_error, @expected_message = expected_error_or_message, expected_message
+            @expected_error = expected_error_or_message
+            @expected_message = expected_message
           end
         end
 
-        def matches?(given_proc, negative_expectation = false)
-          if negative_expectation && (expecting_specific_exception? || @expected_message)
-            what_to_deprecate = if expecting_specific_exception? && @expected_message
-                                  "`expect { }.not_to raise_error(SpecificErrorClass, message)`"
-                                elsif expecting_specific_exception?
-                                  "`expect { }.not_to raise_error(SpecificErrorClass)`"
-                                elsif @expected_message
-                                  "`expect { }.not_to raise_error(message)`"
-                                end
-            RSpec.deprecate(what_to_deprecate, :replacement => "`expect { }.not_to raise_error()`")
-          end
+        # @api public
+        # Specifies the expected error message.
+        def with_message(expected_message)
+          raise_message_already_set if @expected_message
+          @warn_about_bare_error = false
+          @expected_message = expected_message
+          self
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        # @private
+        def matches?(given_proc, negative_expectation=false, &block)
+          @given_proc = given_proc
+          @block ||= block
           @raised_expected_error = false
           @with_expected_message = false
           @eval_block = false
           @eval_block_passed = false
-          unless given_proc.respond_to?(:call)
-            ::Kernel.warn "`raise_error` was called with non-proc object #{given_proc.inspect}"
-            return false
-          end
+
+          return false unless Proc === given_proc
+
           begin
             given_proc.call
           rescue Exception => @actual_error
-            if @actual_error == @expected_error || @expected_error === @actual_error
+            if values_match?(@expected_error, @actual_error) ||
+               values_match?(@expected_error, actual_error_message)
               @raised_expected_error = true
               @with_expected_message = verify_message
             end
           end
 
           unless negative_expectation
-            eval_block if @raised_expected_error && @with_expected_message && @block
+            warn_about_bare_error! if warn_about_bare_error?
+            warn_about_nil_error! if warn_about_nil_error?
+            eval_block if ready_to_eval_block?
           end
-        ensure
-          return (@raised_expected_error & @with_expected_message) ? (@eval_block ? @eval_block_passed : true) : false
+
+          expectation_matched?
         end
-        alias == matches?
+        # rubocop:enable Metrics/MethodLength
 
+        # @private
         def does_not_match?(given_proc)
-          !matches?(given_proc, :negative_expectation)
+          warn_for_negative_false_positives!
+          !matches?(given_proc, :negative_expectation) && Proc === given_proc
+        end
+
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
+        # @private
+        def supports_value_expectations?
+          false
+        end
+
+        # @private
+        def expects_call_stack_jump?
+          true
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          @eval_block ? actual_error_message : "expected #{expected_error}#{given_error}"
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "expected no #{expected_error}#{given_error}"
+        end
+
+        # @api private
+        # @return [String]
+        def description
+          "raise #{expected_error}"
+        end
+
+      private
+
+        def actual_error_message
+          return nil unless @actual_error
+
+          @actual_error.respond_to?(:original_message) ? @actual_error.original_message : @actual_error.message
+        end
+
+        def expectation_matched?
+          error_and_message_match? && block_matches?
+        end
+
+        def error_and_message_match?
+          @raised_expected_error && @with_expected_message
+        end
+
+        def block_matches?
+          @eval_block ? @eval_block_passed : true
+        end
+
+        def ready_to_eval_block?
+          @raised_expected_error && @with_expected_message && @block
         end
 
         def eval_block
@@ -64,38 +149,88 @@ module RSpec
         end
 
         def verify_message
-          case @expected_message
-          when nil
-            true
-          when Regexp
-            @expected_message =~ @actual_error.message
-          else
-            @expected_message == @actual_error.message
-          end
+          return true if @expected_message.nil?
+          values_match?(@expected_message, actual_error_message.to_s)
         end
 
-        def failure_message_for_should
-          @eval_block ? @actual_error.message : "expected #{expected_error}#{given_error}"
+        def warn_for_negative_false_positives!
+          expression = if expecting_specific_exception? && @expected_message
+                         "`expect { }.not_to raise_error(SpecificErrorClass, message)`"
+                       elsif expecting_specific_exception?
+                         "`expect { }.not_to raise_error(SpecificErrorClass)`"
+                       elsif @expected_message
+                         "`expect { }.not_to raise_error(message)`"
+                       elsif @warn_about_nil_error
+                         "`expect { }.not_to raise_error(nil)`"
+                       end
+
+          return unless expression
+
+          warn_about_negative_false_positive! expression
         end
 
-        def failure_message_for_should_not
-          "expected no #{expected_error}#{given_error}"
+        def handle_warning(message)
+          RSpec::Expectations.configuration.false_positives_handler.call(message)
         end
 
-        def description
-          "raise #{expected_error}"
+        def warn_about_bare_error?
+          @warn_about_bare_error && @block.nil?
+        end
+
+        def warn_about_nil_error?
+          @warn_about_nil_error
+        end
+
+        def warn_about_bare_error!
+          handle_warning("Using the `raise_error` matcher without providing a specific " \
+                         "error or message risks false positives, since `raise_error` " \
+                         "will match when Ruby raises a `NoMethodError`, `NameError` or " \
+                         "`ArgumentError`, potentially allowing the expectation to pass " \
+                         "without even executing the method you are intending to call. " \
+                         "#{warning}"\
+                         "Instead consider providing a specific error class or message. " \
+                         "This message can be suppressed by setting: " \
+                         "`RSpec::Expectations.configuration.on_potential_false" \
+                         "_positives = :nothing`")
+        end
+
+        def warn_about_nil_error!
+          handle_warning("Using the `raise_error` matcher with a `nil` error is probably " \
+                         "unintentional, it risks false positives, since `raise_error` " \
+                         "will match when Ruby raises a `NoMethodError`, `NameError` or " \
+                         "`ArgumentError`, potentially allowing the expectation to pass " \
+                         "without even executing the method you are intending to call. " \
+                         "#{warning}"\
+                         "Instead consider providing a specific error class or message. " \
+                         "This message can be suppressed by setting: " \
+                         "`RSpec::Expectations.configuration.on_potential_false" \
+                         "_positives = :nothing`")
         end
 
-        private
+        def warn_about_negative_false_positive!(expression)
+          handle_warning("Using #{expression} risks false positives, since literally " \
+                         "any other error would cause the expectation to pass, " \
+                         "including those raised by Ruby (e.g. `NoMethodError`, `NameError` " \
+                         "and `ArgumentError`), meaning the code you are intending to test " \
+                         "may not even get reached. Instead consider using " \
+                         "`expect { }.not_to raise_error` or `expect { }.to raise_error" \
+                         "(DifferentSpecificErrorClass)`. This message can be suppressed by " \
+                         "setting: `RSpec::Expectations.configuration.on_potential_false" \
+                         "_positives = :nothing`")
+        end
 
         def expected_error
           case @expected_message
           when nil
-            @expected_error.inspect
+            if RSpec::Support.is_a_matcher?(@expected_error)
+              "Exception with #{description_of(@expected_error)}"
+            else
+              description_of(@expected_error)
+            end
           when Regexp
-            "#{@expected_error} with message matching #{@expected_message.inspect}"
+            "#{@expected_error} with message matching #{description_of(@expected_message)}"
           else
-            "#{@expected_error} with #{@expected_message.inspect}"
+            "#{@expected_error} with #{description_of(@expected_message)}"
           end
         end
 
@@ -105,11 +240,12 @@ module RSpec
         end
 
         def given_error
+          return " but was not given a block" unless Proc === @given_proc
           return " but nothing was raised" unless @actual_error
 
           backtrace = format_backtrace(@actual_error.backtrace)
           [
-            ", got #{@actual_error.inspect} with backtrace:",
+            ", got #{description_of(@actual_error)} with backtrace:",
             *backtrace
           ].join("\n  # ")
         end
@@ -117,7 +253,19 @@ module RSpec
         def expecting_specific_exception?
           @expected_error != Exception
         end
+
+        def raise_message_already_set
+          raise "`expect { }.to raise_error(message).with_message(message)` is not valid. " \
+                'The matcher only allows the expected message to be specified once'
+        end
+
+        def warning
+          warning = "Actual error raised was #{description_of(@actual_error)}. "
+          warning if @actual_error
+        end
       end
+      # rubocop:enable Lint/RescueException
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end