Class: Bundler::UI::Shell

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/ui/shell.rb

Constant Summary

LEVELS =
%w(silent error warn confirm info debug)

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Shell) initialize(options = {})

Returns a new instance of Shell



8
9
10
11
12
13
14
# File 'lib/bundler/ui/shell.rb', line 8

def initialize(options = {})
  if options["no-color"] || !STDOUT.tty?
    Thor::Base.shell = Thor::Shell::Basic
  end
  @shell = Thor::Base.shell.new
  @level = ENV['DEBUG'] ? "debug" : "info"
end

Instance Attribute Details

- (Object) shell=(value) (writeonly)

Sets the attribute shell

Parameters:

  • value

    the value to set the attribute shell to.



6
7
8
# File 'lib/bundler/ui/shell.rb', line 6

def shell=(value)
  @shell = value
end

Instance Method Details

- (Object) ask(msg)



45
46
47
# File 'lib/bundler/ui/shell.rb', line 45

def ask(msg)
  @shell.ask(msg)
end

- (Object) confirm(msg, newline = nil)



20
21
22
# File 'lib/bundler/ui/shell.rb', line 20

def confirm(msg, newline = nil)
  tell_me(msg, :green, newline) if level("confirm")
end

- (Object) debug(msg, newline = nil)



32
33
34
# File 'lib/bundler/ui/shell.rb', line 32

def debug(msg, newline = nil)
  tell_me(msg, nil, newline) if level("debug")
end

- (Boolean) debug?

Returns:

  • (Boolean)


36
37
38
39
# File 'lib/bundler/ui/shell.rb', line 36

def debug?
  # needs to be false instead of nil to be newline param to other methods
  level("debug")
end

- (Object) error(msg, newline = nil)



28
29
30
# File 'lib/bundler/ui/shell.rb', line 28

def error(msg, newline = nil)
  tell_me(msg, :red, newline) if level("error")
end

- (Object) info(msg, newline = nil)



16
17
18
# File 'lib/bundler/ui/shell.rb', line 16

def info(msg, newline = nil)
  tell_me(msg, nil, newline) if level("info")
end

- (Object) level(name = nil)



54
55
56
# File 'lib/bundler/ui/shell.rb', line 54

def level(name = nil)
  name ? LEVELS.index(name) <= LEVELS.index(@level) : @level
end

- (Object) level=(level)

Raises:

  • (ArgumentError)


49
50
51
52
# File 'lib/bundler/ui/shell.rb', line 49

def level=(level)
  raise ArgumentError unless LEVELS.include?(level.to_s)
  @level = level
end

- (Boolean) quiet?

Returns:

  • (Boolean)


41
42
43
# File 'lib/bundler/ui/shell.rb', line 41

def quiet?
  LEVELS.index(@level) <= LEVELS.index("warn")
end

- (Object) silence



67
68
69
70
71
72
# File 'lib/bundler/ui/shell.rb', line 67

def silence
  old_level, @level = @level, "silent"
  yield
ensure
  @level = old_level
end

- (Object) trace(e, newline = nil)



58
59
60
61
62
63
64
65
# File 'lib/bundler/ui/shell.rb', line 58

def trace(e, newline = nil)
  msg = ["#{e.class}: #{e.message}", *e.backtrace].join("\n")
  if debug?
    tell_me(msg, nil, newline)
  elsif @trace
    STDERR.puts "#{msg}#{newline}"
  end
end

- (Object) warn(msg, newline = nil)



24
25
26
# File 'lib/bundler/ui/shell.rb', line 24

def warn(msg, newline = nil)
  tell_me(msg, :yellow, newline) if level("warn")
end