Class: Bundler::UI::Shell

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

Constant Summary collapse

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.



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

def initialize(options = {})
  Thor::Base.shell = options["no-color"] ? Thor::Shell::Basic : nil
  @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.



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

def shell=(value)
  @shell = value
end

Instance Method Details

#add_color(string, *color) ⇒ Object



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

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

#ask(msg) ⇒ Object



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

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

#confirm(msg = nil, newline = nil) ⇒ Object



29
30
31
32
33
# File 'lib/bundler/ui/shell.rb', line 29

def confirm(msg = nil, newline = nil)
  return unless confirm?

  tell_me(msg || yield, :green, newline)
end

#confirm?Boolean

Returns:

  • (Boolean)


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

def confirm?
  level("confirm")
end

#debug(msg = nil, newline = nil) ⇒ Object



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

def debug(msg = nil, newline = nil)
  return unless debug?

  tell_me(msg || yield, nil, newline)
end

#debug?Boolean

Returns:

  • (Boolean)


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

def debug?
  level("debug")
end

#error(msg = nil, newline = nil, color = :red) ⇒ Object



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

def error(msg = nil, newline = nil, color = :red)
  return unless error?

  tell_err(msg || yield, color, newline)
end

#error?Boolean

Returns:

  • (Boolean)


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

def error?
  level("error")
end

#info(msg = nil, newline = nil) ⇒ Object



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

def info(msg = nil, newline = nil)
  return unless info?

  tell_me(msg || yield, nil, newline)
end

#info?Boolean

Returns:

  • (Boolean)


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

def info?
  level("info")
end

#level(name = nil) ⇒ Object



96
97
98
99
100
101
102
# File 'lib/bundler/ui/shell.rb', line 96

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)


91
92
93
94
# File 'lib/bundler/ui/shell.rb', line 91

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

#no?Boolean

Returns:

  • (Boolean)


87
88
89
# File 'lib/bundler/ui/shell.rb', line 87

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

#quiet?Boolean

Returns:

  • (Boolean)


75
76
77
# File 'lib/bundler/ui/shell.rb', line 75

def quiet?
  level("quiet")
end

#silence(&blk) ⇒ Object



110
111
112
# File 'lib/bundler/ui/shell.rb', line 110

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

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



104
105
106
107
108
# File 'lib/bundler/ui/shell.rb', line 104

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

#unprinted_warningsObject



114
115
116
# File 'lib/bundler/ui/shell.rb', line 114

def unprinted_warnings
  []
end

#warn(msg = nil, newline = nil, color = :yellow) ⇒ Object



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

def warn(msg = nil, newline = nil, color = :yellow)
  return unless warn?
  return if @warning_history.include? msg
  @warning_history << msg

  tell_err(msg || yield, color, newline)
end

#warn?Boolean

Returns:

  • (Boolean)


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

def warn?
  level("warn")
end

#yes?(msg) ⇒ Boolean

Returns:

  • (Boolean)


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

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