Class: BranchDb::InstallGenerator

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

Instance Method Summary collapse

Instance Method Details

#create_initializerObject



9
10
11
# File 'lib/generators/branch_db/install_generator.rb', line 9

def create_initializer
  template "initializer.rb", "config/initializers/branch_db.rb"
end

#show_instructionsObject

rubocop:disable Metrics/AbcSize,Metrics/MethodLength



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/generators/branch_db/install_generator.rb', line 13

def show_instructions # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
  say ""
  say "=== BranchDb Installation Complete ===", :green
  say ""
  say "Next steps:", :yellow
  say ""
  say "1. Update your config/database.yml to use dynamic database names:"
  say ""
  say "   development:"
  say "     database: <%= BranchDb.database_name('#{app_name}_development') rescue '#{app_name}_development' %>"
  say ""
  say "   test:"
  say "     database: <%= BranchDb.database_name('#{app_name}_test') rescue '#{app_name}_test' %>"
  say ""
  say "2. Initialize your database:"
  say "   rails db:prepare          # Creates and clones from main"
  say ""
  say "3. Other available tasks:"
  say "   rails db:branch:list      # List all branch databases"
  say "   rails db:branch:purge     # Remove all branch databases (keeps main/current)"
  say "   rails db:branch:prune     # Remove databases for deleted git branches"
  say ""
  say "4. Optional environment variable overrides:"
  say "   BRANCH_DB_BRANCH                  # Override the detected git branch name"
  say "   BRANCH_DB_DATABASE_DEVELOPMENT    # Override the development database name"
  say "   BRANCH_DB_DATABASE_TEST           # Override the test database name"
  say "   See the README's \"Overriding the Branch or Database\" section for details."
  say ""
end