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
18
19
 
# File 'lib/bundler/ui/shell.rb', line 12

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.



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 



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

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

#ask(msg) ⇒ Object 



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

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

#confirm(msg, newline = nil) ⇒ Object 



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

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

#debug(msg, newline = nil) ⇒ Object 



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

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

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


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

def debug?
  level("debug")
end

#error(msg, newline = nil) ⇒ Object 



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

def error(msg, newline = nil)
  return unless level("error")
  return tell_err(msg, :red, newline) if Bundler.feature_flag.error_on_stderr?
  tell_me(msg, :red, newline)
end

#info(msg, newline = nil) ⇒ Object 



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

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

#level(name = nil) ⇒ Object 



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

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) 


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

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

#no? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


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

def quiet?
  level("quiet")
end

#silence(&blk) ⇒ Object 



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

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

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



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

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_warnings ⇒ Object 



95
96
97
 
# File 'lib/bundler/ui/shell.rb', line 95

def unprinted_warnings
  []
end

#warn(msg, newline = nil) ⇒ Object 



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

def warn(msg, newline = nil)
  return unless level("warn")
  return if @warning_history.include? msg
  @warning_history << msg

  return tell_err(msg, :yellow, newline) if Bundler.feature_flag.error_on_stderr?
  tell_me(msg, :yellow, newline)
end

#yes?(msg) ⇒ Boolean

Returns:

  • (Boolean) 


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

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