Update RSpec test style across docs

Instead of using describe Foo do # ... end use RSpec.describe Foo, type: :model do # ... end instead. This is not exactly official, as the former style still works, but the latter style is highly suggested in RSpec documentation and the like, so this is what people are used to. [ci skip]
Fatsoma · Jun 16, 2016 · afa6a7b · afa6a7b
1 parent a1eee11
commit afa6a7b
Show file tree

Hide file tree

Showing 32 changed files with 159 additions and 159 deletions.
diff --git a/docs/errors/NonCaseSwappableValueError.md b/docs/errors/NonCaseSwappableValueError.md
@@ -46,7 +46,7 @@ error message explains, you have two options:
         end
 
         # RSpec
-        describe User do
+        RSpec.describe User, type: :model do
           context "validations" do
             subject do
               # Note that "123" == "123".swapcase. This is a problem!
@@ -87,7 +87,7 @@ error message explains, you have two options:
         end
         
         # RSpec
-        describe User do
+        RSpec.describe User, type: :model do
           context "validations" do
             subject do
               # Note that "123" == "123".swapcase, but it's okay

diff --git a/lib/shoulda/matchers/action_controller/callback_matcher.rb b/lib/shoulda/matchers/action_controller/callback_matcher.rb
@@ -9,7 +9,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe UsersController do
+      #     RSpec.describe UsersController, type: :controller do
       #       it { should use_before_filter(:authenticate_user!) }
       #       it { should_not use_before_filter(:prevent_ssl) }
       #     end
@@ -34,7 +34,7 @@ def use_before_filter(callback)
       #     end
       #
       #     # RSpec
-      #     describe IssuesController do
+      #     RSpec.describe IssuesController, type: :controller do
       #       it { should use_after_filter(:log_activity) }
       #       it { should_not use_after_filter(:destroy_user) }
       #     end
@@ -59,7 +59,7 @@ def use_after_filter(callback)
       #     end
       #
       #     # RSpec
-      #     describe UsersController do
+      #     RSpec.describe UsersController, type: :controller do
       #       it { should use_before_action(:authenticate_user!) }
       #       it { should_not use_before_action(:prevent_ssl) }
       #     end
@@ -84,7 +84,7 @@ def use_before_action(callback)
       #     end
       #
       #     # RSpec
-      #     describe IssuesController do
+      #     RSpec.describe IssuesController, type: :controller do
       #       it { should use_after_action(:log_activity) }
       #       it { should_not use_after_action(:destroy_user) }
       #     end
@@ -109,7 +109,7 @@ def use_after_action(callback)
       #     end
       #
       #     # RSpec
-      #     describe ChangesController do
+      #     RSpec.describe ChangesController, type: :controller do
       #       it { should use_around_filter(:wrap_in_transaction) }
       #       it { should_not use_around_filter(:save_view_context) }
       #     end
@@ -134,7 +134,7 @@ def use_around_filter(callback)
       #     end
       #
       #     # RSpec
-      #     describe ChangesController do
+      #     RSpec.describe ChangesController, type: :controller do
       #       it { should use_around_action(:wrap_in_transaction) }
       #       it { should_not use_around_action(:save_view_context) }
       #     end

diff --git a/lib/shoulda/matchers/action_controller/filter_param_matcher.rb b/lib/shoulda/matchers/action_controller/filter_param_matcher.rb
@@ -10,7 +10,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe ApplicationController do
+      #     RSpec.describe ApplicationController, type: :controller do
       #       it { should filter_param(:secret_key) }
       #     end
       #

diff --git a/lib/shoulda/matchers/action_controller/permit_matcher.rb b/lib/shoulda/matchers/action_controller/permit_matcher.rb
@@ -35,7 +35,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe UsersController do
+      #     RSpec.describe UsersController, type: :controller do
       #       it do
       #         params = {
       #           user: {
@@ -96,7 +96,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe UsersController do
+      #     RSpec.describe UsersController, type: :controller do
       #       before do
       #         create(:user, id: 1)
       #       end
@@ -170,7 +170,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe UsersController do
+      #     RSpec.describe UsersController, type: :controller do
       #       before do
       #         create(:user, id: 1)
       #       end

diff --git a/lib/shoulda/matchers/action_controller/redirect_to_matcher.rb b/lib/shoulda/matchers/action_controller/redirect_to_matcher.rb
@@ -14,7 +14,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #show' do
       #         before { get :show }
       #

diff --git a/lib/shoulda/matchers/action_controller/render_template_matcher.rb b/lib/shoulda/matchers/action_controller/render_template_matcher.rb
@@ -15,7 +15,7 @@ module ActionController
       #     <%= render 'sidebar' %>
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #show' do
       #         before { get :show }
       #

diff --git a/lib/shoulda/matchers/action_controller/render_with_layout_matcher.rb b/lib/shoulda/matchers/action_controller/render_with_layout_matcher.rb
@@ -11,7 +11,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #show' do
       #         before { get :show }
       #
@@ -38,7 +38,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #sidebar' do
       #         before { get :sidebar }
       #

diff --git a/lib/shoulda/matchers/action_controller/rescue_from_matcher.rb b/lib/shoulda/matchers/action_controller/rescue_from_matcher.rb
@@ -16,7 +16,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe ApplicationController do
+      #     RSpec.describe ApplicationController, type: :controller do
       #       it do
       #         should rescue_from(ActiveRecord::RecordNotFound).
       #           with(:handle_not_found)

diff --git a/lib/shoulda/matchers/action_controller/respond_with_matcher.rb b/lib/shoulda/matchers/action_controller/respond_with_matcher.rb
@@ -13,7 +13,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -39,7 +39,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'DELETE #destroy' do
       #         before { delete :destroy }
       #
@@ -65,7 +65,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #show' do
       #         before { get :show }
       #

diff --git a/lib/shoulda/matchers/action_controller/route_matcher.rb b/lib/shoulda/matchers/action_controller/route_matcher.rb
@@ -24,7 +24,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       it { should route(:get, '/posts').to(action: :index) }
       #       it { should route(:get, '/posts/1').to(action: :show, id: 1) }
       #     end
@@ -38,7 +38,7 @@ module ActionController
       # Or you could place the tests along with other route tests:
       #
       #     # RSpec
-      #     describe 'Routing' do
+      #     describe 'Routing', type: :routing do
       #       it do
       #         should route(:get, '/posts').
       #           to(controller: :posts, action: :index)

diff --git a/lib/shoulda/matchers/action_controller/set_flash_matcher.rb b/lib/shoulda/matchers/action_controller/set_flash_matcher.rb
@@ -16,7 +16,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -58,7 +58,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -89,7 +89,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -124,7 +124,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #show' do
       #         before { get :show }
       #

diff --git a/lib/shoulda/matchers/action_controller/set_session_matcher.rb b/lib/shoulda/matchers/action_controller/set_session_matcher.rb
@@ -16,7 +16,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -58,7 +58,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -89,7 +89,7 @@ module ActionController
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #

diff --git a/lib/shoulda/matchers/active_model.rb b/lib/shoulda/matchers/active_model.rb
@@ -60,7 +60,7 @@ module Matchers
     #     end
     #
     #     # RSpec
-    #     describe User do
+    #     RSpec.describe User, type: :model do
     #       context "when an admin" do
     #         subject { User.new(admin: true) }
     #

diff --git a/lib/shoulda/matchers/active_model/allow_mass_assignment_of_matcher.rb b/lib/shoulda/matchers/active_model/allow_mass_assignment_of_matcher.rb
@@ -23,11 +23,11 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe Post do
+      #     RSpec.describe Post, type: :model do
       #       it { should allow_mass_assignment_of(:title) }
       #     end
       #
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it { should_not allow_mass_assignment_of(:encrypted_password) }
       #     end
       #
@@ -56,7 +56,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe Post do
+      #     RSpec.describe Post, type: :model do
       #       it { should allow_mass_assignment_of(:title).as(:admin) }
       #     end
       #

diff --git a/lib/shoulda/matchers/active_model/allow_value_matcher.rb b/lib/shoulda/matchers/active_model/allow_value_matcher.rb
@@ -17,7 +17,7 @@ module ActiveModel
       # You can use `allow_value` to test one value at a time:
       #
       #     # RSpec
-      #     describe UserProfile do
+      #     RSpec.describe UserProfile, type: :model do
       #       it { should allow_value('http://foo.com').for(:website_url) }
       #       it { should allow_value('http://bar.com').for(:website_url) }
       #     end
@@ -34,7 +34,7 @@ module ActiveModel
       # that none of the values cause the record to be valid:
       #
       #     # RSpec
-      #     describe UserProfile do
+      #     RSpec.describe UserProfile, type: :model do
       #       it do
       #         should allow_values('http://foo.com', 'http://bar.com').
       #           for(:website_url)
@@ -82,7 +82,7 @@ module ActiveModel
       #           end
       #         end
       #
-      #         describe Foo do
+      #         RSpec.describe Foo, type: :model do
       #           it do
       #             foo = Foo.new
       #             foo.bar = "baz"
@@ -105,7 +105,7 @@ module ActiveModel
       #           end
       #         end
       #
-      #         describe Foo do
+      #         RSpec.describe Foo, type: :model do
       #           it do
       #             foo = Foo.new
       #             # This will raise an AttributeChangedValueError since `foo.bar` is now "123"
@@ -116,7 +116,7 @@ module ActiveModel
       # * You're passing a value to `allow_value` that the model typecasts into
       #   another value:
       #
-      #         describe Foo do
+      #         RSpec.describe Foo, type: :model do
       #           # Assume that `attr` is a string
       #           # This will raise an AttributeChangedValueError since `attr` typecasts `[]` to `"[]"`
       #           it { should_not allow_value([]).for(:attr) }
@@ -154,7 +154,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe UserProfile do
+      #     RSpec.describe UserProfile, type: :model do
       #       it do
       #         should allow_value('2013-01-01').
       #           for(:birthday_as_string).
@@ -183,7 +183,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe UserProfile do
+      #     RSpec.describe UserProfile, type: :model do
       #       it do
       #         should allow_value('open', 'closed').
       #           for(:state).
@@ -210,7 +210,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe UserProfile do
+      #     RSpec.describe UserProfile, type: :model do
       #       it do
       #         should allow_value('open', 'closed').
       #           for(:state).
@@ -246,7 +246,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe UserProfile do
+      #     RSpec.describe UserProfile, type: :model do
       #       it do
       #         should allow_value('Broncos', 'Titans').
       #           for(:sports_team).
@@ -276,7 +276,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe Address do
+      #     RSpec.describe Address, type: :model do
       #       it do
       #         should_not allow_value([]).
       #           for(:zip_code).

diff --git a/lib/shoulda/matchers/active_model/have_secure_password_matcher.rb b/lib/shoulda/matchers/active_model/have_secure_password_matcher.rb
@@ -15,7 +15,7 @@ module ActiveModel
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it { should have_secure_password }
       #     end
       #