rspec-core 3.0.4 → 3.12.2

data/lib/rspec/core/ruby_project.rb

@@ -1,15 +1,12 @@
 # This is borrowed (slightly modified) from Scott Taylor's
 # project_path project:
 #   http://github.com/smtlaissezfaire/project_path
-
-require 'pathname'
-
 module RSpec
   module Core
     # @private
     module RubyProject
       def add_to_load_path(*dirs)
-        dirs.map {|dir| add_dir_to_load_path(File.join(root, dir))}
+        dirs.each { |dir| add_dir_to_load_path(File.join(root, dir)) }
       end
 
       def add_dir_to_load_path(dir)
@@ -25,12 +22,23 @@ module RSpec
       end
 
       def find_first_parent_containing(dir)
-        ascend_until {|path| File.exist?(File.join(path, dir))}
+        ascend_until { |path| File.exist?(File.join(path, dir)) }
       end
 
       def ascend_until
-        Pathname(File.expand_path('.')).ascend do |path|
+        fs = File::SEPARATOR
+        escaped_slash = "\\#{fs}"
+        special = "_RSPEC_ESCAPED_SLASH_"
+        project_path = File.expand_path(".")
+        parts = project_path.gsub(escaped_slash, special).squeeze(fs).split(fs).map do |x|
+          x.gsub(special, escaped_slash)
+        end
+
+        until parts.empty?
+          path = parts.join(fs)
+          path = fs if path == ""
           return path if yield(path)
+          parts.pop
         end
       end
 

data/lib/rspec/core/runner.rb

@@ -2,6 +2,9 @@ module RSpec
   module Core
     # Provides the main entry point to run a suite of RSpec examples.
     class Runner
+      # @attr_reader
+      # @private
+      attr_reader :options, :configuration, :world
 
       # Register an `at_exit` hook that runs the suite when the process exits.
       #
@@ -18,21 +21,25 @@ module RSpec
           return
         end
 
-        at_exit do
-          # Don't bother running any specs and just let the program terminate
-          # if we got here due to an unrescued exception (anything other than
-          # SystemExit, which is raised when somebody calls Kernel#exit).
-          next unless $!.nil? || $!.kind_of?(SystemExit)
-
-          # We got here because either the end of the program was reached or
-          # somebody called Kernel#exit.  Run the specs and then override any
-          # existing exit status with RSpec's exit status if any specs failed.
-          invoke
-        end
+        at_exit { perform_at_exit }
         @installed_at_exit = true
       end
 
-      # Runs the suite of specs and exits the process with an appropriate exit code.
+      # @private
+      def self.perform_at_exit
+        # Don't bother running any specs and just let the program terminate
+        # if we got here due to an unrescued exception (anything other than
+        # SystemExit, which is raised when somebody calls Kernel#exit).
+        return unless $!.nil? || $!.is_a?(SystemExit)
+
+        # We got here because either the end of the program was reached or
+        # somebody called Kernel#exit. Run the specs and then override any
+        # existing exit status with RSpec's exit status if any specs failed.
+        invoke
+      end
+
+      # Runs the suite of specs and exits the process with an appropriate exit
+      # code.
       def self.invoke
         disable_autorun!
         status = run(ARGV, $stderr, $stdout).to_i
@@ -58,14 +65,8 @@ module RSpec
         trap_interrupt
         options = ConfigurationOptions.new(args)
 
-        if options.options[:drb]
-          require 'rspec/core/drb'
-          begin
-            DRbRunner.new(options).run(err, out)
-          rescue DRb::DRbConnError
-            err.puts "No DRb server is running. Running in local process instead ..."
-            new(options).run(err, out)
-          end
+        if options.options[:runner]
+          options.options[:runner].call(options, err, out)
         else
           new(options).run(err, out)
         end
@@ -83,7 +84,11 @@ module RSpec
       # @param out [IO] output stream
       def run(err, out)
         setup(err, out)
-        run_specs(@world.ordered_example_groups)
+        return @configuration.reporter.exit_early(exit_code) if RSpec.world.wants_to_quit
+
+        run_specs(@world.ordered_example_groups).tap do
+          persist_example_statuses
+        end
       end
 
       # Wires together the various configuration objects and state holders.
@@ -91,10 +96,11 @@ module RSpec
       # @param err [IO] error stream
       # @param out [IO] output stream
       def setup(err, out)
-        @configuration.error_stream = err
-        @configuration.output_stream = out if @configuration.output_stream == $stdout
-        @options.configure(@configuration)
+        configure(err, out)
+        return if RSpec.world.wants_to_quit
+
         @configuration.load_spec_files
+      ensure
         @world.announce_filters
       end
 
@@ -105,15 +111,25 @@ module RSpec
       #   or the configured failure exit code (1 by default) if specs
       #   failed.
       def run_specs(example_groups)
-        @configuration.reporter.report(@world.example_count(example_groups)) do |reporter|
-          begin
-            hook_context = SuiteHookContext.new
-            @configuration.hooks.run(:before, :suite, hook_context)
-            example_groups.map { |g| g.run(reporter) }.all? ? 0 : @configuration.failure_exit_code
-          ensure
-            @configuration.hooks.run(:after, :suite, hook_context)
+        examples_count = @world.example_count(example_groups)
+        examples_passed = @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
+
+        exit_code(examples_passed)
+      end
+
+      # @private
+      def configure(err, out)
+        @configuration.error_stream = err
+        @configuration.output_stream = out if @configuration.output_stream == $stdout
+        @options.configure(@configuration)
       end
 
       # @private
@@ -133,29 +149,64 @@ module RSpec
 
       # @private
       def self.running_in_drb?
-        begin
-          if defined?(DRb) && DRb.current_server
-            require 'socket'
-            require 'uri'
+        return false unless defined?(DRb)
 
-            local_ipv4 = IPSocket.getaddress(Socket.gethostname)
+        server = begin
+                   DRb.current_server
+                 rescue DRb::DRbServerNotFound
+                   return false
+                 end
 
-            local_drb = ["127.0.0.1", "localhost", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }
-          end
-        rescue DRb::DRbServerNotFound
-        ensure
-          return local_drb || false
-        end
+        return false unless server && server.alive?
+
+        require 'socket'
+        require 'uri'
+
+        local_ipv4 = begin
+                       IPSocket.getaddress(Socket.gethostname)
+                     rescue SocketError
+                       return false
+                     end
+
+        ["127.0.0.1", "localhost", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }
       end
 
       # @private
       def self.trap_interrupt
-        trap('INT') do
-          exit!(1) if RSpec.world.wants_to_quit
+        trap('INT') { handle_interrupt }
+      end
+
+      # @private
+      def self.handle_interrupt
+        if RSpec.world.wants_to_quit
+          exit!(1)
+        else
           RSpec.world.wants_to_quit = true
-          STDERR.puts "\nExiting... Interrupt again to exit immediately."
+          $stderr.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
         end
       end
+
+      # @private
+      def exit_code(examples_passed=false)
+        return @configuration.error_exit_code || @configuration.failure_exit_code if @world.non_example_failure
+        return @configuration.failure_exit_code unless examples_passed
+
+        0
+      end
+
+    private
+
+      def persist_example_statuses
+        return if @configuration.dry_run
+        return unless (path = @configuration.example_status_persistence_file_path)
+
+        ExampleStatusPersister.persist(@world.all_examples, path)
+      rescue SystemCallError => e
+        RSpec.warning "Could not write example statuses to #{path} (configured as " \
+                      "`config.example_status_persistence_file_path`) due to a " \
+                      "system error: #{e.inspect}. Please check that the config " \
+                      "option is set to an accessible, valid file path", :call_site => nil
+      end
     end
   end
 end

data/lib/rspec/core/sandbox.rb

@@ -0,0 +1,37 @@
+module RSpec
+  module Core
+    # A sandbox isolates the enclosed code into an environment that looks 'new'
+    # meaning globally accessed objects are reset for the duration of the
+    # sandbox.
+    #
+    # @note This module is not normally available. You must require
+    #   `rspec/core/sandbox` to load it.
+    module Sandbox
+      # Execute a provided block with RSpec global objects (configuration,
+      # world) reset.  This is used to test RSpec with RSpec.
+      #
+      # When calling this the configuration is passed into the provided block.
+      # Use this to set custom configs for your sandboxed examples.
+      #
+      # ```
+      # Sandbox.sandboxed do |config|
+      #   config.before(:context) { RSpec.current_example = nil }
+      # end
+      # ```
+      def self.sandboxed
+        orig_config  = RSpec.configuration
+        orig_world   = RSpec.world
+        orig_example = RSpec.current_example
+
+        RSpec.configuration = RSpec::Core::Configuration.new
+        RSpec.world         = RSpec::Core::World.new(RSpec.configuration)
+
+        yield RSpec.configuration
+      ensure
+        RSpec.configuration   = orig_config
+        RSpec.world           = orig_world
+        RSpec.current_example = orig_example
+      end
+    end
+  end
+end

data/lib/rspec/core/set.rb

@@ -0,0 +1,54 @@
+module RSpec
+  module Core
+    # @private
+    #
+    # We use this to replace `::Set` so we can have the advantage of
+    # constant time key lookups for unique arrays but without the
+    # potential to pollute a developers environment with an extra
+    # piece of the stdlib. This helps to prevent false positive
+    # builds.
+    #
+    class Set
+      include Enumerable
+
+      def initialize(array=[])
+        @values = {}
+        merge(array)
+      end
+
+      def empty?
+        @values.empty?
+      end
+
+      def <<(key)
+        @values[key] = true
+        self
+      end
+
+      def delete(key)
+        @values.delete(key)
+      end
+
+      def each(&block)
+        @values.keys.each(&block)
+        self
+      end
+
+      def include?(key)
+        @values.key?(key)
+      end
+
+      def merge(values)
+        values.each do |key|
+          @values[key] = true
+        end
+        self
+      end
+
+      def clear
+        @values.clear
+        self
+      end
+    end
+  end
+end

data/lib/rspec/core/shared_example_group.rb

@@ -1,5 +1,46 @@
+RSpec::Support.require_rspec_support "with_keywords_when_needed"
+
 module RSpec
   module Core
+    # Represents some functionality that is shared with multiple example groups.
+    # The functionality is defined by the provided block, which is lazily
+    # eval'd when the `SharedExampleGroupModule` instance is included in an example
+    # group.
+    class SharedExampleGroupModule < Module
+      # @private
+      attr_reader :definition
+
+      def initialize(description, definition, metadata)
+        @description = description
+        @definition  = definition
+        @metadata    = metadata
+      end
+
+      # Provides a human-readable representation of this module.
+      def inspect
+        "#<#{self.class.name} #{@description.inspect}>"
+      end
+      alias to_s inspect
+
+      # Ruby callback for when a module is included in another module is class.
+      # Our definition evaluates the shared group block in the context of the
+      # including example group.
+      def included(klass)
+        inclusion_line = klass.metadata[:location]
+        include_in klass, inclusion_line, [], nil
+      end
+
+      # @private
+      def include_in(klass, inclusion_line, args, customization_block)
+        klass.update_inherited_metadata(@metadata) unless @metadata.empty?
+
+        SharedExampleGroupInclusionStackFrame.with_frame(@description, inclusion_line) do
+          RSpec::Support::WithKeywordsWhenNeeded.class_exec(klass, *args, &@definition)
+          klass.class_exec(&customization_block) if customization_block
+        end
+      end
+    end
+
     # Shared example groups let you define common context and/or common
     # examples that you wish to use in multiple example groups.
     #
@@ -15,16 +56,15 @@ module RSpec
     # groups defined at the top level can be included from any example group.
     module SharedExampleGroup
       # @overload shared_examples(name, &block)
-      #   @param name [String, Symbol, Module] identifer to use when looking up this shared group
+      #   @param name [String, Symbol, Module] identifer to use when looking up
+      #     this shared group
       #   @param block The block to be eval'd
       # @overload shared_examples(name, metadata, &block)
-      #   @param name [String, Symbol, Module] identifer to use when looking up this shared group
-      #   @param metadata [Array<Symbol>, Hash] metadata to attach to this group; any example group
-      #     with matching metadata will automatically include this shared example group.
-      #   @param block The block to be eval'd
-      # @overload shared_examples(metadata, &block)
-      #   @param metadata [Array<Symbol>, Hash] metadata to attach to this group; any example group
-      #     with matching metadata will automatically include this shared example group.
+      #   @param name [String, Symbol, Module] identifer to use when looking up
+      #     this shared group
+      #   @param metadata [Array<Symbol>, Hash] metadata to attach to this
+      #     group; any example group or example with matching metadata will
+      #     automatically include this shared example group.
       #   @param block The block to be eval'd
       #
       # Stores the block for later use. The block will be evaluated
@@ -38,7 +78,7 @@ module RSpec
       #     end
       #   end
       #
-      #   describe Account do
+      #   RSpec.describe Account do
       #     it_behaves_like "auditable" do
       #       let(:auditable) { Account.new }
       #     end
@@ -49,9 +89,9 @@ module RSpec
       # @see ExampleGroup.include_context
       def shared_examples(name, *args, &block)
         top_level = self == ExampleGroup
-        if top_level && RSpec.thread_local_metadata[:in_example_group]
-          raise "Creating isolated shared examples from within a context is " +
-                "not allowed. Remove `RSpec.` prefix or move this to a " +
+        if top_level && RSpec::Support.thread_local_data[:in_example_group]
+          raise "Creating isolated shared examples from within a context is " \
+                "not allowed. Remove `RSpec.` prefix or move this to a " \
                 "top-level scope."
         end
 
@@ -62,7 +102,7 @@ module RSpec
 
       # @api private
       #
-      # Shared examples top level DSL
+      # Shared examples top level DSL.
       module TopLevelDSL
         # @private
         def self.definitions
@@ -82,7 +122,7 @@ module RSpec
 
         # @api private
         #
-        # Adds the top level DSL methods to Module and the top level binding
+        # Adds the top level DSL methods to Module and the top level binding.
         def self.expose_globally!
           return if exposed_globally?
           Core::DSL.change_global_dsl(&definitions)
@@ -91,7 +131,7 @@ module RSpec
 
         # @api private
         #
-        # Removes the top level DSL methods to Module and the top level binding
+        # Removes the top level DSL methods to Module and the top level binding.
         def self.remove_globally!
           return unless exposed_globally?
 
@@ -103,28 +143,32 @@ module RSpec
 
           @exposed_globally = false
         end
-
       end
 
       # @private
       class Registry
         def add(context, name, *metadata_args, &block)
-          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }
+          unless block
+            RSpec.warning "Shared example group #{name} was defined without a "\
+                          "block and will have no effect. Please define a "\
+                          "block or remove the definition."
+          end
 
-          if valid_name?(name)
-            warn_if_key_taken context, name, block
-            shared_example_groups[context][name] = block
-          else
-            metadata_args.unshift name
+          if RSpec.configuration.shared_context_metadata_behavior == :trigger_inclusion
+            return legacy_add(context, name, *metadata_args, &block)
           end
 
-          unless metadata_args.empty?
-            mod = Module.new
-            (class << mod; self; end).__send__(:define_method, :included) do |host|
-              host.class_exec(&block)
-            end
-            RSpec.configuration.include mod, *metadata_args
+          unless valid_name?(name)
+            raise ArgumentError, "Shared example group names can only be a string, " \
+                                 "symbol or module but got: #{name.inspect}"
           end
+
+          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }
+          warn_if_key_taken context, name, block
+
+          metadata = Metadata.build_hash_from(metadata_args)
+          shared_module = SharedExampleGroupModule.new(name, block, metadata)
+          shared_example_groups[context][name] = shared_module
         end
 
         def find(lookup_contexts, name)
@@ -138,40 +182,86 @@ module RSpec
 
       private
 
+        # TODO: remove this in RSpec 4. This exists only to support
+        # `config.shared_context_metadata_behavior == :trigger_inclusion`,
+        # the legacy behavior of shared context metadata, which we do
+        # not want to support in RSpec 4.
+        def legacy_add(context, name, *metadata_args, &block)
+          ensure_block_has_source_location(block) { CallerFilter.first_non_rspec_line }
+          shared_module = SharedExampleGroupModule.new(name, block, {})
+
+          if valid_name?(name)
+            warn_if_key_taken context, name, block
+            shared_example_groups[context][name] = shared_module
+          else
+            metadata_args.unshift name
+          end
+
+          return if metadata_args.empty?
+          RSpec.configuration.include shared_module, *metadata_args
+        end
+
         def shared_example_groups
           @shared_example_groups ||= Hash.new { |hash, context| hash[context] = {} }
         end
 
         def valid_name?(candidate)
           case candidate
-            when String, Symbol, Module then true
-            else false
+          when String, Symbol, Module then true
+          else false
           end
         end
 
         def warn_if_key_taken(context, key, new_block)
-          return unless existing_block = shared_example_groups[context][key]
-
-          RSpec.warn_with <<-WARNING.gsub(/^ +\|/, ''), :call_site => nil
-            |WARNING: Shared example group '#{key}' has been previously defined at:
-            |  #{formatted_location existing_block}
-            |...and you are now defining it at:
-            |  #{formatted_location new_block}
-            |The new definition will overwrite the original one.
-          WARNING
+          existing_module = shared_example_groups[context][key]
+          return unless existing_module
+
+          old_definition_location = formatted_location existing_module.definition
+          new_definition_location = formatted_location new_block
+          loaded_spec_files = RSpec.configuration.loaded_spec_files
+
+          if loaded_spec_files.include?(new_definition_location) && old_definition_location == new_definition_location
+            RSpec.warn_with <<-WARNING.gsub(/^ +\|/, ''), :call_site => nil
+              |WARNING: Your shared example group, '#{key}', defined at:
+              | #{old_definition_location}
+              |was automatically loaded by RSpec because the file name
+              |matches the configured autoloading pattern (#{RSpec.configuration.pattern}),
+              |and is also being required from somewhere else. To fix this
+              |warning, either rename the file to not match the pattern, or
+              |do not explicitly require the file.
+            WARNING
+          else
+            RSpec.warn_with <<-WARNING.gsub(/^ +\|/, ''), :call_site => nil
+              |WARNING: Shared example group '#{key}' has been previously defined at:
+              |  #{old_definition_location}
+              |...and you are now defining it at:
+              |  #{new_definition_location}
+              |The new definition will overwrite the original one.
+            WARNING
+          end
         end
 
-        def formatted_location(block)
-          block.source_location.join ":"
+        if RUBY_VERSION.to_f >= 1.9
+          def formatted_location(block)
+            block.source_location.join(":")
+          end
+        else # 1.8.7
+          # :nocov:
+          def formatted_location(block)
+            block.source_location.join(":").gsub(/:in.*$/, '')
+          end
+          # :nocov:
         end
 
         if Proc.method_defined?(:source_location)
-          def ensure_block_has_source_location(block); end
+          def ensure_block_has_source_location(_block); end
         else # for 1.8.7
+          # :nocov:
           def ensure_block_has_source_location(block)
             source_location = yield.split(':')
-            block.extend Module.new { define_method(:source_location) { source_location } }
+            block.extend(Module.new { define_method(:source_location) { source_location } })
           end
+          # :nocov:
         end
       end
     end

data/lib/rspec/core/shell_escape.rb

@@ -0,0 +1,49 @@
+module RSpec
+  module Core
+    # @private
+    # Deals with the fact that `shellwords` only works on POSIX systems.
+    module ShellEscape
+      module_function
+
+      def quote(argument)
+        "'#{argument.to_s.gsub("'", "\\\\'")}'"
+      end
+
+      if RSpec::Support::OS.windows?
+        # :nocov:
+        alias escape quote
+        # :nocov:
+      else
+        require 'shellwords'
+
+        def escape(shell_command)
+          Shellwords.escape(shell_command.to_s)
+        end
+      end
+
+      # Known shells that require quoting: zsh, csh, tcsh.
+      #
+      # Feel free to add other shells to this list that are known to
+      # allow `rspec ./some_spec.rb[1:1]` syntax without quoting the id.
+      #
+      # @private
+      SHELLS_ALLOWING_UNQUOTED_IDS = %w[ bash ksh fish ]
+
+      def conditionally_quote(id)
+        return id if shell_allows_unquoted_ids?
+        quote(id)
+      end
+
+      def shell_allows_unquoted_ids?
+        # Note: ENV['SHELL'] isn't necessarily the shell the user is currently running.
+        # According to http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html:
+        # "This variable shall represent a pathname of the user's preferred command language interpreter."
+        #
+        # It's the best we can easily do, though. We err on the side of safety (quoting
+        # the id when not actually needed) so it's not a big deal if the user is actually
+        # using a different shell.
+        SHELLS_ALLOWING_UNQUOTED_IDS.include?(ENV['SHELL'].to_s.split('/').last)
+      end
+    end
+  end
+end

data/lib/rspec/core/test_unit_assertions_adapter.rb

@@ -16,14 +16,14 @@ module RSpec
       # adding a shim for the new updates. Thus instead of checking on the
       # RUBY_VERSION we need to check ancestors.
       begin
-        # MiniTest is 4.x
-        # Minitest is 5.x
+        # MiniTest is 4.x.
+        # Minitest is 5.x.
         if ancestors.include?(::Minitest::Assertions)
           require 'rspec/core/minitest_assertions_adapter'
           include ::RSpec::Core::MinitestAssertionsAdapter
         end
-      rescue NameError => _ignored
-        # No-op. Minitest 5.x was not loaded
+      rescue NameError
+        # No-op. Minitest 5.x was not loaded.
       end
     end
   end

data/lib/rspec/core/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Core.
     module Version
       # Current version of RSpec Core, in semantic versioning format.
-      STRING = '3.0.4'
+      STRING = '3.12.2'
     end
   end
 end