rspec-rails 2.14.2 → 4.1.2

data/README.md

@@ -1,449 +1,374 @@
-# rspec-rails [![Build Status](https://secure.travis-ci.org/rspec/rspec-rails.png?branch=master)](http://travis-ci.org/rspec/rspec-rails) [![Code Climate](https://codeclimate.com/github/rspec/rspec-rails.png)](https://codeclimate.com/github/rspec/rspec-rails)
-
-**rspec-rails** is a testing framework for Rails 3.x and 4.x.
-
-Use **[rspec-rails 1.x](http://github.com/dchelimsky/rspec-rails)** for Rails
-2.x.
+# rspec-rails [![Code Climate][]][code-climate] [![Gem Version][]][gem-version]
+
+`rspec-rails` brings the [RSpec][] testing framework to [Ruby on Rails][]
+as a drop-in alternative to its default testing framework, Minitest.
+
+In RSpec, tests are not just scripts that verify your application code.
+They’re also specifications (or _specs,_ for short):
+detailed explanations of how the application is supposed to behave,
+expressed in plain English.
+
+Use **[`rspec-rails` 3.x][]** for Rails earlier than 5.0.
+Use **[`rspec-rails` 1.x][]** for Rails 2.x.
+
+[Build Status]: https://secure.travis-ci.org/rspec/rspec-rails.svg?branch=main
+[travis-ci]: https://travis-ci.org/rspec/rspec-rails
+[Code Climate]: https://codeclimate.com/github/rspec/rspec-rails.svg
+[code-climate]: https://codeclimate.com/github/rspec/rspec-rails
+[Gem Version]: https://badge.fury.io/rb/rspec-rails.svg
+[gem-version]: https://badge.fury.io/rb/rspec-rails
+[RSpec]: https://rspec.info/
+[Ruby on Rails]: https://rubyonrails.org/
+[`rspec-rails` 1.x]: https://github.com/dchelimsky/rspec-rails
+[`rspec-rails` 3.x]: https://github.com/rspec/rspec-rails/tree/3-9-maintenance
 
 ## Installation
 
-Add `rspec-rails` to **both** the `:development` and `:test` groups in the
-`Gemfile`:
-
-```ruby
-group :development, :test do
-  gem 'rspec-rails', '~> 2.0'
-end
-```
-
-Download and install by running:
+**IMPORTANT** This README / branch refers to the `4.1.x` series of releases.
+See the [`main` branch on Github](https://github.com/rspec/rspec-rails/tree/main) for more up to date releases.
 
-```
-bundle install
-```
+1. Add `rspec-rails` to **both** the `:development` and `:test` groups
+   of your app’s `Gemfile`:
 
-Initialize the `spec/` directory (where specs will reside) with:
+   ```ruby
+   # Run against the latest stable release
+   group :development, :test do
+     gem 'rspec-rails', '~> 4.1.0'
+   end
 
-```
-rails generate rspec:install
-```
+   # Or, run against the main branch
+   # (requires main-branch versions of all related RSpec libraries)
+   group :development, :test do
+     %w[rspec-core rspec-expectations rspec-mocks rspec-rails rspec-support].each do |lib|
+       gem lib, git: "https://github.com/rspec/#{lib}.git", branch: 'main'
+     end
+   end
+   ```
 
-To run your specs, use the `rspec` command:
+   (Adding it to the `:development` group is not strictly necessary,
+   but without it, generators and rake tasks must be preceded by `RAILS_ENV=test`.)
 
-```
-bundle exec rspec
+2. Then, in your project directory:
 
-# Run only model specs
-bundle exec rspec spec/models
+   ```sh
+   # Download and install
+   $ bundle install
 
-# Run only specs for AccountsController
-bundle exec rspec spec/controllers/accounts_controller_spec.rb
-```
+   # Generate boilerplate configuration files
+   # (check the comments in each generated file for more information)
+   $ rails generate rspec:install
+         create  .rspec
+         create  spec
+         create  spec/spec_helper.rb
+         create  spec/rails_helper.rb
+   ```
 
-Specs can also be run via `rake spec`, though this command may be slower to
-start than the `rspec` command.
+## Upgrading
 
-In Rails 4, you may want to create a binstub for the `rspec` command so it can
-be run via `bin/rspec`:
+If your project is already using an older version of `rspec-rails`,
+upgrade to the latest version with:
 
-```
-bundle binstubs rspec-core
+```sh
+$ bundle update rspec-rails
 ```
 
-### Generators
+RSpec follows [semantic versioning](https://semver.org/),
+which means that “major version” upgrades (_e.g.,_ 2.x → 3.x)
+come with **breaking changes**.
+If you’re upgrading from version 2.x or below,
+read the [`rspec-rails` upgrade notes][] to find out what to watch out for.
 
-Once installed, RSpec will generate spec files instead of Test::Unit test files
-when commands like `rails generate model` and `rails generate controller` are
-used.
+Be sure to check the general [RSpec upgrade notes][] as well.
 
-You may also invoke invoke RSpec generators independently. For instance,
-running `rails generate rspec:model` will generate a model spec. For more
-information, see [list of all
-generators](https://www.relishapp.com/rspec/rspec-rails/docs/generators).
+[`rspec-rails` upgrade notes]: https://www.relishapp.com/rspec/rspec-rails/docs/upgrade
+[RSpec upgrade notes]: https://relishapp.com/rspec/docs/upgrade
 
-## Model Specs
+## Usage
 
-Model specs reside in the `spec/models` folder. Use model specs to describe
-behavior of models (usually ActiveRecord-based) in the application. For example:
+### Creating boilerplate specs with `rails generate`
 
-```ruby
-require "spec_helper"
+```sh
+# RSpec hooks into built-in generators
+$ rails generate model user
+      invoke  active_record
+      create    db/migrate/20181017040312_create_users.rb
+      create    app/models/user.rb
+      invoke    rspec
+      create      spec/models/user_spec.rb
 
-describe User do
-  it "orders by last name" do
-    lindeman = User.create!(first_name: "Andy", last_name: "Lindeman")
-    chelimsky = User.create!(first_name: "David", last_name: "Chelimsky")
+# RSpec also provides its own spec file generators
+$ rails generate rspec:model user
+      create  spec/models/user_spec.rb
 
-    expect(User.ordered_by_last_name).to eq([chelimsky, lindeman])
-  end
-end
+# List all RSpec generators
+$ rails generate --help | grep rspec
 ```
 
-For more information, see [cucumber scenarios for model
-specs](https://www.relishapp.com/rspec/rspec-rails/docs/model-specs).
+### Running specs
 
-## Controller Specs
+```sh
+# Default: Run all spec files (i.e., those matching spec/**/*_spec.rb)
+$ bundle exec rspec
 
-Controller specs reside in the `spec/controllers` folder. Use controller specs
-to describe behavior of Rails controllers. For example:
+# Run all spec files in a single directory (recursively)
+$ bundle exec rspec spec/models
 
-```ruby
-require "spec_helper"
-
-describe PostsController do
-  describe "GET #index" do
-    it "responds successfully with an HTTP 200 status code" do
-      get :index
-      expect(response).to be_success
-      expect(response.status).to eq(200)
-    end
-
-    it "renders the index template" do
-      get :index
-      expect(response).to render_template("index")
-    end
+# Run a single spec file
+$ bundle exec rspec spec/controllers/accounts_controller_spec.rb
 
-    it "loads all of the posts into @posts" do
-      post1, post2 = Post.create!, Post.create!
-      get :index
+# Run a single example from a spec file (by line number)
+$ bundle exec rspec spec/controllers/accounts_controller_spec.rb:8
 
-      expect(assigns(:posts)).to match_array([post1, post2])
-    end
-  end
-end
+# See all options for running specs
+$ bundle exec rspec --help
 ```
 
-For more information, see [cucumber scenarios for controller
-specs](https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs).
+**Optional:** If `bundle exec rspec` is too verbose for you,
+you can generate a binstub at `bin/rspec` and use that instead:
 
-**Note:** To encourage more isolated testing, views are not rendered by default
-in controller specs. If you wish to assert against the contents of the rendered
-view in a controller spec, enable
-[render\_views](https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs/render-views)
-or use a higher-level [request spec](#request-specs) or [feature
-spec](#feature-specs).
+ ```sh
+ $ bundle binstubs rspec-core
+ ```
 
-## <a id="request-spec"></a>Request Specs
+## RSpec DSL Basics (or, how do I write a spec?)
 
-Request specs live in spec/requests, spec/api and
-spec/integration, and mix in behavior
-[ActionDispatch::Integration::Runner](http://api.rubyonrails.org/classes/ActionDispatch/Integration/Runner.html),
-which is the basis for [Rails' integration
-tests](http://guides.rubyonrails.org/testing.html#integration-testing).  The
-intent is to specify one or more request/response cycles from end to end using
-a black box approach.
+In RSpec, application behavior is described
+**first in (almost) plain English, then again in test code**, like so:
 
 ```ruby
-require 'spec_helper'
-describe "home page" do
-  it "displays the user's username after successful login" do
-    user = User.create!(:username => "jdoe", :password => "secret")
-    get "/login"
-    assert_select "form.login" do
-      assert_select "input[name=?]", "username"
-      assert_select "input[name=?]", "password"
-      assert_select "input[type=?]", "submit"
+RSpec.describe 'Post' do           #
+  context 'before publication' do  # (almost) plain English
+    it 'cannot have comments' do   #
+      expect { Post.create.comments.create! }.to raise_error(ActiveRecord::RecordInvalid)  # test code
     end
-
-    post "/login", :username => "jdoe", :password => "secret"
-    assert_select ".header .username", :text => "jdoe"
   end
 end
 ```
 
-This example uses only standard Rails and RSpec API's, but many RSpec/Rails
-users like to use extension libraries like
-[FactoryGirl](https://github.com/thoughtbot/factory_girl) and
-[Capybara](https://github.com/jnicklas/capybara):
+Running `rspec` will execute this test code,
+and then use the plain-English descriptions
+to generate a report of where the application
+conforms to (or fails to meet) the spec:
 
-```ruby
-require 'spec_helper'
-describe "home page" do
-  it "displays the user's username after successful login" do
-    user = FactoryGirl.create(:user, :username => "jdoe", :password => "secret")
-    visit "/login"
-    fill_in "Username", :with => "jdoe"
-    fill_in "Password", :with => "secret"
-    click_button "Log in"
-
-    expect(page).to have_selector(".header .username", :text => "jdoe")
-  end
-end
 ```
+$ rspec --format documentation spec/models/post_spec.rb
 
-FactoryGirl decouples this example from changes to validation requirements,
-which can be encoded into the underlying factory definition without requiring
-changes to this example.
+Post
+  before publication
+    cannot have comments
 
-Among other benefits, Capybara binds the form post to the generated HTML, which
-means we don't need to specify them separately.  Note that Capybara's DSL as
-shown is, by default, only available in specs in the spec/features directory.
-For more information, see the [Capybara integration
-docs](http://rubydoc.info/gems/rspec-rails/file/Capybara.md).
+Failures:
 
-There are several other Ruby libs that implement the factory pattern or provide
-a DSL for request specs (a.k.a. acceptance or integration specs), but
-FactoryGirl and Capybara seem to be the most widely used. Whether you choose
-these or other libs, we strongly recommend using something for each of these
-roles.
+  1) Post before publication cannot have comments
+     Failure/Error: expect { Post.create.comments.create! }.to raise_error(ActiveRecord::RecordInvalid)
+       expected ActiveRecord::RecordInvalid but nothing was raised
+     # ./spec/models/post.rb:4:in `block (3 levels) in <top (required)>'
 
-# View specs
+Finished in 0.00527 seconds (files took 0.29657 seconds to load)
+1 example, 1 failure
 
-View specs live in spec/views, and mix in ActionView::TestCase::Behavior.
+Failed examples:
 
-```ruby
-require 'spec_helper'
-describe "events/index" do
-  it "renders _event partial for each event" do
-    assign(:events, [stub_model(Event), stub_model(Event)])
-    render
-    expect(view).to render_template(:partial => "_event", :count => 2)
-  end
-end
-
-describe "events/show" do
-  it "displays the event location" do
-    assign(:event, stub_model(Event,
-      :location => "Chicago"
-    ))
-    render
-    expect(rendered).to include("Chicago")
-  end
-end
+rspec ./spec/models/post_spec.rb:3 # Post before publication cannot have comments
 ```
 
-View specs infer the controller name and path from the path to the view
-template. e.g. if the template is "events/index.html.erb" then:
+For an in-depth look at the RSpec DSL, including lots of examples,
+read the official Cucumber documentation for [RSpec Core][].
+
+[RSpec Core]: https://relishapp.com/rspec/rspec-core/docs
+
+### Helpful Rails Matchers
+
+In RSpec, assertions are called _expectations,_
+and every expectation is built around a _matcher._
+When you `expect(a).to eq(b)`, you’re using the `eq` matcher.
+
+In addition to [the matchers that come standard in RSpec][],
+here are some extras that make it easier
+to test the various parts of a Rails system:
+
+| RSpec matcher            | Delegates to        | Available in                    | Notes                                                    |
+| ------------------------ | ------------------- | ------------------------------- | -------------------------------------------------------- |
+| [`be_a_new`][]           |                     | all                             | primarily intended for controller specs                  |
+| [`render_template`][]    | `assert_template`   | request / controller / view     | use with `expect(response).to`                           |
+| [`redirect_to`][]        | `assert_redirect`   | request / controller            | use with `expect(response).to`                           |
+| [`route_to`]             | `assert_recognizes` | routing / controller            | use with `expect(...).to route_to`                       |
+| [`be_routable`]          |                     | routing / controller            | use with `expect(...).not_to be_routable`                |
+| [`have_http_status`][]   |                     | request / controller / feature  |                                                          |
+| [`match_array`][]        |                     | all                             | for comparing arrays of ActiveRecord objects             |
+| [`have_been_enqueued`][] |                     | all                             | requires config: `ActiveJob::Base.queue_adapter = :test` |
+| [`have_enqueued_job`][]  |                     | all                             | requires config: `ActiveJob::Base.queue_adapter = :test` |
+
+Follow the links above for examples of how each matcher is used.
+
+[the matchers that come standard in RSpec]: https://relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+[`be_a_new`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/be-a-new-matcher
+[`render_template`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/render-template-matcher
+[`redirect_to`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/redirect-to-matcher
+[`route_to`]: https://relishapp.com/rspec/rspec-rails/docs/routing-specs/route-to-matcher
+[`be_routable`]: https://relishapp.com/rspec/rspec-rails/docs/routing-specs/be-routable-matcher
+[`have_http_status`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/have-http-status-matcher
+[`match_array`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/activerecord-relation-match-array
+[`have_been_enqueued`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/have-been-enqueued-matcher
+[`have_enqueued_job`]: https://relishapp.com/rspec/rspec-rails/docs/matchers/have-enqueued-job-matcher
+
+### What else does RSpec Rails add?
+
+For a comprehensive look at RSpec Rails’ features,
+read the [official Cucumber documentation][].
+
+[official Cucumber documentation]: https://relishapp.com/rspec/rspec-rails/docs
+
+## What tests should I write?
+
+RSpec Rails defines ten different _types_ of specs
+for testing different parts of a typical Rails application.
+Each one inherits from one of Rails’ built-in `TestCase` classes,
+meaning the helper methods provided by default in Rails tests
+are available in RSpec, as well.
+
+  | Spec type      | Corresponding Rails test class        |
+  | -------------- | --------------------------------      |
+  | [model][]      |                                       |
+  | [controller][] | [`ActionController::TestCase`][]      |
+  | [mailer][]     | `ActionMailer::TestCase`              |
+  | [job][]        |                                       |
+  | [view][]       | `ActionView::TestCase`                |
+  | [routing][]    |                                       |
+  | [helper][]     | `ActionView::TestCase`                |
+  | [request][]    | [`ActionDispatch::IntegrationTest`][] |
+  | [feature][]    |                                       |
+  | [system][]     | [`ActionDispatch::SystemTestCase`][]  |
+
+Follow the links above to see examples of each spec type,
+or for official Rails API documentation on the given `TestCase` class.
+
+> **Note: This is not a checklist.**
+>
+> Ask a hundred developers how to test an application,
+> and you’ll get a hundred different answers.
+>
+> RSpec Rails provides thoughtfully selected features
+> to encourage good testing practices, but there’s no “right” way to do it.
+> Ultimately, it’s up to you to decide how your test suite will be composed.
+
+When creating a spec file,
+assign it a type in the top-level `describe` block, like so:
 
 ```ruby
-controller.controller_path == "events"
-controller.request.path_parameters[:controller] == "events"
-```
-
-This means that most of the time you don't need to set these values. When
-spec'ing a partial that is included across different controllers, you _may_
-need to override these values before rendering the view.
-
-To provide a layout for the render, you'll need to specify _both_ the template
-and the layout explicitly.  For example:
+# spec/models/user_spec.rb
 
-```ruby
-render :template => "events/show", :layout => "layouts/application"
+RSpec.describe User, type: :model do
+...
 ```
 
-## `assign(key, val)`
-
-Use this to assign values to instance variables in the view:
+[request]: https://relishapp.com/rspec/rspec-rails/docs/request-specs/request-spec
+[feature]: https://www.relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec
+[system]: https://relishapp.com/rspec/rspec-rails/docs/system-specs/system-spec
+[model]: https://www.relishapp.com/rspec/rspec-rails/docs/model-specs
+[controller]: https://www.relishapp.com/rspec/rspec-rails/docs/controller-specs
+[mailer]: https://relishapp.com/rspec/rspec-rails/docs/mailer-specs
+[job]: https://relishapp.com/rspec/rspec-rails/docs/job-specs/job-spec
+[view]: https://www.relishapp.com/rspec/rspec-rails/docs/view-specs/view-spec
+[routing]: https://www.relishapp.com/rspec/rspec-rails/docs/routing-specs
+[helper]: https://www.relishapp.com/rspec/rspec-rails/docs/helper-specs/helper-spec
+[`ActionDispatch::IntegrationTest`]: https://api.rubyonrails.org/classes/ActionDispatch/IntegrationTest.html
+[`ActionDispatch::SystemTestCase`]: https://api.rubyonrails.org/classes/ActionDispatch/SystemTestCase.html
+[`ActionController::TestCase`]: https://api.rubyonrails.org/classes/ActionController/TestCase.html
+[in the appropriate folder]: https://relishapp.com/rspec/rspec-rails/docs/directory-structure
 
-```ruby
-assign(:widget, stub_model(Widget))
-render
-```
+### System specs, feature specs, request specs–what’s the difference?
 
-The code above assigns `stub_model(Widget)` to the `@widget` variable in the view, and then
-renders the view.
+RSpec Rails provides some end-to-end (entire application) testing capability
+to specify the interaction with the client.
 
-Note that because view specs mix in `ActionView::TestCase` behavior, any
-instance variables you set will be transparently propagated into your views
-(similar to how instance variables you set in controller actions are made
-available in views). For example:
+#### System specs
 
-```ruby
-@widget = stub_model(Widget)
-render # @widget is available inside the view
-```
+Also called **acceptance tests**, **browser tests**, or **end-to-end tests**,
+system specs test the application from the perspective of a _human client._
+The test code walks through a user’s browser interactions,
 
-RSpec doesn't officially support this pattern, which only works as a
-side-effect of the inclusion of `ActionView::TestCase`. Be aware that it may be
-made unavailable in the future.
+* `visit '/login'`
+* `fill_in 'Name', with: 'jdoe'`
 
-### Upgrade note
+and the expectations revolve around page content.
 
-```ruby
-# rspec-rails-1.x
-assigns[key] = value
+* `expect(page).to have_text('Welcome')`
 
-# rspec-rails-2.x
-assign(key, value)
-```
+Because system specs are a wrapper around Rails’ built-in `SystemTestCase`,
+they’re only available on Rails 5.1+.
+(Feature specs serve the same purpose, but without this dependency.)
 
-## `rendered`
+#### Feature specs
 
-This represents the rendered view.
+Before Rails introduced system testing facilities,
+feature specs were the only spec type for end-to-end testing.
+While the RSpec team now [officially recommends system specs][] instead,
+feature specs are still fully supported, look basically identical,
+and work on older versions of Rails.
 
-```ruby
-render
-expect(rendered).to match /Some text expected to appear on the page/
-```
+On the other hand, feature specs require non-trivial configuration
+to get some important features working,
+like JavaScript testing or making sure each test runs with a fresh DB state.
+With system specs, this configuration is provided out-of-the-box.
 
-### Upgrade note
+Like system specs, feature specs require the [Capybara][] gem.
+Rails 5.1+ includes it by default as part of system tests,
+but if you don’t have the luxury of upgrading,
+be sure to add it to the `:test` group of your `Gemfile` first:
 
 ```ruby
-# rspec-rails-1.x
-render
-response.should xxx
-
-# rspec-rails-2.x
-render
-rendered.should xxx
-
-# rspec-rails-2.x with expect syntax
-render
-expect(rendered).to xxx
-```
-
-# Routing specs
-
-Routing specs live in spec/routing.
-
-```ruby
-require 'spec_helper'
-describe "routing to profiles" do
-  it "routes /profile/:username to profile#show for username" do
-    expect(:get => "/profiles/jsmith").to route_to(
-      :controller => "profiles",
-      :action => "show",
-      :username => "jsmith"
-    )
-  end
-
-  it "does not expose a list of profiles" do
-    expect(:get => "/profiles").not_to be_routable
-  end
-end
-```
-
-### Upgrade note
-
-`route_for` from rspec-rails-1.x is gone. Use `route_to` and `be_routable` instead.
-
-# Helper specs
-
-Helper specs live in spec/helpers, and mix in ActionView::TestCase::Behavior.
-
-Provides a `helper` object which mixes in the helper module being spec'd, along
-with `ApplicationHelper` (if present).
-
-```ruby
-require 'spec_helper'
-describe EventsHelper do
-  describe "#link_to_event" do
-    it "displays the title, and formatted date" do
-      event = Event.new("Ruby Kaigi", Date.new(2010, 8, 27))
-      # helper is an instance of ActionView::Base configured with the
-      # EventsHelper and all of Rails' built-in helpers
-      expect(helper.link_to_event).to match /Ruby Kaigi, 27 Aug, 2010/
-    end
-  end
+group :test do
+  gem "capybara"
 end
 ```
 
-# Matchers
-
-rspec-rails exposes domain-specific matchers to each of the example group types. Most
-of them simply delegate to Rails' assertions.
-
-## `be_a_new`
-* Available in all specs.
-* Primarily intended for controller specs
-
-```ruby
-expect(object).to be_a_new(Widget)
-```
-
-
-Passes if the object is a `Widget` and returns true for `new_record?`
-
-## `render_template`
-* Delegates to Rails' assert_template.
-* Available in request, controller, and view specs.
-
-In request and controller specs, apply to the response object:
-
-```ruby
-expect(response).to render_template("new")
-```
-
-In view specs, apply to the view object:
-
-```ruby
-expect(view).to render_template(:partial => "_form", :locals => { :widget => widget } )
-```
-
-## `redirect_to`
-* Delegates to assert_redirect
-* Available in request and controller specs.
-
-```ruby
-expect(response).to redirect_to(widgets_path)
-```
-
-## `route_to`
-
-* Delegates to Rails' assert_routing.
-* Available in routing and controller specs.
-
-```ruby
-expect(:get => "/widgets").to route_to(:controller => "widgets", :action => "index")
-```
-
-## `be_routable`
+[officially recommends system specs]: https://rspec.info/blog/2017/10/rspec-3-7-has-been-released/#rails-actiondispatchsystemtest-integration-system-specs
+[Capybara]: https://github.com/teamcapybara/capybara
 
-Passes if the path is recognized by Rails' routing. This is primarily intended
-to be used with `not_to` to specify routes that should not be routable.
+#### Request specs
 
-```ruby
-expect(:get => "/widgets/1/edit").not_to be_routable
-```
+Request specs are for testing the application
+from the perspective of a _machine client._
+They begin with an HTTP request and end with the HTTP response,
+so they’re faster than feature specs,
+but do not examine your app’s UI or JavaScript.
 
-# `rake` tasks
+Request specs provide a high-level alternative to controller specs.
+In fact, as of RSpec 3.5, both the Rails and RSpec teams
+[discourage directly testing controllers][]
+in favor of functional tests like request specs.
 
-`rspec-rails` defines rake tasks to run the entire test suite (`rake spec`)
-and subsets of tests (e.g., `rake spec:models`).
+When writing them, try to answer the question,
+“For a given HTTP request (verb + path + parameters),
+what HTTP response should the application return?”
 
-A full list of the available rake tasks can be seen by running `rake -T | grep
-spec`.
+[discourage directly testing controllers]: https://rspec.info/blog/2016/07/rspec-3-5-has-been-released/#rails-support-for-rails-5
 
-## Customizing `rake` tasks
-
-If you want to customize the behavior of `rake spec`, you may [define your own
-task in the `Rakefile` for your
-project](https://www.relishapp.com/rspec/rspec-core/docs/command-line/rake-task).
-However, you must first clear the task that rspec-rails defined:
-
-```ruby
-task("spec").clear
-```
-
-### Webrat and Capybara
-
-You can choose between webrat or capybara for simulating a browser, automating
-a browser, or setting expectations using the matchers they supply. Just add
-your preference to the Gemfile:
-
-```ruby
-gem "webrat"
-# ... or ...
-gem "capybara"
-```
+## Contributing
 
-See [http://rubydoc.info/gems/rspec-rails/file/Capybara.md](http://rubydoc.info/gems/rspec-rails/file/Capybara.md)
-for more info on Capybara integration.
+- [Build details](BUILD_DETAIL.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Detailed contributing guide](CONTRIBUTING.md)
 
-# Contribute
+Once you’ve cloned the repo and [set up the environment](DEVELOPMENT.md),
+you can run the specs and Cucumber features, or submit a pull request.
 
-See [http://github.com/rspec/rspec-dev](http://github.com/rspec/rspec-dev).
+## See Also
 
-For `rspec-rails`-specific development information, see
-[DEV-README](https://github.com/rspec/rspec-rails/blob/master/DEV-README.md).
+### RSpec base libraries
 
-# Also see
+* <https://github.com/rspec/rspec>
+* <https://github.com/rspec/rspec-core>
+* <https://github.com/rspec/rspec-expectations>
+* <https://github.com/rspec/rspec-mocks>
 
-* [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
-* [http://github.com/rspec/rspec-core](http://github.com/rspec/rspec-core)
-* [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)
-* [http://github.com/rspec/rspec-mocks](http://github.com/rspec/rspec-mocks)
+### Recommended third-party extensions
 
-## Feature Requests & Bugs
+* [FactoryBot](https://github.com/thoughtbot/factory_bot)
+* [Capybara](https://github.com/teamcapybara/capybara)
+  (Included by default in Rails 5.1+.
+  Note that [additional configuration is required][] to use the Capybara DSL
+  anywhere other than system specs and feature specs.)
 
-See <http://github.com/rspec/rspec-rails/issues>
+  [additional configuration is required]: https://rubydoc.info/gems/rspec-rails/file/Capybara.md