rspec-core 3.5.2 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cec44daa280723490f842a4f70fc2155a28379c0
-  data.tar.gz: 3d74dfc5863a12e75a5d5ff591ecdba51f399489
+  metadata.gz: 33bf2ee1c5d02653b19cece430ba75ac28668df0
+  data.tar.gz: 5c3e3a2f628543125d4bc02ffff6ee05135e4d1e
 SHA512:
-  metadata.gz: 61c37f52ef3408f9c4a6813708fb6e5785a87e8d610e25398b0a1ab0264de42afd008f1ff621d55b253b59718cf52a29862458fdc7db55647d6d91704be3d6cf
-  data.tar.gz: d1baf10d2a985bff5b8b9af2ed77be391c0a30ff77ced7b13d4b837b78c4b6c263c7de3b61878282734d3c06ee51ff09643a27549b3f6c81ce5c045e420e9131
+  metadata.gz: ca2f7dea70f81dad661b79e61b7b4142989368fddca025d8741a97d5d36037bf598c4dff28a37c4a25bc5116520aa49ace6fbd4cc16b1f7b49bc8f5ef1956435
+  data.tar.gz: 8d104339ba402be5aec231e5d16e6fcad61cd9b81554593f71f87393b0638f6be590fdbdab06c54b1f981ef9f576eff8db302e32026d8ecabaebb9710d219ba9

data/Changelog.md

@@ -1,3 +1,90 @@
+### 3.6.0 / 2017-05-04
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.6.0.beta2...v3.6.0)
+
+Enhancements:
+
+* Add seed information to JSON formatter output. (#2388, Mitsutaka Mimura)
+* Include example id in the JSON formatter output. (#2369, Xavier Shay)
+* Respect changes to `config.output_stream` after formatters have been
+  setup. (#2401, #2419, Ilya Lavrov)
+
+Bug Fixes:
+
+* Delay formatter loading until the last minute to allow accessing the reporter
+  without triggering formatter setup. (Jon Rowe, #2243)
+* Ensure context hook failures running before an example can access the
+  reporter. (Jon Jensen, #2387)
+* Multiple fixes to allow using the runner multiple times within the same
+  process: `RSpec.clear_examples` resets the formatter and no longer clears
+  shared examples, and streams can be used across multiple runs rather than
+  being closed after the first. (#2368, Xavier Shay)
+* Prevent unexpected `example_group_finished` notifications causing an error.
+  (#2396, VTJamie)
+* Fix bugs where `config.when_first_matching_example_defined` hooks would fire
+  multiple times in some cases. (Yuji Nakayama, #2400)
+* Default `last_run_status` to "unknown" when the `status` field in the
+  persistence file contains an unrecognized value. (#2360, matrinox)
+* Prevent `let` from defining an `initialize` method. (#2414, Jon Rowe)
+
+### 3.6.0.beta2 / 2016-12-12
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.6.0.beta1...v3.6.0.beta2)
+
+Enhancements:
+
+* Include count of errors occurring outside examples in default summaries.
+  (#2351, Jon Rowe)
+* Warn when including shared example groups recursively. (#2356, Jon Rowe)
+* Improve failure snippet syntax highlighting with CodeRay to highlight
+  RSpec "keywords" like `expect`. (#2358, Myron Marston)
+
+### 3.6.0.beta1 / 2016-10-09
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.5.4...v3.6.0.beta1)
+
+Enhancements:
+
+* Warn when duplicate shared examples definitions are loaded due to being
+  defined in files matching the spec pattern (e.g. `_spec.rb`) (#2278, Devon Estes)
+* Improve metadata filtering so that it can match against any object
+  that implements `===` instead of treating regular expressions as
+  special. (Myron Marston, #2294)
+* Improve `rspec -v` so that it prints out the versions of each part of
+  RSpec to prevent confusion. (Myron Marston, #2304)
+* Add `config.fail_if_no_examples` option which causes RSpec to fail if
+  no examples are found. (Ewa Czechowska, #2302)
+* Nicely format errors encountered while loading spec files.
+  (Myron Marston, #2323)
+* Improve the API for enabling and disabling color output (Josh
+  Justice, #2321):
+  * Automatically enable color if the output is a TTY, since color is
+    nearly always desirable if the output can handle it.
+  * Introduce new CLI flag to force color on (`--force-color`), even
+    if the output is not a TTY. `--no-color` continues to work as well.
+  * Introduce `config.color_mode` for configuring the color from Ruby.
+    `:automatic` is the default and will produce color if the output is
+    a TTY. `:on` forces it on and `:off` forces it off.
+
+### 3.5.4 / 2016-09-30
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.5.3...v3.5.4)
+
+Bug Fixes:
+
+* Remove accumulated `ExampleGroup` constants when reseting RSpec,
+  preventing a memory leak. (TravisSpangle, #2328)
+
+### 3.5.3 / 2016-09-02
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.5.2...v3.5.3)
+
+Bug Fixes:
+
+* When applying shared group metadata to a host group, overwrite
+  conflicting keys if the value in the host group was inherited from
+  a parent group instead of being specified at that level.
+  (Myron Marston, #2307)
+* Handle errors in `:suite` hooks and provide the same nicely formatted
+  output as errors that happen in examples. (Myron Marston, #2316)
+* Set the exit status to non-zero when an error occurs in an
+  `after(:context)` hook. (Myron Marston, #2320)
+
 ### 3.5.2 / 2016-07-28
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.5.1...v3.5.2)
 
@@ -1841,7 +1928,7 @@ project's root directory or in your home directory:
 
     require "autotest/bundler"
 
-Now you can just type 'autotest' on the commmand line and it will work as you expect.
+Now you can just type 'autotest' on the command line and it will work as you expect.
 
 If you don't want 'bundle exec', there is nothing you have to do.
 
@@ -2029,7 +2116,7 @@ Bug fixes
 Enhancements
 
 * implicitly require unknown formatters so you don't have to require the file
-  explicitly on the commmand line (Michael Grosser)
+  explicitly on the command line (Michael Grosser)
 * add --out/-o option to assign output target
 * added fail_fast configuration option to abort on first failure
 * support a Hash subject (its([:key]) { should == value }) (Josep M. Bach)

data/lib/rspec/core/bisect/server.rb

@@ -25,7 +25,12 @@ module RSpec
           self.files_or_directories_to_run = files_or_directories_to_run
           self.latest_run_results = nil
           run_output = yield
-          latest_run_results || raise_bisect_failed(run_output)
+
+          if latest_run_results.nil? || latest_run_results.all_example_ids.empty?
+            raise_bisect_failed(run_output)
+          end
+
+          latest_run_results
         end
 
         def start

data/lib/rspec/core/configuration.rb

@@ -1,6 +1,7 @@
 RSpec::Support.require_rspec_core "backtrace_formatter"
 RSpec::Support.require_rspec_core "ruby_project"
 RSpec::Support.require_rspec_core "formatters/deprecation_formatter"
+RSpec::Support.require_rspec_core "output_wrapper"
 
 module RSpec
   module Core
@@ -141,7 +142,7 @@ module RSpec
 
       # Determines where deprecation warnings are printed.
       # Defaults to `$stderr`.
-      # @return [IO, String] IO to write to or filename to write to
+      # @return [IO, String] IO or filename to write to
       define_reader :deprecation_stream
 
       # Determines where deprecation warnings are printed.
@@ -199,6 +200,10 @@ module RSpec
       # The exit code to return if there are any failures (default: 1).
       add_setting :failure_exit_code
 
+      # @macro add_setting
+      # Whether or not to fail when there are no RSpec examples (default: false).
+      add_setting :fail_if_no_examples
+
       # @macro define_reader
       # Indicates files configured to be required.
       define_reader :requires
@@ -214,7 +219,7 @@ module RSpec
       define_reader :output_stream
 
       # Set the output stream for reporter.
-      # @attr value [IO] value for output, defaults to $stdout
+      # @attr value [IO, String] IO to write to or filename to write to, defaults to $stdout
       def output_stream=(value)
         if @reporter && !value.equal?(@output_stream)
           warn "RSpec's reporter has already been initialized with " \
@@ -223,6 +228,7 @@ module RSpec
             "it to take effect. (Called from #{CallerFilter.first_non_rspec_line})"
         else
           @output_stream = value
+          output_wrapper.output = @output_stream
         end
       end
 
@@ -394,6 +400,7 @@ module RSpec
       add_setting :max_displayed_failure_line_count
 
       # @private
+      # @deprecated Use {#color_mode} = :on, instead of {#color} with {#tty}
       add_setting :tty
       # @private
       attr_writer :files_to_run
@@ -422,9 +429,11 @@ module RSpec
         @files_or_directories_to_run = []
         @loaded_spec_files = Set.new
         @color = false
+        @color_mode = :automatic
         @pattern = '**{,/*/**}/*_spec.rb'
         @exclude_pattern = ''
         @failure_exit_code = 1
+        @fail_if_no_examples = false
         @spec_files_loaded = false
 
         @backtrace_formatter = BacktraceFormatter.new
@@ -473,8 +482,14 @@ module RSpec
       # @private
       def reset
         @spec_files_loaded = false
+        reset_reporter
+      end
+
+      # @private
+      def reset_reporter
         @reporter = nil
         @formatter_loader = nil
+        @output_wrapper = nil
       end
 
       # @private
@@ -773,24 +788,54 @@ module RSpec
         @backtrace_formatter.full_backtrace = true_or_false
       end
 
-      # Returns the configuration option for color, but should not
-      # be used to check if color is supported.
+      # Enables color output if the output is a TTY.  As of RSpec 3.6, this is
+      # the default behavior and this option is retained only for backwards
+      # compatibility.
       #
+      # @deprecated No longer recommended because of complex behavior. Instead,
+      #   rely on the fact that TTYs will display color by default, or set
+      #   {#color_mode} to :on to display color on a non-TTY output.
+      # @see color_mode
       # @see color_enabled?
       # @return [Boolean]
       def color
         value_for(:color) { @color }
       end
 
+      # The mode for determining whether to display output in color. One of:
+      #
+      # - :automatic - the output will be in color if the output is a TTY (the
+      #   default)
+      # - :on - the output will be in color, whether or not the output is a TTY
+      # - :off - the output will not be in color
+      #
+      # @see color_enabled?
+      # @return [Boolean]
+      def color_mode
+        value_for(:color_mode) { @color_mode }
+      end
+
       # Check if color is enabled for a particular output.
       # @param output [IO] an output stream to use, defaults to the current
       #        `output_stream`
       # @return [Boolean]
       def color_enabled?(output=output_stream)
-        output_to_tty?(output) && color
+        case color_mode
+        when :on then true
+        when :off then false
+        else # automatic
+          output_to_tty?(output) || (color && tty?)
+        end
       end
 
+      # Set the color mode.
+      attr_writer :color_mode
+
       # Toggle output color.
+      #
+      # @deprecated No longer recommended because of complex behavior. Instead,
+      #   rely on the fact that TTYs will display color by default, or set
+      #   {:color_mode} to :on to display color on a non-TTY output.
       attr_writer :color
 
       # @private
@@ -813,19 +858,22 @@ module RSpec
       end
 
       # @overload add_formatter(formatter)
+      # @overload add_formatter(formatter, output)
       #
-      # Adds a formatter to the formatters collection. `formatter` can be a
-      # string representing any of the built-in formatters (see
-      # `built_in_formatter`), or a custom formatter class.
+      # @param formatter [Class, String] formatter to use. Can be any of the
+      #   string values supported from the CLI (`p`/`progress`,
+      #   `d`/`doc`/`documentation`, `h`/`html`, or `j`/`json`) or any
+      #   class that implements the formatter protocol and has registered
+      #   itself with RSpec as a formatter.
+      # @param output [String, IO] where the formatter will write its output.
+      #   Can be an IO object or a string path to a file. If not provided,
+      #   the configured `output_stream` (`$stdout`, by default) will be used.
       #
-      # ### Note
+      # Adds a formatter to the set RSpec will use for this run.
       #
-      # For internal purposes, `add_formatter` also accepts the name of a class
-      # and paths to use for output streams, but you should consider that a
-      # private api that may change at any time without notice.
-      def add_formatter(formatter_to_use, *paths)
-        paths << output_stream if paths.empty?
-        formatter_loader.add formatter_to_use, *paths
+      # @see RSpec::Core::Formatters::Protocol
+      def add_formatter(formatter, output=output_wrapper)
+        formatter_loader.add(formatter, output)
       end
       alias_method :formatter=, :add_formatter
 
@@ -890,7 +938,7 @@ module RSpec
         @reporter_buffer || @reporter ||=
           begin
             @reporter_buffer = DeprecationReporterBuffer.new
-            formatter_loader.setup_default output_stream, deprecation_stream
+            formatter_loader.prepare_default output_wrapper, deprecation_stream
             @reporter_buffer.play_onto(formatter_loader.reporter)
             @reporter_buffer = nil
             formatter_loader.reporter
@@ -934,7 +982,9 @@ module RSpec
           if (path = example_status_persistence_file_path)
             begin
               ExampleStatusPersister.load_from(path).inject(statuses) do |hash, example|
-                hash[example.fetch(:example_id)] = example.fetch(:status)
+                status = example[:status]
+                status = UNKNOWN_STATUS unless VALID_STATUSES.include?(status)
+                hash[example.fetch(:example_id)] = status
                 hash
               end
             rescue SystemCallError => e
@@ -954,6 +1004,15 @@ module RSpec
       # @private
       FAILED_STATUS = "failed".freeze
 
+      # @private
+      PASSED_STATUS = "passed".freeze
+
+      # @private
+      PENDING_STATUS = "pending".freeze
+
+      # @private
+      VALID_STATUSES = [UNKNOWN_STATUS, FAILED_STATUS, PASSED_STATUS, PENDING_STATUS]
+
       # @private
       def spec_files_with_failures
         @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|
@@ -1432,7 +1491,7 @@ module RSpec
 
         files_to_run.uniq.each do |f|
           file = File.expand_path(f)
-          load file
+          load_spec_file_handling_errors(file)
           loaded_spec_files << file
         end
 
@@ -1658,7 +1717,7 @@ module RSpec
       #       mocks.patch_marshal_to_support_partial_doubles = false
       #     end
       #
-      #     config.mock_with :rspec do |expectations|
+      #     config.expect_with :rspec do |expectations|
       #       expectations.syntax = :expect
       #     end
       #   end
@@ -1721,7 +1780,7 @@ module RSpec
           return unless example_or_group_meta.key?(:example_group)
 
           # Ensure the callback only fires once.
-          @derived_metadata_blocks.items_for(specified_meta).delete(callback)
+          @derived_metadata_blocks.delete(callback, specified_meta)
 
           block.call
         end
@@ -1830,12 +1889,11 @@ module RSpec
       def with_suite_hooks
         return yield if dry_run?
 
-        hook_context = SuiteHookContext.new
         begin
-          run_hooks_with(@before_suite_hooks, hook_context)
+          run_suite_hooks("a `before(:suite)` hook", @before_suite_hooks)
           yield
         ensure
-          run_hooks_with(@after_suite_hooks, hook_context)
+          run_suite_hooks("an `after(:suite)` hook", @after_suite_hooks)
         end
       end
 
@@ -1860,6 +1918,14 @@ module RSpec
 
     private
 
+      def load_spec_file_handling_errors(file)
+        load file
+      rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
+        relative_file = Metadata.relative_path(file)
+        reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.")
+        RSpec.world.wants_to_quit = true
+      end
+
       def handle_suite_hook(scope, meta)
         return nil unless scope == :suite
 
@@ -1875,8 +1941,22 @@ module RSpec
         yield
       end
 
-      def run_hooks_with(hooks, hook_context)
-        hooks.each { |h| h.run(hook_context) }
+      def run_suite_hooks(hook_description, hooks)
+        context = SuiteHookContext.new(hook_description, reporter)
+
+        hooks.each do |hook|
+          begin
+            hook.run(context)
+          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => ex
+            context.set_exception(ex)
+
+            # Do not run subsequent `before` hooks if one fails.
+            # But for `after` hooks, we run them all so that all
+            # cleanup bits get a chance to complete, minimizing the
+            # chance that resources get left behind.
+            break if hooks.equal?(@before_suite_hooks)
+          end
+        end
       end
 
       def get_files_to_run(paths)
@@ -1978,8 +2058,12 @@ module RSpec
         )
       end
 
+      def output_wrapper
+        @output_wrapper ||= OutputWrapper.new(output_stream)
+      end
+
       def output_to_tty?(output=output_stream)
-        tty? || (output.respond_to?(:tty?) && output.tty?)
+        output.respond_to?(:tty?) && output.tty?
       end
 
       def conditionally_disable_mocks_monkey_patching

data/lib/rspec/core/configuration_options.rb

@@ -186,8 +186,10 @@ module RSpec
       def global_options_file
         File.join(File.expand_path("~"), ".rspec")
       rescue ArgumentError
+        # :nocov:
         RSpec.warning "Unable to find ~/.rspec because the HOME environment variable is not set"
         nil
+        # :nocov:
       end
     end
   end

data/lib/rspec/core/drb.rb

@@ -41,6 +41,8 @@ module RSpec
       def options
         argv = []
         argv << "--color"        if @submitted_options[:color]
+        argv << "--force-color"  if @submitted_options[:color_mode] == :on
+        argv << "--no-color"     if @submitted_options[:color_mode] == :off
         argv << "--profile"      if @submitted_options[:profile_examples]
         argv << "--backtrace"    if @submitted_options[:full_backtrace]
         argv << "--tty"          if @submitted_options[:tty]

data/lib/rspec/core/example.rb

@@ -260,7 +260,11 @@ module RSpec
                         'Expected example to fail since it is pending, but it passed.',
                         [location]
                 end
-              rescue Pending::SkipDeclaredInExample
+              rescue Pending::SkipDeclaredInExample => _
+                # The "=> _" is normally useless but on JRuby it is a workaround
+                # for a bug that prevents us from getting backtraces:
+                # https://github.com/jruby/jruby/issues/4467
+                #
                 # no-op, required metadata has already been set by the `skip`
                 # method.
               rescue AllExceptionsExcludingDangerousOnesOnRubiesThatAllowIt => e
@@ -465,22 +469,22 @@ module RSpec
 
         if @exception
           execution_result.exception = @exception
-          record_finished :failed
+          record_finished :failed, reporter
           reporter.example_failed self
           false
         elsif pending_message
           execution_result.pending_message = pending_message
-          record_finished :pending
+          record_finished :pending, reporter
           reporter.example_pending self
           true
         else
-          record_finished :passed
+          record_finished :passed, reporter
           reporter.example_passed self
           true
         end
       end
 
-      def record_finished(status)
+      def record_finished(status, reporter)
         execution_result.record_finished(status, clock.now)
         reporter.example_finished(self)
       end
@@ -632,16 +636,16 @@ module RSpec
     # @private
     # Provides an execution context for before/after :suite hooks.
     class SuiteHookContext < Example
-      def initialize
-        super(AnonymousExampleGroup, "", {})
+      def initialize(hook_description, reporter)
+        super(AnonymousExampleGroup, hook_description, {})
         @example_group_instance = AnonymousExampleGroup.new
+        @reporter = reporter
       end
 
       # rubocop:disable Style/AccessorMethodName
-
-      # To ensure we don't silence errors.
       def set_exception(exception)
-        raise exception
+        reporter.notify_non_example_exception(exception, "An error occurred in #{description}.")
+        RSpec.world.wants_to_quit = true
       end
       # rubocop:enable Style/AccessorMethodName
     end

data/lib/rspec/core/example_group.rb

@@ -415,10 +415,10 @@ module RSpec
         # not be applied where they should.
         registration_collection << self
 
-        user_metadata = Metadata.build_hash_from(args)
+        @user_metadata = Metadata.build_hash_from(args)
 
         @metadata = Metadata::ExampleGroupHash.create(
-          superclass_metadata, user_metadata,
+          superclass_metadata, @user_metadata,
           superclass.method(:next_runnable_index_for),
           description, *args, &example_group_block
         )
@@ -705,8 +705,8 @@ module RSpec
 
       # @private
       def self.update_inherited_metadata(updates)
-        metadata.update(updates) do |_key, existing_group_value, _new_inherited_value|
-          existing_group_value
+        metadata.update(updates) do |key, existing_group_value, new_inherited_value|
+          @user_metadata.key?(key) ? existing_group_value : new_inherited_value
         end
 
         RSpec.configuration.configure_group(self)
@@ -793,8 +793,12 @@ module RSpec
       # @private
       def self.with_frame(name, location)
         current_stack = shared_example_group_inclusions
-        current_stack << new(name, location)
-        yield
+        if current_stack.any? { |frame| frame.shared_group_name == name }
+          raise ArgumentError, "can't include shared examples recursively"
+        else
+          current_stack << new(name, location)
+          yield
+        end
       ensure
         current_stack.pop
       end
@@ -827,6 +831,12 @@ module RSpec
       const_scope
     end
 
+    def self.remove_all_constants
+      constants.each do |constant|
+        __send__(:remove_const, constant)
+      end
+    end
+
     def self.base_name_for(group)
       return "Anonymous" if group.description.empty?
 

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

@@ -1,5 +1,4 @@
 RSpec::Support.require_rspec_core "formatters/base_formatter"
-RSpec::Support.require_rspec_core "formatters/console_codes"
 
 module RSpec
   module Core
@@ -58,18 +57,17 @@ module RSpec
 
         # @api public
         #
-        # 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] (Ignored)
         def close(_notification)
-          return unless IO === output
           return if output.closed?
 
           output.puts
 
           output.flush
-          output.close unless output == $stdout
         end
       end
     end

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

@@ -23,9 +23,12 @@ module RSpec
         module_function
 
         # @private
-        CONFIG_COLORS_TO_METHODS = Configuration.instance_methods.grep(/_color\z/).inject({}) do |hash, method|
-          hash[method.to_s.sub(/_color\z/, '').to_sym] = method
-          hash
+        def config_colors_to_methods
+          @config_colors_to_methods ||=
+            Configuration.instance_methods.grep(/_color\z/).inject({}) do |hash, method|
+              hash[method.to_s.sub(/_color\z/, '').to_sym] = method
+              hash
+            end
         end
 
         # Fetches the correct code for the supplied symbol, or checks
@@ -34,7 +37,7 @@ module RSpec
         # @param code_or_symbol [Symbol, Fixnum] Symbol or code to check
         # @return [Fixnum] a console code
         def console_code_for(code_or_symbol)
-          if (config_method = CONFIG_COLORS_TO_METHODS[code_or_symbol])
+          if (config_method = config_colors_to_methods[code_or_symbol])
             console_code_for RSpec.configuration.__send__(config_method)
           elsif VT100_CODE_VALUES.key?(code_or_symbol)
             code_or_symbol

data/lib/rspec/core/formatters/documentation_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
@@ -21,7 +22,7 @@ module RSpec
         end
 
         def example_group_finished(_notification)
-          @group_level -= 1
+          @group_level -= 1 if @group_level > 0
         end
 
         def example_passed(passed)