Class: Pu::Invites::InstallGenerator

Inherits:

Rails::Generators::Base

• Object
• Rails::Generators::Base
• Pu::Invites::InstallGenerator

Includes:

ActiveRecord::Generators::Migration, PlutoniumGenerators::Concerns::RodauthRedirects, PlutoniumGenerators::Generator

Defined in:

lib/generators/pu/invites/install_generator.rb

Instance Method Summary

• #add_entity_action ⇒ Object
• #add_entity_association ⇒ Object
• #add_entity_policy ⇒ Object
• #add_resource_policy_helper ⇒ Object
• #add_routes ⇒ Object
• #add_user_action ⇒ Object
• #add_user_policy ⇒ Object
• #add_welcome_invite_class ⇒ Object
• #configure_rodauth ⇒ Object
• #create_controllers ⇒ Object
• #create_definition ⇒ Object
• #create_entity_interaction ⇒ Object
• #create_interactions ⇒ Object
• #create_mailer ⇒ Object
• #create_model ⇒ Object
• #create_package ⇒ Object
• #create_policy ⇒ Object
• #create_user_interaction ⇒ Object
• #create_user_invites_migration ⇒ Object
• #create_views ⇒ Object
• #integrate_with_welcome_controller ⇒ Object
• #show_instructions ⇒ Object
• #validate_requirements ⇒ Object
• #verify_active_record_encryption ⇒ Object

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

# File 'lib/generators/pu/invites/install_generator.rb', line 189

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

# File 'lib/generators/pu/invites/install_generator.rb', line 173

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

#add_entity_policy ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 195

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

# File 'lib/generators/pu/invites/install_generator.rb', line 218

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 = "  def current_membership\n    return unless entity_scope && user\n\n    @current_membership ||= \#{membership_model}.find_by(\#{entity_association_name}: entity_scope, \#{user_association_name}: user)\n  end\n  RUBY\n\n  if file_content.include?(\"private\\n\")\n    inject_into_file resource_policy_path,\n      \"\\n\#{helper_code}\",\n      after: \"private\\n\"\n  else\n    inject_into_file resource_policy_path,\n      \"\\n  private\\n\\n\#{helper_code}\",\n      before: /^end\\s*\\z/\n  end\nend\n"

#add_routes ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 244

def add_routes
  routes_content = File.read(Rails.root.join("config/routes.rb"))
  flow_marker = "# Invitation routes for #{invite_model}"

  if routes_content.include?(flow_marker)
    say_status :skip, "Invitation routes for #{invite_model} already present", :yellow
  else
    welcome_present = routes_content.include?("# Invitation welcome routes")

    welcome_block = if welcome_present
      ""
    else
      "\n  # Invitation welcome routes (shared across all invite flows)\n  scope module: :invites do\n    get \"invitations/welcome\", to: \"welcome#index\", as: :invites_welcome_check\n    delete \"invitations/welcome\", to: \"welcome#skip\", as: :invites_welcome_skip\n  end\n      RUBY\n    end\n\n    flow_block = <<-RUBY\n\n  \#{flow_marker}\n  scope module: :invites do\n    get \"\#{invitations_path}/:token\", to: \"\#{invitations_path}#show\", as: :\#{invite_route_prefix}_invitation\n    post \"\#{invitations_path}/:token/accept\", to: \"\#{invitations_path}#accept\", as: :accept_\#{invite_route_prefix}_invitation\n    get \"\#{invitations_path}/:token/signup\", to: \"\#{invitations_path}#signup\", as: :\#{invite_route_prefix}_invitation_signup\n    post \"\#{invitations_path}/:token/signup\", to: \"\#{invitations_path}#signup\"\n  end\n    RUBY\n\n    inject_into_file \"config/routes.rb\",\n      welcome_block + flow_block,\n      before: /^end\\s*\\z/\n  end\n\n  # If no main WelcomeController exists, add /welcome route pointing to\n  # Invites::WelcomeController so Rodauth's login_redirect \"/welcome\" works.\n  routes_content = File.read(Rails.root.join(\"config/routes.rb\"))\n  unless File.exist?(Rails.root.join(\"app/controllers/welcome_controller.rb\")) ||\n      routes_content.include?(%(get \"welcome\", to: \"invites/welcome#index\"))\n    welcome_route = <<-RUBY\n\n  # Welcome route (handled by invites package \u2014 replace with pu:saas:welcome for full onboarding)\n  get \"welcome\", to: \"invites/welcome#index\"\n    RUBY\n\n    inject_into_file \"config/routes.rb\",\n      welcome_route,\n      before: /^\\s*# Invitation welcome routes/\n  end\nend\n"

#add_user_action ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 206

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

# File 'lib/generators/pu/invites/install_generator.rb', line 212

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

#add_welcome_invite_class ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 110

def add_welcome_invite_class
  welcome_path = "packages/invites/app/controllers/invites/welcome_controller.rb"
  return unless File.exist?(Rails.root.join(welcome_path))

  content = File.read(Rails.root.join(welcome_path))
  new_class = "::Invites::#{invite_model}"

  # Already present? bail. Use a non-word lookahead so we don't match
  # `::Invites::FunderInvite` when looking for `::Invites::Funder`.
  return if content =~ /#{Regexp.escape(new_class)}(?!\w)/

  # Find `def invite_classes` block; inject before the closing `]`.
  injection = content.sub(/(\bdef invite_classes\b.*?\[)([^\]]*)(\])/m) do
    before, list, after = Regexp.last_match[1], Regexp.last_match[2], Regexp.last_match[3]
    existing = list.strip
    new_list = existing.empty? ? new_class : "#{existing.chomp(",").strip}, #{new_class}"
    "#{before}#{new_list}#{after}"
  end

  if injection != content
    File.write(Rails.root.join(welcome_path), injection)
    say_status :inject, "Added #{new_class} to welcome controller's invite_classes", :green
  end
end

#configure_rodauth ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 299

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 = "      \#{indent}after_login do\n      \#{indent}  \#{existing_code}\n      \#{indent}  session[:after_welcome_redirect] = session.delete(login_redirect_session_key)\n      \#{indent}end\n    RUBY\n\n    gsub_file rodauth_file, original_line, new_block\n    say_status :info, \"Added session redirect to existing after_login block\", :green\n  elsif multi_line_match\n    # Multi-line block - add our line before the end\n    indent = multi_line_match[1]\n    block_content = multi_line_match[2]\n    end_indent = multi_line_match[3]\n    original_block = multi_line_match[0]\n\n    new_block = <<~RUBY.chomp\n      \#{indent}after_login do\n      \#{block_content}\n      \#{indent}  session[:after_welcome_redirect] = session.delete(login_redirect_session_key)\n      \#{end_indent}end\n    RUBY\n\n    gsub_file rodauth_file, original_block, new_block\n    say_status :info, \"Added session redirect to existing after_login block\", :green\n  else\n    # Add new after_login block\n    after_login_code = <<-RUBY\n\n    # ==> User Invites - Move captured path to session for WelcomeController\n    after_login do\nsession[:after_welcome_redirect] = session.delete(login_redirect_session_key)\n    end\n    RUBY\n\n    inject_into_file rodauth_file,\n      after_login_code,\n      before: /^  end\\s*\\n/\n\n    say_status :info, \"Added after_login block for invites\", :green\n  end\n\n  # Add other config options if not present\n  unless file_content.include?(\"login_return_to_requested_location?\")\n    inject_into_file rodauth_file,\n      \"\\n    # Enable path capture so Rodauth stores the originally requested URL\\n    login_return_to_requested_location? true\\n\",\n      after: /login_redirect.*\\n/\n  end\n\n  # Update login_redirect and create_account_redirect to /welcome\n  update_rodauth_redirects(rodauth_file)\nend\n".chomp

#create_controllers ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 98

def create_controllers
  template "packages/invites/app/controllers/invites/user_invitations_controller.rb",
    "packages/invites/app/controllers/invites/#{invitations_path}_controller.rb"

  # Welcome controller is a one-shot — only generate if it doesn't exist yet.
  welcome_path = "packages/invites/app/controllers/invites/welcome_controller.rb"
  unless File.exist?(Rails.root.join(welcome_path))
    template "packages/invites/app/controllers/invites/welcome_controller.rb",
      welcome_path
  end
end

#create_definition ⇒ Object

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

def create_definition
  template "packages/invites/app/definitions/invites/user_invite_definition.rb",
    "packages/invites/app/definitions/invites/#{invite_underscore}_definition.rb"
end

#create_entity_interaction ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 179

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

# File 'lib/generators/pu/invites/install_generator.rb', line 155

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

# File 'lib/generators/pu/invites/install_generator.rb', line 87

def create_mailer
  template "packages/invites/app/mailers/invites/user_invite_mailer.rb",
    "packages/invites/app/mailers/invites/#{invite_underscore}_mailer.rb"

  template "packages/invites/app/views/invites/user_invite_mailer/invitation.html.erb",
    "packages/invites/app/views/invites/#{invite_underscore}_mailer/invitation.html.erb"

  template "packages/invites/app/views/invites/user_invite_mailer/invitation.text.erb",
    "packages/invites/app/views/invites/#{invite_underscore}_mailer/invitation.text.erb"
end

#create_model ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 82

def create_model
  template "packages/invites/app/models/invites/user_invite.rb",
    "packages/invites/app/models/invites/#{invite_underscore}.rb"
end

#create_package ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 72

def create_package
  return if File.exist?(File.join(destination_root, "packages/invites"))
  generate "pu:pkg:package", "invites"
end

#create_policy ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 168

def create_policy
  template "packages/invites/app/policies/invites/user_invite_policy.rb",
    "packages/invites/app/policies/invites/#{invite_underscore}_policy.rb"
end

#create_user_interaction ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 201

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

# File 'lib/generators/pu/invites/install_generator.rb', line 77

def create_user_invites_migration
  migration_template "db/migrate/create_user_invites.rb",
    "db/migrate/create_#{invite_table}.rb"
end

#create_views ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 135

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/#{invitations_path}/#{view}.html.erb"
  end

  # Welcome view is a one-shot too.
  pending_path = "packages/invites/app/views/invites/welcome/pending_invitation.html.erb"
  unless File.exist?(Rails.root.join(pending_path))
    template "packages/invites/app/views/invites/welcome/pending_invitation.html.erb",
      pending_path
  end

  layout_path = "packages/invites/app/views/layouts/invites/invitation.html.erb"
  unless File.exist?(Rails.root.join(layout_path))
    template "packages/invites/app/views/layouts/invites/invitation.html.erb",
      layout_path
  end
end

#integrate_with_welcome_controller ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 382

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_classes method if neither it nor invite_class is present
  if file_content !~ /def invite_classes\b/ && file_content !~ /def invite_class\b/
    inject_into_file relative_path,
      "\n  def invite_classes\n    [::Invites::#{invite_model}]\n  end\n",
      before: /^end\s*\z/
  else
    # Inject this invite_model into the existing invite_classes array if missing.
    host_content = File.read(Rails.root.join(relative_path))
    if host_content =~ /def invite_classes\b/ && host_content !~ /::Invites::#{invite_model}\b/
      updated = host_content.sub(/(\bdef invite_classes\b.*?\[)([^\]]*)(\])/m) do
        before, list, after = Regexp.last_match[1], Regexp.last_match[2], Regexp.last_match[3]
        existing = list.strip
        new_list = existing.empty? ? "::Invites::#{invite_model}" : "#{existing.chomp(",").strip}, ::Invites::#{invite_model}"
        "#{before}#{new_list}#{after}"
      end
      File.write(Rails.root.join(relative_path), updated)
    end
  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

# File 'lib/generators/pu/invites/install_generator.rb', line 454

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

#validate_requirements ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 39

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

#verify_active_record_encryption ⇒ Object

# File 'lib/generators/pu/invites/install_generator.rb', line 432

def verify_active_record_encryption
  return if behavior == :revoke
  return if active_record_encryption_configured?

  say_status :warning, "ActiveRecord encryption keys are not configured", :yellow
  say "\n    Invite tokens use `encrypts :token, deterministic: true`. Without keys,\n    creating or accepting an invite raises\n    ActiveRecord::Encryption::Errors::Configuration.\n\n    Generate keys and add them to credentials with:\n\n        bin/rails db:encryption:init\n\n    Then paste the printed `active_record_encryption:` block into\n    config/credentials.yml.enc (or set the equivalent ENV vars in\n    production).\n\n  MSG\nend\n".indent(2)