rspec-rails 2.14.2 → 6.1.0

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

@@ -0,0 +1,17 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class RequestGenerator < Base
+      class_option :request_specs, type: :boolean, default: true, desc: 'Generate request specs'
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        template 'request_spec.rb',
+                 target_path('requests', "#{name.underscore.pluralize}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/request/templates/request_spec.rb

@@ -0,0 +1,10 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:request) %> do
+  describe "GET /<%= name.underscore.pluralize %>" do
+    it "works! (now write some real specs)" do
+      get <%= index_helper %>_path
+      expect(response).to have_http_status(200)
+    end
+  end
+end

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

@@ -3,30 +3,50 @@ require 'rails/generators/resource_helpers'
 
 module Rspec
   module Generators
+    # @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"
-
-      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 :controller_specs, :type => :boolean, :default => true,  :desc => "Generate controller specs"
-      class_option :view_specs,       :type => :boolean, :default => true,  :desc => "Generate view specs"
-      class_option :webrat,           :type => :boolean, :default => false, :desc => "Use webrat methods/matchers"
-      class_option :webrat_matchers,  :type => :boolean, :default => false, :desc => "Use webrat methods/matchers (deprecated - use --webrat)"
-      class_option :helper_specs,     :type => :boolean, :default => true,  :desc => "Generate helper specs"
-      class_option :routing_specs,    :type => :boolean, :default => true,  :desc => "Generate routing specs"
+      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 :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
+        super(*args, &blk)
+      end
 
       def generate_controller_spec
         return unless options[:controller_specs]
 
-        template 'controller_spec.rb',
-                 File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb")
+        if options[:api]
+          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 'request_spec.rb', template_file(folder: 'requests')
+        end
       end
 
       def generate_view_specs
+        return if options[:api]
         return unless options[:view_specs] && options[:template_engine]
 
         copy_view :edit
@@ -38,155 +58,79 @@ module Rspec
       def generate_routing_spec
         return unless options[:routing_specs]
 
-        template 'routing_spec.rb',
-          File.join('spec/routing', controller_class_path, "#{controller_file_name}_routing_spec.rb")
+        template_file = target_path(
+          'routing',
+          controller_class_path,
+          "#{controller_file_name}_routing_spec.rb"
+        )
+        template 'routing_spec.rb', template_file
       end
 
-      hook_for :integration_tool, :as => :integration
+    protected
 
-      protected
-
-        # @deprecated Use `--webrat` instead.
-        def webrat?
-          RSpec.deprecate("--webrat-matchers", :replacement => "--webrat") if options[:webrat_matchers]
-          options[:webrat] || options[:webrat_matchers]
-        end
+      attr_reader :generator_args
 
-        def copy_view(view)
-          template "#{view}_spec.rb",
-                   File.join("spec/views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
-        end
-
-        def example_valid_attributes
-          # Only take the first attribute so this hash does not become unweildy and large in the
-          # generated controller spec. It is the responsibility of the user to keep the the valid
-          # attributes method up-to-date as they add validations.
-          @example_valid_attributes ||=
-            if attributes.any?
-              { attributes.first.name => attributes.first.default.to_s }
-            else
-              { }
-            end
-        end
-
-        def example_invalid_attributes
-          @example_invalid_attributes ||=
-            if attributes.any?
-              { attributes.first.name => "invalid value" }
-            else
-              { }
-            end
-        end
-
-        def example_params_for_update
-          @example_params_for_update ||=
-            if example_valid_attributes.any?
-              example_valid_attributes
-            else
-              { "these" => "params" }
-            end
-        end
+      def copy_view(view)
+        template "#{view}_spec.rb",
+                 target_path("views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
+      end
 
-        def formatted_hash(hash)
-          formatted = hash.inspect
-          formatted.gsub!("{", "{ ")
-          formatted.gsub!("}", " }")
-          formatted.gsub!("=>", " => ")
-          formatted
-        end
+      # support for namespaced-resources
+      def ns_file_name
+        return file_name if ns_parts.empty?
 
-        # support for namespaced-resources
-        def ns_file_name
-          ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
-        end
+        "#{ns_prefix.map(&:underscore).join('/')}_#{ns_suffix.singularize.underscore}"
+      end
 
-        # support for namespaced-resources
-        def ns_table_name
-          ns_parts.empty? ? table_name : "#{ns_parts[0].underscore}/#{ns_parts[1].tableize}"
-        end
+      # support for namespaced-resources
+      def ns_table_name
+        return table_name if ns_parts.empty?
 
-        def ns_parts
-          @ns_parts ||= begin
-                          matches = ARGV[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
-                          matches ? [matches[1], matches[2]] : []
-                        end
-        end
+        "#{ns_prefix.map(&:underscore).join('/')}/#{ns_suffix.tableize}"
+      end
 
-        # Returns the name of the mock. For example, if the file name is user,
-        # it returns mock_user.
-        #
-        # If a hash is given, it uses the hash key as the ORM method and the
-        # value as response. So, for ActiveRecord and file name "User":
-        #
-        #   mock_file_name(:save => true)
-        #   #=> mock_user(:save => true)
-        #
-        # If another ORM is being used and another method instead of save is
-        # called, it will be the one used.
-        #
-        def mock_file_name(hash=nil)
-          if hash
-            method, and_return = hash.to_a.first
-            method = orm_instance.send(method).split('.').last.gsub(/\(.*?\)/, '')
-            "mock_#{ns_file_name}(:#{method} => #{and_return})"
-          else
-            "mock_#{ns_file_name}"
-          end
-        end
+      def ns_parts
+        @ns_parts ||= begin
+                        parts = generator_args[0].split(/\/|::/)
+                        parts.size > 1 ? parts : []
+                      end
+      end
 
-        # Receives the ORM chain and convert to expects. For ActiveRecord:
-        #
-        #   should! orm_class.find(User, "37")
-        #   #=> User.should_receive(:find).with(37)
-        #
-        # For Datamapper:
-        #
-        #   should! orm_class.find(User, "37")
-        #   #=> User.should_receive(:get).with(37)
-        #
-        def should_receive(chain)
-          stub_or_should_chain(:should_receive, chain)
-        end
+      def ns_prefix
+        @ns_prefix ||= ns_parts[0..-2]
+      end
 
-        # Receives the ORM chain and convert to stub. For ActiveRecord:
-        #
-        #   stub orm_class.find(User, "37")
-        #   #=> User.stub(:find).with(37)
-        #
-        # For Datamapper:
-        #
-        #   stub orm_class.find(User, "37")
-        #   #=> User.stub(:get).with(37)
-        #
-        def stub(chain)
-          stub_or_should_chain(:stub, chain)
-        end
+      def ns_suffix
+        @ns_suffix ||= ns_parts[-1]
+      end
 
-        def stub_or_should_chain(mode, chain)
-          receiver, method = chain.split(".")
-          method.gsub!(/\((.*?)\)/, '')
+      def value_for(attribute)
+        raw_value_for(attribute).inspect
+      end
 
-          response = "#{receiver}.#{mode}(:#{method})"
-          response << ".with(#{$1})" unless $1.blank?
-          response
+      def raw_value_for(attribute)
+        case attribute.type
+        when :string
+          attribute.name.titleize
+        when :integer, :float
+          @attribute_id_map ||= {}
+          @attribute_id_map[attribute] ||= @attribute_id_map.keys.size.next + attribute.default
+        else
+          attribute.default
         end
+      end
 
-        def value_for(attribute)
-          case attribute.type
-          when :string
-            "#{attribute.name.titleize}".inspect
-          when :integer
-            @attribute_id_map ||= {}
-            @attribute_id_map[attribute] ||= @attribute_id_map.keys.size.next.to_s
-          else
-            attribute.default.inspect
-          end
-        end
+      def template_file(folder:, suffix: '')
+        target_path(folder, controller_class_path, "#{controller_file_name}#{suffix}_spec.rb")
+      end
 
-        def banner
-          self.class.banner
-        end
+      def banner
+        self.class.banner
+      end
 
+      def show_helper(resource_name = file_name)
+        "#{singular_route_name}_url(#{resource_name})"
+      end
     end
   end
 end

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

@@ -0,0 +1,129 @@
+require 'rails_helper'
+
+# This spec was generated by rspec-rails when you ran the scaffold generator.
+# It demonstrates how one might use RSpec to specify 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.
+#
+# Compared to earlier versions of this generator, there is very limited use of
+# stubs and message expectations in this spec.  Stubs are only used when there
+# is no simpler way to get a handle on the object needed for the example.
+# Message expectations are only used when there is no simpler way to specify
+# that an instance is receiving a specific message.
+#
+# Also compared to earlier versions of this generator, there are no longer any
+# expectations of assigns and templates rendered. These features have been
+# removed from Rails core in Rails 5, but can be added back in via the
+# `rails-controller-testing` gem.
+
+<% module_namespacing do -%>
+RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:controller) %> 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 session
+  # in order to pass any filters (e.g. authentication) defined in
+  # <%= controller_class_name %>Controller. Be sure to keep this updated too.
+  let(:valid_session) { {} }
+
+<% unless options[:singleton] -%>
+  describe "GET #index" do
+    it "returns a success response" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      get :index, params: {}, session: valid_session
+      expect(response).to be_successful
+    end
+  end
+
+<% end -%>
+  describe "GET #show" do
+    it "returns a success response" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      get :show, params: {id: <%= file_name %>.to_param}, session: valid_session
+      expect(response).to be_successful
+    end
+  end
+
+  describe "POST #create" do
+    context "with valid params" do
+      it "creates a new <%= class_name %>" do
+        expect {
+          post :create, params: {<%= singular_table_name %>: valid_attributes}, session: valid_session
+        }.to change(<%= class_name %>, :count).by(1)
+      end
+
+      it "renders a JSON response with the new <%= singular_table_name %>" do
+        post :create, params: {<%= singular_table_name %>: valid_attributes}, session: valid_session
+        expect(response).to have_http_status(:created)
+        expect(response.content_type).to eq('application/json')
+        expect(response.location).to eq(<%= singular_table_name %>_url(<%= class_name %>.last))
+      end
+    end
+
+    context "with invalid params" do
+      it "renders a JSON response with errors for the new <%= singular_table_name %>" do
+        post :create, params: {<%= singular_table_name %>: invalid_attributes}, session: valid_session
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to eq('application/json')
+      end
+    end
+  end
+
+  describe "PUT #update" do
+    context "with valid params" do
+      let(:new_attributes) {
+        skip("Add a hash of attributes valid for your model")
+      }
+
+      it "updates the requested <%= singular_table_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        put :update, params: {id: <%= file_name %>.to_param, <%= singular_table_name %>: new_attributes}, session: valid_session
+        <%= file_name %>.reload
+        skip("Add assertions for updated state")
+      end
+
+      it "renders a JSON response with the <%= singular_table_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        put :update, params: {id: <%= file_name %>.to_param, <%= singular_table_name %>: new_attributes}, session: valid_session
+        expect(response).to have_http_status(:ok)
+        expect(response.content_type).to eq('application/json')
+      end
+    end
+
+    context "with invalid params" do
+      it "renders a JSON response with errors for the <%= singular_table_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        put :update, params: {id: <%= file_name %>.to_param, <%= singular_table_name %>: invalid_attributes}, session: valid_session
+        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 <%= singular_table_name %>" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      expect {
+        delete :destroy, params: {id: <%= file_name %>.to_param}, session: valid_session
+      }.to change(<%= class_name %>, :count).by(-1)
+    end
+  end
+
+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 %>, 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: { <%= singular_table_name %>: valid_attributes }, headers: valid_headers, as: :json
+        }.to change(<%= class_name %>, :count).by(1)
+      end
+
+      it "renders a JSON response with the new <%= singular_table_name %>" do
+        post <%= index_helper %>_url,
+             params: { <%= singular_table_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: { <%= singular_table_name %>: invalid_attributes }, as: :json
+        }.to change(<%= class_name %>, :count).by(0)
+      end
+
+      it "renders a JSON response with errors for the new <%= singular_table_name %>" do
+        post <%= index_helper %>_url,
+             params: { <%= singular_table_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to match(a_string_including("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 <%= singular_table_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper %>,
+              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 <%= singular_table_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper %>,
+              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 <%= singular_table_name %>" do
+        <%= file_name %> = <%= class_name %>.create! valid_attributes
+        patch <%= show_helper %>,
+              params: { <%= singular_table_name %>: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+  end
+
+  describe "DELETE /destroy" do
+    it "destroys the requested <%= singular_table_name %>" do
+      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      expect {
+        delete <%= show_helper %>, headers: valid_headers, as: :json
+      }.to change(<%= class_name %>, :count).by(-1)
+    end
+  end
+end
+<% end -%>