Class: Pu::Invites::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Includes:
ActiveRecord::Generators::Migration, PlutoniumGenerators::Concerns::RodauthRedirects, PlutoniumGenerators::Generator
Defined in:
lib/generators/pu/invites/install_generator.rb

Instance Method Summary collapse

Methods included from PlutoniumGenerators::Concerns::RodauthRedirects

#update_rodauth_redirects

Methods included from PlutoniumGenerators::Generator

derive_association_name, find_shared_namespace, included

Methods included from PlutoniumGenerators::Concerns::Logger

#debug, #error, #exception, #info, #success, #warn

Methods included from PlutoniumGenerators::Concerns::Config

#read_config, #write_config

Instance Method Details

#add_entity_action ⇒ Object 



149
150
151
152
153
 
# File 'lib/generators/pu/invites/install_generator.rb', line 149

def add_entity_action
  inject_into_file entity_definition_path,
    "  action :invite_user, interaction: #{entity_model}::InviteUserInteraction, category: :secondary\n",
    after: /class #{entity_model}Definition < .+\n/
end

#add_entity_association ⇒ Object 



133
134
135
136
137
 
# File 'lib/generators/pu/invites/install_generator.rb', line 133

def add_entity_association
  inject_into_file entity_model_path,
    "  has_many :user_invites, class_name: \"Invites::UserInvite\", dependent: :destroy\n",
    before: /^\s*# add has_many associations above\.\n/
end

#add_entity_policy ⇒ Object 



155
156
157
158
159
 
# File 'lib/generators/pu/invites/install_generator.rb', line 155

def add_entity_policy
  inject_into_file entity_policy_path,
    "def invite_user?\n    current_membership&.owner?\n  end\n\n  ",
    before: "# Core attributes"
end

#add_resource_policy_helper ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/generators/pu/invites/install_generator.rb', line 178

def add_resource_policy_helper
  resource_policy_path = "app/policies/resource_policy.rb"

  return unless File.exist?(Rails.root.join(resource_policy_path))

  file_content = File.read(Rails.root.join(resource_policy_path))

  helper_code = <<-RUBY
  def current_membership
    return unless entity_scope && user

    @current_membership ||= #{membership_model}.find_by(#{entity_association_name}: entity_scope, #{user_association_name}: user)
  end
  RUBY

  if file_content.include?("private\n")
    inject_into_file resource_policy_path,
      "\n#{helper_code}",
      after: "private\n"
  else
    inject_into_file resource_policy_path,
      "\n  private\n\n#{helper_code}",
      before: /^end\s*\z/
  end
end

#add_routes ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/generators/pu/invites/install_generator.rb', line 204

def add_routes
  routes_content = File.read(Rails.root.join("config/routes.rb"))
  if routes_content.include?("# User invitation routes")
    say_status :skip, "Invitation routes already present", :yellow
    return
  end

  route_code = <<-RUBY

  # User invitation routes
  scope module: :invites do
    get "invitations/welcome", to: "welcome#index", as: :invites_welcome_check
    delete "invitations/welcome", to: "welcome#skip", as: :invites_welcome_skip
    get "invitations/:token", to: "user_invitations#show", as: :invitation
    post "invitations/:token/accept", to: "user_invitations#accept", as: :accept_invitation
    get "invitations/:token/signup", to: "user_invitations#signup", as: :invitation_signup
    post "invitations/:token/signup", to: "user_invitations#signup"
  end
  RUBY

  inject_into_file "config/routes.rb",
    route_code,
    before: /^end\s*\z/

  # If no main WelcomeController exists, add /welcome route pointing to
  # Invites::WelcomeController so Rodauth's login_redirect "/welcome" works.
  unless File.exist?(Rails.root.join("app/controllers/welcome_controller.rb"))
    welcome_route = <<-RUBY

  # Welcome route (handled by invites package — replace with pu:saas:welcome for full onboarding)
  get "welcome", to: "invites/welcome#index"
    RUBY

    inject_into_file "config/routes.rb",
      welcome_route,
      before: /^\s*# User invitation routes/
  end
end

#add_user_action ⇒ Object 



166
167
168
169
170
 
# File 'lib/generators/pu/invites/install_generator.rb', line 166

def add_user_action
  inject_into_file user_definition_path,
    "  action :invite_user, interaction: #{user_model}::InviteUserInteraction, category: :primary\n",
    after: /class #{user_model}Definition < .+\n/
end

#add_user_policy ⇒ Object 



172
173
174
175
176
 
# File 'lib/generators/pu/invites/install_generator.rb', line 172

def add_user_policy
  inject_into_file user_policy_path,
    "def invite_user?\n    current_membership&.owner?\n  end\n\n  ",
    before: "# Core attributes"
end

#configure_rodauth ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/generators/pu/invites/install_generator.rb', line 243

def configure_rodauth
  return unless rodauth?

  rodauth_file = "app/rodauth/#{rodauth_config}_rodauth_plugin.rb"

  unless File.exist?(Rails.root.join(rodauth_file))
    say_status :skip, "Rodauth plugin not found: #{rodauth_file}", :yellow
    return
  end

  file_content = File.read(Rails.root.join(rodauth_file))

  # Check if already configured
  if file_content.include?("after_welcome_redirect")
    say_status :skip, "Rodauth already configured for invites", :yellow
    return
  end

  # Check for existing after_login block (non-commented)
  # Single-line: after_login { remember_login }
  single_line_match = file_content.match(/^(\s*)after_login\s*\{\s*(.+?)\s*\}/)
  # Multi-line: after_login do ... end
  multi_line_match = file_content.match(/^(\s*)after_login\s+do\s*\n(.*?)\n(\s*)end/m)

  if single_line_match
    # Convert single-line block to multi-line with our code added
    indent = single_line_match[1]
    existing_code = single_line_match[2]
    original_line = single_line_match[0]

    new_block = <<~RUBY.chomp
      #{indent}after_login do
      #{indent}  #{existing_code}
      #{indent}  session[:after_welcome_redirect] = session.delete(:login_redirect)
      #{indent}end
    RUBY

    gsub_file rodauth_file, original_line, new_block
    say_status :info, "Added session redirect to existing after_login block", :green
  elsif multi_line_match
    # Multi-line block - add our line before the end
    indent = multi_line_match[1]
    block_content = multi_line_match[2]
    end_indent = multi_line_match[3]
    original_block = multi_line_match[0]

    new_block = <<~RUBY.chomp
      #{indent}after_login do
      #{block_content}
      #{indent}  session[:after_welcome_redirect] = session.delete(:login_redirect)
      #{end_indent}end
    RUBY

    gsub_file rodauth_file, original_block, new_block
    say_status :info, "Added session redirect to existing after_login block", :green
  else
    # Add new after_login block
     = <<-RUBY

    # ==> User Invites - Move captured path to session for WelcomeController
    after_login do
session[:after_welcome_redirect] = session.delete(:login_redirect)
    end
    RUBY

    inject_into_file rodauth_file,
      ,
      before: /^  end\s*\n/

    say_status :info, "Added after_login block for invites", :green
  end

  # Add other config options if not present
  unless file_content.include?("login_return_to_requested_location?")
    inject_into_file rodauth_file,
      "\n    # Enable path capture so Rodauth stores the originally requested URL\n    login_return_to_requested_location? true\n",
      after: /login_redirect.*\n/
  end

  # Update login_redirect and create_account_redirect to /welcome
  update_rodauth_redirects(rodauth_file)
end

#create_controllers ⇒ Object 



94
95
96
97
98
99
100
 
# File 'lib/generators/pu/invites/install_generator.rb', line 94

def create_controllers
  template "packages/invites/app/controllers/invites/user_invitations_controller.rb",
    "packages/invites/app/controllers/invites/user_invitations_controller.rb"

  template "packages/invites/app/controllers/invites/welcome_controller.rb",
    "packages/invites/app/controllers/invites/welcome_controller.rb"
end

#create_definition ⇒ Object 



123
124
125
126
 
# File 'lib/generators/pu/invites/install_generator.rb', line 123

def create_definition
  template "packages/invites/app/definitions/invites/user_invite_definition.rb",
    "packages/invites/app/definitions/invites/user_invite_definition.rb"
end

#create_entity_interaction ⇒ Object 



139
140
141
142
143
144
145
146
147
 
# File 'lib/generators/pu/invites/install_generator.rb', line 139

def create_entity_interaction
  dest_path = if entity_in_package?
    "packages/#{entity_package}/app/interactions/#{entity_table}/invite_user_interaction.rb"
  else
    "app/interactions/#{entity_table}/invite_user_interaction.rb"
  end

  template "app/interactions/invite_user_interaction.rb", dest_path
end

#create_interactions ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/generators/pu/invites/install_generator.rb', line 115

def create_interactions
  template "packages/invites/app/interactions/invites/resend_invite_interaction.rb",
    "packages/invites/app/interactions/invites/resend_invite_interaction.rb"

  template "packages/invites/app/interactions/invites/cancel_invite_interaction.rb",
    "packages/invites/app/interactions/invites/cancel_invite_interaction.rb"
end

#create_mailer ⇒ Object 



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/generators/pu/invites/install_generator.rb', line 83

def create_mailer
  template "packages/invites/app/mailers/invites/user_invite_mailer.rb",
    "packages/invites/app/mailers/invites/user_invite_mailer.rb"

  template "packages/invites/app/views/invites/user_invite_mailer/invitation.html.erb",
    "packages/invites/app/views/invites/user_invite_mailer/invitation.html.erb"

  template "packages/invites/app/views/invites/user_invite_mailer/invitation.text.erb",
    "packages/invites/app/views/invites/user_invite_mailer/invitation.text.erb"
end

#create_model ⇒ Object 



78
79
80
81
 
# File 'lib/generators/pu/invites/install_generator.rb', line 78

def create_model
  template "packages/invites/app/models/invites/user_invite.rb",
    "packages/invites/app/models/invites/user_invite.rb"
end

#create_package ⇒ Object 



69
70
71
 
# File 'lib/generators/pu/invites/install_generator.rb', line 69

def create_package
  generate "pu:pkg:package", "invites"
end

#create_policy ⇒ Object 



128
129
130
131
 
# File 'lib/generators/pu/invites/install_generator.rb', line 128

def create_policy
  template "packages/invites/app/policies/invites/user_invite_policy.rb",
    "packages/invites/app/policies/invites/user_invite_policy.rb"
end

#create_user_interaction ⇒ Object 



161
162
163
164
 
# File 'lib/generators/pu/invites/install_generator.rb', line 161

def create_user_interaction
  template "app/interactions/user_invite_user_interaction.rb",
    "app/interactions/#{user_table}/invite_user_interaction.rb"
end

#create_user_invites_migration ⇒ Object 



73
74
75
76
 
# File 'lib/generators/pu/invites/install_generator.rb', line 73

def create_user_invites_migration
  migration_template "db/migrate/create_user_invites.rb",
    "db/migrate/create_user_invites.rb"
end

#create_views ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/generators/pu/invites/install_generator.rb', line 102

def create_views
  %w[landing show signup error].each do |view|
    template "packages/invites/app/views/invites/user_invitations/#{view}.html.erb",
      "packages/invites/app/views/invites/user_invitations/#{view}.html.erb"
  end

  template "packages/invites/app/views/invites/welcome/pending_invitation.html.erb",
    "packages/invites/app/views/invites/welcome/pending_invitation.html.erb"

  template "packages/invites/app/views/layouts/invites/invitation.html.erb",
    "packages/invites/app/views/layouts/invites/invitation.html.erb"
end

#integrate_with_welcome_controller ⇒ Object 



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/generators/pu/invites/install_generator.rb', line 326

def integrate_with_welcome_controller
  welcome_controller_path = Rails.root.join("app/controllers/welcome_controller.rb")
  return unless File.exist?(welcome_controller_path)

  file_content = File.read(welcome_controller_path)
  return if file_content.include?("PendingInviteCheck")

  relative_path = "app/controllers/welcome_controller.rb"

  # Add PendingInviteCheck concern and invites view path
  inject_into_file relative_path,
    "  include Plutonium::Invites::PendingInviteCheck\n\n  prepend_view_path Invites::Engine.root.join(\"app/views\")\n",
    after: /class WelcomeController.*\n/

  # Add invite check as first step in index
  inject_into_file relative_path,
    "    return redirect_to(invites_welcome_check_path) if pending_invite\n\n",
    after: /def index\n/

  # Add invite_class method if not present
  unless file_content.include?("def invite_class")
    inject_into_file relative_path,
      "\n  def invite_class\n    ::Invites::UserInvite\n  end\n",
      before: /^end\s*\z/
  end

  # Update Invites::WelcomeController to redirect to /welcome (the main hub)
  # instead of / (the app root)
  invites_welcome_path = "packages/invites/app/controllers/invites/welcome_controller.rb"
  if File.exist?(Rails.root.join(invites_welcome_path))
    gsub_file invites_welcome_path,
      /def default_redirect_path\n\s*"\/"\n\s*end/,
      "def default_redirect_path\n      \"/welcome\"\n    end"
  end

  say_status :info, "Integrated invite check into WelcomeController", :green
end

#show_instructions ⇒ Object 



364
365
366
 
# File 'lib/generators/pu/invites/install_generator.rb', line 364

def show_instructions
  readme "INSTRUCTIONS" if behavior == :invoke
end

#validate_requirements ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/generators/pu/invites/install_generator.rb', line 36

def validate_requirements
  errors = []

  unless File.exist?(Rails.root.join(entity_model_path))
    errors << "Entity model not found: #{entity_model_path}"
  end

  unless File.exist?(Rails.root.join(entity_definition_path))
    errors << "Entity definition not found: #{entity_definition_path}"
  end

  unless File.exist?(Rails.root.join(entity_policy_path))
    errors << "Entity policy not found: #{entity_policy_path}"
  end

  unless File.exist?(Rails.root.join(user_definition_path))
    errors << "User definition not found: #{user_definition_path}"
  end

  unless File.exist?(Rails.root.join(user_policy_path))
    errors << "User policy not found: #{user_policy_path}"
  end

  unless File.exist?(membership_model_file)
    errors << "Membership model not found: #{membership_model_file.relative_path_from(Rails.root)}"
  end

  if errors.any?
    errors.each { |e| say_status :error, e, :red }
    raise Thor::Error, "Required files missing:\n  - #{errors.join("\n  - ")}"
  end
end