rspec-core 3.5.4 → 3.6.0

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

@@ -33,7 +33,7 @@ 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
         # @api public
@@ -45,8 +45,8 @@ 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
         # @api public
@@ -54,8 +54,8 @@ module RSpec
         #
         # 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
         # @api public
@@ -63,8 +63,8 @@ module RSpec
         #
         # 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
         # @api public
@@ -72,8 +72,8 @@ module RSpec
         #
         # 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
         # @api public
@@ -81,8 +81,8 @@ module RSpec
         #
         # 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
         # @api public
@@ -90,8 +90,8 @@ module RSpec
         #
         # 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
         # @api public
@@ -99,8 +99,8 @@ module RSpec
         #
         # 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
         # @api public
@@ -108,7 +108,7 @@ module RSpec
         #
         # Used by the reporter to send messages to the output stream.
         #
-        # @param notification [MessageNotification] containing message
+        # @param notification [Notifications::MessageNotification] containing message
 
         # @method stop
         # @api public
@@ -117,7 +117,7 @@ module RSpec
         # Invoked after all examples have executed, before dumping post-run
         # reports.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
         # @method start_dump
         # @api public
@@ -128,7 +128,7 @@ module RSpec
         # (BaseTextFormatter then calls {#dump_failures} once for each failed
         # example).
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
         # @method dump_failures
         # @api public
@@ -136,7 +136,7 @@ module RSpec
         #
         # Dumps detailed information about each example failure.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
 
         # @method dump_summary
         # @api public
@@ -145,7 +145,7 @@ module RSpec
         # 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
@@ -155,7 +155,7 @@ module RSpec
         # 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
@@ -165,16 +165,17 @@ module RSpec
         # 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
         # @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.
@@ -31,12 +31,32 @@ 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
           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/formatters.rb

@@ -24,7 +24,7 @@ RSpec::Support.require_rspec_support "directory_maker"
 # ## Custom Formatters
 #
 # You can tell RSpec to use a custom formatter by passing its path and name to
-# the `rspec` commmand. For example, if you define MyCustomFormatter in
+# the `rspec` command. For example, if you define MyCustomFormatter in
 # path/to/my_custom_formatter.rb, you would type this command:
 #
 #     rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter
@@ -115,6 +115,11 @@ module RSpec::Core::Formatters
     # @return [String] the default formatter to setup, defaults to `progress`
     attr_accessor :default_formatter
 
+    # @private
+    def prepare_default(output_stream, deprecation_stream)
+      reporter.prepare_default(self, output_stream, deprecation_stream)
+    end
+
     # @private
     def setup_default(output_stream, deprecation_stream)
       add default_formatter, output_stream if @formatters.empty?
@@ -140,7 +145,7 @@ module RSpec::Core::Formatters
     def add(formatter_to_use, *paths)
       formatter_class = find_formatter(formatter_to_use)
 
-      args = paths.map { |p| p.respond_to?(:puts) ? p : file_at(p) }
+      args = paths.map { |p| p.respond_to?(:puts) ? p : open_stream(p) }
 
       if !Loader.formatters[formatter_class].nil?
         formatter = formatter_class.new(*args)
@@ -247,9 +252,14 @@ module RSpec::Core::Formatters
       word
     end
 
-    def file_at(path)
-      RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path))
-      File.new(path, 'w')
+    def open_stream(path_or_wrapper)
+      if RSpec::Core::OutputWrapper === path_or_wrapper
+        path_or_wrapper.output = open_stream(path_or_wrapper.output)
+        path_or_wrapper
+      else
+        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(path_or_wrapper))
+        File.new(path_or_wrapper, 'w')
+      end
     end
   end
 end

data/lib/rspec/core/invocations.rb

@@ -49,16 +49,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

data/lib/rspec/core/memoized_helpers.rb

@@ -285,6 +285,9 @@ EOS
           # We have to pass the block directly to `define_method` to
           # allow it to use method constructs like `super` and `return`.
           raise "#let or #subject called without a block" if block.nil?
+          raise(
+            "#let or #subject called with a reserved name #initialize"
+          ) if :initialize == name
           MemoizedHelpers.module_for(self).__send__(:define_method, name, &block)
 
           # Apply the memoization. The method has been defined in an ancestor

data/lib/rspec/core/metadata_filter.rb

@@ -13,24 +13,19 @@ module RSpec
         end
 
         # @private
-        def filter_applies?(key, value, metadata)
+        def filter_applies?(key, filter_value, metadata)
           silence_metadata_example_group_deprecations do
-            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)
-            return true if TrueClass === value && !!metadata[key]
-            return filter_applies_to_any_value?(key, value, metadata) if Array === metadata[key] && !(Proc === value)
-
-            case value
-            when Regexp
-              metadata[key] =~ value
-            when Proc
-              proc_filter_applies?(key, value, metadata)
-            else
-              metadata[key].to_s == value.to_s
-            end
+            return location_filter_applies?(filter_value, metadata) if key == :locations
+            return id_filter_applies?(filter_value, metadata)       if key == :ids
+            return filters_apply?(key, filter_value, metadata)      if Hash === filter_value
+
+            meta_value = metadata.fetch(key) { return false }
+
+            return true if TrueClass === filter_value && meta_value
+            return proc_filter_applies?(key, filter_value, metadata) if Proc === filter_value
+            return filter_applies_to_any_value?(key, filter_value, metadata) if Array === meta_value
+
+            filter_value === meta_value || filter_value.to_s == meta_value.to_s
           end
         end
 
@@ -116,6 +111,10 @@ module RSpec
           @items_and_filters.unshift [item, metadata]
         end
 
+        def delete(item, metadata)
+          @items_and_filters.delete [item, metadata]
+        end
+
         def items_for(request_meta)
           @items_and_filters.each_with_object([]) do |(item, item_meta), to_return|
             to_return << item if item_meta.empty? ||
@@ -172,6 +171,11 @@ module RSpec
           handle_mutation(metadata)
         end
 
+        def delete(item, metadata)
+          super
+          reconstruct_caches
+        end
+
         def items_for(metadata)
           # The filtering of `metadata` to `applicable_metadata` is the key thing
           # that makes the memoization actually useful in practice, since each
@@ -196,6 +200,14 @@ module RSpec
 
       private
 
+        def reconstruct_caches
+          @applicable_keys.clear
+          @proc_keys.clear
+          @items_and_filters.each do |_item, metadata|
+            handle_mutation(metadata)
+          end
+        end
+
         def handle_mutation(metadata)
           @applicable_keys.merge(metadata.keys)
           @proc_keys.merge(proc_keys_from metadata)

data/lib/rspec/core/notifications.rb

@@ -1,3 +1,4 @@
+RSpec::Support.require_rspec_core "formatters/console_codes"
 RSpec::Support.require_rspec_core "formatters/exception_presenter"
 RSpec::Support.require_rspec_core "formatters/helpers"
 RSpec::Support.require_rspec_core "shell_escape"
@@ -199,6 +200,12 @@ module RSpec::Core
         @exception_presenter.fully_formatted(failure_number, colorizer)
       end
 
+      # @return [Array<string>] The failure information fully formatted in the way that
+      #   RSpec's built-in formatters emit, split by line.
+      def fully_formatted_lines(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+        @exception_presenter.fully_formatted_lines(failure_number, colorizer)
+      end
+
     private
 
       def initialize(example, exception_presenter=Formatters::ExceptionPresenter::Factory.new(example).build)
@@ -280,8 +287,12 @@ module RSpec::Core
     # @attr pending_examples [Array<RSpec::Core::Example>] the pending examples
     # @attr load_time [Float] the number of seconds taken to boot RSpec
     #                         and load the spec files
+    # @attr errors_outside_of_examples_count [Integer] the number of errors that
+    #                                                  have occurred processing
+    #                                                  the spec suite
     SummaryNotification = Struct.new(:duration, :examples, :failed_examples,
-                                     :pending_examples, :load_time)
+                                     :pending_examples, :load_time,
+                                     :errors_outside_of_examples_count)
     class SummaryNotification
       # @api
       # @return [Fixnum] the number of examples run
@@ -307,6 +318,11 @@ module RSpec::Core
         summary = Formatters::Helpers.pluralize(example_count, "example")
         summary << ", " << Formatters::Helpers.pluralize(failure_count, "failure")
         summary << ", #{pending_count} pending" if pending_count > 0
+        if errors_outside_of_examples_count > 0
+          summary << ", "
+          summary << Formatters::Helpers.pluralize(errors_outside_of_examples_count, "error")
+          summary << " occurred outside of examples"
+        end
         summary
       end
 
@@ -320,7 +336,7 @@ module RSpec::Core
       #                          specific colors.
       # @return [String] A colorized results line.
       def colorized_totals_line(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
-        if failure_count > 0
+        if failure_count > 0 || errors_outside_of_examples_count > 0
           colorizer.wrap(totals_line, RSpec.configuration.failure_color)
         elsif pending_count > 0
           colorizer.wrap(totals_line, RSpec.configuration.pending_color)

data/lib/rspec/core/option_parser.rb

@@ -39,6 +39,8 @@ module RSpec::Core
     # rubocop:disable PerceivedComplexity
     def parser(options)
       OptionParser.new do |parser|
+        parser.summary_width = 34
+
         parser.banner = "Usage: rspec [options] [files or directories]\n\n"
 
         parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dirs|
@@ -131,8 +133,24 @@ module RSpec::Core
           options[:full_backtrace] = true
         end
 
-        parser.on('-c', '--[no-]color', '--[no-]colour', 'Enable color in the output.') do |o|
-          options[:color] = o
+        parser.on('-c', '--color', '--colour', '') do |_o|
+          # flag will be excluded from `--help` output because it is deprecated
+          options[:color] = true
+          options[:color_mode] = :automatic
+        end
+
+        parser.on('--force-color', '--force-colour', 'Force the output to be in color, even if the output is not a TTY') do |_o|
+          if options[:color_mode] == :off
+            abort "Please only use one of `--force-color` and `--no-color`"
+          end
+          options[:color_mode] = :on
+        end
+
+        parser.on('--no-color', '--no-colour', 'Force the output to not be in color, even if the output is a TTY') do |_o|
+          if options[:color_mode] == :on
+            abort "Please only use one of --force-color and --no-color"
+          end
+          options[:color_mode] = :off
         end
 
         parser.on('-p', '--[no-]profile [COUNT]',
@@ -256,8 +274,10 @@ FILTERING
         #     trigger --default-path.
         invalid_options = %w[-d --I]
 
+        hidden_options = invalid_options + %w[-c]
+
         parser.on_tail('-h', '--help', "You're looking at it.") do
-          options[:runner] = RSpec::Core::Invocations::PrintHelp.new(parser, invalid_options)
+          options[:runner] = RSpec::Core::Invocations::PrintHelp.new(parser, hidden_options)
         end
 
         # This prevents usage of the invalid_options.

data/lib/rspec/core/output_wrapper.rb

@@ -0,0 +1,29 @@
+module RSpec
+  module Core
+    # @private
+    class OutputWrapper
+      # @private
+      attr_accessor :output
+
+      # @private
+      def initialize(output)
+        @output = output
+      end
+
+      def respond_to?(name, priv=false)
+        output.respond_to?(name, priv)
+      end
+
+      def method_missing(name, *args, &block)
+        output.send(name, *args, &block)
+      end
+
+      # Redirect calls for IO interface methods
+      IO.instance_methods(false).each do |method|
+        define_method(method) do |*args, &block|
+          output.send(method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/project_initializer/.rspec

@@ -1,2 +1 @@
---color
 --require spec_helper

data/lib/rspec/core/project_initializer/spec/spec_helper.rb

@@ -12,9 +12,6 @@
 # the additional setup, and require it from the spec files that actually need
 # it.
 #
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
@@ -80,7 +77,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
   end
 
   # Print the 10 slowest examples and example groups at the

data/lib/rspec/core/reporter.rb

@@ -18,19 +18,14 @@ module RSpec::Core
       @failed_examples = []
       @pending_examples = []
       @duration = @start = @load_time = nil
+      @non_example_exception_count = 0
+      @setup_default = lambda {}
+      @setup = false
     end
 
     # @private
     attr_reader :examples, :failed_examples, :pending_examples
 
-    # @private
-    def reset
-      @examples = []
-      @failed_examples = []
-      @pending_examples = []
-      @profiler = Profiler.new if defined?(@profiler)
-    end
-
     # @private
     def setup_profiler
       @profiler = Profiler.new
@@ -51,6 +46,13 @@ module RSpec::Core
       true
     end
 
+    # @private
+    def prepare_default(loader, output_stream, deprecation_stream)
+      @setup_default = lambda do
+        loader.setup_default output_stream, deprecation_stream
+      end
+    end
+
     # @private
     def registered_listeners(notification)
       @listeners[notification].to_a
@@ -153,10 +155,11 @@ module RSpec::Core
 
     # @private
     # Provides a way to notify of an exception that is not tied to any
-    # particular exception (such as an exception encountered in a :suite hook).
+    # particular example (such as an exception encountered in a :suite hook).
     # Exceptions will be formatted the same way they normally are.
     def notify_non_example_exception(exception, context_description)
       @configuration.world.non_example_failure = true
+      @non_example_exception_count += 1
 
       example = Example.new(AnonymousExampleGroup, context_description, {})
       presenter = Formatters::ExceptionPresenter.new(exception, example, :indentation => 0)
@@ -177,7 +180,8 @@ module RSpec::Core
                                                                        @profiler.example_groups)
         end
         notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples,
-                                                                     @pending_examples, @load_time)
+                                                                     @pending_examples, @load_time,
+                                                                     @non_example_exception_count)
         notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
       end
     end
@@ -197,6 +201,7 @@ module RSpec::Core
 
     # @private
     def notify(event, notification)
+      ensure_listeners_ready
       registered_listeners(event).each do |formatter|
         formatter.__send__(event, notification)
       end
@@ -222,6 +227,13 @@ module RSpec::Core
 
   private
 
+    def ensure_listeners_ready
+      return if @setup
+
+      @setup_default.call
+      @setup = true
+    end
+
     def close
       notify :close, Notifications::NullNotification
     end

data/lib/rspec/core/runner.rb

@@ -108,8 +108,13 @@ module RSpec
       #   or the configured failure exit code (1 by default) if specs
       #   failed.
       def run_specs(example_groups)
-        success = @configuration.reporter.report(@world.example_count(example_groups)) do |reporter|
+        examples_count = @world.example_count(example_groups)
+        success = @configuration.reporter.report(examples_count) do |reporter|
           @configuration.with_suite_hooks do
+            if examples_count == 0 && @configuration.fail_if_no_examples
+              return @configuration.failure_exit_code
+            end
+
             example_groups.map { |g| g.run(reporter) }.all?
           end
         end && !@world.non_example_failure

data/lib/rspec/core/set.rb

@@ -44,6 +44,11 @@ module RSpec
         end
         self
       end
+
+      def clear
+        @values.clear
+        self
+      end
     end
   end
 end