Class: Seams::Generators::AuthGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Includes:
EjectAware, HostInjector
Defined in:
lib/generators/seams/auth/auth_generator.rb

Overview

Generates a canonical Auth engine on top of the generic engine scaffold. Adds:

- Identity and Session ActiveRecord models (has_secure_password).
- SessionsController + RegistrationsController with sign in /
  sign up / sign out.
- Authenticatable concern that the host application's user-like
  model can `include Auth::Authenticatable` (added to the
  engine's ExposedConcerns automatically) — OPTIONAL post-Wave-9.
- Migrations for auth_identities and auth_sessions.
- lib/auth/engine.rb registers the canonical events:
  identity.signed_up.auth, identity.signed_in.auth,
  identity.signed_out.auth, session.expired.auth.

Run with: bin/rails generate seams:auth rubocop:disable Metrics/ClassLength

Constant Summary collapse

ENGINE_NAME = 
"auth"

Constants included from EjectAware

EjectAware::EJECT_HEADER_PREFIX

Instance Method Summary collapse

Methods included from EjectAware

#ejected?, #template_unless_ejected

Methods included from HostInjector

#host_inject_gem, #host_inject_include_in_application_controller, #host_inject_include_in_user, #host_inject_mount, #host_uninject_gem, #host_uninject_include, #host_uninject_mount, #routes_draw_anchor

Instance Method Details

#create_base_engine ⇒ Object 



37
38
39
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 37

def create_base_engine
  EngineGenerator.start([ENGINE_NAME], destination_root: destination_root)
end

#create_concerns ⇒ Object 



146
147
148
149
150
151
152
153
154
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 146

def create_concerns
  template_unless_ejected "lib/concerns/authenticatable.rb.tt",
                          engine_path("lib/auth/concerns/authenticatable.rb")
  template_unless_ejected "lib/concerns/authentication.rb.tt",
                          engine_path("lib/auth/concerns/authentication.rb")
  # Bearer-token controller auth for API endpoints.
  template_unless_ejected "lib/concerns/api_authenticatable.rb.tt",
                          engine_path("lib/auth/concerns/api_authenticatable.rb")
end

#create_controllers ⇒ Object 



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 76

def create_controllers
  template_unless_ejected "app/controllers/sessions_controller.rb.tt",
                          engine_path("app/controllers/auth/sessions_controller.rb")
  template_unless_ejected "app/controllers/registrations_controller.rb.tt",
                          engine_path("app/controllers/auth/registrations_controller.rb")
  template_unless_ejected "app/controllers/password_resets_controller.rb.tt",
                          engine_path("app/controllers/auth/password_resets_controller.rb")
  template_unless_ejected "app/controllers/oauth/callbacks_controller.rb.tt",
                          engine_path("app/controllers/auth/oauth/callbacks_controller.rb")
end

#create_dummy_app ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 197

def create_dummy_app
  # Post Wave 9: the dummy app no longer ships a host User
  # model. Auth::Identity is the human now, and the auth specs
  # don't need a host User to exercise the engine. Hosts that
  # keep a User model can include Auth::Authenticatable in their
  # own test fixture.
  Seams::Generators::DummyAppWriter.write!(
    engine_path: File.join(destination_root, "engines", ENGINE_NAME),
    engine_module: "Auth",
    mount_at: "/auth",
    schema: dummy_schema
  )
  template "spec/runtime/boot_spec.rb.tt",
           engine_path("spec/runtime/auth_boot_spec.rb")
  template "spec/runtime/event_payload_spec.rb.tt",
           engine_path("spec/runtime/auth_event_payload_spec.rb")
  # Phase 2A finish — login flow round-trip via the request stack.
  template "spec/runtime/login_flow_spec.rb.tt",
           engine_path("spec/runtime/auth_login_flow_spec.rb")
end

#create_jobs ⇒ Object 



104
105
106
107
108
109
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 104

def create_jobs
  template_unless_ejected "app/jobs/application_job.rb.tt",
                          engine_path("app/jobs/auth/application_job.rb")
  template_unless_ejected "app/jobs/cleanup_expired_sessions_job.rb.tt",
                          engine_path("app/jobs/auth/cleanup_expired_sessions_job.rb")
end

#create_mailer ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 126

def create_mailer
  template_unless_ejected "app/mailers/passwords_mailer.rb.tt",
                          engine_path("app/mailers/auth/passwords_mailer.rb")
  template_unless_ejected "app/views/passwords_mailer/reset_email.html.erb.tt",
                          engine_path("app/views/auth/passwords_mailer/reset_email.html.erb")
end

#create_migrations ⇒ Object 



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 156

def create_migrations
  template "db/migrate/create_auth_identities.rb.tt",
           engine_path("db/migrate/#{timestamp(0)}_create_auth_identities.rb")
  template "db/migrate/create_auth_sessions.rb.tt",
           engine_path("db/migrate/#{timestamp(1)}_create_auth_sessions.rb")
  template "db/migrate/create_auth_oauth_providers.rb.tt",
           engine_path("db/migrate/#{timestamp(2)}_create_auth_oauth_providers.rb")
  template "db/migrate/create_auth_api_tokens.rb.tt",
           engine_path("db/migrate/#{timestamp(3)}_create_auth_api_tokens.rb")
end

#create_models ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 56

def create_models
  template_unless_ejected "app/models/application_record.rb.tt",
                          engine_path("app/models/auth/application_record.rb")
  template_unless_ejected "app/models/identity.rb.tt",
                          engine_path("app/models/auth/identity.rb")
  template_unless_ejected "app/models/session.rb.tt",
                          engine_path("app/models/auth/session.rb")
  template_unless_ejected "app/models/current.rb.tt",
                          engine_path("app/models/auth/current.rb")
  # OAuth identity link table — issue #2 section 2A. Lives under
  # the Auth::OAuth namespace alongside the lib/ adapter classes
  # (Abstract, Google, Github) so the Zeitwerk inflector only
  # needs the single "oauth" => "OAuth" mapping at engine boot.
  template_unless_ejected "app/models/oauth/provider.rb.tt",
                          engine_path("app/models/auth/oauth/provider.rb")
  # Bearer-token API access — issue #2 section 2A.
  template_unless_ejected "app/models/api_token.rb.tt",
                          engine_path("app/models/auth/api_token.rb")
end

#create_oauth_adapters ⇒ Object 



117
118
119
120
121
122
123
124
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 117

def create_oauth_adapters
  template_unless_ejected "lib/oauth/abstract.rb.tt",
                          engine_path("lib/auth/oauth/abstract.rb")
  template_unless_ejected "lib/oauth/google.rb.tt",
                          engine_path("lib/auth/oauth/google.rb")
  template_unless_ejected "lib/oauth/github.rb.tt",
                          engine_path("lib/auth/oauth/github.rb")
end

#create_rake_tasks ⇒ Object 



111
112
113
114
115
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 111

def create_rake_tasks
  # Wave 11: PII rotation task for hosts upgrading from Wave ≤10.
  template_unless_ejected "lib/tasks/auth_pii.rake.tt",
                          engine_path("lib/tasks/auth_pii.rake")
end

#create_services ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 87

def create_services
  template_unless_ejected "app/services/register_identity.rb.tt",
                          engine_path("app/services/auth/register_identity.rb")
  template_unless_ejected "app/services/authenticate_identity.rb.tt",
                          engine_path("app/services/auth/authenticate_identity.rb")
  template_unless_ejected "app/services/reset_password.rb.tt",
                          engine_path("app/services/auth/reset_password.rb")
  template_unless_ejected "app/services/oauth/authenticator.rb.tt",
                          engine_path("app/services/auth/oauth/authenticator.rb")
  template_unless_ejected "app/services/generate_api_token.rb.tt",
                          engine_path("app/services/auth/generate_api_token.rb")
  # Phase Wave 5 (review fix): the revoke path was documented in
  # the README + registered in engine.rb but had no implementer.
  template_unless_ejected "app/services/revoke_api_token.rb.tt",
                          engine_path("app/services/auth/revoke_api_token.rb")
end

#create_specs ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 167

def create_specs
  template_unless_ejected "spec/models/identity_spec.rb.tt",
                          engine_path("spec/models/auth/identity_spec.rb")
  template_unless_ejected "spec/models/session_spec.rb.tt",
                          engine_path("spec/models/auth/session_spec.rb")
  # Phase 2A finish — coverage for the new Wave-9/10 models.
  template_unless_ejected "spec/models/api_token_spec.rb.tt",
                          engine_path("spec/models/auth/api_token_spec.rb")
  template_unless_ejected "spec/models/oauth/provider_spec.rb.tt",
                          engine_path("spec/models/auth/oauth/provider_spec.rb")
  template_unless_ejected "spec/mailers/passwords_mailer_spec.rb.tt",
                          engine_path("spec/mailers/auth/passwords_mailer_spec.rb")
  template_unless_ejected "spec/factories/auth.rb.tt",
                          engine_path("spec/factories/auth.rb")
end

#create_views ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 133

def create_views
  template_unless_ejected "app/views/sessions/new.html.erb.tt",
                          engine_path("app/views/auth/sessions/new.html.erb")
  template_unless_ejected "app/views/sessions/_oauth_buttons.html.erb.tt",
                          engine_path("app/views/auth/sessions/_oauth_buttons.html.erb")
  template_unless_ejected "app/views/registrations/new.html.erb.tt",
                          engine_path("app/views/auth/registrations/new.html.erb")
  template_unless_ejected "app/views/password_resets/new.html.erb.tt",
                          engine_path("app/views/auth/password_resets/new.html.erb")
  template_unless_ejected "app/views/password_resets/edit.html.erb.tt",
                          engine_path("app/views/auth/password_resets/edit.html.erb")
end

#overwrite_engine_entry_point ⇒ Object 



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 41

def overwrite_engine_entry_point
  # engine.rb / lib/auth.rb stay framework-managed (NOT
  # eject-eligible — see Seams::Generators::EjectAware).
  # configuration.rb is eject-eligible so a host that has
  # ejected it keeps its overrides on regenerate.
  template "lib/engine.rb.tt",                 engine_path("lib/auth/engine.rb"),        force: true
  template "lib/auth.rb.tt",                   engine_path("lib/auth.rb"),               force: true
  template_unless_ejected "lib/configuration.rb.tt",
                          engine_path("lib/auth/configuration.rb")
end

#overwrite_readme ⇒ Object 



183
184
185
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 183

def overwrite_readme
  template "README.md.tt", engine_path("README.md"), force: true
end

#overwrite_routes ⇒ Object 



52
53
54
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 52

def overwrite_routes
  template_unless_ejected "config/routes.rb.tt", engine_path("config/routes.rb"), force: true
end

#report_summary ⇒ Object 



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 236

def report_summary
  say ""
  say "  Auth engine generated at engines/auth/", :green
  say ""
  say "  Next steps:", :yellow
  say "    1. bundle install   (picks up bcrypt + Auth::Engine)"
  say "    2. bin/rails db:migrate"
  say "    3. Run the engine specs: bin/rails seams:test[auth]"
  say ""
end

#update_exposed_concerns ⇒ Object 



187
188
189
190
191
192
193
194
195
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 187

def update_exposed_concerns
  rubocop_path = engine_path(".rubocop.yml")
  return unless File.exist?(rubocop_path)

  contents = File.read(rubocop_path)
  replacement = "  ExposedConcerns:\n    - Auth::Authenticatable\n    - Auth::Authentication"
  contents.sub!(/^  ExposedConcerns: \[\]$/, replacement)
  File.write(rubocop_path, contents)
end

#wire_into_host ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/generators/seams/auth/auth_generator.rb', line 218

def wire_into_host
  host_inject_gem("bcrypt",  "~> 3.1")
  # OAuth adapters speak HTTP via Faraday (no Net::HTTP — see
  # memory feedback_external_apis.md). The host needs Faraday on
  # the load path even if it never configures an OAuth provider.
  host_inject_gem("faraday", "~> 2.0")
  # factory_bot_rails powers the engine's spec/factories/*. Lives
  # in the host's test group only.
  host_inject_gem("factory_bot_rails", "~> 6.4", group: :test)
  host_inject_mount(engine_class: "Auth::Engine", at: "/auth")
  # NB: post-Wave-9 the canonical host has no `app/models/user.rb`,
  # so this call is a best-effort no-op (the helper logs `skip`
  # and moves on). Hosts that DO maintain a domain User on top
  # of `Auth::Identity` get the include wired automatically.
  host_inject_include_in_user("Auth::Authenticatable")
  host_inject_include_in_application_controller("Auth::Authentication")
end