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
OUTPUT_STREAMS = 
[:stdout, :stderr].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Shell

Returns a new instance of Shell.



14
15
16
17
18
19
20
21
 
# File 'lib/bundler/ui/shell.rb', line 14

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 = []
  @output_stream = :stdout
  @thread_safe_logger_key = "logger_level_#{object_id}"
end

Instance Attribute Details

#output_stream ⇒ Object

Returns the value of attribute output_stream.



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

def output_stream
  @output_stream
end

#shell=(value) ⇒ Object (writeonly)

Sets the attribute shell

Parameters:

  • value —

    the value to set the attribute shell to.



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

def shell=(value)
  @shell = value
end

Instance Method Details

#add_color(string, *color) ⇒ Object 



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

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

#ask(msg) ⇒ Object 



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

def ask(msg)
  @shell.ask(msg, :green)
end

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



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

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

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

#confirm? ⇒ Boolean

Returns:

  • (Boolean) 


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

def confirm?
  level("confirm")
end

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



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

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

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

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


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

def debug?
  level("debug")
end

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



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

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

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

#error? ⇒ Boolean

Returns:

  • (Boolean) 


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

def error?
  level("error")
end

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



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

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

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

#info? ⇒ Boolean

Returns:

  • (Boolean) 


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

def info?
  level("info")
end

#level(name = nil) ⇒ Object 



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

def level(name = nil)
  current_level = Thread.current.thread_variable_get(@thread_safe_logger_key) || @level
  return current_level unless name

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

#level=(level) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

#no?(msg) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#progress(&blk) ⇒ Object 



125
126
127
 
# File 'lib/bundler/ui/shell.rb', line 125

def progress(&blk)
  with_output_stream(:stderr, &blk)
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


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

def quiet?
  level("quiet")
end

#silence(&blk) ⇒ Object 



121
122
123
 
# File 'lib/bundler/ui/shell.rb', line 121

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

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



115
116
117
118
119
 
# File 'lib/bundler/ui/shell.rb', line 115

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



129
130
131
 
# File 'lib/bundler/ui/shell.rb', line 129

def unprinted_warnings
  []
end

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



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

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) 


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

def warn?
  level("warn")
end

#yes?(msg) ⇒ Boolean

Returns:

  • (Boolean) 


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

def yes?(msg)
  @shell.yes?(msg, :green)
end