rspec-core 3.2.3 → 3.3.0

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

@@ -0,0 +1,28 @@
+module RSpec
+  module Core
+    module Formatters
+      # @api private
+      # Formatter for providing message output as a fallback when no other
+      # profiler implements #message
+      class FallbackMessageFormatter
+        Formatters.register self, :message
+
+        def initialize(output)
+          @output = output
+        end
+
+        # @private
+        attr_reader :output
+
+        # @api public
+        #
+        # Used by the reporter to send messages to the output stream.
+        #
+        # @param notification [MessageNotification] containing message
+        def message(notification)
+          output.puts notification.message
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+RSpec::Support.require_rspec_core "shell_escape"
+
 module RSpec
   module Core
     module Formatters
@@ -65,11 +67,13 @@ module RSpec
         #
         # Remove trailing zeros from a string.
         #
+        # Only remove trailing zeros after a decimal place.
+        # see: http://rubular.com/r/ojtTydOgpn
+        #
         # @param string [String] string with trailing zeros
         # @return [String] string with trailing zeros removed
         def self.strip_trailing_zeroes(string)
-          stripped = string.sub(/[^1-9]+$/, '')
-          stripped.empty? ? "0" : stripped
+          string.sub(/(?:(\..*[^0])0+|\.0+)$/, '\1')
         end
         private_class_method :strip_trailing_zeroes
 
@@ -83,6 +87,22 @@ module RSpec
         def self.pluralize(count, string)
           "#{count} #{string}#{'s' unless count.to_f == 1}"
         end
+
+        # @api private
+        # Given a list of example ids, organizes them into a compact, ordered list.
+        def self.organize_ids(ids)
+          grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|
+            file, id = id.split(Configuration::ON_SQUARE_BRACKETS)
+            hash[file] << id
+            hash
+          end
+
+          grouped.sort_by(&:first).map do |file, grouped_ids|
+            grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }
+            id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))
+            ShellEscape.conditionally_quote(id)
+          end
+        end
       end
     end
   end

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

@@ -74,8 +74,6 @@ module RSpec
                                   :message => exception.message,
                                   :backtrace => failure.formatted_backtrace.join("\n")
                                 }
-                              else
-                                false
                               end
           extra = extra_failure_content(failure)
 
@@ -85,8 +83,7 @@ module RSpec
             example.execution_result.run_time,
             @failed_examples.size,
             exception_details,
-            (extra == "") ? false : extra,
-            true
+            (extra == "") ? false : extra
           )
           @printer.flush
         end

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

@@ -35,7 +35,7 @@ module RSpec
 
         # rubocop:disable Style/ParameterLists
         def print_example_failed(pending_fixed, description, run_time, failure_id,
-                                 exception, extra_content, escape_backtrace=false)
+                                 exception, extra_content)
           # rubocop:enable Style/ParameterLists
           formatted_run_time = "%.5f" % run_time
 
@@ -45,11 +45,7 @@ module RSpec
           @output.puts "      <div class=\"failure\" id=\"failure_#{failure_id}\">"
           if exception
             @output.puts "        <div class=\"message\"><pre>#{h(exception[:message])}</pre></div>"
-            if escape_backtrace
-              @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
-            else
-              @output.puts "        <div class=\"backtrace\"><pre>#{exception[:backtrace]}</pre></div>"
-            end
+            @output.puts "        <div class=\"backtrace\"><pre>#{h exception[:backtrace]}</pre></div>"
           end
           @output.puts extra_content if extra_content
           @output.puts "      </div>"

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

@@ -12,7 +12,9 @@ module RSpec
 
         def initialize(output)
           super
-          @output_hash = {}
+          @output_hash = {
+            :version => RSpec::Core::Version::STRING
+          }
         end
 
         def message(notification)
@@ -58,8 +60,7 @@ module RSpec
         # @api private
         def dump_profile_slowest_examples(profile)
           @output_hash[:profile] = {}
-          sorted_examples = profile.slowest_examples
-          @output_hash[:profile][:examples] = sorted_examples.map do |example|
+          @output_hash[:profile][:examples] = profile.slowest_examples.map do |example|
             format_example(example).tap do |hash|
               hash[:run_time] = example.execution_result.run_time
             end
@@ -85,7 +86,8 @@ module RSpec
             :status => example.execution_result.status.to_s,
             :file_path => example.metadata[:file_path],
             :line_number  => example.metadata[:line_number],
-            :run_time => example.execution_result.run_time
+            :run_time => example.execution_result.run_time,
+            :pending_message => example.execution_result.pending_message,
           }
         end
       end

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

@@ -7,26 +7,30 @@ module RSpec
       # and applies synax highlighting and line numbers using html.
       class SnippetExtractor
         # @private
-        class NullConverter
-          def convert(code)
+        module NullConverter
+          def self.convert(code)
             %Q(#{code}\n<span class="comment"># Install the coderay gem to get syntax highlighting</span>)
           end
         end
 
         # @private
-        class CoderayConverter
-          def convert(code)
+        module CoderayConverter
+          def self.convert(code)
             CodeRay.scan(code, :ruby).html(:line_numbers => false)
           end
         end
 
+        # rubocop:disable Style/ClassVars
+        @@converter = NullConverter
         begin
           require 'coderay'
-          # rubocop:disable Style/ClassVars
-          @@converter = CoderayConverter.new
+          @@converter = CoderayConverter
+          # rubocop:disable Lint/HandleExceptions
         rescue LoadError
-          @@converter = NullConverter.new
+          # it'll fall back to the NullConverter assigned above
+          # rubocop:enable Lint/HandleExceptions
         end
+
         # rubocop:enable Style/ClassVars
 
         # @api private
@@ -43,6 +47,7 @@ module RSpec
           highlighted = @@converter.convert(raw_code)
           post_process(highlighted, line)
         end
+        # rubocop:enable Style/ClassVars
 
         # @api private
         #

data/lib/rspec/core/hooks.rb

@@ -361,7 +361,9 @@ module RSpec
       # @private
       class AfterHook < Hook
         def run(example)
-          example.instance_exec_with_rescue("in an after hook", &block)
+          example.instance_exec(example, &block)
+        rescue Exception => ex
+          example.set_exception(ex)
         end
       end
 
@@ -394,10 +396,12 @@ EOS
           def hook_description
             "around hook at #{Metadata.relative_path(block.source_location.join(':'))}"
           end
-        else
+        else # for 1.8.7
+          # :nocov:
           def hook_description
             "around hook"
           end
+          # :nocov:
         end
       end
 
@@ -622,9 +626,11 @@ EOS
             @owner.parent_groups
           end
         else # Ruby < 2.1 (see https://bugs.ruby-lang.org/issues/8035)
+          # :nocov:
           def owner_parent_groups
             @owner_parent_groups ||= [@owner] + @owner.parent_groups
           end
+          # :nocov:
         end
       end
     end

data/lib/rspec/core/memoized_helpers.rb

@@ -1,3 +1,5 @@
+require 'rspec/core/reentrant_mutex'
+
 module RSpec
   module Core
     # This module is included in {ExampleGroup}, making the methods
@@ -53,11 +55,9 @@ module RSpec
       # @see #should_not
       # @see #is_expected
       def subject
-        __memoized.fetch(:subject) do
-          __memoized[:subject] = begin
-            described = described_class || self.class.metadata.fetch(:description_args).first
-            Class === described ? described.new : described
-          end
+        __memoized.fetch_or_store(:subject) do
+          described = described_class || self.class.metadata.fetch(:description_args).first
+          Class === described ? described.new : described
         end
       end
 
@@ -119,33 +119,85 @@ module RSpec
         expect(subject)
       end
 
+      # @private
+      # should just be placed in private section,
+      # but Ruby issues warnings on private attributes.
+      # and expanding it to the equivalent method upsets Rubocop,
+      # b/c it should obviously be a reader
+      attr_reader :__memoized
+      private :__memoized
+
     private
 
       # @private
-      def __memoized
-        @__memoized ||= {}
+      def initialize(*)
+        __init_memoized
+        super
+      end
+
+      # @private
+      def __init_memoized
+        @__memoized = if RSpec.configuration.threadsafe?
+                        ThreadsafeMemoized.new
+                      else
+                        NonThreadSafeMemoized.new
+                      end
+      end
+
+      # @private
+      class ThreadsafeMemoized
+        def initialize
+          @memoized = {}
+          @mutex = ReentrantMutex.new
+        end
+
+        def fetch_or_store(key)
+          @memoized.fetch(key) do # only first access pays for synchronization
+            @mutex.synchronize do
+              @memoized.fetch(key) { @memoized[key] = yield }
+            end
+          end
+        end
+      end
+
+      # @private
+      class NonThreadSafeMemoized
+        def initialize
+          @memoized = {}
+        end
+
+        def fetch_or_store(key)
+          @memoized.fetch(key) { @memoized[key] = yield }
+        end
       end
 
       # Used internally to customize the behavior of the
       # memoized hash when used in a `before(:context)` hook.
       #
       # @private
-      class ContextHookMemoizedHash
+      class ContextHookMemoized
         def self.isolate_for_context_hook(example_group_instance)
-          hash = self
+          exploding_memoized = self
 
           example_group_instance.instance_exec do
-            @__memoized = hash
+            @__memoized = exploding_memoized
 
             begin
               yield
             ensure
-              @__memoized = nil
+              # This is doing a reset instead of just isolating for context hook.
+              # Really, this should set the old @__memoized back into place.
+              #
+              # Caller is the before and after context hooks
+              # which are both called from self.run
+              # I didn't look at why it made tests fail, maybe an object was getting reused in RSpec tests,
+              # if so, then that probably already works, and its the tests that are wrong.
+              __init_memoized
             end
           end
         end
 
-        def self.fetch(key, &_block)
+        def self.fetch_or_store(key, &_block)
           description = if key == :subject
                           "subject"
                         else
@@ -206,9 +258,10 @@ EOS
         #   maybe 3 declarations) in any given example group, but that can
         #   quickly degrade with overuse. YMMV.
         #
-        # @note `let` uses an `||=` conditional that has the potential to
-        #   behave in surprising ways in examples that spawn separate threads,
-        #   though we have yet to see this in practice. You've been warned.
+        # @note `let` can be configured to be threadsafe or not.
+        #   If it is threadsafe, it will take longer to access the value.
+        #   If it is not threadsafe, it may behave in surprising ways in examples
+        #   that spawn separate threads. Specify this on `RSpec.configure`
         #
         # @note Because `let` is designed to create state that is reset between
         #   each example, and `before(:context)` is designed to setup state that
@@ -237,9 +290,9 @@ EOS
           # Apply the memoization. The method has been defined in an ancestor
           # module so we can use `super` here to get the value.
           if block.arity == 1
-            define_method(name) { __memoized.fetch(name) { |k| __memoized[k] = super(RSpec.current_example, &nil) } }
+            define_method(name) { __memoized.fetch_or_store(name) { super(RSpec.current_example, &nil) } }
           else
-            define_method(name) { __memoized.fetch(name) { |k| __memoized[k] = super(&nil) } }
+            define_method(name) { __memoized.fetch_or_store(name) { super(&nil) } }
           end
         end
 
@@ -312,6 +365,11 @@ EOS
         #
         # When given a `name`, calling `super` in the block is not supported.
         #
+        # @note `subject` can be configured to be threadsafe or not.
+        #   If it is threadsafe, it will take longer to access the value.
+        #   If it is not threadsafe, it may behave in surprising ways in examples
+        #   that spawn separate threads. Specify this on `RSpec.configure`
+        #
         # @param name [String,Symbol] used to define an accessor with an
         #   intention revealing name
         # @param block defines the value to be returned by `subject` in examples
@@ -443,6 +501,7 @@ EOS
         # Gets the named constant or yields.
         # On 1.8, const_defined? / const_get do not take into
         # account the inheritance hierarchy.
+        # :nocov:
         def self.get_constant_or_yield(example_group, name)
           if example_group.const_defined?(name)
             example_group.const_get(name)
@@ -450,6 +509,7 @@ EOS
             yield
           end
         end
+        # :nocov:
       else
         # @private
         #

data/lib/rspec/core/metadata.rb

@@ -100,9 +100,8 @@ module RSpec
       end
 
       # @private
-      def self.backtrace_from(block)
-        return caller unless block.respond_to?(:source_location)
-        [block.source_location.join(':')]
+      def self.id_from(metadata)
+        "#{metadata[:rerun_file_path]}[#{metadata[:scoped_id]}]"
       end
 
       # @private
@@ -111,9 +110,10 @@ module RSpec
       class HashPopulator
         attr_reader :metadata, :user_metadata, :description_args, :block
 
-        def initialize(metadata, user_metadata, description_args, block)
+        def initialize(metadata, user_metadata, index_provider, description_args, block)
           @metadata         = metadata
           @user_metadata    = user_metadata
+          @index_provider   = index_provider
           @description_args = description_args
           @block            = block
         end
@@ -151,6 +151,8 @@ module RSpec
           metadata[:line_number]        = line_number.to_i
           metadata[:location]           = "#{relative_file_path}:#{line_number}"
           metadata[:absolute_file_path] = File.expand_path(relative_file_path)
+          metadata[:rerun_file_path]  ||= relative_file_path
+          metadata[:scoped_id]          = build_scoped_id_for(relative_file_path)
         end
 
         def file_path_and_line_number_from(backtrace)
@@ -173,6 +175,12 @@ module RSpec
           (parent_description.to_s + separator) << my_description.to_s
         end
 
+        def build_scoped_id_for(file_path)
+          index = @index_provider.call(file_path).to_s
+          parent_scoped_id = metadata.fetch(:scoped_id) { return index }
+          "#{parent_scoped_id}:#{index}"
+        end
+
         def ensure_valid_user_keys
           RESERVED_KEYS.each do |key|
             next unless user_metadata.key?(key)
@@ -196,7 +204,7 @@ module RSpec
 
       # @private
       class ExampleHash < HashPopulator
-        def self.create(group_metadata, user_metadata, description, block)
+        def self.create(group_metadata, user_metadata, index_provider, description, block)
           example_metadata = group_metadata.dup
           group_metadata = Hash.new(&ExampleGroupHash.backwards_compatibility_default_proc do |hash|
             hash[:parent_example_group]
@@ -208,7 +216,7 @@ module RSpec
           example_metadata.delete(:parent_example_group)
 
           description_args = description.nil? ? [] : [description]
-          hash = new(example_metadata, user_metadata, description_args, block)
+          hash = new(example_metadata, user_metadata, index_provider, description_args, block)
           hash.populate
           hash.metadata
         end
@@ -229,7 +237,7 @@ module RSpec
 
       # @private
       class ExampleGroupHash < HashPopulator
-        def self.create(parent_group_metadata, user_metadata, *args, &block)
+        def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)
           group_metadata = hash_with_backwards_compatibility_default_proc
 
           if parent_group_metadata
@@ -237,7 +245,7 @@ module RSpec
             group_metadata[:parent_example_group] = parent_group_metadata
           end
 
-          hash = new(group_metadata, user_metadata, args, block)
+          hash = new(group_metadata, user_metadata, example_group_index, args, block)
           hash.populate
           hash.metadata
         end
@@ -262,7 +270,7 @@ module RSpec
               # that take a metadata hash, and MetadataFilter sets this thread
               # local to silence the warning here since it would be so
               # confusing.
-              unless RSpec.thread_local_metadata[:silence_metadata_example_group_deprecations]
+              unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]
                 RSpec.deprecate("The `:example_group` key in an example group's metadata hash",
                                 :replacement => "the example group's hash directly for the " \
                                 "computed keys and `:parent_example_group` to access the parent " \
@@ -308,15 +316,21 @@ module RSpec
       # @private
       RESERVED_KEYS = [
         :description,
+        :description_args,
+        :described_class,
         :example_group,
         :parent_example_group,
         :execution_result,
+        :last_run_status,
         :file_path,
         :absolute_file_path,
+        :rerun_file_path,
         :full_description,
         :line_number,
         :location,
-        :block
+        :scoped_id,
+        :block,
+        :shared_group_inclusion_backtrace
       ]
     end