Class: Rails::Console

Inherits:
Object show all
Defined in:
railties/lib/rails/commands/console/console_command.rb

Defined Under Namespace

Modules: BacktraceCleaner

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, options = {}) ⇒ Console

Returns a new instance of Console.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 21

def initialize(app, options = {})
  @app     = app
  @options = options

  app.sandbox = sandbox?

  if sandbox? && app.config.disable_sandbox
    puts "Error: Unable to start console in sandbox mode as sandbox mode is disabled (config.disable_sandbox is true)."
    exit 1
  end

  app.load_console

  @console = app.config.console || begin
    require "irb"
    require "irb/completion"

    IRB::WorkSpace.prepend(BacktraceCleaner)

    if !Rails.env.local?
      ENV["IRB_USE_AUTOCOMPLETE"] ||= "false"
    end

    IRB
  end
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app



19
20
21
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 19

def app
  @app
end

#console ⇒ Object (readonly)

Returns the value of attribute console



19
20
21
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 19

def console
  @console
end

#options ⇒ Object (readonly)

Returns the value of attribute options



19
20
21
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 19

def options
  @options
end

Class Method Details

.start(*args) ⇒ Object 



15
16
17
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 15

def self.start(*args)
  new(*args).start
end

Instance Method Details

#environment ⇒ Object Also known as: environment? 



52
53
54
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 52

def environment
  options[:environment]
end

#sandbox? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 48

def sandbox?
  options[:sandbox]
end

#set_environment! ⇒ Object 



57
58
59
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 57

def set_environment!
  Rails.env = environment
end

#start ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'railties/lib/rails/commands/console/console_command.rb', line 61

def start
  set_environment! if environment?

  if sandbox?
    puts "Loading #{Rails.env} environment in sandbox (Rails #{Rails.version})"
    puts "Any modifications you make will be rolled back on exit"
  else
    puts "Loading #{Rails.env} environment (Rails #{Rails.version})"
  end

  if defined?(console::ExtendCommandBundle)
    console::ExtendCommandBundle.include(Rails::ConsoleMethods)
  end
  console.start
end