rspec-rails 3.8.2 → 7.0.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_metatag(: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/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/feature/feature_generator.rb

@@ -4,13 +4,13 @@ module Rspec
   module Generators
     # @private
     class FeatureGenerator < Base
-      class_option :feature_specs, :type => :boolean, :default => true,  :desc => "Generate feature specs"
-      class_option :singularize,   :type => :boolean, :default => false, :desc => "Singularize the generated feature"
+      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 template_name, File.join('spec/features', class_path, filename)
+        template template_name, target_path('features', class_path, filename)
       end
 
       def template_name

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/install/install_generator.rb

@@ -12,6 +12,8 @@ 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,20 +22,20 @@ 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
 
@@ -41,13 +43,19 @@ DESC
 
         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)
@@ -56,7 +64,16 @@ DESC
         gsub_file spec_helper_path,
                   /#{empty_line}(#{comment_line})+\s+config\.warnings = true\n/,
                   '',
-                  :verbose => false
+                  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,9 +1,14 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 require 'spec_helper'
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+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!
 
@@ -20,37 +25,47 @@ require 'rspec/rails'
 # directory. Alternatively, in the individual `*_spec.rb` files, manually
 # require only the support files necessary.
 #
-# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
+# Rails.root.glob('spec/support/**/*.rb').sort_by(&:to_s).each { |f| require f }
 
-<% if RSpec::Rails::FeatureCheck.can_maintain_test_schema? -%>
+<% 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
-  puts e.to_s.strip
-  exit 1
-end
-<% elsif RSpec::Rails::FeatureCheck.can_check_pending_migrations? -%>
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove these lines.
-begin
-  ActiveRecord::Migration.check_pending!
-rescue ActiveRecord::PendingMigrationError => e
-  puts e.to_s.strip
-  exit 1
+  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
 
+  # 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
@@ -59,12 +74,12 @@ RSpec.configure do |config|
   # 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
+  #     RSpec.describe UsersController, type: :controller do
   #       # ...
   #     end
   #
   # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/docs
+  # https://rspec.info/features/7-0/rspec-rails
   config.infer_spec_type_from_file_location!
 
   # Filter lines from Rails gems in backtraces.

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

@@ -5,7 +5,8 @@ module Rspec
     # @private
     class JobGenerator < Base
       def create_job_spec
-        template 'job_spec.rb.erb', File.join('spec/jobs', class_path, "#{file_name}_job_spec.rb")
+        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

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

@@ -1,7 +1,7 @@
 require 'rails_helper'
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %>Job, <%= type_metatag(:job) %> 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

@@ -5,22 +5,25 @@ 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?
-        template "preview.rb", File.join("spec/mailers/previews", class_path, "#{file_name}_preview.rb")
+
+        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

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

@@ -1,10 +1,10 @@
 require "rails_helper"
 
 <% module_namespacing do -%>
-RSpec.describe <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>, <%= type_metatag(:mailer) %> do
+RSpec.describe <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>, <%= type_metatag(:mailer) %> do
 <% for action in actions -%>
   describe "<%= action %>" do
-    let(:mail) { <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : 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

@@ -1,11 +1,11 @@
 <% module_namespacing do -%>
-# Preview all emails at http://localhost:3000/rails/mailers/<%= file_path %>
-class <%= class_name %>Preview < ActionMailer::Preview
+# 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 %>/<%= action %>
+  # Preview this email at http://localhost:3000/rails/mailers/<%= file_path %>_mailer/<%= action %>
   def <%= action %>
-    <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>.<%= action %>
+    <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %>
   end
 <% end -%>
 

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

@@ -5,14 +5,14 @@ module Rspec
     # @private
     class ModelGenerator < Base
       argument :attributes,
-               :type => :array,
-               :default => [],
-               :banner => "field:type field:type"
-      class_option :fixture, :type => :boolean
+               type: :array,
+               default: [],
+               banner: "field:type field:type"
+      class_option :fixture, type: :boolean
 
       def create_model_spec
-        template_file = File.join(
-          'spec/models',
+        template_file = target_path(
+          'models',
           class_path,
           "#{file_name}_spec.rb"
         )
@@ -23,7 +23,8 @@ module Rspec
 
       def create_fixture_file
         return unless missing_fixture_replacement?
-        template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
+
+        template 'fixtures.yml', target_path('fixtures', class_path, "#{(pluralize_table_names? ? plural_file_name : file_name)}.yml")
       end
 
     private

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

@@ -1,10 +1,17 @@
-require 'generators/rspec/integration/integration_generator'
+require 'generators/rspec'
 
 module Rspec
   module Generators
     # @private
-    class RequestGenerator < IntegrationGenerator
-      source_paths << File.expand_path("../../integration/templates", __FILE__)
+    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/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
 
@@ -52,34 +58,34 @@ module Rspec
       def generate_routing_spec
         return unless options[:routing_specs]
 
-        template_file = File.join(
-          'spec/routing',
+        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
 
       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")
+                 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
 
@@ -114,9 +120,17 @@ module Rspec
         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