opal-rspec 0.8.0 → 1.0.0

data/rspec-expectations/upstream/Changelog.md

@@ -1,3 +1,453 @@
+### Development
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.0...main)
+
+### 3.12.0 / 2022-10-26
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.11.1...v3.12.0)
+
+Enhancements:
+
+* Add `an_array_matching` alias for `match_array` to improve readability as an argument
+  matcher. (Mark Schneider, #1361)
+
+### 3.11.1 / 2022-09-12
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.11.0...v3.11.1)
+
+Bug Fixes:
+
+* Allow the `contain_exactly` matcher to be reused by resetting its
+  internals on `matches?` (@bclayman-sq, #1326)
+* Using the exist matcher on `FileTest` no longer produces a deprecation warning.
+  (Ryo Nakamura, #1383)
+
+### 3.11.0 / 2022-02-09
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.2...v3.11.0)
+
+Enhancements:
+
+* Return `true` from `aggregate_failures` when no exception occurs. (Jon Rowe, #1225)
+
+Deprecations:
+
+* Print a deprecation message when using the implicit block expectation syntax.
+  (Phil Pirozhkov, #1139)
+
+### 3.10.2 / 2022-01-14
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.1...v3.10.2)
+
+Bug Fixes:
+
+* Fix support for dynamic matchers for expectation target checks (Phil Pirozhkov, #1294)
+* Fix `expect(array).to include(hash).times`, previously this would fail due to
+  matching the entire array as a single hash, rather than a member of the hash.
+  (Slava Kardakov, #1322)
+* Ensure `raise_error` matches works with the `error_highlight` option from Ruby 3.1.
+  (Peter Goldstein, #1339)
+
+### 3.10.1 / 2020-12-27
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.0...v3.10.1)
+
+Bug Fixes:
+
+* Allow JRuby 9.2.x.x to generate backtraces normally rather than via our
+  backfill workaround. (#1230, Jon Rowe)
+
+### 3.10.0 / 2020-10-30
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.3...v3.10.0)
+
+Enhancements:
+
+* Allow `include` matcher to be chained with `once`, `at_least`, etc. for simple cases.
+  (Marc-André Lafortune, #1168)
+* Add an explicit warning when `nil` is passed to `raise_error`. (Phil Pirozhkov, #1143)
+* Improve `include` matcher's composability. (Phil Pirozhkov, #1155)
+* Mocks expectations can now set a custom failure message.
+  (Benoit Tigeot and Nicolas Zermati, #1156)
+* `aggregate_failures` now shows the backtrace line for each failure. (Fabricio Bedin, #1163)
+* Support multiple combinations of `yield_control` modifiers like `at_least`, `at_most`.
+  (Jon Rowe, #1169)
+* Dynamic `have_<n>` matchers now have output consistent with other dynamic matchers.
+  (Marc-André Lafortune, #1195)
+* New config option `strict_predicate_matchers` allows predicate matcher to be strict
+  (i.e. match for `true` or `false`) instead of the default (match truthy vs `false` or `nil`).
+  (Marc-André Lafortune, #1196)
+
+### 3.9.4 / 2020-10-29
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.3...v3.9.4)
+
+Bug Fixes:
+
+* Fix regression with `be_` and `have_` matchers and arguments implementing `to_hash`
+  were they would act like keywords and be cast to a hash. (Jon Rowe, #1222)
+
+### 3.9.3 / 2020-10-23
+
+Bug Fixes:
+
+* Swap the comparison of the delta vs the expected for the `be_within` matcher allowing
+  more complicated oobjects to be compared providing they provide `abs` and other
+  comparison methods. (Kelly Stannard, #1182)
+* Properly format expected in the description of the `be_within` matcher. (Jon Rowe, #1185)
+* Remove warning when using keyword arguments with `be_` and `have_` matchers on 2.7.x
+  (Jon Rowe, #1187)
+* Prevent formatting a single hash as a list of key value pairs in default failure messages
+  for custom matches (fixes formatting in `EnglishPhrasing#list`). (Robert Eshleman, #1193)
+* Prevent errors from causing false positives when using `be <operator>` comparison, e.g.
+  `expect(1).not_to be < 'a'` will now correctly fail rather than pass. (Jon Rowe, #1208)
+
+
+### 3.9.2 / 2020-05-08
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.1...v3.9.2)
+
+Bug Fixes:
+
+* Issue a proper `ArgumentError` when invalid arguments are given to `yield_control`
+  modifiers such as `at_least` et al. (Marc-André Lafortune, #1167)
+* Prevent Ruby 2.7 keyword arguments warning from being issued by custom
+  matcher definitions. (Jon Rowe, #1176)
+
+### 3.9.1 / 2020-03-13
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.9.0...v3.9.1)
+
+Bug Fixes:
+
+* Issue an improved warning when using `respond_to(...).with(n).arguments` and ignore
+  the warning when using with `have_attributes(...)`. (Jon Rowe, #1164)
+
+### 3.9.0 / 2019-10-08
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.6...v3.9.0)
+
+Enhancements:
+
+* The `respond_to` matcher now uses the signature from `initialize` to validate checks
+  for `new` (unless `new` is non standard). (Jon Rowe, #1072)
+* Generated descriptions for matchers now use `is expected to` rather than `should` in
+  line with our preferred DSL. (Pete Johns, #1080, rspec/rspec-core#2572)
+* Add the ability to re-raise expectation errors when matching
+  with `match_when_negated` blocks. (Jon Rowe, #1130)
+* Add a warning when an empty diff is produce due to identical inspect output.
+  (Benoit Tigeot, #1126)
+
+### 3.8.6 / 2019-10-07
+
+Bug Fixes:
+
+* Revert #1125 due to the change being incompatible with our semantic versioning
+  policy.
+
+### 3.8.5 / 2019-10-02
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.4...v3.8.5)
+
+Bug Fixes:
+
+* Prevent unsupported implicit block expectation syntax from being used.
+  (Phil Pirozhkov, #1125)
+
+### 3.8.4 / 2019-06-10
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.3...v3.8.4)
+
+Bug Fixes:
+
+* Prevent false negatives when checking objects for the methods required to run the
+  the `be_an_instance_of` and `be_kind_of` matchers. (Nazar Matus, #1112)
+
+### 3.8.3 / 2019-04-20
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.2...v3.8.3)
+
+Bug Fixes:
+
+* Prevent composed `all` matchers from leaking into their siblings leading to duplicate
+  failures. (Jamie English, #1086)
+* Prevent objects which change their hash on comparison from failing change checks.
+  (Phil Pirozhkov, #1100)
+* Issue an `ArgumentError` rather than a `NoMethodError` when `be_an_instance_of` and
+  `be_kind_of` matchers encounter objects not supporting those methods.
+  (Taichi Ishitani, #1107)
+
+### 3.8.2 / 2018-10-09
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.1...v3.8.2)
+
+Bug Fixes:
+
+* Change `include` matcher to rely on a `respond_to?(:include?)` check rather than a direct
+  Hash comparison before calling `to_hash` to convert to a hash. (Jordan Owens, #1073)
+* Prevent unexpected call stack jumps from causing an obscure error (`IndexError`), and
+  replace that error with a proper informative message. (Jon Rowe, #1076)
+
+### 3.8.1 / 2018-08-06
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.0...v3.8.1)
+
+Bug Fixes:
+
+* Fix regression in `include` matcher so stopped
+  `expect(hash.with_indifferent_access).to include(:symbol_key)`
+  from working. (Eito Katagiri, #1069)
+
+### 3.8.0 / 2018-08-04
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.7.0...v3.8.0)
+
+Enhancements:
+
+* Improve failure message of `change(receiver, :message)` by including the
+  receiver as `SomeClass#some_message`. (Tomohiro Hashidate, #1005)
+* Improve `change` matcher so that it can correctly detect changes in
+  deeply nested mutable objects (such as arrays-of-hashes-of-arrays).
+  The improved logic uses the before/after `hash` value to see if the
+  object has been mutated, rather than shallow duping the object.
+  (Myron Marston, #1034)
+* Improve `include` matcher so that pseudo-hash objects (e.g. objects
+  that decorate a hash using a `SimpleDelegator` or similar) are treated
+  as a hash, as long as they implement `to_hash`. (Pablo Brasero, #1012)
+* Add `max_formatted_output_length=` to configuration, allowing changing
+  the length at which we truncate large output strings.
+  (Sam Phippen #951, Benoit Tigeot #1056)
+* Improve error message when passing a matcher that doesn't support block
+  expectations to a block based `expect`. (@nicktime, #1066)
+
+### 3.7.0 / 2017-10-17
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.6.0...v3.7.0)
+
+Enhancements:
+
+* Improve compatibility with `--enable-frozen-string-literal` option
+  on Ruby 2.3+. (Pat Allan, #997)
+
+### 3.6.0 / 2017-05-04
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.6.0.beta2...v3.6.0)
+
+Enhancements:
+
+* Treat NoMethodError as a failure for comparison matchers. (Jon Rowe, #972)
+* Allow for scoped aliased and negated matchers--just call
+  `alias_matcher` or `define_negated_matcher` from within an example
+  group. (Markus Reiter, #974)
+* Improve failure message of `change` matcher with block and `satisfy` matcher
+  by including the block snippet instead of just describing it as `result` or
+  `block` when Ripper is available. (Yuji Nakayama, #987)
+
+Bug Fixes:
+
+* Fix `yield_with_args` and `yield_successive_args` matchers so that
+  they compare expected to actual args at the time the args are yielded
+  instead of at the end, in case the method that is yielding mutates the
+  arguments after yielding. (Alyssa Ross, #965)
+
+### 3.6.0.beta2 / 2016-12-12
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.6.0.beta1...v3.6.0.beta2)
+
+Bug Fixes:
+
+* Using the exist matcher on `File` no longer produces a deprecation warning.
+  (Jon Rowe, #954)
+
+### 3.6.0.beta1 / 2016-10-09
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.5.0...v3.6.0.beta1)
+
+Bug Fixes:
+
+* Fix `contain_exactly` to work correctly with ranges. (Myron Marston, #940)
+* Fix `change` to work correctly with sets. (Marcin Gajewski, #939)
+
+### 3.5.0 / 2016-07-01
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.5.0.beta4...v3.5.0)
+
+Enhancements:
+
+* Add support for keyword arguments to the `respond_to` matcher. (Rob Smith, #915).
+
+### 3.5.0.beta4 / 2016-06-05
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.5.0.beta3...v3.5.0.beta4)
+
+Bug Fixes:
+
+* Fix `include` matcher so that it provides a valid diff for hashes. (Yuji Nakayama, #916)
+
+### 3.5.0.beta3 / 2016-04-02
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.5.0.beta2...v3.5.0.beta3)
+
+Enhancements:
+
+* Make `rspec/expectations/minitest_integration` work on Minitest::Spec
+  5.6+. (Myron Marston, #904)
+* Add an alias `having_attributes` for `have_attributes` matcher.
+  (Yuji Nakayama, #905)
+* Improve `change` matcher error message when block is mis-used.
+  (Alex Altair, #908)
+
+### 3.5.0.beta2 / 2016-03-10
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.5.0.beta1...v3.5.0.beta2)
+
+Enhancements:
+
+* Add the ability to raise an error on encountering false positives via
+  `RSpec::Configuration#on_potential_false_positives = :raise`. (Jon Rowe, #900)
+* When using the custom matcher DSL, support new
+  `notify_expectation_failures: true` option for the `match` method to
+  allow expectation failures to be raised as normal instead of being
+  converted into a `false` return value for `matches?`. (Jon Rowe, #892)
+
+Bug Fixes:
+
+* Allow `should` deprecation check to work on `BasicObject`s. (James Coleman, #898)
+
+### 3.5.0.beta1 / 2016-02-06
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.4.0...v3.5.0.beta1)
+
+Enhancements:
+
+* Make `match_when_negated` in custom matcher DSL support use of
+  expectations within the match logic. (Chris Arcand, #789)
+
+Bug Fixes:
+
+* Return `true` as expected from passing negated expectations
+  (such as `expect("foo").not_to eq "bar"`), so they work
+  properly when used within a `match` or `match_when_negated`
+  block. (Chris Arcand, #789)
+
+### 3.4.0 / 2015-11-11
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.3.1...v3.4.0)
+
+Enhancements:
+
+* Warn when `RSpec::Matchers` is included in a superclass after it has
+  already been included in a subclass on MRI 1.9, since that situation
+  can cause uses of `super` to trigger infinite recursion. (Myron Marston, #816)
+* Stop rescuing `NoMemoryError`, `SignalExcepetion`, `Interrupt` and
+  `SystemExit`. It is dangerous to interfere with these. (Myron Marston, #845)
+* Add `#with_captures` to the
+  [match matcher](https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/match-matcher)
+  which allows a user to specify expected captures when matching a regex
+  against a string. (Sam Phippen, #848)
+* Always print compound failure messages in the multi-line form. Trying
+  to print it all on a single line didn't read very well. (Myron Marston, #859)
+
+Bug Fixes:
+
+* Fix failure message from dynamic predicate matchers when the object
+  does not respond to the predicate so that it is inspected rather
+  than relying upon its `to_s` -- that way for `nil`, `"nil"` is
+  printed rather than an empty string. (Myron Marston, #841)
+* Fix SystemStackError raised when diffing an Enumerable object
+  whose `#each` includes the object itself. (Yuji Nakayama, #857)
+
+### 3.3.1 / 2015-07-15
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.3.0...v3.3.1)
+
+Bug Fixes:
+
+* Fix `be >`, `be <`, etc so that it fails rather than allowing an
+  argument error to be raised when compared against an object of the
+  wrong type. This allows it to be used in composed matcher expressions
+  against heterogeneous objects. (Dennis Günnewig, #809)
+* Fix `respond_to` to work properly on target objects
+  that redefine the `method` method. (unmanbearpig, #821)
+
+### 3.3.0 / 2015-06-12
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.2.1...v3.3.0)
+
+Enhancements:
+
+* Expose `RSpec::Matchers::EnglishPhrasing` to make it easier to write
+  nice failure messages in custom matchers. (Jared Beck, #736)
+* Add `RSpec::Matchers::FailMatchers`, a mixin which provides
+  `fail`, `fail_with` and `fail_including` matchers for use in
+  specifying that an expectation fails for use by
+  extension/plugin authors. (Charlie Rudolph, #729)
+* Avoid loading `tempfile` (and its dependencies) unless
+  it is absolutely needed. (Myron Marston, #735)
+* Improve failure output when attempting to use `be_true` or `be_false`.
+  (Tim Wade, #744)
+* Define `RSpec::Matchers#respond_to_missing?` so that
+  `RSpec::Matchers#respond_to?` and `RSpec::Matchers#method` handle
+  dynamic predicate matchers. (Andrei Botalov, #751)
+* Use custom Time/DateTime/BigDecimal formatting for all matchers
+  so they are consistently represented in failure messages.
+  (Gavin Miller, #740)
+* Add configuration to turn off warnings about matcher combinations that
+  may cause false positives. (Jon Rowe, #768)
+* Warn when using a bare `raise_error` matcher that you may be subject to
+  false positives. (Jon Rowe, #768)
+* Warn rather than raise when using the`raise_error` matcher in negative
+  expectations that may be subject to false positives. (Jon Rowe, #775)
+* Improve failure message for `include(a, b, c)` so that if `a` and `b`
+  are included the failure message only mentions `c`. (Chris Arcand, #780)
+* Allow `satisfy` matcher to take an optional description argument
+  that will be used in the `description`, `failure_message` and
+  `failure_message_when_negated` in place of the undescriptive
+  "sastify block". (Chris Arcand, #783)
+* Add new `aggregate_failures` API that allows multiple independent
+  expectations to all fail and be listed in the failure output, rather
+  than the example aborting on the first failure. (Myron Marston, #776)
+* Improve `raise_error` matcher so that it can accept a matcher as a single argument
+  that matches the message. (Time Wade, #782)
+
+Bug Fixes:
+
+* Make `contain_exactly` / `match_array` work with strict test doubles
+  that have not defined `<=>`. (Myron Marston, #758)
+* Fix `include` matcher so that it omits the diff when it would
+  confusingly highlight items that are actually included but are not
+  an exact match in a line-by-line diff. (Tim Wade, #763)
+* Fix `match` matcher so that it does not blow up when matching a string
+  or regex against another matcher (rather than a string or regex).
+  (Myron Marston, #772)
+* Silence whitespace-only diffs. (Myron Marston, #801)
+
+### 3.2.1 / 2015-04-06
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.2.0...v3.2.1)
+
+Bug Fixes:
+
+* Prevent `Range`s from being enumerated when generating matcher
+  descriptions. (Jon Rowe, #755)
+* Ensure exception messages are compared as strings in the `raise_error`
+  matcher. (Jon Rowe, #755)
+
+### 3.2.0 / 2015-02-03
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.1.2...v3.2.0)
+
+Enhancements:
+
+* Add `block_arg` method to custom matcher API, which allows you to
+  access the block passed to a custom matcher, if there is one.
+  (Mike Dalton, #645)
+* Provide more detail in failure message of `yield_control` matcher.
+  (Jon Rowe, #650)
+* Add a shorthand syntax for `chain` in the matcher DSL which assigns values
+  for use elsewhere, for example `chain :and_smaller_than, :small_value`
+  creates an `attr_reader` for `small_value` (Tom Stuart, #644)
+* Provide a more helpful deprecation message when using the `should` syntax.
+  (Elia Schito, #663)
+* Provide more detail in the `have_attributes` matcher failure message.
+  (Jon Rowe,  #668)
+* Make the `have_attributes` matcher diffable.
+  (Jon Rowe, Alexey Fedorov, #668)
+* Add `output(...).to_std(out|err)_from_any_process` as alternatives
+  to `output(...).to_std(out|err)`. The latter doesn't work when a sub
+  process writes to the named stream but is much faster.
+  (Alex Genco, #700)
+* Improve compound matchers (created by `and` and `or`) so that diffs
+  are included in failures when one or more of their matchers
+  are diffable. (Alexey Fedorov, #713)
+
+Bug Fixes:
+
+* Avoid calling `private_methods` from the `be` predicate matcher on
+  the target object if the object publicly responds to the predicate
+  method. This avoids a possible error that can occur if the object
+  raises errors from `private_methods` (which can happen with celluloid
+  objects). (@chapmajs, #670)
+* Make `yield_control` (with no modifier) default to
+  `at_least(:once)` rather than raising a confusing error
+  when multiple yields are encountered.
+  (Myron Marston, #675)
+* Fix "instance variable @color not initialized" warning when using
+  rspec-expectations outside of an rspec-core context. (Myron Marston, #689)
+* Fix `start_with` and `end_with` to work properly when checking a
+  string against an array of strings. (Myron Marston, #690)
+* Don't use internally delegated matchers when generating descriptions
+  for examples without doc strings. (Myron Marston, #692)
+
 ### 3.1.2 / 2014-09-26
 [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.1.1...v3.1.2)
 
@@ -266,7 +716,7 @@ Breaking Changes for 3.0.0:
   (Sam Phippen)
 * Remove the deprecated `have`, `have_at_least` and `have_at_most` matchers.
   You can continue using those matchers through https://github.com/rspec/rspec-collection_matchers,
-  or you can rewrite your expectations with something like 
+  or you can rewrite your expectations with something like
   `expect(your_object.size).to eq(num)`. (Hugo Baraúna)
 * Rename `be_true` and `be_false` to `be_truthy` and `be_falsey`. (Sam Phippen)
 * Make `expect { }.to_not raise_error(SomeSpecificClass, message)`,
@@ -387,9 +837,9 @@ Deprecations:
 Deprecations
 
 * Deprecate `have`, `have_at_least` and `have_at_most`. You can continue using those
-	matchers through https://github.com/rspec/rspec-collection_matchers, or
-	you can rewrite your expectations with something like
-	`expect(your_object.size).to eq(num)`. (Hugo Baraúna)
+  matchers through https://github.com/rspec/rspec-collection_matchers, or
+  you can rewrite your expectations with something like
+  `expect(your_object.size).to eq(num)`. (Hugo Baraúna)
 * Deprecate `be_xyz` predicate matcher when `xyz?` is a private method.
   (Jon Rowe)
 * Deprecate `be_true`/`be_false` in favour of `be_truthy`/`be_falsey`

data/rspec-expectations/upstream/DEV-README.md

@@ -1,6 +1,6 @@
 ## Set up the dev environment
 
-    git clone git://github.com/rspec/rspec-expectations.git
+    git clone https://github.com/rspec/rspec-expectations.git
     cd rspec-expectations
     gem install bundler
     bundle install
@@ -20,9 +20,9 @@ Or ...
     bundle install --binstubs
     bin/rspec
 
-## Customize the dev enviroment
+## Customize the dev environment
 
 The Gemfile includes the gems you'll need to be able to run specs. If you want
-to customize your dev enviroment with additional tools like guard or
+to customize your dev environment with additional tools like guard or
 ruby-debug, add any additional gem declarations to Gemfile-custom (see
 Gemfile-custom.sample for some examples).

data/rspec-expectations/upstream/DEVELOPMENT.md

@@ -0,0 +1,131 @@
+<!---
+This file was generated on 2020-12-25T18:48:30+00:00 from the rspec-dev repo.
+DO NOT modify it by hand as your changes will get lost the next time it is generated.
+-->
+
+# Development Setup
+
+Generally speaking, you only need to clone the project and install
+the dependencies with [Bundler](https://bundler.io/). You can either
+get a full RSpec development environment using
+[rspec-dev](https://github.com/rspec/rspec-dev#README) or you can
+set this project up individually.
+
+## Setting up rspec-expectations individually
+
+For most contributors, setting up the project individually will be simpler.
+Unless you have a specific reason to use rspec-dev, we recommend using this approach.
+
+Clone the repo:
+
+```
+$ git clone git@github.com:rspec/rspec-expectations.git
+```
+
+Install the dependencies using [Bundler](https://bundler.io/):
+
+```
+$ cd rspec-expectations
+$ bundle install
+```
+
+To minimize boot time and to ensure we don't depend upon any extra dependencies
+loaded by Bundler, our CI builds avoid loading Bundler at runtime
+by using Bundler's [`--standalone option`](https://myronmars.to/n/dev-blog/2012/03/faster-test-boot-times-with-bundler-standalone).
+While not strictly necessary (many/most of our contributors do not do this!),
+if you want to exactly reproduce our CI builds you'll want to do the same:
+
+```
+$ bundle install --standalone --binstubs
+```
+
+The `--binstubs` option creates the `bin/rspec` file that, like `bundle exec rspec`, will load
+all the versions specified in `Gemfile.lock` without loading bundler at runtime!
+
+## Using rspec-dev
+
+See the [rspec-dev README](https://github.com/rspec/rspec-dev#README)
+for setup instructions.
+
+The rspec-dev project contains many rake tasks for helping manage
+an RSpec development environment, making it easy to do things like:
+
+* Change branches across all repos
+* Update all repos with the latest code from `main`
+* Cut a new release across all repos
+* Push out updated build scripts to all repos
+
+These sorts of tasks are essential for the RSpec maintainers but will
+probably be unnecessary complexity if you're just contributing to one
+repository. If you are getting setup to make your first contribution,
+we recommend you take the simpler route of setting up rspec-expectations
+individually.
+
+## Gotcha: Version mismatch from sibling repos
+
+The [Gemfile](Gemfile) is designed to be flexible and support using
+the other RSpec repositories either from a local sibling directory
+(e.g. `../rspec-<subproject>`) or, if there is no such directory,
+directly from git. This generally does the "right thing", but can
+be a gotcha in some situations. For example, if you are setting up
+`rspec-core`, and you happen to have an old clone of `rspec-expectations`
+in a sibling directory, it'll be used even though it might be months or
+years out of date, which can cause confusing failures.
+
+To avoid this problem, you can either `export USE_GIT_REPOS=1` to force
+the use of `:git` dependencies instead of local dependencies, or update
+the code in the sibling directory. rspec-dev contains rake tasks to
+help you keep all repos in sync.
+
+## Extra Gems
+
+If you need additional gems for any tasks---such as `benchmark-ips` for benchmarking
+or `byebug` for debugging---you can create a `Gemfile-custom` file containing those
+gem declarations. The `Gemfile` evaluates that file if it exists, and it is git-ignored.
+
+# Running the build
+
+The [Travis CI build](https://travis-ci.org/rspec/rspec-expectations)
+runs many verification steps to prevent regressions and
+ensure high-quality code. To run the Travis build locally, run:
+
+```
+$ script/run_build
+```
+
+See [build detail](BUILD_DETAIL.md) for more detail.
+
+# What to Expect
+
+To ensure high, uniform code quality, all code changes (including
+changes from the maintainers!) are subject to a pull request code
+review. We'll often ask for clarification or suggest alternate ways
+to do things. Our code reviews are intended to be a two-way
+conversation.
+
+Here's a short, non-exhaustive checklist of things we typically ask contributors to do before PRs are ready to merge. It can help get your PR merged faster if you do these in advance!
+
+- [ ] New behavior is covered by tests and all tests are passing.
+- [ ] No Ruby warnings are issued by your changes.
+- [ ] Documentation reflects changes and renders as intended.
+- [ ] RuboCop passes (e.g. `bundle exec rubocop lib`).
+- [ ] Commits are squashed into a reasonable number of logical changesets that tell an easy-to-follow story.
+- [ ] No changelog entry is necessary (we'll add it as part of the merge process!)
+
+# Adding Docs
+
+RSpec uses [YARD](https://yardoc.org/) for its API documentation. To
+ensure the docs render well, we recommend running a YARD server and
+viewing your edits in a browser.
+
+To run a YARD server:
+
+```
+$ bundle exec yard server --reload
+
+# or, if you installed your bundle with `--standalone --binstubs`:
+
+$ bin/yard server --reload
+```
+
+Then navigate to `localhost:8808` to view the rendered docs.