Class: Verikloak::Generators::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/verikloak/install/install_generator.rb

Overview

Rails generator that creates ‘config/initializers/verikloak.rb` and prints follow-up instructions for configuring verikloak-rails.

Instance Method Summary collapse

Instance Method Details

#create_initializer ⇒ void

This method returns an undefined value.

Create the initializer file under config/initializers.

Examples:

rails g verikloak:install



18
19
20
 
# File 'lib/generators/verikloak/install/install_generator.rb', line 18

def create_initializer
  template 'initializer.rb.erb', 'config/initializers/verikloak.rb'
end

#say_next_steps ⇒ void

This method returns an undefined value.

Print next steps for configuring the gem.



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/generators/verikloak/install/install_generator.rb', line 24

def say_next_steps
  say "    \u2705 verikloak: initializer created.\n\n    Next steps:\n    1) Ensure the base gem is installed:   gem 'verikloak', '>= 0.2.0', '< 1.0.0'\n    2) Set discovery_url / audience in config/initializers/verikloak.rb\n    3) (Optional) If you disable auto-include, add this line to ApplicationController:\n         include Verikloak::Rails::Controller\n    4) (Optional) For BFF/proxy setups, add gem 'verikloak-bff' to normalize headers.\n    5) (Optional) When using Pundit policies, consider gem 'verikloak-pundit' for richer errors.\n  MSG\nend\n"