rspec-core 3.6.0.beta1 → 3.6.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9750d19aad7f7ef5eb954f4f6a9bc4730d7a09c7
-  data.tar.gz: 64fe3413f9233665ca9e9ed11f08c0053b3024c9
+  metadata.gz: cedf9914463a5f8470ddb33bef491f31615a7b63
+  data.tar.gz: 8eecab50a480c797c96f53932f955643f23db6eb
 SHA512:
-  metadata.gz: 4565a663755384105496c948d14b93fa0bc8fb752ac3e2f2c201f42c5c463ac19cccbf3cddc8cdf025b337d46f361e8fc9a385fd5ffb5be3eaa02804a937c132
-  data.tar.gz: eb1bb367afa8fd11bfb7e838df3fe933edff6a4bdfaa0b649ccbc9ce24b294ac1a94e37bd51c01b8522c816ba8ad0ea3a99bd0aaeebd99c49c6b96928c6093d9
+  metadata.gz: a162b44414bcbd3ac23ee749f456976c10858bc84b8703a4ef63f370fcf8a691b7366ef8a9d0d2e15f7cecea6f38ce78379da1a25be1f75bf09ea9e913aa4939
+  data.tar.gz: f9a9b8815b6a42d5da60f033443dbf145b025058a6ec327c8a16fde556c83a753b1ed2bfd54ae85e02772fa54e8d7169c7323e034622b52ffbd9e3eab0826841

data/Changelog.md

@@ -1,3 +1,14 @@
+### 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)
 

data/lib/rspec/core/configuration.rb

@@ -850,19 +850,22 @@ module RSpec
       end
 
       # @overload add_formatter(formatter)
-      #
-      # 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.
-      #
-      # ### Note
-      #
-      # 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
+      # @overload add_formatter(formatter, output)
+      #
+      # @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.
+      #
+      # Adds a formatter to the set RSpec will use for this run.
+      #
+      # @see RSpec::Core::Formatters::Protocol
+      def add_formatter(formatter, output=output_stream)
+        formatter_loader.add(formatter, output)
       end
       alias_method :formatter=, :add_formatter
 

data/lib/rspec/core/example_group.rb

@@ -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

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

@@ -346,7 +346,10 @@ module RSpec
 
                 failure   = common_backtrace_truncater.with_truncated_backtrace(failure)
                 presenter = ExceptionPresenter.new(failure, @example, options)
-                presenter.fully_formatted_lines("#{failure_number}.#{index + 1}", colorizer)
+                presenter.fully_formatted_lines(
+                  "#{failure_number ? "#{failure_number}." : ''}#{index + 1}",
+                  colorizer
+                )
               end
             end
           end

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

@@ -69,10 +69,12 @@ module RSpec
           example = failure.example
 
           exception = failure.exception
+          message_lines = failure.fully_formatted_lines(nil, RSpec::Core::Notifications::NullColorizer)
           exception_details = if exception
                                 {
-                                  :message => failure.message_lines.join("\n"),
-                                  :backtrace => failure.formatted_backtrace.join("\n")
+                                  # drop 2 removes the description (regardless of newlines) and leading blank line
+                                  :message => message_lines.drop(2).join("\n"),
+                                  :backtrace => failure.formatted_backtrace.join("\n"),
                                 }
                               end
           extra = extra_failure_content(failure)

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

@@ -24,6 +24,8 @@ module RSpec
         @@converter = NullConverter
         begin
           require 'coderay'
+          RSpec::Support.require_rspec_core 'source/syntax_highlighter'
+          RSpec::Core::Source::SyntaxHighlighter.attempt_to_add_rspec_terms_to_coderay_keywords
           @@converter = CoderayConverter
           # rubocop:disable Lint/HandleExceptions
         rescue LoadError

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,7 +165,7 @@ 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
@@ -174,7 +174,7 @@ module RSpec
         # Invoked at the very end, `close` allows the formatter to clean
         # up resources, e.g. open streams, etc.
         #
-        # @param notification [NullNotification]
+        # @param notification [Notifications::NullNotification]
       end
     end
   end

data/lib/rspec/core/notifications.rb

@@ -200,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)
@@ -281,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
@@ -308,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
 

data/lib/rspec/core/reporter.rb

@@ -18,6 +18,7 @@ module RSpec::Core
       @failed_examples = []
       @pending_examples = []
       @duration = @start = @load_time = nil
+      @non_example_exception_count = 0
     end
 
     # @private
@@ -157,6 +158,7 @@ module RSpec::Core
     # 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 +179,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

data/lib/rspec/core/shared_example_group.rb

@@ -153,6 +153,12 @@ module RSpec
       # @private
       class Registry
         def add(context, name, *metadata_args, &block)
+          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 RSpec.configuration.shared_context_metadata_behavior == :trigger_inclusion
             return legacy_add(context, name, *metadata_args, &block)
           end

data/lib/rspec/core/source/syntax_highlighter.rb

@@ -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/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.6.0.beta1'
+      STRING = '3.6.0.beta2'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-core
 version: !ruby/object:Gem::Version
-  version: 3.6.0.beta1
+  version: 3.6.0.beta2
 platform: ruby
 authors:
 - Steven Baker
@@ -46,7 +46,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-support
@@ -54,14 +54,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.0.beta1
+        version: 3.6.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.0.beta1
+        version: 3.6.0.beta2
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -280,9 +280,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: rspec-core-3.6.0.beta1
+summary: rspec-core-3.6.0.beta2
 test_files: []
 has_rdoc: