Class: SolidObserver::Generators::InstallGenerator

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

Instance Method Summary collapse

Instance Method Details

#add_database_configuration ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/generators/solid_observer/install_generator.rb', line 16

def add_database_configuration
  %w[development test production].each do |env|
    config_block = <<-YAML
  solid_observer_queue:
    adapter: sqlite3
    pool: 5
    timeout: 5000
    database: storage/#{env}_solid_observer_queue.sqlite3
    migrations_paths: db/solid_observer_migrate
    YAML
    inject_into_file "config/database.yml", config_block, after: /^#{env}:\n(?:  .*\n)*/
  end
end

#add_engine_mount ⇒ Object 



30
31
32
 
# File 'lib/generators/solid_observer/install_generator.rb', line 30

def add_engine_mount
  route 'mount SolidObserver::Engine, at: "/solid_observer"'
end

#create_initializer ⇒ Object 



12
13
14
 
# File 'lib/generators/solid_observer/install_generator.rb', line 12

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

#show_instructions ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/generators/solid_observer/install_generator.rb', line 34

def show_instructions
  say "\n"
  print_banner
  say "\n"
  say "Next steps:", :yellow
  say "  1. Review configuration in config/initializers/solid_observer.rb"
  say "  2. Install migrations: bin/rails solid_observer:install:migrations"
  say "  3. Create database: bin/rails db:create"
  say "  4. Run migrations: bin/rails db:migrate"
  say "  5. Restart your Rails server"
  say "  6. Visit /solid_observer to access the web dashboard"
  say "\n"
  say "IMPORTANT: If your host app uses PostgreSQL or MySQL, review the", :yellow
  say "solid_observer_queue entries in config/database.yml before running", :yellow
  say "db:create. The generated config uses adapter: sqlite3 by default.", :yellow
  say "\n"
  say "Documentation: https://solid.observer", :red
  say "GitHub: https://github.com/bart-oz/solid_observer", :red
  say "\n"
end