RubyGems - rspec-core - Versions diffs - 3.0.4 → 3.1.0 - Mend

rspec-core 3.0.4 → 3.1.0

Files changed (55) hide show

checksums.yaml +4 -4
checksums.yaml.gz.sig +0 -0
data.tar.gz.sig +0 -0
data/Changelog.md +67 -0
data/lib/rspec/core.rb +3 -1
data/lib/rspec/core/backtrace_formatter.rb +13 -10
data/lib/rspec/core/configuration.rb +123 -57
data/lib/rspec/core/configuration_options.rb +12 -12
data/lib/rspec/core/drb.rb +11 -11
data/lib/rspec/core/dsl.rb +0 -1
data/lib/rspec/core/example.rb +39 -12
data/lib/rspec/core/example_group.rb +31 -98
data/lib/rspec/core/filter_manager.rb +16 -17
data/lib/rspec/core/formatters.rb +14 -13
data/lib/rspec/core/formatters/base_formatter.rb +8 -113
data/lib/rspec/core/formatters/base_text_formatter.rb +3 -5
data/lib/rspec/core/formatters/console_codes.rb +1 -2
data/lib/rspec/core/formatters/deprecation_formatter.rb +2 -3
data/lib/rspec/core/formatters/documentation_formatter.rb +3 -4
data/lib/rspec/core/formatters/helpers.rb +5 -6
data/lib/rspec/core/formatters/html_formatter.rb +20 -19
data/lib/rspec/core/formatters/html_printer.rb +6 -5
data/lib/rspec/core/formatters/json_formatter.rb +3 -2
data/lib/rspec/core/formatters/profile_formatter.rb +0 -2
data/lib/rspec/core/formatters/progress_formatter.rb +4 -4
data/lib/rspec/core/formatters/protocol.rb +163 -0
data/lib/rspec/core/formatters/snippet_extractor.rb +7 -6
data/lib/rspec/core/hooks.rb +25 -10
data/lib/rspec/core/memoized_helpers.rb +7 -5
data/lib/rspec/core/metadata.rb +29 -30
data/lib/rspec/core/metadata_filter.rb +66 -66
data/lib/rspec/core/minitest_assertions_adapter.rb +1 -1
data/lib/rspec/core/mocking_adapters/flexmock.rb +3 -1
data/lib/rspec/core/mocking_adapters/mocha.rb +3 -1
data/lib/rspec/core/mocking_adapters/null.rb +2 -0
data/lib/rspec/core/mocking_adapters/rr.rb +3 -1
data/lib/rspec/core/mocking_adapters/rspec.rb +3 -1
data/lib/rspec/core/notifications.rb +36 -29
data/lib/rspec/core/option_parser.rb +29 -25
data/lib/rspec/core/ordering.rb +8 -9
data/lib/rspec/core/pending.rb +6 -8
data/lib/rspec/core/project_initializer.rb +4 -2
data/lib/rspec/core/project_initializer/.rspec +0 -1
data/lib/rspec/core/project_initializer/spec/spec_helper.rb +37 -26
data/lib/rspec/core/rake_task.rb +37 -19
data/lib/rspec/core/reporter.rb +13 -16
data/lib/rspec/core/ruby_project.rb +2 -2
data/lib/rspec/core/runner.rb +11 -14
data/lib/rspec/core/shared_example_group.rb +14 -13
data/lib/rspec/core/test_unit_assertions_adapter.rb +1 -1
data/lib/rspec/core/version.rb +1 -1
data/lib/rspec/core/warnings.rb +4 -4
data/lib/rspec/core/world.rb +22 -24
metadata +6 -5
metadata.gz.sig +0 -0

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

@@ -27,12 +27,14 @@ module RSpec
         end
         def print_example_passed(description, run_time)
-          formatted_run_time = sprintf("%.5f", run_time)
+          formatted_run_time = "%.5f" % run_time
           @output.puts "    <dd class=\"example passed\"><span class=\"passed_spec_name\">#{h(description)}</span><span class='duration'>#{formatted_run_time}s</span></dd>"
         end
-        def print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace = false)
-          formatted_run_time = sprintf("%.5f", run_time)
+        # rubocop:disable Style/ParameterLists
+        def print_example_failed(pending_fixed, description, run_time, failure_id, exception, extra_content, escape_backtrace=false)
+          # rubocop:enable Style/ParameterLists
+          formatted_run_time = "%.5f" % run_time
           @output.puts "    <dd class=\"example #{pending_fixed ? 'pending_fixed' : 'failed'}\">"
           @output.puts "      <span class=\"failed_spec_name\">#{h(description)}</span>"
@@ -60,7 +62,7 @@ module RSpec
           totals << "#{failure_count} failure#{'s' unless failure_count == 1}"
           totals << ", #{pending_count} pending" if pending_count > 0
-          formatted_duration = sprintf("%.5f", duration)
+          formatted_duration = "%.5f" % duration
           @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{formatted_duration} seconds</strong>\";</script>"
           @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
@@ -395,7 +397,6 @@ EOF
 </head>
 <body>
 EOF
       end
     end
   end

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

@@ -32,7 +32,8 @@ module RSpec
         def stop(notification)
           @output_hash[:examples] = notification.examples.map do |example|
             format_example(example).tap do |hash|
-              if e=example.exception
+              e = example.exception
+              if e
                 hash[:exception] =  {
                   :class => e.class.name,
                   :message => e.message,
@@ -43,7 +44,7 @@ module RSpec
           end
         end
-        def close(notification)
+        def close(_notification)
           output.write @output_hash.to_json
           output.close if IO === output && output != $stdout
         end

data/lib/rspec/core/formatters/profile_formatter.rb CHANGED

@@ -3,7 +3,6 @@ RSpec::Support.require_rspec_core "formatters/console_codes"
 module RSpec
   module Core
     module Formatters
       # @api private
       # Formatter for providing profile output
       class ProfileFormatter
@@ -60,7 +59,6 @@ module RSpec
         def bold(text)
           ConsoleCodes.wrap(text, :bold)
         end
       end
     end
   end

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

@@ -7,19 +7,19 @@ module RSpec
       class ProgressFormatter < BaseTextFormatter
         Formatters.register self, :example_passed, :example_pending, :example_failed, :start_dump
-        def example_passed(notification)
+        def example_passed(_notification)
           output.print ConsoleCodes.wrap('.', :success)
         end
-        def example_pending(notification)
+        def example_pending(_notification)
           output.print ConsoleCodes.wrap('*', :pending)
         end
-        def example_failed(notification)
+        def example_failed(_notification)
           output.print ConsoleCodes.wrap('F', :failure)
         end
-        def start_dump(notification)
+        def start_dump(_notification)
           output.puts
         end
       end

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

@@ -0,0 +1,163 @@
+module RSpec
+  module Core
+    module Formatters
+      # This class isn't loaded at runtime but serves to document all of the
+      # notifications implemented as part of the standard interface. The
+      # reporter will issue these during a normal test suite run, but a
+      # formatter will only receive those notifications it has registered
+      # itself to receive. To register a formatter call:
+      #
+      # `::RSpec::Core::Formatters.register class, :list, :of, :notifications`
+      #
+      # e.g.
+      #
+      # `::RSpec::Core::Formatters.register self, :start, :example_started`
+      #
+      # @see RSpec::Core::Formatters::BaseFormatter
+      # @see RSpec::Core::Formatters::BaseTextFormatter
+      # @see RSpec::Core::Reporter
+      class Protocol
+        # @method initialize
+        # @api public
+        #
+        # @param output [IO] the formatter output
+        # @method start
+        # @api public
+        # @group Suite Notifications
+        #
+        # This method is invoked before any examples are run, right after
+        # they have all been collected. This can be useful for special
+        # formatters that need to provide progress on feedback (graphical ones).
+        #
+        # This will only be invoked once, and the next one to be invoked
+        # is {#example_group_started}.
+        #
+        # @param notification [StartNotification]
+        # @method example_group_started
+        # @api public
+        # @group Group Notifications
+        #
+        # This method is invoked at the beginning of the execution of each example group.
+        #
+        # 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`
+        # @method example_group_finished
+        # @api public
+        # @group Group Notifications
+        #
+        # Invoked at the end of the execution of each example group.
+        #
+        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
+        # @method example_started
+        # @api public
+        # @group Example Notifications
+        #
+        # Invoked at the beginning of the execution of each example.
+        #
+        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @method example_passed
+        # @api public
+        # @group Example Notifications
+        #
+        # Invoked when an example passes.
+        #
+        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @method example_pending
+        # @api public
+        # @group Example Notifications
+        #
+        # Invoked when an example is pending.
+        #
+        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @method example_failed
+        # @api public
+        # @group Example Notifications
+        #
+        # Invoked when an example fails.
+        #
+        # @param notification [ExampleNotification] containing example subclass of `RSpec::Core::Example`
+        # @method message
+        # @api public
+        # @group Suite Notifications
+        #
+        # Used by the reporter to send messages to the output stream.
+        #
+        # @param notification [MessageNotification] containing message
+        # @method stop
+        # @api public
+        # @group Suite Notifications
+        #
+        # Invoked after all examples have executed, before dumping post-run reports.
+        #
+        # @param notification [NullNotification]
+        # @method start_dump
+        # @api public
+        # @group Suite Notifications
+        #
+        # This method is invoked after all of the examples have executed. The next method
+        # to be invoked after this one is {#dump_failures}
+        # (BaseTextFormatter then calls {#dump_failure} once for each failed example.)
+        #
+        # @param notification [NullNotification]
+        # @method dump_failures
+        # @api public
+        # @group Suite Notifications
+        #
+        # Dumps detailed information about each example failure.
+        #
+        # @param notification [NullNotification]
+        # @method dump_summary
+        # @api public
+        # @group Suite Notifications
+        #
+        # This method is invoked after the dumping of examples and failures. Each parameter
+        # is assigned to a corresponding attribute.
+        #
+        # @param summary [SummaryNotification] containing duration, example_count,
+        #                                      failure_count and pending_count
+        # @method dump_profile
+        # @api public
+        # @group Suite Notifications
+        #
+        # This method is invoked after the dumping the summary if profiling is
+        # enabled.
+        #
+        # @param profile [ProfileNotification] containing duration, slowest_examples
+        #                                      and slowest_example_groups
+        # @method dump_pending
+        # @api public
+        # @group Suite Notifications
+        #
+        # Outputs a report of pending examples.  This gets invoked
+        # after the summary if option is set to do so.
+        #
+        # @param notification [NullNotification]
+        # @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.
+        #
+        # @param notification [NullNotification]
+      end
+    end
+  end
+end

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

@@ -21,10 +21,12 @@ module RSpec
         begin
           require 'coderay'
+          # rubocop:disable Style/ClassVars
           @@converter = CoderayConverter.new
         rescue LoadError
           @@converter = NullConverter.new
         end
+        # rubocop:enable Style/ClassVars
         # @api private
         #
@@ -50,8 +52,8 @@ module RSpec
         # @see #lines_around
         def snippet_for(error_line)
           if error_line =~ /(.*):(\d+)/
-            file = $1
-            line = $2.to_i
+            file = Regexp.last_match[1]
+            line = Regexp.last_match[2].to_i
             [lines_around(file, line), line]
           else
             ["# Couldn't get snippet for #{error_line}", 1]
@@ -68,8 +70,8 @@ module RSpec
         def lines_around(file, line)
           if File.file?(file)
             lines = File.read(file).split("\n")
-            min = [0, line-3].max
-            max = [line+1, lines.length-1].min
+            min = [0, line - 3].max
+            max = [line + 1, lines.length - 1].min
             selected_lines = []
             selected_lines.join("\n")
             lines[min..max].join("\n")
@@ -90,13 +92,12 @@ module RSpec
         def post_process(highlighted, offending_line)
           new_lines = []
           highlighted.split("\n").each_with_index do |line, i|
-            new_line = "<span class=\"linenum\">#{offending_line+i-2}</span>#{line}"
+            new_line = "<span class=\"linenum\">#{offending_line + i - 2}</span>#{line}"
             new_line = "<span class=\"offending\">#{new_line}</span>" if i == 2
             new_lines << new_line
           end
           new_lines.join("\n")
         end
       end
     end
   end

data/lib/rspec/core/hooks.rb CHANGED

@@ -320,7 +320,8 @@ module RSpec
       # @private
       # Holds the various registered hooks.
       def hooks
-        @hooks ||= HookCollections.new(self,
+        @hooks ||= HookCollections.new(
+          self,
           :around => { :example => AroundHookCollection.new },
           :before => { :example => HookCollection.new, :context => HookCollection.new, :suite => HookCollection.new },
           :after  => { :example => HookCollection.new, :context => HookCollection.new, :suite => HookCollection.new }
@@ -374,7 +375,23 @@ EOS
       end
       # @private
-      AroundHook = Hook
+      class AroundHook < Hook
+        def execute_with(example, procsy)
+          example.instance_exec(procsy, &block)
+          return if procsy.executed?
+          Pending.mark_skipped!(example, "#{hook_description} did not execute the example")
+        end
+        if Proc.method_defined?(:source_location)
+          def hook_description
+            "around hook at #{Metadata.relative_path(block.source_location.join(':'))}"
+          end
+        else
+          def hook_description
+            "around hook"
+          end
+        end
+      end
       # @private
       class BaseHookCollection
@@ -383,7 +400,7 @@ EOS
         end
         attr_reader :hooks
-        protected   :hooks
+        protected :hooks
         alias append push
         alias prepend unshift
@@ -397,7 +414,7 @@ EOS
       class HookCollection < BaseHookCollection
         def for(example_or_group)
           self.class.
-            new(hooks.select {|hook| hook.options_apply?(example_or_group)}).
+            new(hooks.select { |hook| hook.options_apply?(example_or_group) }).
             with(example_or_group)
         end
@@ -407,14 +424,14 @@ EOS
         end
         def run
-          hooks.each {|h| h.run(@example)}
+          hooks.each { |h| h.run(@example) }
         end
       end
       # @private
       class AroundHookCollection < BaseHookCollection
         def for(example, initial_procsy=nil)
-          self.class.new(hooks.select {|hook| hook.options_apply?(example)}).
+          self.class.new(hooks.select { |hook| hook.options_apply?(example) }).
             with(example, initial_procsy)
         end
@@ -426,9 +443,7 @@ EOS
         def run
           hooks.inject(@initial_procsy) do |procsy, around_hook|
-            procsy.wrap do
-              @example.instance_exec(procsy, &around_hook.block)
-            end
+            procsy.wrap { around_hook.execute_with(@example, procsy) }
           end.call
         end
       end
@@ -502,7 +517,7 @@ EOS
         def process(host, globals, position, scope)
           globals[position][scope].each do |hook|
             next unless scope == :example || hook.options_apply?(host)
-            next if host.parent_groups.any? {|a| a.hooks[position][scope].include?(hook)}
+            next if host.parent_groups.any? { |a| a.hooks[position][scope].include?(hook) }
             self[position][scope] << hook
           end
         end

data/lib/rspec/core/memoized_helpers.rb CHANGED

@@ -145,12 +145,12 @@ module RSpec
           end
         end
-        def self.fetch(key, &block)
+        def self.fetch(key, &_block)
           description = if key == :subject
-            "subject"
-          else
-            "let declaration `#{key}`"
-          end
+                          "subject"
+                        else
+                          "let declaration `#{key}`"
+                        end
           raise <<-EOS
 #{description} accessed in #{article} #{hook_expression} hook at:
@@ -310,6 +310,8 @@ EOS
         # implicitly in one-liners and explicitly using an intention revealing
         # name.
         #
+        # When given a `name`, calling `super` in the block is not supported.
+        #
         # @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

data/lib/rspec/core/metadata.rb CHANGED

@@ -46,9 +46,7 @@ module RSpec
       def self.build_hash_from(args, warn_about_example_group_filtering=false)
         hash = args.last.is_a?(Hash) ? args.pop : {}
-        while args.last.is_a?(Symbol)
-          hash[args.pop] = true
-        end
+        hash[args.pop] = true while args.last.is_a?(Symbol)
         if warn_about_example_group_filtering && hash.key?(:example_group)
           RSpec.deprecate("Filtering by an `:example_group` subhash",
@@ -95,13 +93,15 @@ module RSpec
       private
         def populate_location_attributes
-          file_path, line_number = if backtrace = user_metadata.delete(:caller)
-            file_path_and_line_number_from(backtrace)
-          elsif block.respond_to?(:source_location)
-            block.source_location
-          else
-            file_path_and_line_number_from(caller)
-          end
+          backtrace = user_metadata.delete(:caller)
+          file_path, line_number = if backtrace
+                                     file_path_and_line_number_from(backtrace)
+                                   elsif block.respond_to?(:source_location)
+                                     block.source_location
+                                   else
+                                     file_path_and_line_number_from(caller)
+                                   end
           file_path              = Metadata.relative_path(file_path)
           metadata[:file_path]   = file_path
@@ -110,7 +110,7 @@ module RSpec
         end
         def file_path_and_line_number_from(backtrace)
-          first_caller_from_outside_rspec = backtrace.detect { |l| l !~ CallerFilter::LIB_REGEX }
+          first_caller_from_outside_rspec = backtrace.find { |l| l !~ CallerFilter::LIB_REGEX }
           first_caller_from_outside_rspec ||= backtrace.first
           /(.+?):(\d+)(?:|:\d+)/.match(first_caller_from_outside_rspec).captures
         end
@@ -131,22 +131,21 @@ module RSpec
         def ensure_valid_user_keys
           RESERVED_KEYS.each do |key|
-            if user_metadata.has_key?(key)
-              raise <<-EOM.gsub(/^\s+\|/, '')
-                |#{"*"*50}
-                |:#{key} is not allowed
-                |
-                |RSpec reserves some hash keys for its own internal use,
-                |including :#{key}, which is used on:
-                |
-                |  #{CallerFilter.first_non_rspec_line}.
-                |
-                |Here are all of RSpec's reserved hash keys:
-                |
-                |  #{RESERVED_KEYS.join("\n  ")}
-                |#{"*"*50}
-              EOM
-            end
+            next unless user_metadata.key?(key)
+            raise <<-EOM.gsub(/^\s+\|/, '')
+              |#{"*" * 50}
+              |:#{key} is not allowed
+              |
+              |RSpec reserves some hash keys for its own internal use,
+              |including :#{key}, which is used on:
+              |
+              |  #{CallerFilter.first_non_rspec_line}.
+              |
+              |Here are all of RSpec's reserved hash keys:
+              |
+              |  #{RESERVED_KEYS.join("\n  ")}
+              |#{"*" * 50}
+            EOM
           end
         end
       end
@@ -217,8 +216,8 @@ module RSpec
               # 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]
                 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 " +
+                                :replacement => "the example group's hash directly for the " \
+                                "computed keys and `:parent_example_group` to access the parent " \
                                 "example group metadata")
               end
@@ -357,7 +356,7 @@ module RSpec
         to_h
       end
-      def issue_deprecation(method_name, *args)
+      def issue_deprecation(_method_name, *_args)
         # no-op by default: subclasses can override
       end