class Bundler::UI::Shell - bundler-1.15.4 Documentation

# class Bundler::UI::Shell

### Constants

LEVELS

### Attributes

shell[W]

### Public Class Methods

new(options = {}) click to toggle source

    # File lib/bundler/ui/shell.rb, line 10
    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

### Public Instance Methods

add_color(string, *color) click to toggle source

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

ask(msg) click to toggle source

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

confirm(msg, newline = nil) click to toggle source

    # File lib/bundler/ui/shell.rb, line 27
    def confirm(msg, newline = nil)
      tell_me(msg, :green, newline) if level("confirm")
    end

debug(msg, newline = nil) click to toggle source

    # File lib/bundler/ui/shell.rb, line 41
    def debug(msg, newline = nil)
      tell_me(msg, nil, newline) if debug?
    end

debug?() click to toggle source

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

error(msg, newline = nil) click to toggle source

    # File lib/bundler/ui/shell.rb, line 37
    def error(msg, newline = nil)
      tell_me(msg, :red, newline) if level("error")
    end

info(msg, newline = nil) click to toggle source

    # File lib/bundler/ui/shell.rb, line 23
    def info(msg, newline = nil)
      tell_me(msg, nil, newline) if level("info")
    end

level(name = nil) click to toggle source

    # File lib/bundler/ui/shell.rb, line 70
    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 lib/bundler/ui/shell.rb, line 65
    def level=(level)
      raise ArgumentError unless LEVELS.include?(level.to_s)
      @level = level.to_s
    end

no?() click to toggle source

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

quiet?() click to toggle source

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

silence(&blk) click to toggle source

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

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

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

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

warn(msg, newline = nil) click to toggle source

    # File lib/bundler/ui/shell.rb, line 31
    def warn(msg, newline = nil)
      return if @warning_history.include? msg
      @warning_history << msg
      tell_me(msg, :yellow, newline) if level("warn")
    end

yes?(msg) click to toggle source

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

### Private Instance Methods

strip_leading_spaces(text) click to toggle source

    # File lib/bundler/ui/shell.rb, line 112
    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 lib/bundler/ui/shell.rb, line 104
    def tell_err(message, color = nil, newline = nil)
      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 lib/bundler/ui/shell.rb, line 95
    def tell_me(msg, color = nil, newline = nil)
      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 lib/bundler/ui/shell.rb, line 123
    def with_level(level)
      original = @level
      @level = level
      yield
    ensure
      @level = original
    end

word_wrap(text, line_width = @shell.terminal_width) click to toggle source

    # File lib/bundler/ui/shell.rb, line 117
    def word_wrap(text, line_width = @shell.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