rspec-support 3.0.4 → 3.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 71ada7066e53a0b40d343dd8f26528715c2fbf24
-  data.tar.gz: 712553112d6764d89e35fa1a1657a268f16d2d83
+SHA256:
+  metadata.gz: cd43ff0da6f307b7e9ccc56ceb9e3fdd972f27b7d160b8ba860c6625bb62f39b
+  data.tar.gz: a0c09feee171d7a1b02793888c995d9dd42f20660b6449db9c79eeed4a297b3f
 SHA512:
-  metadata.gz: 2e5ffa54dcf62a550f3b87fdbfb1c548e2db1ac97f70a5b3608c9c51955fd81b496738b37050e991987788b32bbdd8d76179ef86fa091e99437593c34145947d
-  data.tar.gz: a394b169979e054239c96ec27a10326f96273098ae993159a78c9db9e72f2fbc1ea334c3513f73d48b39771f47f31f16a339824c1ce602ea913230d0800fd0a8
+  metadata.gz: 247e3e818ef3c367c1ecbc4938dca5a0ca7c9b185c1b608900461e146ea1f8c5053e0d97adc692cd0871debeb764407a3403682ce425aebf1de6511f17f366fc
+  data.tar.gz: b3b600ca9061f37b529af60308df73b4c9724de1d173ee01eda44c0f61404396d8f2af7a52b071db93299bb607905e8b1aa3ddac29cc364ef41136a1815735d1

data/Changelog.md

@@ -1,3 +1,325 @@
+### Development
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.12.1...3-12-maintenance)
+
+### 3.12.1 / 2023-06-26
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.12.0...v3.12.1)
+
+Bug Fixes:
+
+* Fix `RSpec::Support.thread_local_data` to be Thread local but not Fiber local.
+  (Jon Rowe, #581)
+
+### 3.12.0 / 2022-10-26
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.11.1...v3.12.0)
+Enhancements:
+
+* Add `RSpec::Support::RubyFeatures.distincts_kw_args_from_positional_hash?`
+  (Jean byroot Boussier, #535)
+
+### 3.11.1 / 2022-09-12
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.11.0...v3.11.1)
+
+Bug Fixes:
+
+* Fix ripper detection on TruffleRuby. (Brandon Fish, #541)
+
+### 3.11.0 / 2022-02-09
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.10.3...v3.11.0)
+
+No changes. Released to support other RSpec releases.
+
+### 3.10.3 / 2021-11-03
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.10.2...v3.10.3)
+
+Bug Fixes:
+
+* Use `Mutex#owned?` to allow `RSpec::Support::ReentrantMutex` to work in
+  nested Fibers on Ruby 3.0 and later. (Benoit Daloze, #503, #504)
+* Support `end`-less methods in `RSpec::Support::Source::Token`
+  so that RSpec won't hang when an `end`-less method raises an error. (Yuji Nakayama, #505)
+
+### 3.10.2 / 2021-01-28
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.10.1...v3.10.2)
+
+Bug Fixes:
+
+* Fix issue with `RSpec::Support.define_optimized_require_for_rspec` on JRuby
+  9.1.17.0 (Jon Rowe, #492)
+
+### 3.10.1 / 2020-12-27
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.10.0...v3.10.1)
+
+Bug Fixes:
+
+* Fix deprecation expectations to fail correctly when
+  asserting on messages. (Phil Pirozhkov, #453)
+
+### 3.10.0 / 2020-10-30
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.9.4...v3.10.0)
+
+No changes. Released to support other RSpec releases.
+
+### 3.9.4 / 2020-10-23
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.9.3...v3.9.4)
+
+Bug Fixes:
+
+* Flag ripper as supported on Truffle Ruby. (Brandon Fish, #427)
+* Prevent stubbing `File.read` from breaking source extraction.
+  (Jon Rowe, #431)
+
+### 3.9.3 / 2020-05-02
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.9.2...v3.9.3)
+
+Bug Fixes:
+
+* Mark ripper as unsupported on Truffle Ruby. (Brandon Fish, #395)
+* Mark ripper as unsupported on JRuby 9.2.0.0. (Brian Hawley, #400)
+* Capture `Mutex.new` for our `RSpec::Support:Mutex` in order to
+  allow stubbing `Mutex.new`. (Jon Rowe, #411)
+
+### 3.9.2 / 2019-12-30
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.9.1...v3.9.2)
+
+Bug Fixes:
+
+* Remove unneeded eval. (Matijs van Zuijlen, #394)
+
+### 3.9.1 / 2019-12-28
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.9.0...v3.9.1)
+
+Bug Fixes:
+
+* Remove warning caused by keyword arguments on Ruby 2.7.0.
+  (Jon Rowe, #392)
+
+### 3.9.0 / 2019-10-07
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.8.3...v3.9.0)
+
+*NO CHANGES*
+
+Version 3.9.0 was released to allow other RSpec gems to release 3.9.0.
+
+### 3.8.3 / 2019-10-02
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.8.2...v3.8.3)
+
+Bug Fixes:
+
+* Escape \r when outputting strings inside arrays.
+  (Tomita Masahiro, Jon Rowe, #378)
+* Ensure that optional hash arguments are recognised correctly vs keyword
+  arguments. (Evgeni Dzhelyov, #366)
+
+### 3.8.2 / 2019-06-10
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.8.1...v3.8.2)
+
+Bug Fixes:
+
+* Ensure that an empty hash is recognised as empty keyword arguments when
+  applicable. (Thomas Walpole, #375)
+* Ensure that diffing truthy values produce diffs consistently.
+  (Lucas Nestor, #377)
+
+### 3.8.1 / 2019-03-03
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.8.0...v3.8.1)
+
+Bug Fixes:
+
+* Ensure that inspecting a `SimpleDelegator` based object works regardless of
+  visibilty of the `__getobj__` method. (Jon Rowe, #369)
+
+### 3.8.0 / 2018-08-04
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.7.1...v3.8.0)
+
+Bug Fixes:
+
+* Order hash keys before diffing to improve diff accuracy when using mocked calls.
+  (James Crisp, #334)
+
+### 3.7.1 / 2018-01-29
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.7.0...v3.7.1)
+
+Bug Fixes:
+
+* Fix source extraction logic so that it does not trigger a `SystemStackError`
+  when processing deeply nested example groups. (Craig Bass, #343)
+
+### 3.7.0 / 2017-10-17
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.6.0...v3.7.0)
+
+Enhancements:
+
+* Improve compatibility with `--enable-frozen-string-literal` option
+  on Ruby 2.3+. (Pat Allan, #320)
+* Add `Support.class_of` for extracting class of any object.
+  (Yuji Nakayama, #325)
+
+Bug Fixes:
+
+* Fix recursive const support to not blow up when given buggy classes
+  that raise odd errors from `#to_str`. (Myron Marston, #317)
+
+### 3.6.0 / 2017-05-04
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.6.0.beta2...3.6.0)
+
+Enhancements:
+
+* Import `Source` classes from rspec-core. (Yuji Nakayama, #315)
+
+### 3.6.0.beta2 / 2016-12-12
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.6.0.beta1...v3.6.0.beta2)
+
+No user-facing changes.
+
+### 3.6.0.beta1 / 2016-10-09
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.5.0...v3.6.0.beta1)
+
+Bug Fixes:
+
+* Prevent truncated formatted object output from mangling console codes. (#294, Anson Kelly)
+
+### 3.5.0 / 2016-07-01
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.5.0.beta4...v3.5.0)
+
+**No user facing changes since beta4**
+
+### 3.5.0.beta4 / 2016-06-05
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.5.0.beta3...v3.5.0.beta4)
+
+Enhancements:
+* Improve `MethodSignature` to better support keyword arguments. (#250, Rob Smith).
+
+### 3.5.0.beta3 / 2016-04-02
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.5.0.beta2...v3.5.0.beta3)
+
+Bug Fixes:
+
+* Fix `EncodedString` to properly handle the behavior of `String#split`
+  on JRuby when the string contains invalid bytes. (Jon Rowe, #268)
+* Fix `ObjectFormatter` so that formatting objects that don't respond to
+  `#inspect` (such as `BasicObject`) does not cause `NoMethodError`.
+  (Yuji Nakayama, #269)
+* Fix `ObjectFormatter` so that formatting recursive array or hash does not
+  cause `SystemStackError`. (Yuji Nakayama, #270, #272)
+
+### 3.5.0.beta2 / 2016-03-10
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.5.0.beta1...v3.5.0.beta2)
+
+No user-facing changes.
+
+### 3.5.0.beta1 / 2016-02-06
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.4.1...v3.5.0.beta1)
+
+Enhancements:
+
+* Improve formatting of objects by allowing truncation to a pre-configured length.
+  (Liam M, #256)
+
+### 3.4.1 / 2015-11-20
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.4.0...v3.4.1)
+
+Bug Fixes:
+
+* Fix `RSpec::Support::RubyFeature.ripper_supported?` so it returns
+  `false` on Rubinius since the Rubinius team has no plans to support
+  it. This prevents rspec-core from trying to load and use ripper to
+  extract failure snippets. (Aaron Stone, #251)
+
+Changes:
+
+* Remove `VersionChecker` in favor of `ComparableVersion`. (Yuji Nakayama, #266)
+
+### 3.4.0 / 2015-11-11
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.3.0...v3.4.0)
+
+Enhancements:
+
+* Improve formatting of `Delegator` based objects (e.g. `SimpleDelgator`) in
+  failure messages and diffs. (Andrew Horner, #215)
+* Add `ComparableVersion`. (Yuji Nakayama, #245)
+* Add `Ripper` support detection. (Yuji Nakayama, #245)
+
+Bug Fixes:
+
+* Work around bug in JRuby that reports that `attr_writer` methods
+  have no parameters, causing RSpec's verifying doubles to wrongly
+  fail when mocking or stubbing a writer method on JRuby. (Myron Marston, #225)
+
+### 3.3.0 / 2015-06-12
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.2.2...v3.3.0)
+
+Enhancements:
+
+* Improve formatting of arrays and hashes in failure messages so they
+  use our custom formatting of matchers, time objects, etc.
+  (Myron Marston, Nicholas Chmielewski, #205)
+* Use improved formatting for diffs as well. (Nicholas Chmielewski, #205)
+
+Bug Fixes:
+
+* Fix `FuzzyMatcher` so that it checks `expected == actual` rather than
+  `actual == expected`, which avoids errors in situations where the
+  `actual` object's `==` is improperly implemented to assume that only
+  objects of the same type will be given. This allows rspec-mocks'
+  `anything` to match against objects with buggy `==` definitions.
+  (Myron Marston, #193)
+
+### 3.2.2 / 2015-02-23
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.2.1...v3.2.2)
+
+Bug Fixes:
+
+* Fix an encoding issue with `EncodedString#split` when encountering an
+  invalid byte string. (Benjamin Fleischer, #1760)
+
+### 3.2.1 / 2015-02-04
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.2.0...v3.2.1)
+
+Bug Fixes:
+
+* Fix `RSpec::CallerFilter` to work on Rubinius 2.2.
+  (Myron Marston, #169)
+
+### 3.2.0 / 2015-02-03
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.1.2...v3.2.0)
+
+Enhancements:
+
+* Add extra Ruby type detection. (Jon Rowe, #133)
+* Make differ instance re-usable. (Alexey Fedorov, #160)
+
+Bug Fixes:
+
+* Do not consider `[]` and `{}` to match when performing fuzzy matching.
+  (Myron Marston, #157)
+
+### 3.1.2 / 2014-10-08
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.1.1...v3.1.2)
+
+Bug Fixes:
+
+* Fix method signature to not blow up with a `NoMethodError` on 1.8.7 when
+  verifying against an RSpec matcher. (Myron Marston, #116)
+
+### 3.1.1 / 2014-09-26
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.1.0...v3.1.1)
+
+Bug Fixes:
+
+* Fix `RSpec::Support::DirectoryMaker` (used by `rspec --init` and
+  `rails generate rspec:install`) so that it detects absolute paths
+   on Windows properly. (Scott Archer, #107, #108, #109) (Jon Rowe, #110)
+
+### 3.1.0 / 2014-09-04
+[Full Changelog](http://github.com/rspec/rspec-support/compare/v3.0.4...v3.1.0)
+
+Bug Fixes:
+
+* Fix `FuzzyMatcher` so that it does not wrongly match a struct against
+  an array. (Myron Marston, #97)
+* Prevent infinitely recursing `#flatten` methods from causing the differ
+  to hang. (Jon Rowe, #101)
+
 ### 3.0.4 / 2014-08-14
 [Full Changelog](http://github.com/rspec/rspec-support/compare/v3.0.3...v3.0.4)
 

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,7 @@
-Copyright (c) 2013 David Chelimsky, Myron Marston, Jon Rowe, Sam Phippen, Xavier Shay, Bradley Schaefer
+The MIT License (MIT)
+====================
 
-MIT License
+* Copyright © 2013 David Chelimsky, Myron Marston, Jon Rowe, Sam Phippen, Xavier Shay, Bradley Schaefer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# RSpec::Support
+# RSpec::Support [![Build Status](https://github.com/rspec/rspec-support/workflows/RSpec%20CI/badge.svg)](https://github.com/rspec/rspec-support/actions)
 
 `RSpec::Support` provides common functionality to `RSpec::Core`,
 `RSpec::Expectations` and `RSpec::Mocks`. It is considered
@@ -8,10 +8,33 @@ suitable for internal use only at this time.
 
 Install one or more of the `RSpec` gems.
 
+Want to run against the `main` branch? You'll need to include the dependent
+RSpec repos as well. Add the following to your `Gemfile`:
+
+```ruby
+%w[rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
+  gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'main'
+end
+```
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+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)
+
+## Patches
+
+Please submit a pull request or a github issue. If you submit an issue, please
+include a link to either of:
+
+* a gist (or equivalent) of the patch
+* a branch or commit in your github fork of the repo

data/lib/rspec/support/caller_filter.rb

@@ -1,10 +1,11 @@
+RSpec::Support.require_rspec_support "ruby_features"
+
 module RSpec
   # Consistent implementation for "cleaning" the caller method to strip out
   # non-rspec lines. This enables errors to be reported at the call site in
   # the code using the library, which is far more useful than the particular
   # internal method that raised an error.
   class CallerFilter
-
     RSPEC_LIBS = %w[
       core
       mocks
@@ -24,10 +25,32 @@ module RSpec
     # when `CallerFilter.first_non_rspec_line` is called from the top level of a required
     # file, but it depends on if rubygems is loaded or not. We don't want to have to deal
     # with this complexity in our `RSpec.deprecate` calls, so we ignore it here.
-    IGNORE_REGEX = Regexp.union(LIB_REGEX, "rubygems/core_ext/kernel_require.rb")
+    IGNORE_REGEX = Regexp.union(LIB_REGEX, "rubygems/core_ext/kernel_require.rb", "<internal:")
+
+    if RSpec::Support::RubyFeatures.caller_locations_supported?
+      # This supports args because it's more efficient when the caller specifies
+      # these. It allows us to skip frames the caller knows are part of RSpec,
+      # and to decrease the increment size if the caller is confident the line will
+      # be found in a small number of stack frames from `skip_frames`.
+      #
+      # Note that there is a risk to passing a `skip_frames` value that is too high:
+      # If it skipped the first non-rspec line, then this method would return the
+      # 2nd or 3rd (or whatever) non-rspec line. Thus, you generally shouldn't pass
+      # values for these parameters, particularly since most places that use this are
+      # not hot spots (generally it gets used for deprecation warnings). However,
+      # if you do have a hot spot that calls this, passing `skip_frames` can make
+      # a significant difference. Just make sure that that particular use is tested
+      # so that if the provided `skip_frames` changes to no longer be accurate in
+      # such a way that would return the wrong stack frame, a test will fail to tell you.
+      #
+      # See benchmarks/skip_frames_for_caller_filter.rb for measurements.
+      def self.first_non_rspec_line(skip_frames=3, increment=5)
+        # Why a default `skip_frames` of 3?
+        # By the time `caller_locations` is called below, the first 3 frames are:
+        #   lib/rspec/support/caller_filter.rb:63:in `block in first_non_rspec_line'
+        #   lib/rspec/support/caller_filter.rb:62:in `loop'
+        #   lib/rspec/support/caller_filter.rb:62:in `first_non_rspec_line'
 
-    if RUBY_VERSION >= '2.0.0'
-      def self.first_non_rspec_line
         # `caller` is an expensive method that scales linearly with the size of
         # the stack. The performance hit for fetching it in chunks is small,
         # and since the target line is probably near the top of the stack, the
@@ -35,28 +58,24 @@ module RSpec
         #
         # See benchmarks/caller.rb for measurements.
 
-        # Initial value here is mostly arbitrary, but is chosen to give good
-        # performance on the common case of creating a double.
-        increment = 5
-        i         = 1
-        line      = nil
+        # The default increment of 5 for this method are mostly arbitrary, but
+        # is chosen to give good performance on the common case of creating a double.
 
-        while !line
-          stack = caller(i, increment)
+        loop do
+          stack = caller_locations(skip_frames, increment)
           raise "No non-lib lines in stack" unless stack
 
-          line = stack.find { |l| l !~ IGNORE_REGEX }
+          line = stack.find { |l| l.path !~ IGNORE_REGEX }
+          return line.to_s if line
 
-          i         += increment
+          skip_frames += increment
           increment *= 2 # The choice of two here is arbitrary.
         end
-
-        line
       end
     else
       # Earlier rubies do not support the two argument form of `caller`. This
       # fallback is logically the same, but slower.
-      def self.first_non_rspec_line
+      def self.first_non_rspec_line(*)
         caller.find { |line| line !~ IGNORE_REGEX }
       end
     end

data/lib/rspec/support/comparable_version.rb

@@ -0,0 +1,46 @@
+module RSpec
+  module Support
+    # @private
+    class ComparableVersion
+      include Comparable
+
+      attr_reader :string
+
+      def initialize(string)
+        @string = string
+      end
+
+      def <=>(other)
+        other = self.class.new(other) unless other.is_a?(self.class)
+
+        return 0 if string == other.string
+
+        longer_segment_count = [self, other].map { |version| version.segments.count }.max
+
+        longer_segment_count.times do |index|
+          self_segment = segments[index] || 0
+          other_segment = other.segments[index] || 0
+
+          if self_segment.class == other_segment.class
+            result = self_segment <=> other_segment
+            return result unless result == 0
+          else
+            return self_segment.is_a?(String) ? -1 : 1
+          end
+        end
+
+        0
+      end
+
+      def segments
+        @segments ||= string.scan(/[a-z]+|\d+/i).map do |segment|
+          if segment =~ /\A\d+\z/
+            segment.to_i
+          else
+            segment
+          end
+        end
+      end
+    end
+  end
+end