rspec-core 3.5.4 → 3.9.0

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

@@ -21,9 +21,13 @@ module RSpec
         end
 
         # rubocop:disable Style/ClassVars
+        # @private
         @@converter = NullConverter
+
         begin
           require 'coderay'
+          RSpec::Support.require_rspec_core 'formatters/syntax_highlighter'
+          RSpec::Core::Formatters::SyntaxHighlighter.attempt_to_add_rspec_terms_to_coderay_keywords
           @@converter = CoderayConverter
           # rubocop:disable Lint/HandleExceptions
         rescue LoadError

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

@@ -6,7 +6,7 @@ module RSpec
     module Formatters
       # @private
       class JsonFormatter < BaseFormatter
-        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :close
+        Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
 
         attr_reader :output_hash
 
@@ -26,7 +26,8 @@ module RSpec
             :duration => summary.duration,
             :example_count => summary.example_count,
             :failure_count => summary.failure_count,
-            :pending_count => summary.pending_count
+            :pending_count => summary.pending_count,
+            :errors_outside_of_examples_count => summary.errors_outside_of_examples_count
           }
           @output_hash[:summary_line] = summary.totals_line
         end
@@ -46,9 +47,13 @@ module RSpec
           end
         end
 
+        def seed(notification)
+          return unless notification.seed_used?
+          @output_hash[:seed] = notification.seed
+        end
+
         def close(_notification)
           output.write @output_hash.to_json
-          output.close if IO === output && output != $stdout
         end
 
         def dump_profile(profile)
@@ -81,6 +86,7 @@ module RSpec
 
         def format_example(example)
           {
+            :id => example.id,
             :description => example.description,
             :full_description => example.full_description,
             :status => example.execution_result.status.to_s,

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

@@ -1,4 +1,5 @@
 RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+RSpec::Support.require_rspec_core "formatters/console_codes"
 
 module RSpec
   module Core

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
         #
@@ -33,9 +33,9 @@ module RSpec
         # This will only be invoked once, and the next one to be invoked
         # is {#example_group_started}.
         #
-        # @param notification [StartNotification]
+        # @param notification [Notifications::StartNotification]
 
-        # @method example_group_started
+        # @method example_group_started(notification)
         # @api public
         # @group Group Notifications
         #
@@ -45,81 +45,81 @@ module RSpec
         # The next method to be invoked after this is {#example_passed},
         # {#example_pending}, or {#example_group_finished}.
         #
-        # @param notification [GroupNotification] containing example_group
-        #   subclass of `RSpec::Core::ExampleGroup`
+        # @param notification [Notifications::GroupNotification] containing example_group
+        #   subclass of {ExampleGroup}
 
-        # @method example_group_finished
+        # @method example_group_finished(notification)
         # @api public
         # @group Group Notifications
         #
         # Invoked at the end of the execution of each example group.
         #
-        # @param notification [GroupNotification] containing example_group
-        #   subclass of `RSpec::Core::ExampleGroup`
+        # @param notification [Notifications::GroupNotification] containing example_group
+        #   subclass of {ExampleGroup}
 
-        # @method example_started
+        # @method example_started(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked at the beginning of the execution of each example.
         #
-        # @param notification [ExampleNotification] containing example subclass
-        #   of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_finished
+        # @method example_finished(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked at the end of the execution of each example.
         #
-        # @param notification [ExampleNotification] containing example subclass
-        #   of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_passed
+        # @method example_passed(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked when an example passes.
         #
-        # @param notification [ExampleNotification] containing example subclass
-        #   of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_pending
+        # @method example_pending(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked when an example is pending.
         #
-        # @param notification [ExampleNotification] containing example subclass
-        #   of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method example_failed
+        # @method example_failed(notification)
         # @api public
         # @group Example Notifications
         #
         # Invoked when an example fails.
         #
-        # @param notification [ExampleNotification] containing example subclass
-        #   of `RSpec::Core::Example`
+        # @param notification [Notifications::ExampleNotification] containing example subclass
+        #   of {Example}
 
-        # @method message
+        # @method message(notification)
         # @api public
         # @group Suite Notifications
         #
         # Used by the reporter to send messages to the output stream.
         #
-        # @param notification [MessageNotification] containing message
+        # @param notification [Notifications::MessageNotification] containing message
 
-        # @method stop
+        # @method stop(notification)
         # @api public
         # @group Suite Notifications
         #
         # Invoked after all examples have executed, before dumping post-run
         # reports.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method start_dump
+        # @method start_dump(notification)
         # @api public
         # @group Suite Notifications
         #
@@ -128,53 +128,54 @@ module RSpec
         # (BaseTextFormatter then calls {#dump_failures} once for each failed
         # example).
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method dump_failures
+        # @method dump_failures(notification)
         # @api public
         # @group Suite Notifications
         #
         # Dumps detailed information about each example failure.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method dump_summary
+        # @method dump_summary(summary)
         # @api public
         # @group Suite Notifications
         #
         # This method is invoked after the dumping of examples and failures.
         # Each parameter is assigned to a corresponding attribute.
         #
-        # @param summary [SummaryNotification] containing duration,
+        # @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
         #
         # This method is invoked after the dumping the summary if profiling is
         # enabled.
         #
-        # @param profile [ProfileNotification] containing duration,
+        # @param profile [Notifications::ProfileNotification] containing duration,
         #   slowest_examples and slowest_example_groups
 
-        # @method dump_pending
+        # @method dump_pending(notification)
         # @api public
         # @group Suite Notifications
         #
         # Outputs a report of pending examples. This gets invoked
         # after the summary if option is set to do so.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
-        # @method close
+        # @method close(notification)
         # @api public
         # @group Suite Notifications
         #
-        # Invoked at the very end, `close` allows the formatter to clean
-        # up resources, e.g. open streams, etc.
+        # Invoked at the end of a suite run. Allows the formatter to do any
+        # tidying up, but be aware that formatter output streams may be used
+        # elsewhere so don't actually close them.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
       end
     end
   end

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

@@ -1,5 +1,3 @@
-RSpec::Support.require_rspec_core "source"
-
 module RSpec
   module Core
     module Formatters
@@ -17,7 +15,7 @@ module RSpec
 
         def self.source_from_file(path)
           raise NoSuchFileError unless File.exist?(path)
-          RSpec.world.source_cache.source_from_file(path)
+          RSpec.world.source_from_file(path)
         end
 
         if RSpec::Support::RubyFeatures.ripper_supported?

data/lib/rspec/core/{source → formatters}/syntax_highlighter.rb

@@ -1,6 +1,6 @@
 module RSpec
   module Core
-    class Source
+    module Formatters
       # @private
       # Provides terminal syntax highlighting of code snippets
       # when coderay is available.
@@ -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?
@@ -31,6 +50,7 @@ module RSpec
         def color_enabled_implementation
           @color_enabled_implementation ||= begin
             require 'coderay'
+            self.class.attempt_to_add_rspec_terms_to_coderay_keywords
             CodeRayImplementation
           rescue LoadError
             NoSyntaxHighlightingImplementation

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)
 
@@ -456,7 +462,9 @@ module RSpec
           return if RSpec.configuration.dry_run?
 
           if scope == :context
-            run_owned_hooks_for(position, :context, example_or_group)
+            unless example_or_group.class.metadata[:skip]
+              run_owned_hooks_for(position, :context, example_or_group)
+            end
           else
             case position
             when :before then run_example_hooks_for(example_or_group, :before, :reverse_each)

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
@@ -49,16 +51,34 @@ module RSpec
       # @private
       class PrintVersion
         def call(_options, _err, out)
-          out.puts RSpec::Core::Version::STRING
+          overall_version = RSpec::Core::Version::STRING
+          unless overall_version =~ /[a-zA-Z]+/
+            overall_version = overall_version.split('.').first(2).join('.')
+          end
+
+          out.puts "RSpec #{overall_version}"
+
+          [:Core, :Expectations, :Mocks, :Rails, :Support].each do |const_name|
+            lib_name = const_name.to_s.downcase
+            begin
+              require "rspec/#{lib_name}/version"
+            rescue LoadError
+              # Not worth mentioning libs that are not installed
+              nil
+            else
+              out.puts "  - rspec-#{lib_name} #{RSpec.const_get(const_name)::Version::STRING}"
+            end
+          end
+
           0
         end
       end
 
       # @private
-      PrintHelp = Struct.new(:parser, :invalid_options) do
+      PrintHelp = Struct.new(:parser, :hidden_options) do
         def call(_options, _err, out)
-          # Removing the blank invalid options from the output.
-          out.puts parser.to_s.gsub(/^\s+(#{invalid_options.join('|')})\s*$\n/, '')
+          # Removing the hidden options from the output.
+          out.puts parser.to_s.gsub(/^\s+(#{hidden_options.join('|')})\b.*$\n/, '')
           0
         end
       end