Class: Bundler::UI::Shell
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/bundler/ui/shell.rb |
Constant Summary
-
LEVELS =
# File 'lib/bundler/ui/shell.rb', line 8%w[silent error warn confirm info debug].freeze
-
OUTPUT_STREAMS =
# File 'lib/bundler/ui/shell.rb', line 9[:stdout, :stderr].freeze
Class Method Summary
- .new(options = {}) ⇒ Shell constructor
Instance Attribute Summary
- #confirm? ⇒ Boolean readonly
- #debug? ⇒ Boolean readonly
- #error? ⇒ Boolean readonly
- #info? ⇒ Boolean readonly
- #level(name = nil) rw
- #level=(level) rw
- #output_stream rw
- #output_stream=(symbol) rw
- #quiet? ⇒ Boolean readonly
- #shell=(value) writeonly
- #warn? ⇒ Boolean readonly
Instance Method Summary
- #add_color(string, *color)
- #ask(msg)
- #confirm(msg = nil, newline = nil) readonly
- #debug(msg = nil, newline = nil) readonly
- #error(msg = nil, newline = nil, color = :red) readonly
- #info(msg = nil, newline = nil) readonly
- #no?(msg) ⇒ Boolean
- #progress(&blk)
- #silence(&blk)
- #trace(e, newline = nil, force = false)
- #unprinted_warnings
- #warn(msg = nil, newline = nil, color = :yellow) readonly
- #yes?(msg) ⇒ Boolean
- #strip_leading_spaces(text) private
- #tell_err(message, color = nil, newline = nil) private
-
#tell_me(msg, color = nil, newline = nil)
private
valimism.
- #with_level(level) private
- #with_output_stream(symbol) private
- #word_wrap(text, line_width = Thor::Terminal.terminal_width) private
Constructor Details
.new(options = {}) ⇒ Shell
Instance Attribute Details
#confirm? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/ui/shell.rb', line 62
def confirm? level("confirm") end
#debug? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/ui/shell.rb', line 74
def debug? level("debug") end
#error? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/ui/shell.rb', line 70
def error? level("error") end
#info? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/ui/shell.rb', line 58
def info? level("info") end
#level(name = nil) (rw)
[ GitHub ]#level=(level) (rw)
#output_stream (rw)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 12
attr_reader :output_stream
#output_stream=(symbol) (rw)
# File 'lib/bundler/ui/shell.rb', line 107
def output_stream=(symbol) raise ArgumentError unless OUTPUT_STREAMS.include?(symbol) @output_stream = symbol end
#quiet? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/ui/shell.rb', line 78
def quiet? level("quiet") end
#shell=(value) (writeonly)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 11
attr_writer :shell
#warn? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/ui/shell.rb', line 66
def warn? level("warn") end
Instance Method Details
#add_color(string, *color)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 22
def add_color(string, *color) @shell.set_color(string, *color) end
#ask(msg)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 82
def ask(msg) @shell.ask(msg) end
#confirm(msg = nil, newline = nil) (readonly)
[ GitHub ]#debug(msg = nil, newline = nil) (readonly)
[ GitHub ]#error(msg = nil, newline = nil, color = :red) (readonly)
[ GitHub ]#info(msg = nil, newline = nil) (readonly)
[ GitHub ]
#no?(msg) ⇒ Boolean
# File 'lib/bundler/ui/shell.rb', line 90
def no?(msg) @shell.no?(msg) end
#progress(&blk)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 122
def progress(&blk) with_output_stream(:stderr, &blk) end
#silence(&blk)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 118
def silence(&blk) with_level("silent", &blk) end
#strip_leading_spaces(text) (private)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 159
def strip_leading_spaces(text) spaces = text[/\A\s+/, 0] spaces ? text.gsub(/#{spaces}/, "") : text end
#tell_err(message, color = nil, newline = nil) (private)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 144
def tell_err(, color = nil, newline = nil) return if @shell.send(:stderr).closed? newline = ! .to_s.match?(/( |\t)\Z/) if newline.nil? = word_wrap( ) if newline.is_a?(Hash) && newline[:wrap] color = nil if color && !$stderr.tty? buffer = @shell.send(:, , *color) buffer << "\n" if newline && ! .to_s.end_with?("\n") @shell.send(:stderr).print(buffer) @shell.send(:stderr).flush end
#tell_me(msg, color = nil, newline = nil) (private)
valimism
# File 'lib/bundler/ui/shell.rb', line 133
def tell_me(msg, color = nil, newline = nil) return tell_err(msg, color, newline) if output_stream == :stderr msg = word_wrap(msg) if newline.is_a?(Hash) && newline[:wrap] if newline.nil? @shell.say(msg, color) else @shell.say(msg, color, newline) end end
#trace(e, newline = nil, force = false)
[ GitHub ]#unprinted_warnings
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 126
def unprinted_warnings [] end
#warn(msg = nil, newline = nil, color = :yellow) (readonly)
[ GitHub ]#with_level(level) (private)
[ GitHub ]#with_output_stream(symbol) (private)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 178
def with_output_stream(symbol) original = output_stream self.output_stream = symbol yield ensure @output_stream = original end
#word_wrap(text, line_width = Thor::Terminal.terminal_width) (private)
[ GitHub ]# File 'lib/bundler/ui/shell.rb', line 164
def word_wrap(text, line_width = Thor::Terminal.terminal_width) strip_leading_spaces(text).split("\n").collect do |line| line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line end * "\n" end
#yes?(msg) ⇒ Boolean
# File 'lib/bundler/ui/shell.rb', line 86
def yes?(msg) @shell.yes?(msg) end