Merge pull request #2811 from jeromedalbert/authentication-generator

Add Rails 8 authentication generator

lib/generators/rspec/authentication/authentication_generator.rb

@@ -0,0 +1,25 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class AuthenticationGenerator < Base
+      def initialize(args, *options)
+        args.replace(['User'])
+        super
+      end
+
+      def create_user_spec
+        template 'user_spec.rb', target_path('models', 'user_spec.rb')
+      end
+
+      hook_for :fixture_replacement
+
+      def create_fixture_file
+        return if options[:fixture_replacement]
+
+        template 'users.yml', target_path('fixtures', 'users.yml')
+      end
+    end
+  end
+end

lib/generators/rspec/authentication/templates/user_spec.rb

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

lib/generators/rspec/authentication/templates/users.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+<%% password_digest = BCrypt::Password.create("password") %>
+
+one:
+  email_address: [email protected]
+  password_digest: <%%= password_digest %>
+
+two:
+  email_address: [email protected]
+  password_digest: <%%= password_digest %>

spec/generators/rspec/authentication/authentication_generator_spec.rb

@@ -0,0 +1,34 @@
+# Generators are not automatically loaded by Rails
+require 'generators/rspec/authentication/authentication_generator'
+require 'support/generators'
+
+RSpec.describe Rspec::Generators::AuthenticationGenerator, type: :generator do
+  setup_default_destination
+
+  it 'runs both the model and fixture tasks' do
+    gen = generator
+    expect(gen).to receive :create_user_spec
+    expect(gen).to receive :create_fixture_file
+    gen.invoke_all
+  end
+
+  describe 'the generated files' do
+    it 'creates the user spec' do
+      run_generator
+
+      expect(File.exist?(file('spec/models/user_spec.rb'))).to be true
+    end
+
+    describe 'with fixture replacement' do
+      before do
+        run_generator ['--fixture-replacement=factory_bot']
+      end
+
+      describe 'the fixtures' do
+        it "will skip the file" do
+          expect(File.exist?(file('spec/fixtures/users.yml'))).to be false
+        end
+      end
+    end
+  end
+end