rspec-rails 3.9.1 → 5.0.1

data/lib/generators/rspec/model/templates/fixtures.yml

@@ -1,4 +1,4 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
 <% unless attributes.empty? -%>
 one:

data/lib/generators/rspec/request/request_generator.rb

@@ -4,7 +4,7 @@ module Rspec
   module Generators
     # @private
     class RequestGenerator < IntegrationGenerator
-      source_paths << File.expand_path("../../integration/templates", __FILE__)
+      source_paths << File.expand_path('../integration/templates', __dir__)
     end
   end
 end

data/lib/generators/rspec/scaffold/scaffold_generator.rb

@@ -6,18 +6,19 @@ module Rspec
     # @private
     class ScaffoldGenerator < Base
       include ::Rails::Generators::ResourceHelpers
-      source_paths << File.expand_path("../../helper/templates", __FILE__)
-      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      source_paths << File.expand_path('../helper/templates', __dir__)
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
-      class_option :orm, :desc => "ORM used to generate the controller"
-      class_option :template_engine, :desc => "Template engine to generate view files"
-      class_option :singleton, :type => :boolean, :desc => "Supply to create a singleton controller"
-      class_option :api, :type => :boolean, :desc => "Skip specs unnecessary for API-only apps"
+      class_option :orm, desc: "ORM used to generate the controller"
+      class_option :template_engine, desc: "Template engine to generate view files"
+      class_option :singleton, type: :boolean, desc: "Supply to create a singleton controller"
+      class_option :api, type: :boolean, desc: "Skip specs unnecessary for API-only apps"
 
-      class_option :controller_specs, :type => :boolean, :default => true,  :desc => "Generate controller specs"
-      class_option :view_specs,       :type => :boolean, :default => true,  :desc => "Generate view specs"
-      class_option :helper_specs,     :type => :boolean, :default => true,  :desc => "Generate helper specs"
-      class_option :routing_specs,    :type => :boolean, :default => true,  :desc => "Generate routing specs"
+      class_option :controller_specs, type: :boolean, default: false, desc: "Generate controller specs"
+      class_option :request_specs,    type: :boolean, default: true,  desc: "Generate request specs"
+      class_option :view_specs,       type: :boolean, default: true,  desc: "Generate view specs"
+      class_option :helper_specs,     type: :boolean, default: true,  desc: "Generate helper specs"
+      class_option :routing_specs,    type: :boolean, default: true,  desc: "Generate routing specs"
 
       def initialize(*args, &blk)
         @generator_args = args.first
@@ -27,15 +28,20 @@ module Rspec
       def generate_controller_spec
         return unless options[:controller_specs]
 
-        template_file = File.join(
-          'spec/controllers',
-          controller_class_path,
-          "#{controller_file_name}_controller_spec.rb"
-        )
         if options[:api]
-          template 'api_controller_spec.rb', template_file
+          template 'api_controller_spec.rb', template_file(folder: 'controllers', suffix: '_controller')
+        else
+          template 'controller_spec.rb', template_file(folder: 'controllers', suffix: '_controller')
+        end
+      end
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        if options[:api]
+          template 'api_request_spec.rb', template_file(folder: 'requests')
         else
-          template 'controller_spec.rb', template_file
+          template 'request_spec.rb', template_file(folder: 'requests')
         end
       end
 
@@ -60,8 +66,6 @@ module Rspec
         template 'routing_spec.rb', template_file
       end
 
-      hook_for :integration_tool, :as => :integration
-
     protected
 
       attr_reader :generator_args
@@ -74,12 +78,14 @@ module Rspec
       # support for namespaced-resources
       def ns_file_name
         return file_name if ns_parts.empty?
+
         "#{ns_prefix.map(&:underscore).join('/')}_#{ns_suffix.singularize.underscore}"
       end
 
       # support for namespaced-resources
       def ns_table_name
         return table_name if ns_parts.empty?
+
         "#{ns_prefix.map(&:underscore).join('/')}/#{ns_suffix.tableize}"
       end
 
@@ -114,6 +120,10 @@ module Rspec
         end
       end
 
+      def template_file(folder:, suffix: '')
+        File.join('spec', folder, controller_class_path, "#{controller_file_name}#{suffix}_spec.rb")
+      end
+
       def banner
         self.class.banner
       end

data/lib/generators/rspec/scaffold/templates/api_controller_spec.rb

@@ -46,11 +46,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
   describe "GET #index" do
     it "returns a success response" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if RUBY_VERSION < '1.9.3' -%>
-      get :index, {}, valid_session
-<% else -%>
       get :index, params: {}, session: valid_session
-<% end -%>
       expect(response).to be_successful
     end
   end
@@ -59,11 +55,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
   describe "GET #show" do
     it "returns a success response" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if RUBY_VERSION < '1.9.3' -%>
-      get :show, {:id => <%= file_name %>.to_param}, valid_session
-<% else -%>
       get :show, params: {id: <%= file_name %>.to_param}, session: valid_session
-<% end -%>
       expect(response).to be_successful
     end
   end
@@ -72,20 +64,12 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
     context "with valid params" do
       it "creates a new <%= class_name %>" do
         expect {
-<% if RUBY_VERSION < '1.9.3' -%>
-          post :create, {:<%= ns_file_name %> => valid_attributes}, valid_session
-<% else -%>
           post :create, params: {<%= ns_file_name %>: valid_attributes}, session: valid_session
-<% end -%>
         }.to change(<%= class_name %>, :count).by(1)
       end
 
       it "renders a JSON response with the new <%= ns_file_name %>" do
-<% if RUBY_VERSION < '1.9.3' -%>
-        post :create, {:<%= ns_file_name %> => valid_attributes}, valid_session
-<% else %>
         post :create, params: {<%= ns_file_name %>: valid_attributes}, session: valid_session
-<% end -%>
         expect(response).to have_http_status(:created)
         expect(response.content_type).to eq('application/json')
         expect(response.location).to eq(<%= ns_file_name %>_url(<%= class_name %>.last))
@@ -94,11 +78,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 
     context "with invalid params" do
       it "renders a JSON response with errors for the new <%= ns_file_name %>" do
-<% if RUBY_VERSION < '1.9.3' -%>
-        post :create, {:<%= ns_file_name %> => invalid_attributes}, valid_session
-<% else %>
         post :create, params: {<%= ns_file_name %>: invalid_attributes}, session: valid_session
-<% end -%>
         expect(response).to have_http_status(:unprocessable_entity)
         expect(response.content_type).to eq('application/json')
       end
@@ -113,22 +93,14 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 
       it "updates the requested <%= ns_file_name %>" do
         <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if RUBY_VERSION < '1.9.3' -%>
-        put :update, {:id => <%= file_name %>.to_param, :<%= ns_file_name %> => new_attributes}, valid_session
-<% else -%>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: new_attributes}, session: valid_session
-<% end -%>
         <%= file_name %>.reload
         skip("Add assertions for updated state")
       end
 
       it "renders a JSON response with the <%= ns_file_name %>" do
         <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if RUBY_VERSION < '1.9.3' -%>
-        put :update, {:id => <%= file_name %>.to_param, :<%= ns_file_name %> => valid_attributes}, valid_session
-<% else %>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: valid_attributes}, session: valid_session
-<% end -%>
         expect(response).to have_http_status(:ok)
         expect(response.content_type).to eq('application/json')
       end
@@ -137,11 +109,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
     context "with invalid params" do
       it "renders a JSON response with errors for the <%= ns_file_name %>" do
         <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if RUBY_VERSION < '1.9.3' -%>
-        put :update, {:id => <%= file_name %>.to_param, :<%= ns_file_name %> => invalid_attributes}, valid_session
-<% else %>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: invalid_attributes}, session: valid_session
-<% end -%>
         expect(response).to have_http_status(:unprocessable_entity)
         expect(response.content_type).to eq('application/json')
       end
@@ -152,11 +120,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
     it "destroys the requested <%= ns_file_name %>" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
       expect {
-<% if RUBY_VERSION < '1.9.3' -%>
-        delete :destroy, {:id => <%= file_name %>.to_param}, valid_session
-<% else -%>
         delete :destroy, params: {id: <%= file_name %>.to_param}, session: valid_session
-<% end -%>
       }.to change(<%= class_name %>, :count).by(-1)
     end
   end

data/lib/generators/rspec/scaffold/templates/api_request_spec.rb

@@ -0,0 +1,131 @@
+require 'rails_helper'
+
+# This spec was generated by rspec-rails when you ran the scaffold generator.
+# It demonstrates how one might use RSpec to test the controller code that
+# was generated by Rails when you ran the scaffold generator.
+#
+# It assumes that the implementation code is generated by the rails scaffold
+# generator. If you are using any extension libraries to generate different
+# controller code, this generated spec may or may not pass.
+#
+# It only uses APIs available in rails and/or rspec-rails. There are a number
+# of tools you can use to make these specs even more expressive, but we're
+# sticking to rails and rspec-rails APIs to keep things simple and stable.
+
+<% module_namespacing do -%>
+RSpec.describe "/<%= name.underscore.pluralize %>", <%= type_metatag(:request) %> do
+  # This should return the minimal set of attributes required to create a valid
+  # <%= class_name %>. As you add validations to <%= class_name %>, be sure to
+  # adjust the attributes here as well.
+  let(:valid_attributes) {
+    skip("Add a hash of attributes valid for your model")
+  }
+
+  let(:invalid_attributes) {
+    skip("Add a hash of attributes invalid for your model")
+  }
+
+  # This should return the minimal set of values that should be in the headers
+  # in order to pass any filters (e.g. authentication) defined in
+  # <%= controller_class_name %>Controller, or in your router and rack
+  # middleware. Be sure to keep this updated too.
+  let(:valid_headers) {
+    {}
+  }
+
+<% unless options[:singleton] -%>
+  describe "GET /index" do
+    it "renders a successful response" do
+      <%= class_name %>.create! valid_attributes
+      get <%= index_helper %>_url, headers: valid_headers, as: :json
+      expect(response).to be_successful
+    end
+  end
+<% end -%>
+
+  describe "GET /show" do
+    it "renders a successful response" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      get <%= show_helper.tr('@', '') %>, as: :json
+      expect(response).to be_successful
+    end
+  end
+
+  describe "POST /create" do
+    context "with valid parameters" do
+      it "creates a new <%= class_name %>" do
+        expect {
+          post <%= index_helper %>_url,
+               params: { <%= ns_file_name %>: valid_attributes }, headers: valid_headers, as: :json
+        }.to change(<%= class_name %>, :count).by(1)
+      end
+
+      it "renders a JSON response with the new <%= ns_file_name %>" do
+        post <%= index_helper %>_url,
+             params: { <%= ns_file_name %>: valid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:created)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "does not create a new <%= class_name %>" do
+        expect {
+          post <%= index_helper %>_url,
+               params: { <%= ns_file_name %>: invalid_attributes }, as: :json
+        }.to change(<%= class_name %>, :count).by(0)
+      end
+
+      it "renders a JSON response with errors for the new <%= ns_file_name %>" do
+        post <%= index_helper %>_url,
+             params: { <%= ns_file_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to eq("application/json")
+      end
+    end
+  end
+
+  describe "PATCH /update" do
+    context "with valid parameters" do
+      let(:new_attributes) {
+        skip("Add a hash of attributes valid for your model")
+      }
+
+      it "updates the requested <%= ns_file_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper.tr('@', '') %>,
+              params: { <%= singular_table_name %>: new_attributes }, headers: valid_headers, as: :json
+        <%= file_name %>.reload
+        skip("Add assertions for updated state")
+      end
+
+      it "renders a JSON response with the <%= ns_file_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper.tr('@', '') %>,
+              params: { <%= singular_table_name %>: new_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:ok)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "renders a JSON response with errors for the <%= ns_file_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper.tr('@', '') %>,
+              params: { <%= singular_table_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to eq("application/json")
+      end
+    end
+  end
+
+  describe "DELETE /destroy" do
+    it "destroys the requested <%= ns_file_name %>" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      expect {
+        delete <%= show_helper.tr('@', '') %>, headers: valid_headers, as: :json
+      }.to change(<%= class_name %>, :count).by(-1)
+    end
+  end
+end
+<% end -%>

data/lib/generators/rspec/scaffold/templates/controller_spec.rb

@@ -46,11 +46,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
   describe "GET #index" do
     it "returns a success response" do
       <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-      get :index, {}, valid_session
-<% else -%>
       get :index, params: {}, session: valid_session
-<% end -%>
       expect(response).to be_successful
     end
   end
@@ -59,22 +55,14 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
   describe "GET #show" do
     it "returns a success response" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-      get :show, {:id => <%= file_name %>.to_param}, valid_session
-<% else -%>
       get :show, params: {id: <%= file_name %>.to_param}, session: valid_session
-<% end -%>
       expect(response).to be_successful
     end
   end
 
   describe "GET #new" do
     it "returns a success response" do
-<% if Rails::VERSION::STRING < '5.0' -%>
-      get :new, {}, valid_session
-<% else -%>
       get :new, params: {}, session: valid_session
-<% end -%>
       expect(response).to be_successful
     end
   end
@@ -82,11 +70,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
   describe "GET #edit" do
     it "returns a success response" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-      get :edit, {:id => <%= file_name %>.to_param}, valid_session
-<% else -%>
       get :edit, params: {id: <%= file_name %>.to_param}, session: valid_session
-<% end -%>
       expect(response).to be_successful
     end
   end
@@ -95,31 +79,19 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
     context "with valid params" do
       it "creates a new <%= class_name %>" do
         expect {
-<% if Rails::VERSION::STRING < '5.0' -%>
-          post :create, {:<%= ns_file_name %> => valid_attributes}, valid_session
-<% else -%>
           post :create, params: {<%= ns_file_name %>: valid_attributes}, session: valid_session
-<% end -%>
         }.to change(<%= class_name %>, :count).by(1)
       end
 
       it "redirects to the created <%= ns_file_name %>" do
-<% if Rails::VERSION::STRING < '5.0' -%>
-        post :create, {:<%= ns_file_name %> => valid_attributes}, valid_session
-<% else -%>
         post :create, params: {<%= ns_file_name %>: valid_attributes}, session: valid_session
-<% end -%>
         expect(response).to redirect_to(<%= class_name %>.last)
       end
     end
 
     context "with invalid params" do
       it "returns a success response (i.e. to display the 'new' template)" do
-<% if Rails::VERSION::STRING < '5.0' -%>
-        post :create, {:<%= ns_file_name %> => invalid_attributes}, valid_session
-<% else -%>
         post :create, params: {<%= ns_file_name %>: invalid_attributes}, session: valid_session
-<% end -%>
         expect(response).to be_successful
       end
     end
@@ -133,22 +105,14 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 
       it "updates the requested <%= ns_file_name %>" do
         <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-        put :update, {:id => <%= file_name %>.to_param, :<%= ns_file_name %> => new_attributes}, valid_session
-<% else -%>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: new_attributes}, session: valid_session
-<% end -%>
         <%= file_name %>.reload
         skip("Add assertions for updated state")
       end
 
       it "redirects to the <%= ns_file_name %>" do
         <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-        put :update, {:id => <%= file_name %>.to_param, :<%= ns_file_name %> => valid_attributes}, valid_session
-<% else -%>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: valid_attributes}, session: valid_session
-<% end -%>
         expect(response).to redirect_to(<%= file_name %>)
       end
     end
@@ -156,11 +120,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
     context "with invalid params" do
       it "returns a success response (i.e. to display the 'edit' template)" do
         <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-        put :update, {:id => <%= file_name %>.to_param, :<%= ns_file_name %> => invalid_attributes}, valid_session
-<% else -%>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: invalid_attributes}, session: valid_session
-<% end -%>
         expect(response).to be_successful
       end
     end
@@ -170,21 +130,13 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
     it "destroys the requested <%= ns_file_name %>" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
       expect {
-<% if Rails::VERSION::STRING < '5.0' -%>
-        delete :destroy, {:id => <%= file_name %>.to_param}, valid_session
-<% else -%>
         delete :destroy, params: {id: <%= file_name %>.to_param}, session: valid_session
-<% end -%>
       }.to change(<%= class_name %>, :count).by(-1)
     end
 
     it "redirects to the <%= table_name %> list" do
       <%= file_name %> = <%= class_name %>.create! valid_attributes
-<% if Rails::VERSION::STRING < '5.0' -%>
-      delete :destroy, {:id => <%= file_name %>.to_param}, valid_session
-<% else -%>
       delete :destroy, params: {id: <%= file_name %>.to_param}, session: valid_session
-<% end -%>
       expect(response).to redirect_to(<%= index_helper %>_url)
     end
   end