Class: Rails::Console

Inherits:
Object
  • Object
show all
Defined in:
lib/rails/commands/console/irb_console.rb,
lib/rails/commands/console/console_command.rb

Defined Under Namespace

Classes: AppInstance, ControllerHelper, ControllerInstance, IRBConsole, NewSession, RailsHelperBase, Reloader

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Console.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rails/commands/console/console_command.rb', line 13

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 "rails/commands/console/irb_console"
    IRBConsole.new(app)
  end
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



11
12
13
 
# File 'lib/rails/commands/console/console_command.rb', line 11

def app
  @app
end

#console ⇒ Object (readonly)

Returns the value of attribute console.



11
12
13
 
# File 'lib/rails/commands/console/console_command.rb', line 11

def console
  @console
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



11
12
13
 
# File 'lib/rails/commands/console/console_command.rb', line 11

def options
  @options
end

Class Method Details

.start(*args) ⇒ Object 



7
8
9
 
# File 'lib/rails/commands/console/console_command.rb', line 7

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

Instance Method Details

#environment ⇒ Object Also known as: environment? 



40
41
42
 
# File 'lib/rails/commands/console/console_command.rb', line 40

def environment
  options[:environment]
end

#sandbox? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
35
36
37
38
 
# File 'lib/rails/commands/console/console_command.rb', line 32

def sandbox?
  return options[:sandbox] if !options[:sandbox].nil?

  return false if Rails.env.local?

  app.config.sandbox_by_default
end

#set_environment! ⇒ Object 



45
46
47
 
# File 'lib/rails/commands/console/console_command.rb', line 45

def set_environment!
  Rails.env = environment
end

#start ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rails/commands/console/console_command.rb', line 49

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

  console.start
end