rspec-rails 3.0.2 → 7.1.1

data/lib/generators/rspec/channel/channel_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class ChannelGenerator < Base
+      def create_channel_spec
+        template 'channel_spec.rb.erb', target_path('channels', class_path, "#{file_name}_channel_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/{observer/templates/observer_spec.rb → channel/templates/channel_spec.rb.erb}

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

data/lib/generators/rspec/controller/controller_generator.rb

@@ -4,21 +4,30 @@ module Rspec
   module Generators
     # @private
     class ControllerGenerator < Base
-      argument :actions, :type => :array, :default => [], :banner => "action action"
+      argument :actions, type: :array, default: [], banner: "action action"
 
-      class_option :template_engine, :desc => "Template engine to generate view files"
-      class_option :controller_specs, :type => :boolean, :default => true
-      class_option :view_specs,       :type => :boolean, :default => true
+      class_option :template_engine,  desc: "Template engine to generate view files"
+      class_option :request_specs,    type: :boolean, default: true, desc: "Generate request specs"
+      class_option :controller_specs, type: :boolean, default: false, desc: "Generate controller specs"
+      class_option :view_specs,       type: :boolean, default: true, desc: "Generate view specs"
+      class_option :routing_specs,    type: :boolean, default: false, desc: "Generate routing specs"
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        template 'request_spec.rb',
+                 target_path('requests', class_path, "#{file_name}_spec.rb")
+      end
 
       def generate_controller_spec
         return unless options[:controller_specs]
 
         template 'controller_spec.rb',
-                 File.join('spec/controllers', class_path, "#{file_name}_controller_spec.rb")
+                 target_path('controllers', class_path, "#{file_name}_controller_spec.rb")
       end
 
       def generate_view_specs
-        return if actions.empty?
+        return if actions.empty? && behavior == :invoke
         return unless options[:view_specs] && options[:template_engine]
 
         empty_directory File.join("spec", "views", file_path)
@@ -26,9 +35,17 @@ module Rspec
         actions.each do |action|
           @action = action
           template 'view_spec.rb',
-                   File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
+                   target_path('views', file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
         end
       end
+
+      def generate_routing_spec
+        return if actions.empty?
+        return unless options[:routing_specs]
+
+        template 'routing_spec.rb',
+                 target_path('routing', class_path, "#{file_name}_routing_spec.rb")
+      end
     end
   end
 end

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

@@ -1,13 +1,13 @@
 require 'rails_helper'
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %>Controller, :type => :controller do
+RSpec.describe <%= class_name %>Controller, <%= type_metatag(:controller) %> do
 
 <% for action in actions -%>
-  describe "GET <%= action %>" do
+  describe "GET #<%= action %>" do
     it "returns http success" do
       get :<%= action %>
-      expect(response).to be_success
+      expect(response).to have_http_status(:success)
     end
   end
 

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

@@ -0,0 +1,19 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:request) %> do
+<% namespaced_path = regular_class_path.join('/') -%>
+<% if actions.empty? -%>
+  describe "GET /index" do
+    pending "add some examples (or delete) #{__FILE__}"
+  end
+<% end -%>
+<% for action in actions -%>
+  describe "GET /<%= action %>" do
+    it "returns http success" do
+      get "<%= "/#{namespaced_path}" if namespaced_path != '' %>/<%= file_name %>/<%= action %>"
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+<% end -%>
+end

data/lib/generators/rspec/controller/templates/routing_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe '<%= class_name %>Controller', <%= type_metatag(:routing) %> do
+  describe 'routing' do
+<% for action in actions -%>
+    it 'routes to #<%= action %>' do
+      expect(get: "/<%= class_name.underscore %>/<%= action %>").to route_to("<%= class_name.underscore %>#<%= action  %>")
+    end
+<% end -%>
+  end
+end
+<% end -%>

data/lib/generators/rspec/controller/templates/view_spec.rb

@@ -1,5 +1,5 @@
 require 'rails_helper'
 
-RSpec.describe "<%= file_name %>/<%= @action %>.html.<%= options[:template_engine] %>", :type => :view do
+RSpec.describe "<%= file_name %>/<%= @action %>.html.<%= options[:template_engine] %>", <%= type_metatag(:view) %> do
   pending "add some examples to (or delete) #{__FILE__}"
 end

data/lib/generators/rspec/feature/feature_generator.rb

@@ -4,12 +4,25 @@ module Rspec
   module Generators
     # @private
     class FeatureGenerator < Base
-      class_option :feature_specs, :type => :boolean, :default => true, :desc => "Generate feature specs"
+      class_option :feature_specs, type: :boolean, default: true,  desc: "Generate feature specs"
+      class_option :singularize,   type: :boolean, default: false, desc: "Singularize the generated feature"
 
       def generate_feature_spec
         return unless options[:feature_specs]
 
-        template 'feature_spec.rb', File.join('spec/features', class_path, "#{table_name}_spec.rb") # file_name?
+        template template_name, target_path('features', class_path, filename)
+      end
+
+      def template_name
+        options[:singularize] ? 'feature_singular_spec.rb' : 'feature_spec.rb'
+      end
+
+      def filename
+        if options[:singularize]
+          "#{file_name.singularize}_spec.rb"
+        else
+          "#{file_name}_spec.rb"
+        end
       end
     end
   end

data/lib/generators/rspec/feature/templates/feature_singular_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.feature "<%= class_name.singularize %>", <%= type_metatag(:feature) %> do
+  pending "add some scenarios (or delete) #{__FILE__}"
+end

data/lib/generators/rspec/feature/templates/feature_spec.rb

@@ -1,5 +1,5 @@
 require 'rails_helper'
 
-feature "<%= class_name.pluralize %>", :type => :feature do
+RSpec.feature "<%= class_name.pluralize %>", <%= type_metatag(:feature) %> do
   pending "add some scenarios (or delete) #{__FILE__}"
 end

data/lib/generators/rspec/generator/generator_generator.rb

@@ -0,0 +1,24 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class GeneratorGenerator < Base
+      class_option :generator_specs, type: :boolean, default: true, desc: 'Generate generator specs'
+
+      def generate_generator_spec
+        return unless options[:generator_specs]
+
+        template template_name, target_path('generator', class_path, filename)
+      end
+
+      def template_name
+        'generator_spec.rb'
+      end
+
+      def filename
+        "#{file_name}_generator_spec.rb"
+      end
+    end
+  end
+end

data/lib/generators/rspec/generator/templates/generator_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name %>Generator", <%= type_metatag(:generator) %> do
+  pending "add some scenarios (or delete) #{__FILE__}"
+end

data/lib/generators/rspec/helper/helper_generator.rb

@@ -4,12 +4,12 @@ module Rspec
   module Generators
     # @private
     class HelperGenerator < Base
-      class_option :helper_specs, :type => :boolean, :default => true
+      class_option :helper_specs, type: :boolean, default: true
 
       def generate_helper_spec
         return unless options[:helper_specs]
 
-        template 'helper_spec.rb', File.join('spec/helpers', class_path, "#{file_name}_helper_spec.rb")
+        template 'helper_spec.rb', target_path('helpers', class_path, "#{file_name}_helper_spec.rb")
       end
     end
   end

data/lib/generators/rspec/helper/templates/helper_spec.rb

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

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

@@ -1,17 +1,19 @@
 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
@@ -20,26 +22,58 @@ DESC
         Dir.mktmpdir do |dir|
           generate_rspec_init dir
           template File.join(dir, '.rspec'), '.rspec'
-          directory File.join(dir, 'spec'), 'spec'
+          directory File.join(dir, 'spec'), default_path
         end
       end
 
       def copy_rails_files
-        template 'spec/rails_helper.rb'
+        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
+          destination: tmpdir,
+          report_stream: StringIO.new
         )
         initializer.run
-        gsub_file File.join(tmpdir, 'spec', 'spec_helper.rb'),
+
+        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
+                  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

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

@@ -1,8 +1,16 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
 require 'spec_helper'
-require File.expand_path("../../config/environment", __FILE__)
+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?
+<% if RSpec::Rails::FeatureCheck.has_active_record_migration? -%>
+# Uncomment the line below in case you have `--require rails_helper` in the `.rspec` file
+# that will avoid rails generators crashing because migrations haven't been run yet
+# return unless Rails.env.test?
+<% end -%>
 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
@@ -11,40 +19,73 @@ require 'rspec/rails'
 # 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`.
-Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
-
-<% if ::Rails::VERSION::STRING >= '4.1' -%>
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.maintain_test_schema!
-
-<% elsif ::Rails::VERSION::STRING >= '4' -%>
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+#
+# 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_by(&:to_s).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
-  config.fixture_path = "#{::Rails.root}/spec/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
 
-  # 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 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.
   #
-  # You can disable this behaviour by removing the line below, and instead
-  # explicitly tag your specs with their type, e.g.:
+  # config.fixture_path = Rails.root.join('spec/fixtures')
+  # config.use_transactional_fixtures = true
+
+<% end -%>
+  # RSpec Rails uses metadata to mix in different behaviours to your tests,
+  # for example enabling you to call `get` and `post` in request specs. e.g.:
   #
-  #     RSpec.describe UsersController, :type => :controller do
+  #     RSpec.describe UsersController, type: :request do
   #       # ...
   #     end
   #
   # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/docs
-  config.infer_spec_type_from_file_location!
+  # https://rspec.info/features/7-1/rspec-rails
+  #
+  # You can also this infer these behaviours automatically by location, e.g.
+  # /spec/models would pull in the same behaviour as `type: :model` but this
+  # behaviour is considered legacy and will be removed in a future version.
+  #
+  # To enable this behaviour uncomment the line below.
+  # 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/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

@@ -1,21 +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"
+      argument :actions, type: :array, default: [], banner: "method method"
 
       def generate_mailer_spec
-        template "mailer_spec.rb", File.join('spec/mailers', class_path, "#{file_name}_spec.rb")
+        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", File.join("spec/fixtures", @path)
+          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/mailer_spec.rb

@@ -1,10 +1,10 @@
 require "rails_helper"
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %>, :type => :mailer do
+RSpec.describe <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>, <%= type_metatag(:mailer) %> do
 <% for action in actions -%>
   describe "<%= action %>" do
-    let(:mail) { <%= class_name %>.<%= action %> }
+    let(:mail) { <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %> }
 
     it "renders the headers" do
       expect(mail.subject).to eq(<%= action.to_s.humanize.inspect %>)

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 %>_mailer
+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 %>_mailer/<%= action %>
+  def <%= action %>
+    <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %>
+  end
+<% end -%>
+
+end
+<% end -%>

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

@@ -4,19 +4,33 @@ module Rspec
   module Generators
     # @private
     class ModelGenerator < Base
-      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
-      class_option :fixture, :type => :boolean
+      argument :attributes,
+               type: :array,
+               default: [],
+               banner: "field:type field:type"
+      class_option :fixture, type: :boolean
 
       def create_model_spec
-        template 'model_spec.rb', File.join('spec/models', class_path, "#{file_name}_spec.rb")
+        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
-        if options[:fixture] && options[:fixture_replacement].nil?
-          template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
-        end
+        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

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/model/templates/model_spec.rb

@@ -1,7 +1,7 @@
 require 'rails_helper'
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %>, :type => :model 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