rspec-core 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a92217ba6e7e8646843f147e18e37e7e0ae135c4
-  data.tar.gz: e4570a04042e8062b594b4fa4ced79df03b7f620
+  metadata.gz: f967099cbbb51b6251a6fb9bcf05ba70638552eb
+  data.tar.gz: d39f0206c2d7d854b9ccf9b6dc445c58ba2b8f73
 SHA512:
-  metadata.gz: 94d1f44cd702b90bd31088dbc28908732b1ab07a92865c1673d3fd2fcc29839794e661bb4dccdcf58bafb17e18129765e036e4df33f7da1de3b7a79208743b84
-  data.tar.gz: 4822312a6d75661ca374adf584af31f940415524bc787a93cd7f5ce99c24400f61f6f096f920f84ca83bbec2800cca45d5b466cf0135baa053b79a2792f7761d
+  metadata.gz: 7053ad7cca8b00f3b74978fd56843ec81669645caf546c0088aab80a5e047383e1be46e688a7882bee80f4de421d9fee78c6c82ce608e1b3abd77b02aa8cf0f4
+  data.tar.gz: e17b394645c54f8ee66e43620d8aedca1284732ca9f30c5a4de91dc9f17f0c0bb992f1f9c2ce01e825d04baf60f59cf7a6a997983e79aae452df1517d4bdcd49

data/.document

@@ -1,5 +1,5 @@
 lib/**/*.rb
 -
 README.md
-License.txt
+LICENSE.md
 Changelog.md

data/.yardopts

@@ -5,4 +5,4 @@
 -
 Filtering.md
 Changelog.md
-License.txt
+LICENSE.md

data/Changelog.md

@@ -1,3 +1,91 @@
+### 3.4.0 / 2015-11-11
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.3.2...v3.4.0)
+
+Enhancements:
+
+* Combine multiple `--pattern` arguments making them equivalent to
+  `--pattern=1,2,...,n`. (Jon Rowe, #2002)
+* Improve `inspect` and `to_s` output for `RSpec::Core::Example`
+  objects, replacing Ruby's excessively verbose output. (Gavin Miller, #1922)
+* Add `silence_filter_announcements` configuration option.
+  (David Raffensperger, #2007)
+* Add optional `example_finished` notification to the reporter protocol for
+  when you don't care about the example outcome. (Jon Rowe, #2013)
+* Switch `--bisect` to a recursion-based bisection algorithm rather than
+  a permutation-based one. This better handles cases where an example
+  depends upon multiple other examples instead of just one and minimizes
+  the number of runs necessary to determine that an example set cannot be
+  minimized further. (Simon Coffey, #1997)
+* Allow simple filters (e.g. `:symbol` key only) to be triggered by truthey
+  values. (Tim Mertens, #2035)
+* Remove unneeded warning about need for `ansicon` on Windows when using
+  RSpec's `--color` option. (Ashley Engelund, #2038)
+* Add option to configure RSpec to raise errors when issuing warnings.
+  (Jon Rowe, #2052)
+* Append the root `cause` of a failure or error to the printed failure
+  output when a `cause` is available. (Adam Magan)
+* Stop rescuing `NoMemoryError`, `SignalExcepetion`, `Interrupt` and
+  `SystemExit`. It is dangerous to interfere with these. (Myron Marston, #2063)
+* Add `config.project_source_dirs` setting which RSpec uses to determine
+  if a backtrace line comes from your project source or from some
+  external library. It defaults to `spec`, `lib` and `app` but can be
+  configured differently. (Myron Marston, #2088)
+* Improve failure line detection so that it looks for the failure line
+  in any project source directory instead of just in the spec file.
+  In addition, if no backtrace lines can be found from a project source
+  file, we fall back to displaying the source of the first backtrace
+  line. This should virtually eliminate the "Unable to find matching
+  line from backtrace" messages. (Myron Marston, #2088)
+* Add support for `:extra_failure_lines` example metadata that will
+  be appended to the failure output. (bootstraponline, #2092).
+* Add `RSpec::Core::Example#duplicate_with` to produce new examples
+  with cloned metadata. (bootstraponline, #2098)
+* Add `RSpec::Core::Configuration#on_example_group_definition` to register
+  hooks to be invoked when example groups are created. (bootstraponline, #2094)
+* Add `add_example` and `remove_example` to `RSpec::Core::ExampleGroup` to
+  allow  manipulating an example groups examples. (bootstraponline, #2095)
+* Display multiline failure source lines in failure output when Ripper is
+  available (MRI >= 1.9.2, and JRuby >= 1.7.5 && < 9.0.0.0.rc1).
+  (Yuji Nakayama, #2083)
+* Add `max_displayed_failure_line_count` configuration option
+  (defaults to 10). (Yuji Nakayama, #2083)
+* Enhance `fail_fast` option so it can take a number (e.g. `--fail-fast=3`)
+  to force the run to abort after the specified number of failures.
+  (Jack Scotti, #2065)
+* Syntax highlight the failure snippets in text formatters when `color`
+  is enabled and the `coderay` gem is installed on a POSIX system.
+  (Myron Marston, #2109)
+
+Bug Fixes:
+
+* Lock `example_status_persistence_file` when reading from and writing
+  to it to prevent race conditions when multiple processes try to use
+  it. (Ben Woosley, #2029)
+* Fix regression in 3.3 that caused spec file names with square brackets in
+  them (such as `1[]_spec.rb`) to not be loaded properly. (Myron Marston, #2041)
+* Fix output encoding issue caused by ASCII literal on 1.9.3 (Jon Rowe, #2072)
+* Fix requires in `rspec/core/rake_task.rb` to avoid double requires
+  seen by some users. (Myron Marston, #2101)
+
+### 3.3.2 / 2015-07-15
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.3.1...v3.3.2)
+
+Bug Fixes:
+
+* Fix formatters to handle exceptions for which `backtrace` returns `nil`.
+  (Myron Marston, #2023)
+* Fix duplicate formatter detection so that it allows subclasses of formatters
+  to be added. (Sebastián Tello, #2019)
+
+### 3.3.1 / 2015-06-18
+[Full Changelog](http://github.com/rspec/rspec-core/compare/v3.3.0...v3.3.1)
+
+Bug Fixes:
+
+* Correctly run `before(:suite)` (and friends) in the context of an example
+  group instance, thus making the expected RSpec environment available.
+  (Jon Rowe, #1986)
+
 ### 3.3.0 / 2015-06-12
 [Full Changelog](http://github.com/rspec/rspec-core/compare/v3.2.3...v3.3.0)
 

data/{License.txt → LICENSE.md}

@@ -1,9 +1,10 @@
-(The MIT License)
+The MIT License (MIT)
+=====================
 
-Copyright (c) 2012 Chad Humphries, David Chelimsky, Myron Marston
-Copyright (c) 2009 Chad Humphries, David Chelimsky
-Copyright (c) 2006 David Chelimsky, The RSpec Development Team
-Copyright (c) 2005 Steven Baker
+* Copyright © 2012 Chad Humphries, David Chelimsky, Myron Marston
+* Copyright © 2009 Chad Humphries, David Chelimsky
+* Copyright © 2006 David Chelimsky, The RSpec Development Team
+* Copyright © 2005 Steven Baker
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -19,6 +19,20 @@ RSpec repos as well. Add the following to your `Gemfile`:
 end
 ```
 
+## Contributing
+
+Once you've set up the environment, you'll need to cd into the working
+directory of whichever repo you want to work in. From there you can run the
+specs and cucumber features, and make patches.
+
+NOTE: You do not need to use rspec-dev to work on a specific RSpec repo. You
+can treat each RSpec repo as an independent project.
+
+* [Build details](BUILD_DETAIL.md)
+* [Code of Conduct](CODE_OF_CONDUCT.md)
+* [Detailed contributing guide](CONTRIBUTING.md)
+* [Development setup guide](DEVELOPMENT.md)
+
 ## Basic Structure
 
 RSpec uses the words "describe" and "it" so we can express concepts like a conversation:
@@ -364,6 +378,7 @@ Finished in 0.000379 seconds
 
 ## Also see
 
-* [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
-* [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)
-* [http://github.com/rspec/rspec-mocks](http://github.com/rspec/rspec-mocks)
+* [https://github.com/rspec/rspec](https://github.com/rspec/rspec)
+* [https://github.com/rspec/rspec-expectations](https://github.com/rspec/rspec-expectations)
+* [https://github.com/rspec/rspec-mocks](https://github.com/rspec/rspec-mocks)
+* [https://github.com/rspec/rspec-rails](https://github.com/rspec/rspec-rails)

data/lib/rspec/core/bisect/example_minimizer.rb

@@ -1,5 +1,3 @@
-RSpec::Support.require_rspec_core "bisect/subset_enumerator"
-
 module RSpec
   module Core
     module Bisect
@@ -18,20 +16,65 @@ module RSpec
         def find_minimal_repro
           prep
 
-          self.remaining_ids = non_failing_example_ids
+          _, duration = track_duration do
+            bisect(non_failing_example_ids)
+          end
+
+          notify(:bisect_complete, :duration => duration,
+                                   :original_non_failing_count => non_failing_example_ids.size,
+                                   :remaining_count => remaining_ids.size)
+
+          remaining_ids + failed_example_ids
+        end
+
+        def bisect(candidate_ids)
+          notify(:bisect_dependency_check_started)
+          if get_expected_failures_for?([])
+            notify(:bisect_dependency_check_failed)
+            self.remaining_ids = []
+            return
+          end
+          notify(:bisect_dependency_check_passed)
+
+          bisect_over(candidate_ids)
+        end
+
+        def bisect_over(candidate_ids)
+          return if candidate_ids.one?
+
+          notify(
+            :bisect_round_started,
+            :candidate_range => example_range(candidate_ids),
+            :candidates_count => candidate_ids.size
+          )
 
-          each_bisect_round do |subsets|
-            ids_to_ignore = subsets.find do |ids|
+          slice_size = (candidate_ids.length / 2.0).ceil
+          lhs, rhs = candidate_ids.each_slice(slice_size).to_a
+
+          ids_to_ignore, duration = track_duration do
+            [lhs, rhs].find do |ids|
               get_expected_failures_for?(remaining_ids - ids)
             end
+          end
 
-            next :done unless ids_to_ignore
-
+          if ids_to_ignore
             self.remaining_ids -= ids_to_ignore
-            notify(:bisect_ignoring_ids, :ids_to_ignore => ids_to_ignore, :remaining_ids => remaining_ids)
+            notify(
+              :bisect_round_ignoring_ids,
+              :ids_to_ignore => ids_to_ignore,
+              :ignore_range => example_range(ids_to_ignore),
+              :remaining_ids => remaining_ids,
+              :duration => duration
+            )
+            bisect_over(candidate_ids - ids_to_ignore)
+          else
+            notify(
+              :bisect_round_detected_multiple_culprits,
+              :duration => duration
+            )
+            bisect_over(lhs)
+            bisect_over(rhs)
           end
-
-          currently_needed_ids
         end
 
         def currently_needed_ids
@@ -43,8 +86,27 @@ module RSpec
           "(Not yet enough information to provide any repro command)"
         end
 
+        # @private
+        # Convenience class for describing a subset of the candidate examples
+        ExampleRange = Struct.new(:start, :finish) do
+          def description
+            if start == finish
+              "example #{start}"
+            else
+              "examples #{start}-#{finish}"
+            end
+          end
+        end
+
       private
 
+        def example_range(ids)
+          ExampleRange.new(
+            non_failing_example_ids.find_index(ids.first) + 1,
+            non_failing_example_ids.find_index(ids.last) + 1
+          )
+        end
+
         def prep
           notify(:bisect_starting, :original_cli_args => runner.original_cli_args)
 
@@ -52,6 +114,7 @@ module RSpec
             original_results    = runner.original_results
             @all_example_ids    = original_results.all_example_ids
             @failed_example_ids = original_results.failed_example_ids
+            @remaining_ids      = non_failing_example_ids
           end
 
           if @failed_example_ids.empty?
@@ -70,7 +133,11 @@ module RSpec
 
         def get_expected_failures_for?(ids)
           ids_to_run = ids + failed_example_ids
-          notify(:bisect_individual_run_start, :command => runner.repro_command_from(ids_to_run))
+          notify(
+            :bisect_individual_run_start,
+            :command => runner.repro_command_from(ids_to_run),
+            :ids_to_run => ids_to_run
+          )
 
           results, duration = track_duration { runner.run(ids_to_run) }
           notify(:bisect_individual_run_complete, :duration => duration, :results => results)
@@ -79,34 +146,6 @@ module RSpec
           (failed_example_ids & results.failed_example_ids) == failed_example_ids
         end
 
-        INFINITY = (1.0 / 0) # 1.8.7 doesn't define Float::INFINITY so we define our own...
-
-        def each_bisect_round(&block)
-          last_round, duration = track_duration do
-            1.upto(INFINITY) do |round|
-              break if :done == bisect_round(round, &block)
-            end
-          end
-
-          notify(:bisect_complete, :round => last_round, :duration => duration,
-                                   :original_non_failing_count => non_failing_example_ids.size,
-                                   :remaining_count => remaining_ids.size)
-        end
-
-        def bisect_round(round)
-          value, duration = track_duration do
-            subsets = SubsetEnumerator.new(remaining_ids)
-            notify(:bisect_round_started, :round => round,
-                                          :subset_size => subsets.subset_size,
-                                          :remaining_count => remaining_ids.size)
-
-            yield subsets
-          end
-
-          notify(:bisect_round_finished, :duration => duration, :round => round)
-          value
-        end
-
         def track_duration
           start = ::RSpec::Core::Time.now
           [yield, ::RSpec::Core::Time.now - start]

data/lib/rspec/core/configuration.rb

@@ -4,7 +4,7 @@ RSpec::Support.require_rspec_core "formatters/deprecation_formatter"
 
 module RSpec
   module Core
-    # rubocop:disable Style/ClassLength
+    # rubocop:disable Metrics/ClassLength
 
     # Stores runtime configuration information.
     #
@@ -100,7 +100,11 @@ module RSpec
       #
       # @note Other scripts invoking `rspec` indirectly will ignore this
       #   setting.
-      add_setting :default_path
+      add_read_only_setting :default_path
+      def default_path=(path)
+        project_source_dirs << path
+        @default_path = path
+      end
 
       # @macro add_setting
       # Run examples over DRb (default: `false`). RSpec doesn't supply the DRb
@@ -182,7 +186,8 @@ module RSpec
       end
 
       # @macro add_setting
-      # Clean up and exit after the first failure (default: `false`).
+      # If specified, indicates the number of failures required before cleaning
+      # up and exit (default: `nil`).
       add_setting :fail_fast
 
       # @macro add_setting
@@ -241,6 +246,16 @@ module RSpec
         update_pattern_attr :exclude_pattern, value
       end
 
+      # @macro add_setting
+      # Specifies which directories contain the source code for your project.
+      # When a failure occurs, RSpec looks through the backtrace to find a
+      # a line of source to print. It first looks for a line coming from
+      # one of the project source directories so that, for example, it prints
+      # the expectation or assertion call rather than the source code from
+      # the expectation or assertion framework.
+      # @return [Array<String>]
+      add_setting :project_source_dirs
+
       # @macro add_setting
       # Report the times for the slowest examples (default: `false`).
       # Use this to specify the number of examples to include in the profile.
@@ -293,6 +308,11 @@ module RSpec
       #   :cyan]`
       add_setting :detail_color
 
+      # @macro add_setting
+      # Don't print filter info i.e. "Run options: include {:focus=>true}"
+      # (default `false`).
+      add_setting :silence_filter_announcements
+
       # Deprecated. This config option was added in RSpec 2 to pave the way
       # for this being the default behavior in RSpec 3. Now this option is
       # a no-op.
@@ -313,6 +333,11 @@ module RSpec
       # Currently this will place a mutex around memoized values such as let blocks.
       add_setting :threadsafe
 
+      # @macro add_setting
+      # Maximum count of failed source lines to display in the failure reports.
+      # (default `10`).
+      add_setting :max_displayed_failure_line_count
+
       # @private
       add_setting :tty
       # @private
@@ -348,6 +373,7 @@ module RSpec
         @backtrace_formatter = BacktraceFormatter.new
 
         @default_path = 'spec'
+        @project_source_dirs = %w[ spec lib app ]
         @deprecation_stream = $stderr
         @output_stream = $stdout
         @reporter = nil
@@ -367,6 +393,7 @@ module RSpec
         @libs = []
         @derived_metadata_blocks = FilterableItemRepository::QueryOptimized.new(:any?)
         @threadsafe = true
+        @max_displayed_failure_line_count = 10
 
         define_built_in_hooks
       end
@@ -575,7 +602,7 @@ module RSpec
           end
 
         new_name, old_name = [framework_module, @mock_framework].map do |mod|
-          mod.respond_to?(:framework_name) ?  mod.framework_name : :unnamed
+          mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed
         end
 
         unless new_name == old_name
@@ -703,19 +730,7 @@ module RSpec
       end
 
       # Toggle output color.
-      # @attr true_or_false [Boolean] toggle color enabled
-      def color=(true_or_false)
-        return unless true_or_false
-
-        if RSpec::Support::OS.windows? && !ENV['ANSICON']
-          RSpec.warning "You must use ANSICON 1.31 or later " \
-                        "(http://adoxa.3eeweb.com/ansicon/) to use colour " \
-                        "on Windows"
-          @color = false
-        else
-          @color = true
-        end
-      end
+      attr_writer :color
 
       # @private
       def libs=(libs)
@@ -881,7 +896,7 @@ module RSpec
       # @private
       def spec_files_with_failures
         @spec_files_with_failures ||= last_run_statuses.inject(Set.new) do |files, (id, status)|
-          files << id.split(ON_SQUARE_BRACKETS).first if status == FAILED_STATUS
+          files << Example.parse_id(id).first if status == FAILED_STATUS
           files
         end.to_a
       end
@@ -1281,6 +1296,15 @@ module RSpec
         @requires += paths
       end
 
+      # @private
+      def in_project_source_dir_regex
+        regexes = project_source_dirs.map do |dir|
+          /\A#{Regexp.escape(File.expand_path(dir))}\//
+        end
+
+        Regexp.union(regexes)
+      end
+
       # @private
       if RUBY_VERSION.to_f >= 1.9
         # @private
@@ -1322,6 +1346,16 @@ module RSpec
 
       # @private
       def load_spec_files
+        # Note which spec files world is already aware of.
+        # This is generally only needed for when the user runs
+        # `ruby path/to/spec.rb` (and loads `rspec/autorun`) --
+        # in that case, the spec file was loaded by `ruby` and
+        # isn't loaded by us here so we only know about it because
+        # of an example group being registered in it.
+        RSpec.world.registered_example_group_files.each do |f|
+          loaded_spec_files << f # the registered files are already expended absolute paths
+        end
+
         files_to_run.uniq.each do |f|
           file = File.expand_path(f)
           load file
@@ -1428,6 +1462,25 @@ module RSpec
         $VERBOSE
       end
 
+      # @private
+      RAISE_ERROR_WARNING_NOTIFIER = lambda { |message| raise message }
+
+      # Turns warnings into errors. This can be useful when
+      # you want RSpec to run in a 'strict' no warning situation.
+      #
+      # @example
+      #
+      #   RSpec.configure do |rspec|
+      #     rspec.raise_on_warning = true
+      #   end
+      def raise_on_warning=(value)
+        if value
+          RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER
+        else
+          RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER
+        end
+      end
+
       # Exposes the current running example via the named
       # helper method. RSpec 2.x exposed this via `example`,
       # but in RSpec 3.0, the example is instead exposed via
@@ -1638,6 +1691,17 @@ module RSpec
         @hooks ||= HookCollections.new(self, FilterableItemRepository::QueryOptimized)
       end
 
+      # Invokes block before defining an example group
+      def on_example_group_definition(&block)
+        on_example_group_definition_callbacks << block
+      end
+
+      # @api private
+      # Returns an array of blocks to call before defining an example group
+      def on_example_group_definition_callbacks
+        @on_example_group_definition_callbacks ||= []
+      end
+
     private
 
       def handle_suite_hook(args, collection, append_or_prepend, hook_type, block)
@@ -1714,18 +1778,16 @@ module RSpec
         end
       end
 
-      # @private
-      ON_SQUARE_BRACKETS = /[\[\]]/
-
       def extract_location(path)
         match = /^(.*?)((?:\:\d+)+)$/.match(path)
 
         if match
           captures = match.captures
-          path, lines = captures[0], captures[1][1..-1].split(":").map { |n| n.to_i }
+          path = captures[0]
+          lines = captures[1][1..-1].split(":").map(&:to_i)
           filter_manager.add_location path, lines
         else
-          path, scoped_ids = path.split(ON_SQUARE_BRACKETS)
+          path, scoped_ids = Example.parse_id(path)
           filter_manager.add_ids(path, scoped_ids.split(/\s*,\s*/)) if scoped_ids
         end
 
@@ -1745,7 +1807,7 @@ module RSpec
         around(:example, :aggregate_failures => true) do |procsy|
           begin
             aggregate_failures(nil, :hide_backtrace => true, &procsy)
-          rescue Exception => exception
+          rescue Support::AllExceptionsExceptOnesWeMustNotRescue => exception
             procsy.example.set_aggregate_failures_exception(exception)
           end
         end
@@ -1802,6 +1864,6 @@ module RSpec
         @spec_files_with_failures = nil
       end
     end
-    # rubocop:enable Style/ClassLength
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rspec/core/configuration_options.rb

@@ -64,7 +64,7 @@ module RSpec
       end
 
       def order(keys)
-        OPTIONS_ORDER.reverse.each do |key|
+        OPTIONS_ORDER.reverse_each do |key|
           keys.unshift(key) if keys.delete(key)
         end
         keys