rspec-rails 4.0.0.beta4 → 4.1.0

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/request_spec.rb

@@ -0,0 +1,137 @@
+ 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
+  <% if mountable_engine? -%>
+    include Engine.routes.url_helpers
+  <% end -%>
+
+  # <%= 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")
+  }
+
+<% unless options[:singleton] -%>
+  describe "GET /index" do
+    it "renders a successful response" do
+      <%= class_name %>.create! valid_attributes
+      get <%= index_helper %>_url
+      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('@', '') %>
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET /new" do
+    it "renders a successful response" do
+      get <%= new_helper %>
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET /edit" do
+    it "render a successful response" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      get <%= edit_helper.tr('@','') %>
+      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 }
+        }.to change(<%= class_name %>, :count).by(1)
+      end
+
+      it "redirects to the created <%= ns_file_name %>" do
+        post <%= index_helper %>_url, params: { <%= ns_file_name %>: valid_attributes }
+        expect(response).to redirect_to(<%= show_helper.gsub("\@#{file_name}", class_name+".last") %>)
+      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 }
+        }.to change(<%= class_name %>, :count).by(0)
+      end
+
+      it "renders a successful response (i.e. to display the 'new' template)" do
+        post <%= index_helper %>_url, params: { <%= ns_file_name %>: invalid_attributes }
+        expect(response).to be_successful
+      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 }
+        <%= 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
+        patch <%= show_helper.tr('@', '') %>, params: { <%= singular_table_name %>: new_attributes }
+        <%= file_name %>.reload
+        expect(response).to redirect_to(<%= singular_table_name %>_url(<%= file_name %>))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "renders a successful response (i.e. to display the 'edit' template)" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper.tr('@', '') %>, params: { <%= singular_table_name %>: invalid_attributes }
+        expect(response).to be_successful
+      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('@', '') %>
+      }.to change(<%= class_name %>, :count).by(-1)
+    end
+
+    it "redirects to the <%= table_name %> list" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      delete <%= show_helper.tr('@', '') %>
+      expect(response).to redirect_to(<%= index_helper %>_url)
+    end
+  end
+end
+<% end -%>

data/lib/rspec-rails.rb

@@ -31,8 +31,8 @@ module RSpec
       # sets the default for the `preview_path`
       initializer "rspec_rails.action_mailer",
                   before: "action_mailer.set_configs" do |app|
-        setup_preview_path(app)
-      end
+                    setup_preview_path(app)
+                  end
 
     private
 

data/lib/rspec/rails/adapters.rb

@@ -146,9 +146,9 @@ module RSpec
         # examples without exposing non-assertion methods in Test::Unit or
         # Minitest.
         def assertion_method_names
-          ::RSpec::Rails::Assertions.
-            public_instance_methods.
-            select do |m|
+          ::RSpec::Rails::Assertions
+            .public_instance_methods
+            .select do |m|
               m.to_s =~ /^(assert|flunk|refute)/
             end
         end

data/lib/rspec/rails/configuration.rb

@@ -1,3 +1,4 @@
+# rubocop: disable Metrics/ModuleLength
 module RSpec
   module Rails
     # Fake class to document RSpec Rails configuration options. In practice,
@@ -55,8 +56,7 @@ module RSpec
     end
 
     # @private
-    # rubocop:disable Metrics/MethodLength
-    def self.initialize_configuration(config)
+    def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity
       config.backtrace_exclusion_patterns << /vendor\//
       config.backtrace_exclusion_patterns << %r{lib/rspec/rails}
 
@@ -64,6 +64,7 @@ module RSpec
       config.add_setting :infer_base_class_for_anonymous_controllers, default: true
 
       # fixture support
+      config.add_setting :use_active_record, default: true
       config.add_setting :use_transactional_fixtures, alias_with: :use_transactional_examples
       config.add_setting :use_instantiated_fixtures
       config.add_setting :global_fixtures
@@ -105,7 +106,41 @@ module RSpec
         end
 
         def render_views?
-          rendering_views
+          rendering_views?
+        end
+
+        undef :rendering_views? if respond_to?(:rendering_views?)
+        def rendering_views?
+          !!rendering_views
+        end
+
+        # Define boolean predicates rather than relying on rspec-core due
+        # to the bug fix in rspec/rspec-core#2736, note some of these
+        # predicates are a bit nonsensical, but they exist for backwards
+        # compatibility, we can tidy these up in `rspec-rails` 5.
+        undef :fixture_path? if respond_to?(:fixture_path?)
+        def fixture_path?
+          !!fixture_path
+        end
+
+        undef :global_fixtures? if respond_to?(:global_fixtures?)
+        def global_fixtures?
+          !!global_fixtures
+        end
+
+        undef :infer_base_class_for_anonymous_controllers? if respond_to?(:infer_base_class_for_anonymous_controllers?)
+        def infer_base_class_for_anonymous_controllers?
+          !!infer_base_class_for_anonymous_controllers
+        end
+
+        undef :use_instantiated_fixtures? if respond_to?(:use_instantiated_fixtures?)
+        def use_instantiated_fixtures?
+          !!use_instantiated_fixtures
+        end
+
+        undef :use_transactional_fixtures? if respond_to?(:use_transactional_fixtures?)
+        def use_transactional_fixtures?
+          !!use_transactional_fixtures
         end
 
         def infer_spec_type_from_file_location!
@@ -137,6 +172,7 @@ module RSpec
 
       if RSpec::Rails::FeatureCheck.has_action_mailer?
         config.include RSpec::Rails::MailerExampleGroup, type: :mailer
+        config.after { ActionMailer::Base.deliveries.clear }
       end
 
       if RSpec::Rails::FeatureCheck.has_active_job?
@@ -151,8 +187,8 @@ module RSpec
         config.include RSpec::Rails::MailboxExampleGroup, type: :mailbox
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     initialize_configuration RSpec.configuration
   end
 end
+# rubocop: enable Metrics/ModuleLength

data/lib/rspec/rails/example/channel_example_group.rb

@@ -34,7 +34,7 @@ if RSpec::Rails::FeatureCheck.has_action_cable_testing?
               next if klass <= ::ActionCable::Channel::Base
 
               raise "Described class is not a channel class.\n" \
-                    "Specify the channel class in the `describe` statement "\
+                    "Specify the channel class in the `describe` statement " \
                     "or set it manually using `tests MyChannelClass`"
             end
           end
@@ -45,7 +45,7 @@ if RSpec::Rails::FeatureCheck.has_action_cable_testing?
               next if klass <= ::ActionCable::Connection::Base
 
               raise "Described class is not a connection class.\n" \
-                    "Specify the connection class in the `describe` statement "\
+                    "Specify the connection class in the `describe` statement " \
                     "or set it manually using `tests MyConnectionClass`"
             end
           end

data/lib/rspec/rails/example/feature_example_group.rb

@@ -15,7 +15,9 @@ module RSpec
           include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)
           include app.routes.mounted_helpers if app.routes.respond_to?(:mounted_helpers)
 
-          default_url_options[:host] ||= ::RSpec::Rails::FeatureExampleGroup::DEFAULT_HOST
+          if respond_to?(:default_url_options)
+            default_url_options[:host] ||= ::RSpec::Rails::FeatureExampleGroup::DEFAULT_HOST
+          end
         end
       end
 
@@ -38,34 +40,14 @@ unless RSpec.respond_to?(:feature)
     capybara_feature: true,
     type: :feature,
     skip: <<-EOT.squish
-      Feature specs require the Capybara (https://github.com/jnicklas/capybara)
-      gem, version 2.2.0 or later. We recommend version 2.4.0 or later to avoid
-      some deprecation warnings and have support for
-      `config.expose_dsl_globally = false`.
+      Feature specs require the Capybara (https://github.com/teamcapybara/capybara)
+      gem, version 2.13.0 or later.
     EOT
   }
 
-  # Capybara's monkey patching causes us to have to jump through some hoops
-  top_level = self
-  main_feature = nil
-  if defined?(Capybara) && ::Capybara::VERSION.to_f < 2.4
-    # Capybara 2.2 and 2.3 do not use `alias_example_xyz`
-    opts[:skip] = <<-EOT.squish
-      Capybara < 2.4.0 does not support RSpec's namespace or
-      `config.expose_dsl_globally = false`. Upgrade to Capybara >= 2.4.0.
-    EOT
-    main_feature = top_level.method(:feature) if top_level.respond_to?(:feature)
-  end
-
   RSpec.configure do |c|
-    main_feature = nil unless c.expose_dsl_globally?
     c.alias_example_group_to :feature, opts
     c.alias_example_to :scenario
     c.alias_example_to :xscenario, skip: 'Temporarily skipped with xscenario'
   end
-
-  # Due to load order issues and `config.expose_dsl_globally?` defaulting to
-  # `true` we need to put Capybara's monkey patch method back. Otherwise,
-  # app upgrades have a high likelyhood of having all feature specs skipped.
-  top_level.define_singleton_method(:feature, &main_feature) if main_feature
 end

data/lib/rspec/rails/example/mailbox_example_group.rb

@@ -13,7 +13,7 @@ module RSpec
         def self.create_inbound_email(arg)
           case arg
           when Hash
-            create_inbound_email_from_mail(arg)
+            create_inbound_email_from_mail(**arg)
           else
             create_inbound_email_from_source(arg.to_s)
           end