Merge pull request #1190 from rspec/update_request_docs

manually tag request specs to aid users

Author: JonRowe

features/controller_specs/README.md

@@ -1,5 +1,5 @@
-Controller specs live in `spec/controllers` or any example group with
-`:type => :controller`.
+Controller specs are marked by `:type => :controller` or if you have set
+`config.infer_spec_type_from_file_location!` by placing them in `spec/controllers`.
 
 A controller spec is an RSpec wrapper for a Rails functional test
 ([ActionController::TestCase::Behavior](https://github.com/rails/rails/blob/master/actionpack/lib/action_controller/test_case.rb)).

features/controller_specs/anonymous_controller.feature

@@ -20,7 +20,7 @@ Feature: anonymous controller
     c.infer_base_class_for_anonymous_controllers = false
   end
 
-  RSpec.describe BaseController do
+  RSpec.describe BaseController, :type => :controller do
     controller do
       def index; end
 
@@ -48,7 +48,7 @@ Feature: anonymous controller
         end
       end
 
-      RSpec.describe ApplicationController do
+      RSpec.describe ApplicationController, :type => :controller do
         controller do
           def index
             raise ApplicationController::AccessDenied
@@ -86,7 +86,7 @@ Feature: anonymous controller
         end
       end
 
-      RSpec.describe ApplicationControllerSubclass do
+      RSpec.describe ApplicationControllerSubclass, :type => :controller do
         controller(ApplicationControllerSubclass) do
           def index
             raise ApplicationController::AccessDenied
@@ -113,7 +113,7 @@ Feature: anonymous controller
 
       class ApplicationControllerSubclass < ApplicationController; end
 
-      RSpec.describe ApplicationControllerSubclass do
+      RSpec.describe ApplicationControllerSubclass, :type => :controller do
         controller do
           def index
             render :text => "Hello World"
@@ -136,7 +136,7 @@ Feature: anonymous controller
       class ApplicationController < ActionController::Base; end
       class FoosController < ApplicationController; end
 
-      RSpec.describe "FoosController controller_name" do
+      RSpec.describe "FoosController controller_name", :type => :controller do
         controller FoosController do
           def index
             @name = self.class.name
@@ -175,7 +175,7 @@ Feature: anonymous controller
         end
       end
 
-      RSpec.describe ApplicationController do
+      RSpec.describe ApplicationController, :type => :controller do
         controller do
           def index
             render :nothing => true
@@ -197,7 +197,7 @@ Feature: anonymous controller
       """ruby
       require "rails_helper"
 
-      RSpec.describe ApplicationController do
+      RSpec.describe ApplicationController, :type => :controller do
         controller do
           def index
             render :text => "index called"
@@ -375,7 +375,7 @@ Feature: anonymous controller
       """ruby
       require "rails_helper"
 
-      RSpec.describe ApplicationController do
+      RSpec.describe ApplicationController, :type => :controller do
         controller do
           def custom
             render :text => "custom called"
@@ -400,7 +400,7 @@ Feature: anonymous controller
 
       class FoosController < ApplicationController; end
 
-      RSpec.describe ApplicationController do
+      RSpec.describe ApplicationController, :type => :controller do
         controller FoosController do
           def custom
             render :text => "custom called"
@@ -430,7 +430,7 @@ Feature: anonymous controller
         end
       end
 
-      RSpec.describe TopLevel::InnerSpace::FoosController do
+      RSpec.describe TopLevel::InnerSpace::FoosController, :type => :controller do
         controller do
           def index
             @name = self.class.name
@@ -466,7 +466,7 @@ Feature: anonymous controller
         match "/login" => "sessions#new", :as => "login", :via => "get"
       end
 
-      RSpec.describe ApplicationController do
+      RSpec.describe ApplicationController, :type => :controller do
         controller do
           def index
             redirect_to login_url

features/controller_specs/bypass_rescue.feature

@@ -30,7 +30,7 @@ Feature: bypass rescue
 
       require 'controllers/gadgets_controller_spec_context'
 
-      RSpec.describe GadgetsController do
+      RSpec.describe GadgetsController, :type => :controller do
         before do
           def controller.index
             raise AccessDenied
@@ -55,7 +55,7 @@ Feature: bypass rescue
 
       require 'controllers/gadgets_controller_spec_context'
 
-      RSpec.describe GadgetsController do
+      RSpec.describe GadgetsController, :type => :controller do
         before do
           def controller.index
             raise AccessDenied

features/controller_specs/controller_spec.feature

@@ -5,7 +5,7 @@ Feature: controller spec
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         describe "GET index" do
           it "has a 200 status code" do
             get :index
@@ -24,7 +24,7 @@ Feature: controller spec
 
       RSpec.configure {|c| c.before { expect(controller).not_to be_nil }}
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         describe "GET index" do
           it "doesn't matter" do
           end
@@ -46,7 +46,7 @@ Feature: controller spec
 
       RSpec.configure {|c| c.include MyHelper }
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         let(:my_variable) { 'is a value' }
 
         describe 'something' do

features/controller_specs/engine_routes.feature

@@ -34,7 +34,7 @@ Feature: engine routes for controllers
         end
       end
 
-      RSpec.describe MyEngine::WidgetsController do
+      RSpec.describe MyEngine::WidgetsController, :type => :controller do
         routes { MyEngine::Engine.routes }
 
         it "redirects to a random widget" do

features/controller_specs/isolation_from_views.feature

@@ -12,7 +12,7 @@ Feature: views are stubbed by default
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         describe "index" do
           it "renders the index template" do
             get :index
@@ -35,7 +35,7 @@ Feature: views are stubbed by default
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         describe "index" do
           it "renders the 'new' template" do
             get :index
@@ -52,7 +52,7 @@ Feature: views are stubbed by default
       """ruby
       require "rails_helper"
 
-      RSpec.describe ThingsController do
+      RSpec.describe ThingsController, :type => :controller do
         describe "custom_action" do
           it "renders an empty custom_action template" do
             controller.prepend_view_path 'app/views'
@@ -72,7 +72,7 @@ Feature: views are stubbed by default
       """ruby
       require "rails_helper"
 
-      RSpec.describe ThingsController do
+      RSpec.describe ThingsController, :type => :controller do
         render_views
 
         it "renders the real custom_action template" do

features/controller_specs/render_views.feature

@@ -8,7 +8,7 @@ Feature: render_views
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         render_views
 
         describe "GET index" do
@@ -27,7 +27,7 @@ Feature: render_views
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         context "with render_views" do
           render_views
 
@@ -101,7 +101,7 @@ Feature: render_views
       require "rails_helper"
       require "support/render_views"
 
-      RSpec.describe WidgetsController do
+      RSpec.describe WidgetsController, :type => :controller do
         describe "GET index" do
           it "renders the index template" do
             get :index

features/feature_specs/feature_spec.feature

@@ -5,6 +5,9 @@ Feature: feature spec
   through an application. They should drive the application only via its
   external interface, usually web pages.
 
+  Feature specs are marked by `:type => :feature` or if you have set
+  `config.infer_spec_type_from_file_location!` by placing them in `spec/features`.
+
   Feature specs require the [capybara](http://github.com/jnicklas/capybara)
   gem, version 2.2.0 or later (we recommend 2.3.0 or later to avoid some
   deprecation warnings). Refer to the [capybara API
@@ -14,7 +17,8 @@ Feature: feature spec
   The `feature` and `scenario` DSL correspond to `describe` and `it`,
   respectively. These methods are simply aliases that allow feature specs to
   read more as [customer tests](http://c2.com/cgi/wiki?CustomerTest) and
-  [acceptance tests](http://c2.com/cgi/wiki?AcceptanceTest).
+  [acceptance tests](http://c2.com/cgi/wiki?AcceptanceTest). They set
+  `:type => :feature` automatically for you.
 
   Scenario: specify creating a Widget by driving the application with capybara
     Given a file named "spec/features/widget_management_spec.rb" with:

features/helper_specs/helper_spec.feature

@@ -1,7 +1,7 @@
 Feature: helper spec
 
-  Helper specs live in `spec/helpers`, or any example group with `:type =>
-  :helper`.
+  Helper specs are marked by `:type => :helper` or if you have set
+  `config.infer_spec_type_from_file_location!` by placing them in `spec/helpers`.
 
   Helper specs expose a `helper` object, which includes the helper module being
   specified, the `ApplicationHelper` module (if there is one) and all of the
@@ -18,7 +18,7 @@ Feature: helper spec
       """ruby
       require "rails_helper"
 
-      RSpec.describe ApplicationHelper do
+      RSpec.describe ApplicationHelper, :type => :helper do
         describe "#page_title" do
           it "returns the default title" do
             expect(helper.page_title).to eq("RSpec is your friend")
@@ -42,7 +42,7 @@ Feature: helper spec
       """ruby
       require "rails_helper"
 
-      RSpec.describe ApplicationHelper do
+      RSpec.describe ApplicationHelper, :type => :helper do
         describe "#page_title" do
           it "returns the instance variable" do
             assign(:title, "My Title")
@@ -67,7 +67,7 @@ Feature: helper spec
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsHelper do
+      RSpec.describe WidgetsHelper, :type => :helper do
         describe "#widget_title" do
           it "includes the app name" do
             assign(:title, "This Widget")
@@ -100,7 +100,7 @@ Feature: helper spec
       """ruby
       require "rails_helper"
 
-      RSpec.describe WidgetsHelper do
+      RSpec.describe WidgetsHelper, :type => :helper do
         describe "#link_to_widget" do
           it "links to a widget using its name" do
             widget = Widget.create!(:name => "This Widget")

features/mailer_specs/url_helpers.feature

@@ -1,5 +1,8 @@
 Feature: URL helpers in mailer examples
 
+  Mailer specs are marked by `:type => :mailer` or if you have set
+  `config.infer_spec_type_from_file_location!` by placing them in `spec/mailer`.
+
   Scenario: using URL helpers with default options
     Given a file named "config/initializers/mailer_defaults.rb" with:
       """ruby
@@ -9,7 +12,7 @@ Feature: URL helpers in mailer examples
       """ruby
       require 'rails_helper'
 
-      RSpec.describe Notifications do
+      RSpec.describe Notifications, :type => :mailer do
         it 'should have access to URL helpers' do
           expect { gadgets_url }.not_to raise_error
         end
@@ -27,7 +30,7 @@ Feature: URL helpers in mailer examples
       """ruby
       require 'rails_helper'
 
-      RSpec.describe Notifications do
+      RSpec.describe Notifications, :type => :mailer do
         it 'should have access to URL helpers' do
           expect { gadgets_url :host => 'example.com' }.not_to raise_error
           expect { gadgets_url }.to raise_error

features/model_specs/README.md

@@ -1,5 +1,5 @@
-Model specs live in `spec/models` or any example group with
-`:type => :model`.
+Model specs are marked by `:type => :model` or if you have set
+`config.infer_spec_type_from_file_location!` by placing them in `spec/models`.
 
 A model spec is a thin wrapper for an ActiveSupport::TestCase, and includes all
 of the behavior and assertions that it provides, in addition to RSpec's own
@@ -9,7 +9,7 @@ behavior and expectations.
 
     require "rails_helper"
 
-    RSpec.describe Post do
+    RSpec.describe Post, :type => :model do
       context "with 2 or more comments" do
         it "orders them in reverse chronologically" do
           post = Post.create!

features/model_specs/transactional_examples.feature

@@ -10,7 +10,7 @@ Feature: transactional examples
       """ruby
       require "rails_helper"
 
-      RSpec.describe Widget do
+      RSpec.describe Widget, :type => :model do
         it "has none to begin with" do
           expect(Widget.count).to eq 0
         end
@@ -37,7 +37,7 @@ Feature: transactional examples
         c.use_transactional_examples = true
       end
 
-      RSpec.describe Widget do
+      RSpec.describe Widget, :type => :model do
         it "has none to begin with" do
           expect(Widget.count).to eq 0
         end
@@ -65,7 +65,7 @@ Feature: transactional examples
         c.order = "defined"
       end
 
-      RSpec.describe Widget do
+      RSpec.describe Widget, :type => :model do
         it "has none to begin with" do
           expect(Widget.count).to eq 0
         end
@@ -90,7 +90,7 @@ Feature: transactional examples
       """ruby
       require "rails_helper"
 
-      RSpec.describe Thing do
+      RSpec.describe Thing, :type => :model do
         fixtures :things
         it "fixture method defined" do
           things(:one)

features/request_specs/request_spec.feature

@@ -4,6 +4,9 @@ Feature: request spec
   designed to drive behavior through the full stack, including routing
   (provided by Rails) and without stubbing (that's up to you).
 
+  Request specs are marked by `:type => :request` or if you have set
+  `config.infer_spec_type_from_file_location!` by placing them in `spec/requests`.
+
   With request specs, you can:
 
   * specify a single request
@@ -28,7 +31,7 @@ Feature: request spec
       """ruby
       require "rails_helper"
 
-      RSpec.describe "Widget management" do
+      RSpec.describe "Widget management", :type => :request do
 
         it "creates a Widget and redirects to the Widget's page" do
           get "/widgets/new"

features/routing_specs/README.md

@@ -1,5 +1,5 @@
-Routing specs live in the `spec/routing` directory, or any example group with
-`:type => :routing`.
+Routing specs are marked by `:type => :routing` or if you have set
+`config.infer_spec_type_from_file_location!` by placing them in `spec/routing`.
 
 Simple apps with nothing but standard RESTful routes won't get much value from
 routing specs, but they can provide significant value when used to specify