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

Public Instance Methods

add_color(string, *color) click to toggle source
# File lib/bundler/ui/shell.rb, line 21
def add_color(string, *color)
  @shell.set_color(string, *color)
end
ask(msg) click to toggle source
# File lib/bundler/ui/shell.rb, line 60
def ask(msg)
  @shell.ask(msg)
end
confirm(msg, newline = nil) click to toggle source
# 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) click to toggle source
# File lib/bundler/ui/shell.rb, line 48
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 52
def debug?
  level("debug")
end
error(msg, newline = nil) click to toggle source
# 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

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

      def debug?
        level("debug")
      end

      def quiet?
        level("quiet")
      end

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

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

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

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

      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

      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

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

      def unprinted_warnings
        []
      end

    private

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

      def tell_err(message, color = nil, newline = nil)
        return if @shell.send(:stderr).closed?

        newline ||= message.to_s !~ /( |\t)\Z/
        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

      def strip_leading_spaces(text)
        spaces = text[/\A\s+/, 0]
        spaces ? text.gsub(/#{spaces}/, "") : text
      end

      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

      def with_level(level)
        original = @level
        @level = level
        yield
      ensure
        @level = original
      end
    end
  end
end
info(msg, newline = nil) click to toggle source
# 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) click to toggle source
# 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) click to toggle source
# 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?() click to toggle source
# File lib/bundler/ui/shell.rb, line 68
def no?
  @shell.no?(msg)
end
quiet?() click to toggle source
# File lib/bundler/ui/shell.rb, line 56
def quiet?
  level("quiet")
end
silence(&blk) click to toggle source
# File lib/bundler/ui/shell.rb, line 91
def silence(&blk)
  with_level("silent", &blk)
end
strip_leading_spaces(text) click to toggle source
# File lib/bundler/ui/shell.rb, line 126
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 111
  def tell_err(message, color = nil, newline = nil)
    return if @shell.send(:stderr).closed?

    newline ||= message.to_s !~ /( |\t)\Z/
    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

  def strip_leading_spaces(text)
    spaces = text[/\A\s+/, 0]
    spaces ? text.gsub(/#{spaces}/, "") : text
  end

  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

  def with_level(level)
    original = @level
    @level = level
    yield
  ensure
    @level = original
  end
end
tell_me(msg, color = nil, newline = nil) click to toggle source

valimism

# File lib/bundler/ui/shell.rb, line 102
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
trace(e, newline = nil, force = false) click to toggle source
# 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

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

    def unprinted_warnings
      []
    end

  private

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

    def tell_err(message, color = nil, newline = nil)
      return if @shell.send(:stderr).closed?

      newline ||= message.to_s !~ /( |\t)\Z/
      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

    def strip_leading_spaces(text)
      spaces = text[/\A\s+/, 0]
      spaces ? text.gsub(/#{spaces}/, "") : text
    end

    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

    def with_level(level)
      original = @level
      @level = level
      yield
    ensure
      @level = original
    end
  end
end
unprinted_warnings() click to toggle source
# File lib/bundler/ui/shell.rb, line 95
def unprinted_warnings
  []
end
warn(msg, newline = nil) click to toggle source
# 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

    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

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

    def debug?
      level("debug")
    end

    def quiet?
      level("quiet")
    end

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

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

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

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

    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

    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

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

    def unprinted_warnings
      []
    end

  private

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

    def tell_err(message, color = nil, newline = nil)
      return if @shell.send(:stderr).closed?

      newline ||= message.to_s !~ /( |\t)\Z/
      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

    def strip_leading_spaces(text)
      spaces = text[/\A\s+/, 0]
      spaces ? text.gsub(/#{spaces}/, "") : text
    end

    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

    def with_level(level)
      original = @level
      @level = level
      yield
    ensure
      @level = original
    end
  end
end
with_level(level) { || ... } click to toggle source
# File lib/bundler/ui/shell.rb, line 137
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 131
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
yes?(msg) click to toggle source
# File lib/bundler/ui/shell.rb, line 64
def yes?(msg)
  @shell.yes?(msg)
end