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).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Shell

Returns a new instance of Shell



11
12
13
14
15
16
17
18
# File 'lib/bundler/ui/shell.rb', line 11

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"
  @warning_history = []
end

Instance Attribute Details

#shell=(value) ⇒ Object (writeonly)

Sets the attribute shell

Parameters:

  • value

    the value to set the attribute shell to.



9
10
11
# File 'lib/bundler/ui/shell.rb', line 9

def shell=(value)
  @shell = value
end

Instance Method Details

#add_color(string, *color) ⇒ Object



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

def add_color(string, *color)
  @shell.set_color(string, *color)
end

#ask(msg) ⇒ Object



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

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

#confirm(msg, newline = nil) ⇒ Object



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

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

#debug(msg, newline = nil) ⇒ Object



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

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

#debug?Boolean

Returns:

  • (Boolean)


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

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

#error(msg, newline = nil) ⇒ Object



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

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

#info(msg, newline = nil) ⇒ Object



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

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

#level(name = nil) ⇒ Object



72
73
74
# File 'lib/bundler/ui/shell.rb', line 72

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

#level=(level) ⇒ Object

Raises:

  • (ArgumentError)


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

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

#no?Boolean

Returns:

  • (Boolean)


63
64
65
# File 'lib/bundler/ui/shell.rb', line 63

def no?
  @shell.no?(msg)
end

#quiet?Boolean

Returns:

  • (Boolean)


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

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

#silence(&blk) ⇒ Object



82
83
84
# File 'lib/bundler/ui/shell.rb', line 82

def silence(&blk)
  with_level("silent", &blk)
end

#trace(e, newline = nil, force = false) ⇒ Object



76
77
78
79
80
# File 'lib/bundler/ui/shell.rb', line 76

def trace(e, newline = nil, force = false)
  return unless debug? || force
  msg = "#{e.class}: #{e.message}\n#{e.backtrace.join("\n  ")}"
  tell_me(msg, nil, newline)
end

#warn(msg, newline = nil) ⇒ Object



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

def warn(msg, newline = nil)
  return if @warning_history.include? msg
  @warning_history << msg
  tell_me(msg, :yellow, newline) if level("warn")
end

#yes?(msg) ⇒ Boolean

Returns:

  • (Boolean)


59
60
61
# File 'lib/bundler/ui/shell.rb', line 59

def yes?(msg)
  @shell.yes?(msg)
end