rspec-core 3.7.0 → 3.9.0

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

@@ -81,7 +81,7 @@ module RSpec
 
         def fully_formatted_lines(failure_number, colorizer)
           lines = [
-            description,
+            encoded_description(description),
             detail_formatter.call(example, colorizer),
             formatted_message_and_backtrace(colorizer),
             extra_detail_formatter.call(failure_number, colorizer),
@@ -244,6 +244,17 @@ module RSpec
           end
         end
 
+        if  String.method_defined?(:encoding)
+          def encoded_description(description)
+            return if description.nil?
+            encoded_string(description)
+          end
+        else # for 1.8.7
+          def encoded_description(description)
+            description
+          end
+        end
+
         def exception_backtrace
           exception.backtrace || []
         end
@@ -379,6 +390,7 @@ module RSpec
                 parent_bt[index] != child_bt[index]
               end
 
+              return child if index_before_first_common_frame.nil?
               return child if index_before_first_common_frame == -1
 
               child = child.dup

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

@@ -0,0 +1,23 @@
+RSpec::Support.require_rspec_core "formatters/base_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      # @private
+      class FailureListFormatter < BaseFormatter
+        Formatters.register self, :example_failed, :dump_profile, :message
+
+        def example_failed(failure)
+          output.puts "#{failure.example.location}:#{failure.example.description}"
+        end
+
+        # Discard profile and messages
+        #
+        # These outputs are not really relevant in the context of this failure
+        # list formatter.
+        def dump_profile(_profile); end
+        def message(_message); end
+      end
+    end
+  end
+end

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

@@ -115,7 +115,6 @@ module RSpec
           "style=\"margin-left: #{(number_of_parents - 1) * 15}px;\""
         end
 
-        # rubocop:disable LineLength
         REPORT_HEADER = <<-EOF
 <div class="rspec-report">
 
@@ -139,7 +138,6 @@ module RSpec
 
 <div class="results">
 EOF
-        # rubocop:enable LineLength
 
         GLOBAL_SCRIPTS = <<-EOF
 

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

@@ -17,12 +17,12 @@ module RSpec
       # @see RSpec::Core::Formatters::BaseTextFormatter
       # @see RSpec::Core::Reporter
       class Protocol
-        # @method initialize
+        # @method initialize(output)
         # @api public
         #
         # @param output [IO] the formatter output
 
-        # @method start
+        # @method start(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -35,7 +35,7 @@ module RSpec
         #
         # @param notification [Notifications::StartNotification]
 
-        # @method example_group_started
+        # @method example_group_started(notification)
         # @api public
         # @group Group Notifications
         #
@@ -48,7 +48,7 @@ module RSpec
         # @param notification [Notifications::GroupNotification] containing example_group
         #   subclass of {ExampleGroup}
 
-        # @method example_group_finished
+        # @method example_group_finished(notification)
         # @api public
         # @group Group Notifications
         #
@@ -57,7 +57,7 @@ module RSpec
         # @param notification [Notifications::GroupNotification] containing example_group
         #   subclass of {ExampleGroup}
 
-        # @method example_started
+        # @method example_started(notification)
         # @api public
         # @group Example Notifications
         #
@@ -66,7 +66,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_finished
+        # @method example_finished(notification)
         # @api public
         # @group Example Notifications
         #
@@ -75,7 +75,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_passed
+        # @method example_passed(notification)
         # @api public
         # @group Example Notifications
         #
@@ -84,7 +84,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_pending
+        # @method example_pending(notification)
         # @api public
         # @group Example Notifications
         #
@@ -93,7 +93,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method example_failed
+        # @method example_failed(notification)
         # @api public
         # @group Example Notifications
         #
@@ -102,7 +102,7 @@ module RSpec
         # @param notification [Notifications::ExampleNotification] containing example subclass
         #   of {Example}
 
-        # @method message
+        # @method message(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -110,7 +110,7 @@ module RSpec
         #
         # @param notification [Notifications::MessageNotification] containing message
 
-        # @method stop
+        # @method stop(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -119,7 +119,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method start_dump
+        # @method start_dump(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -130,7 +130,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method dump_failures
+        # @method dump_failures(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -138,7 +138,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method dump_summary
+        # @method dump_summary(summary)
         # @api public
         # @group Suite Notifications
         #
@@ -148,7 +148,7 @@ module RSpec
         # @param summary [Notifications::SummaryNotification] containing duration,
         #   example_count, failure_count and pending_count
 
-        # @method dump_profile
+        # @method dump_profile(profile)
         # @api public
         # @group Suite Notifications
         #
@@ -158,7 +158,7 @@ module RSpec
         # @param profile [Notifications::ProfileNotification] containing duration,
         #   slowest_examples and slowest_example_groups
 
-        # @method dump_pending
+        # @method dump_pending(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -167,7 +167,7 @@ module RSpec
         #
         # @param notification [Notifications::NullNotification]
 
-        # @method close
+        # @method close(notification)
         # @api public
         # @group Suite Notifications
         #

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

@@ -13,6 +13,25 @@ module RSpec
           implementation.highlight_syntax(lines)
         end
 
+        # rubocop:disable Lint/RescueException
+        # rubocop:disable Lint/HandleExceptions
+        def self.attempt_to_add_rspec_terms_to_coderay_keywords
+          CodeRay::Scanners::Ruby::Patterns::IDENT_KIND.add(%w[
+            describe context
+            it specify
+            before after around
+            let subject
+            expect allow
+          ], :keyword)
+        rescue Exception
+          # Mutating CodeRay's contants like this is not a public API
+          # and might not always work. If we cannot add our keywords
+          # to CodeRay it is not a big deal and not worth raising an
+          # error over, so we ignore it.
+        end
+      # rubocop:enable Lint/HandleExceptions
+      # rubocop:enable Lint/RescueException
+
       private
 
         if RSpec::Support::OS.windows?
@@ -38,25 +57,6 @@ module RSpec
           end
         end
 
-        # rubocop:disable Lint/RescueException
-        # rubocop:disable Lint/HandleExceptions
-        def self.attempt_to_add_rspec_terms_to_coderay_keywords
-          CodeRay::Scanners::Ruby::Patterns::IDENT_KIND.add(%w[
-            describe context
-            it specify
-            before after around
-            let subject
-            expect allow
-          ], :keyword)
-        rescue Exception
-          # Mutating CodeRay's contants like this is not a public API
-          # and might not always work. If we cannot add our keywords
-          # to CodeRay it is not a big deal and not worth raising an
-          # error over, so we ignore it.
-        end
-        # rubocop:enable Lint/HandleExceptions
-        # rubocop:enable Lint/RescueException
-
         # @private
         module CodeRayImplementation
           RESET_CODE = "\e[0m"

data/lib/rspec/core/hooks.rb

@@ -60,7 +60,8 @@ module RSpec
       #     before(:example)  # Declared in the current group.
       #
       # If more than one `before` is declared within any one scope, they are run
-      # in the order in which they are declared.
+      # in the order in which they are declared. Any `around` hooks will execute
+      # later than any `before` hook regardless of scope.
       #
       # ### Conditions
       #
@@ -74,11 +75,11 @@ module RSpec
       #       end
       #     end
       #
-      #     describe Something, :authorized => true do
+      #     RSpec.describe Something, :authorized => true do
       #       # The before hook will run in before each example in this group.
       #     end
       #
-      #     describe SomethingElse do
+      #     RSpec.describe SomethingElse do
       #       it "does something", :authorized => true do
       #         # The before hook will run before this example.
       #       end
@@ -159,7 +160,7 @@ module RSpec
       #
       # @example before(:example) declared in an {ExampleGroup}
       #
-      #     describe Thing do
+      #     RSpec.describe Thing do
       #       before(:example) do
       #         @thing = Thing.new
       #       end
@@ -171,7 +172,7 @@ module RSpec
       #
       # @example before(:context) declared in an {ExampleGroup}
       #
-      #     describe Parser do
+      #     RSpec.describe Parser do
       #       before(:context) do
       #         File.open(file_to_parse, 'w') do |f|
       #           f.write <<-CONTENT
@@ -261,7 +262,8 @@ module RSpec
       #
       # This is the reverse of the order in which `before` hooks are run.
       # Similarly, if more than one `after` is declared within any one scope,
-      # they are run in reverse order of that in which they are declared.
+      # they are run in reverse order of that in which they are declared. Also
+      # `around` hooks will all have run before any after hooks are invoked.
       #
       # @note The `:example` and `:context` scopes are also available as
       #       `:each` and `:all`, respectively. Use whichever you prefer.
@@ -322,13 +324,19 @@ module RSpec
       #     end
       #
       # The yielded example aliases `run` with `call`, which lets you treat it
-      # like a `Proc`. This is especially handy when working with libaries
+      # like a `Proc`. This is especially handy when working with libraries
       # that manage their own setup and teardown using a block or proc syntax,
       # e.g.
       #
       #     around(:example) {|ex| Database.transaction(&ex)}
       #     around(:example) {|ex| FakeFS(&ex)}
       #
+      # ### Order
+      #
+      # All `around` hooks execute immediately surrounding an example, this means
+      # that all `before` hooks will have run and no `after` hooks will have run yet.
+      #
+      # They are not a synonym for `before`/`after`.
       def around(*args, &block)
         hooks.register :prepend, :around, *args, &block
       end
@@ -339,8 +347,6 @@ module RSpec
         @hooks ||= HookCollections.new(self, FilterableItemRepository::UpdateOptimized)
       end
 
-    private
-
       # @private
       Hook = Struct.new(:block, :options)
 

data/lib/rspec/core/invocations.rb

@@ -26,21 +26,23 @@ module RSpec
 
       # @private
       class Bisect
-        def call(options, _err, _out)
+        def call(options, err, out)
           RSpec::Support.require_rspec_core "bisect/coordinator"
+          runner = Runner.new(options).tap { |r| r.configure(err, out) }
+          formatter = bisect_formatter_klass_for(options.options[:bisect]).new(
+            out, runner.configuration.bisect_runner
+          )
 
           success = RSpec::Core::Bisect::Coordinator.bisect_with(
-            options.args,
-            RSpec.configuration,
-            bisect_formatter_for(options.options[:bisect])
+            runner, options.args, formatter
           )
 
           success ? 0 : 1
         end
 
-        private
+      private
 
-        def bisect_formatter_for(argument)
+        def bisect_formatter_klass_for(argument)
           return Formatters::BisectDebugFormatter if argument == "verbose"
           Formatters::BisectProgressFormatter
         end

data/lib/rspec/core/memoized_helpers.rb

@@ -10,7 +10,7 @@ module RSpec
       # @note `subject` was contributed by Joe Ferris to support the one-liner
       #   syntax embraced by shoulda matchers:
       #
-      #       describe Widget do
+      #       RSpec.describe Widget do
       #         it { is_expected.to validate_presence_of(:name) }
       #         # or
       #         it { should validate_presence_of(:name) }
@@ -23,7 +23,7 @@ module RSpec
       # @example
       #
       #   # Explicit declaration of subject.
-      #   describe Person do
+      #   RSpec.describe Person do
       #     subject { Person.new(:birthdate => 19.years.ago) }
       #     it "should be eligible to vote" do
       #       subject.should be_eligible_to_vote
@@ -32,7 +32,7 @@ module RSpec
       #   end
       #
       #   # Implicit subject => { Person.new }.
-      #   describe Person do
+      #   RSpec.describe Person do
       #     it "should be eligible to vote" do
       #       subject.should be_eligible_to_vote
       #       # ^ ^ explicit reference to subject not recommended
@@ -40,7 +40,7 @@ module RSpec
       #   end
       #
       #   # One-liner syntax - expectation is set on the subject.
-      #   describe Person do
+      #   RSpec.describe Person do
       #     it { is_expected.to be_eligible_to_vote }
       #     # or
       #     it { should be_eligible_to_vote }
@@ -67,7 +67,7 @@ module RSpec
       #
       # @example
       #
-      #   describe Person do
+      #   RSpec.describe Person do
       #     it { should be_eligible_to_vote }
       #   end
       #
@@ -86,7 +86,7 @@ module RSpec
       #
       # @example
       #
-      #   describe Person do
+      #   RSpec.describe Person do
       #     it { should_not be_eligible_to_vote }
       #   end
       #
@@ -270,7 +270,7 @@ EOS
         #
         # @example
         #
-        #   describe Thing do
+        #   RSpec.describe Thing do
         #     let(:thing) { Thing.new }
         #
         #     it "does something" do
@@ -288,7 +288,26 @@ EOS
           raise(
             "#let or #subject called with a reserved name #initialize"
           ) if :initialize == name
-          MemoizedHelpers.module_for(self).__send__(:define_method, name, &block)
+          our_module = MemoizedHelpers.module_for(self)
+
+          # If we have a module clash in our helper module
+          # then we need to remove it to prevent a warning.
+          #
+          # Note we do not check ancestor modules (see: `instance_methods(false)`)
+          # as we can override them.
+          if our_module.instance_methods(false).include?(name)
+            our_module.__send__(:remove_method, name)
+          end
+          our_module.__send__(:define_method, name, &block)
+
+          # If we have a module clash in the example module
+          # then we need to remove it to prevent a warning.
+          #
+          # Note we do not check ancestor modules (see: `instance_methods(false)`)
+          # as we can override them.
+          if instance_methods(false).include?(name)
+            remove_method(name)
+          end
 
           # Apply the memoization. The method has been defined in an ancestor
           # module so we can use `super` here to get the value.
@@ -323,7 +342,7 @@ EOS
         #     end
         #   end
         #
-        #   describe Thing do
+        #   RSpec.describe Thing do
         #     after(:example) { Thing.reset_count }
         #
         #     context "using let" do
@@ -379,13 +398,13 @@ EOS
         #
         # @example
         #
-        #   describe CheckingAccount, "with $50" do
+        #   RSpec.describe CheckingAccount, "with $50" do
         #     subject { CheckingAccount.new(Money.new(50, :USD)) }
         #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }
         #     it { is_expected.not_to be_overdrawn }
         #   end
         #
-        #   describe CheckingAccount, "with a non-zero starting balance" do
+        #   RSpec.describe CheckingAccount, "with a non-zero starting balance" do
         #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }
         #     it { is_expected.not_to be_overdrawn }
         #     it "has a balance equal to the starting balance" do
@@ -433,7 +452,7 @@ EOS
         #     end
         #   end
         #
-        #   describe Thing do
+        #   RSpec.describe Thing do
         #     after(:example) { Thing.reset_count }
         #
         #     context "using subject" do
@@ -483,9 +502,9 @@ EOS
       def self.module_for(example_group)
         get_constant_or_yield(example_group, :LetDefinitions) do
           mod = Module.new do
-            include Module.new {
+            include(Module.new {
               example_group.const_set(:NamedSubjectPreventSuper, self)
-            }
+            })
           end
 
           example_group.const_set(:LetDefinitions, mod)