class Bundler::UI::Shell - bundler: Ruby Standard Library Documentation

# class Bundler::UI::Shell

### Constants

LEVELS
OUTPUT_STREAMS

### Attributes

output_stream[R]
shell[W]

### Public Class Methods

new(options = {}) click to toggle source

    # File 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
    end

### Public Instance Methods

add_color(string, *color) click to toggle source

    # File bundler/ui/shell.rb, line 22
    def add_color(string, *color)
      @shell.set_color(string, *color)
    end

ask(msg) click to toggle source

    # File bundler/ui/shell.rb, line 82
    def ask(msg)
      @shell.ask(msg)
    end

confirm(msg = nil, newline = nil) { || ... } click to toggle source

    # File bundler/ui/shell.rb, line 32
    def confirm(msg = nil, newline = nil)
      return unless confirm?

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

confirm?() click to toggle source

    # File bundler/ui/shell.rb, line 62
    def confirm?
      level("confirm")
    end

debug(msg = nil, newline = nil) { || ... } click to toggle source

    # File bundler/ui/shell.rb, line 52
    def debug(msg = nil, newline = nil)
      return unless debug?

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

debug?() click to toggle source

    # File bundler/ui/shell.rb, line 74
    def debug?
      level("debug")
    end

error(msg = nil, newline = nil, color = :red) { || ... } click to toggle source

    # File bundler/ui/shell.rb, line 46
    def error(msg = nil, newline = nil, color = :red)
      return unless error?

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

error?() click to toggle source

    # File bundler/ui/shell.rb, line 70
    def error?
      level("error")
    end

info(msg = nil, newline = nil) { || ... } click to toggle source

    # File bundler/ui/shell.rb, line 26
    def info(msg = nil, newline = nil)
      return unless info?

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

info?() click to toggle source

    # File bundler/ui/shell.rb, line 58
    def info?
      level("info")
    end

level(name = nil) click to toggle source

    # File bundler/ui/shell.rb, line 99
    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) click to toggle source

    # File bundler/ui/shell.rb, line 94
    def level=(level)
      raise ArgumentError unless LEVELS.include?(level.to_s)
      @level = level.to_s
    end

no?(msg) click to toggle source

    # File bundler/ui/shell.rb, line 90
    def no?(msg)
      @shell.no?(msg)
    end

output_stream=(symbol) click to toggle source

    # File bundler/ui/shell.rb, line 107
    def output_stream=(symbol)
      raise ArgumentError unless OUTPUT_STREAMS.include?(symbol)
      @output_stream = symbol
    end

progress(&blk) click to toggle source

    # File bundler/ui/shell.rb, line 122
    def progress(&blk)
      with_output_stream(:stderr, &blk)
    end

quiet?() click to toggle source

    # File bundler/ui/shell.rb, line 78
    def quiet?
      level("quiet")
    end

silence(&blk) click to toggle source

    # File bundler/ui/shell.rb, line 118
    def silence(&blk)
      with_level("silent", &blk)
    end

trace(e, newline = nil, force = false) click to toggle source

    # File bundler/ui/shell.rb, line 112
    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() click to toggle source

    # File bundler/ui/shell.rb, line 126
    def unprinted_warnings
      []
    end

warn(msg = nil, newline = nil, color = :yellow) { || ... } click to toggle source

    # File bundler/ui/shell.rb, line 38
    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?() click to toggle source

    # File bundler/ui/shell.rb, line 66
    def warn?
      level("warn")
    end

yes?(msg) click to toggle source

    # File bundler/ui/shell.rb, line 86
    def yes?(msg)
      @shell.yes?(msg)
    end

### Private Instance Methods

strip_leading_spaces(text) click to toggle source

    # File 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) click to toggle source

    # File bundler/ui/shell.rb, line 144
    def tell_err(message, color = nil, newline = nil)
      return if @shell.send(:stderr).closed?

      newline = !message.to_s.match?(/( |\t)\Z/) if newline.nil?
      message = word_wrap(message) if newline.is_a?(Hash) && newline[:wrap]

      color = nil if color && !$stderr.tty?

      buffer = @shell.send(:prepare_message, message, *color)
      buffer << "\n" if newline && !message.to_s.end_with?("\n")

      @shell.send(:stderr).print(buffer)
      @shell.send(:stderr).flush
    end

tell_me(msg, color = nil, newline = nil) click to toggle source

valimism

    # File 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

with_level(level) { || ... } click to toggle source

    # File bundler/ui/shell.rb, line 170
    def with_level(level)
      original = @level
      @level = level
      yield
    ensure
      @level = original
    end

with_output_stream(symbol) { || ... } click to toggle source

    # File 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) click to toggle source

    # File 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