rspec-rails 1.3.2 → 6.1.2

data/lib/generators/rspec/install/install_generator.rb

@@ -0,0 +1,80 @@
+require "rspec/support"
+require "rspec/core"
+RSpec::Support.require_rspec_core "project_initializer"
+require "rspec/rails/feature_check"
+
+module Rspec
+  module Generators
+    # @private
+    class InstallGenerator < ::Rails::Generators::Base
+      desc <<DESC
+Description:
+    Copy rspec files to your application.
+DESC
+
+      class_option :default_path, type: :string, default: 'spec'
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def copy_spec_files
+        Dir.mktmpdir do |dir|
+          generate_rspec_init dir
+          template File.join(dir, '.rspec'), '.rspec'
+          directory File.join(dir, 'spec'), default_path
+        end
+      end
+
+      def copy_rails_files
+        template 'spec/rails_helper.rb', "#{default_path}/rails_helper.rb"
+      end
+
+    private
+
+      def generate_rspec_init(tmpdir)
+        initializer = ::RSpec::Core::ProjectInitializer.new(
+          destination: tmpdir,
+          report_stream: StringIO.new
+        )
+        initializer.run
+
+        spec_helper_path = File.join(tmpdir, 'spec', 'spec_helper.rb')
+
+        replace_generator_command(spec_helper_path)
+        remove_warnings_configuration(spec_helper_path)
+
+        unless default_path == "spec"
+          dot_rspec_path = File.join(tmpdir, '.rspec')
+
+          append_default_path(dot_rspec_path)
+        end
+      end
+
+      def replace_generator_command(spec_helper_path)
+        gsub_file spec_helper_path,
+                  'rspec --init',
+                  'rails generate rspec:install',
+                  verbose: false
+      end
+
+      def remove_warnings_configuration(spec_helper_path)
+        empty_line = '^\n'
+        comment_line = '^\s*#.+\n'
+        gsub_file spec_helper_path,
+                  /#{empty_line}(#{comment_line})+\s+config\.warnings = true\n/,
+                  '',
+                  verbose: false
+      end
+
+      def append_default_path(dot_rspec_path)
+        append_to_file dot_rspec_path,
+                       "--default-path #{default_path}"
+      end
+
+      def default_path
+        options[:default_path]
+      end
+    end
+  end
+end

data/lib/generators/rspec/install/templates/spec/rails_helper.rb

@@ -0,0 +1,84 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require_relative '../config/environment'
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Rails.root.glob('spec/support/**/*.rb').sort.each { |f| require f }
+
+<% if RSpec::Rails::FeatureCheck.has_active_record_migration? -%>
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  abort e.to_s.strip
+end
+<% end -%>
+RSpec.configure do |config|
+<% if RSpec::Rails::FeatureCheck.has_active_record? -%>
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+<% if ::Rails::VERSION::STRING < "7.1.0" -%>
+  config.fixture_path = Rails.root.join('spec/fixtures')
+<% else -%>
+  config.fixture_paths = [
+    Rails.root.join('spec/fixtures')
+  ]
+<% end -%>
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+<% else -%>
+  # Remove this line to enable support for ActiveRecord
+  config.use_active_record = false
+
+  # If you enable ActiveRecord support you should uncomment these lines,
+  # note if you'd prefer not to run each example within a transaction, you
+  # should set use_transactional_fixtures to false.
+  #
+  # config.fixture_path = Rails.root.join('spec/fixtures')
+  # config.use_transactional_fixtures = true
+
+<% end -%>
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://rspec.info/features/6-0/rspec-rails
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/lib/generators/rspec/integration/integration_generator.rb

@@ -0,0 +1,29 @@
+require 'generators/rspec'
+require 'rspec/core/warnings'
+
+module Rspec
+  module Generators
+    # @private
+    class IntegrationGenerator < Base
+      class_option :request_specs,
+                   type: :boolean,
+                   default: true,
+                   desc: "Generate request specs"
+
+      source_paths << File.expand_path('../request/templates', __dir__)
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        RSpec.warn_deprecation <<-WARNING.gsub(/\s*\|/, ' ')
+          |The integration generator is deprecated
+          |and will be deleted in RSpec-Rails 7.
+          |Please use the request generator instead.
+        WARNING
+
+        template 'request_spec.rb',
+                 target_path('requests', "#{name.underscore.pluralize}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/job/job_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class JobGenerator < Base
+      def create_job_spec
+        file_suffix = file_name.end_with?('job') ? 'spec.rb' : 'job_spec.rb'
+        template 'job_spec.rb.erb', target_path('jobs', class_path, [file_name, file_suffix].join('_'))
+      end
+    end
+  end
+end

data/lib/generators/rspec/job/templates/job_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %><%= "Job" unless class_name.end_with?("Job")%>, <%= type_metatag(:job) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/mailbox/mailbox_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class MailboxGenerator < Base
+      def create_mailbox_spec
+        template('mailbox_spec.rb.erb',
+                 target_path('mailboxes', class_path, "#{file_name}_mailbox_spec.rb")
+        )
+      end
+    end
+  end
+end

data/lib/generators/rspec/mailbox/templates/mailbox_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Mailbox, <%= type_metatag(:mailbox) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/mailer/mailer_generator.rb

@@ -0,0 +1,30 @@
+require 'generators/rspec'
+require "rspec/rails/feature_check"
+
+module Rspec
+  module Generators
+    # @private
+    class MailerGenerator < Base
+      argument :actions, type: :array, default: [], banner: "method method"
+
+      def generate_mailer_spec
+        file_suffix = file_name.end_with?('mailer') ? 'spec.rb' : 'mailer_spec.rb'
+        template "mailer_spec.rb", target_path('mailers', class_path, [file_name, file_suffix].join('_'))
+      end
+
+      def generate_fixtures_files
+        actions.each do |action|
+          @action, @path = action, File.join(file_path, action)
+          template "fixture", target_path("fixtures", @path)
+        end
+      end
+
+      def generate_preview_files
+        return unless RSpec::Rails::FeatureCheck.has_action_mailer_preview?
+
+        file_suffix = file_name.end_with?('mailer') ? 'preview.rb' : 'mailer_preview.rb'
+        template "preview.rb", target_path("mailers/previews", class_path, [file_name, file_suffix].join('_'))
+      end
+    end
+  end
+end

data/lib/generators/rspec/mailer/templates/fixture

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= @action %>
+
+Hi, find me in app/views/<%= @path %>

data/lib/generators/rspec/mailer/templates/mailer_spec.rb

@@ -0,0 +1,25 @@
+require "rails_helper"
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>, <%= type_metatag(:mailer) %> do
+<% for action in actions -%>
+  describe "<%= action %>" do
+    let(:mail) { <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %> }
+
+    it "renders the headers" do
+      expect(mail.subject).to eq(<%= action.to_s.humanize.inspect %>)
+      expect(mail.to).to eq(["to@example.org"])
+      expect(mail.from).to eq(["from@example.com"])
+    end
+
+    it "renders the body" do
+      expect(mail.body.encoded).to match("Hi")
+    end
+  end
+
+<% end -%>
+<% if actions.blank? -%>
+  pending "add some examples to (or delete) #{__FILE__}"
+<% end -%>
+end
+<% end -%>

data/lib/generators/rspec/mailer/templates/preview.rb

@@ -0,0 +1,13 @@
+<% module_namespacing do -%>
+# Preview all emails at http://localhost:3000/rails/mailers/<%= file_path %>
+class <%= class_name %><%= 'Mailer' unless class_name.end_with?('Mailer') %>Preview < ActionMailer::Preview
+<% actions.each do |action| -%>
+
+  # Preview this email at http://localhost:3000/rails/mailers/<%= file_path %>/<%= action %>
+  def <%= action %>
+    <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %>
+  end
+<% end -%>
+
+end
+<% end -%>

data/lib/generators/rspec/model/model_generator.rb

@@ -0,0 +1,37 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class ModelGenerator < Base
+      argument :attributes,
+               type: :array,
+               default: [],
+               banner: "field:type field:type"
+      class_option :fixture, type: :boolean
+
+      def create_model_spec
+        template_file = target_path(
+          'models',
+          class_path,
+          "#{file_name}_spec.rb"
+        )
+        template 'model_spec.rb', template_file
+      end
+
+      hook_for :fixture_replacement
+
+      def create_fixture_file
+        return unless missing_fixture_replacement?
+
+        template 'fixtures.yml', target_path('fixtures', class_path, "#{(pluralize_table_names? ? plural_file_name : file_name)}.yml")
+      end
+
+    private
+
+      def missing_fixture_replacement?
+        options[:fixture] && options[:fixture_replacement].nil?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+<% unless attributes.empty? -%>
+one:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+
+two:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+<% else -%>
+# one:
+#   column: value
+#
+# two:
+#   column: value
+<% end -%>

data/lib/generators/rspec/model/templates/model_spec.rb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>, <%= type_metatag(:model) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

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

@@ -0,0 +1,136 @@
+require 'generators/rspec'
+require 'rails/generators/resource_helpers'
+
+module Rspec
+  module Generators
+    # @private
+    class ScaffoldGenerator < Base
+      include ::Rails::Generators::ResourceHelpers
+      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]
+
+        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
+        copy_view :index unless options[:singleton]
+        copy_view :new
+        copy_view :show
+      end
+
+      def generate_routing_spec
+        return unless options[:routing_specs]
+
+        template_file = target_path(
+          'routing',
+          controller_class_path,
+          "#{controller_file_name}_routing_spec.rb"
+        )
+        template 'routing_spec.rb', template_file
+      end
+
+    protected
+
+      attr_reader :generator_args
+
+      def copy_view(view)
+        template "#{view}_spec.rb",
+                 target_path("views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
+      end
+
+      # 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
+
+      def ns_parts
+        @ns_parts ||= begin
+                        parts = generator_args[0].split(/\/|::/)
+                        parts.size > 1 ? parts : []
+                      end
+      end
+
+      def ns_prefix
+        @ns_prefix ||= ns_parts[0..-2]
+      end
+
+      def ns_suffix
+        @ns_suffix ||= ns_parts[-1]
+      end
+
+      def value_for(attribute)
+        raw_value_for(attribute).inspect
+      end
+
+      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 template_file(folder:, suffix: '')
+        target_path(folder, controller_class_path, "#{controller_file_name}#{suffix}_spec.rb")
+      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 -%>