Class: Findbug::Generators::InstallGenerator

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

Overview

InstallGenerator sets up Findbug in a Rails application.

Usage:

rails generate findbug:install

This will:

1. Create the initializer (config/initializers/findbug.rb)
2. Create database migrations
3. Display next steps

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.next_migration_number(dirname) ⇒ Object 



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

def self.next_migration_number(dirname)
  ActiveRecord::Generators::Base.next_migration_number(dirname)
end

Instance Method Details

#create_initializer ⇒ Object 



34
35
36
37
 
# File 'lib/generators/findbug/install_generator.rb', line 34

def create_initializer
  template "initializer.rb", "config/initializers/findbug.rb"
  say_status :create, "config/initializers/findbug.rb", :green
end

#create_migrations ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/generators/findbug/install_generator.rb', line 39

def create_migrations
  return if options[:skip_migrations]

  migration_template(
    "create_findbug_error_events.rb",
    "db/migrate/create_findbug_error_events.rb"
  )

  migration_template(
    "create_findbug_performance_events.rb",
    "db/migrate/create_findbug_performance_events.rb"
  )

  migration_template(
    "create_findbug_alert_channels.rb",
    "db/migrate/create_findbug_alert_channels.rb"
  )

  say_status :create, "db/migrate/create_findbug_error_events.rb", :green
  say_status :create, "db/migrate/create_findbug_performance_events.rb", :green
  say_status :create, "db/migrate/create_findbug_alert_channels.rb", :green
end

#display_post_install ⇒ Object 



62
63
64
 
# File 'lib/generators/findbug/install_generator.rb', line 62

def display_post_install
  readme "POST_INSTALL" if behavior == :invoke
end