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



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

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 debug?
end

#debug?Boolean

Returns:

  • (Boolean)


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

def debug?
  level("debug")
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



71
72
73
74
75
76
77
# File 'lib/bundler/ui/shell.rb', line 71

def level(name = nil)
  return @level unless name
  unless index = LEVELS.index(name)
    raise "#{name.inspect} is not a valid level"
  end
  index <= LEVELS.index(@level)
end

#level=(level) ⇒ Object

Raises:

  • (ArgumentError)


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

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

#no?Boolean

Returns:

  • (Boolean)


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

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

#quiet?Boolean

Returns:

  • (Boolean)


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

def quiet?
  level("quiet")
end

#silence(&blk) ⇒ Object



85
86
87
# File 'lib/bundler/ui/shell.rb', line 85

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

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



79
80
81
82
83
# File 'lib/bundler/ui/shell.rb', line 79

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

#unprinted_warningsObject



89
90
91
# File 'lib/bundler/ui/shell.rb', line 89

def unprinted_warnings
  []
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)


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

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