Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Rails 8 authentication generator #2811

Merged
merged 1 commit into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions lib/generators/rspec/authentication/authentication_generator.rb
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions lib/generators/rspec/authentication/templates/user_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
require 'rails_helper'

RSpec.describe User, <%= type_metatag(:model) %> do
pending "add some examples to (or delete) #{__FILE__}"
end
11 changes: 11 additions & 0 deletions lib/generators/rspec/authentication/templates/users.yml
Original file line number Diff line number Diff line change
@@ -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 %>
Original file line number Diff line number Diff line change
@@ -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