ansi 1.1.0 → 1.2.0

data/lib/ansi/mixin.rb

@@ -0,0 +1,113 @@
+module ANSI
+  require 'ansi/code'
+
+  # This module is designed specifically for mixing into
+  # String-like classes or extending String-like objects.
+  #
+  # Generally speaking the String#ansi method is the more
+  # elegant approach to modifying a string with codes
+  # via a method call. But in some cases this Mixin's design
+  # might be preferable. In particular it was primarily
+  # designed to provide a compatability layer for the
+  # +colored+ gem.
+
+  module Mixin
+
+    def bold       ; ANSI::Code.bold       { to_s } ; end
+    def dark       ; ANSI::Code.dark       { to_s } ; end
+    def italic     ; ANSI::Code.italic     { to_s } ; end
+    def underline  ; ANSI::Code.underline  { to_s } ; end
+    def underscore ; ANSI::Code.underscore { to_s } ; end
+    def blink      ; ANSI::Code.blink      { to_s } ; end
+    def rapid      ; ANSI::Code.rapid      { to_s } ; end
+    def reverse    ; ANSI::Code.reverse    { to_s } ; end
+    def negative   ; ANSI::Code.negative   { to_s } ; end
+    def concealed  ; ANSI::Code.concealed  { to_s } ; end
+    def strike     ; ANSI::Code.strike     { to_s } ; end
+
+    def black      ; ANSI::Code.black      { to_s } ; end
+    def red        ; ANSI::Code.red        { to_s } ; end
+    def green      ; ANSI::Code.green      { to_s } ; end
+    def yellow     ; ANSI::Code.yellow     { to_s } ; end
+    def blue       ; ANSI::Code.blue       { to_s } ; end
+    def magenta    ; ANSI::Code.magenta    { to_s } ; end
+    def cyan       ; ANSI::Code.cyan       { to_s } ; end
+    def white      ; ANSI::Code.white      { to_s } ; end
+
+    def on_black   ; ANSI::Code.on_black   { to_s } ; end
+    def on_red     ; ANSI::Code.on_red     { to_s } ; end
+    def on_green   ; ANSI::Code.on_green   { to_s } ; end
+    def on_yellow  ; ANSI::Code.on_yellow  { to_s } ; end
+    def on_blue    ; ANSI::Code.on_blue    { to_s } ; end
+    def on_magenta ; ANSI::Code.on_magenta { to_s } ; end
+    def on_cyan    ; ANSI::Code.on_cyan    { to_s } ; end
+    def on_white   ; ANSI::Code.on_white   { to_s } ; end
+
+    def black_on_red      ; ANSI::Code.black_on_red      { to_s } ; end
+    def black_on_green    ; ANSI::Code.black_on_green    { to_s } ; end
+    def black_on_yellow   ; ANSI::Code.black_on_yellow   { to_s } ; end
+    def black_on_blue     ; ANSI::Code.black_on_blue     { to_s } ; end
+    def black_on_magenta  ; ANSI::Code.black_on_magenta  { to_s } ; end
+    def black_on_cyan     ; ANSI::Code.black_on_cyan     { to_s } ; end
+    def black_on_white    ; ANSI::Code.black_on_white    { to_s } ; end
+
+    def red_on_black      ; ANSI::Code.red_on_black      { to_s } ; end
+    def red_on_green      ; ANSI::Code.red_on_green      { to_s } ; end
+    def red_on_yellow     ; ANSI::Code.red_on_yellow     { to_s } ; end
+    def red_on_blue       ; ANSI::Code.red_on_blue       { to_s } ; end
+    def red_on_magenta    ; ANSI::Code.red_on_magenta    { to_s } ; end
+    def red_on_cyan       ; ANSI::Code.red_on_cyan       { to_s } ; end
+    def red_on_white      ; ANSI::Code.red_on_white      { to_s } ; end
+
+    def green_on_black    ; ANSI::Code.green_on_black    { to_s } ; end
+    def green_on_red      ; ANSI::Code.green_on_red      { to_s } ; end
+    def green_on_yellow   ; ANSI::Code.green_on_yellow   { to_s } ; end
+    def green_on_blue     ; ANSI::Code.green_on_blue     { to_s } ; end
+    def green_on_magenta  ; ANSI::Code.green_on_magenta  { to_s } ; end
+    def green_on_cyan     ; ANSI::Code.green_on_cyan     { to_s } ; end
+    def green_on_white    ; ANSI::Code.green_on_white    { to_s } ; end
+
+    def yellow_on_black   ; ANSI::Code.yellow_on_black   { to_s } ; end
+    def yellow_on_red     ; ANSI::Code.yellow_on_red     { to_s } ; end
+    def yellow_on_green   ; ANSI::Code.yellow_on_green   { to_s } ; end
+    def yellow_on_blue    ; ANSI::Code.yellow_on_blue    { to_s } ; end
+    def yellow_on_magenta ; ANSI::Code.yellow_on_magenta { to_s } ; end
+    def yellow_on_cyan    ; ANSI::Code.yellow_on_cyan    { to_s } ; end
+    def yellow_on_white   ; ANSI::Code.yellow_on_white   { to_s } ; end
+
+    def blue_on_black     ; ANSI::Code.blue_on_black     { to_s } ; end
+    def blue_on_red       ; ANSI::Code.blue_on_red       { to_s } ; end
+    def blue_on_green     ; ANSI::Code.blue_on_green     { to_s } ; end
+    def blue_on_yellow    ; ANSI::Code.blue_on_yellow    { to_s } ; end
+    def blue_on_magenta   ; ANSI::Code.blue_on_magenta   { to_s } ; end
+    def blue_on_cyan      ; ANSI::Code.blue_on_cyan      { to_s } ; end
+    def blue_on_white     ; ANSI::Code.blue_on_white     { to_s } ; end
+
+    def magenta_on_black  ; ANSI::Code.magenta_on_black  { to_s } ; end
+    def magenta_on_red    ; ANSI::Code.magenta_on_red    { to_s } ; end
+    def magenta_on_green  ; ANSI::Code.magenta_on_green  { to_s } ; end
+    def magenta_on_yellow ; ANSI::Code.magenta_on_yellow { to_s } ; end
+    def magenta_on_blue   ; ANSI::Code.magenta_on_blue   { to_s } ; end
+    def magenta_on_cyan   ; ANSI::Code.magenta_on_cyan   { to_s } ; end
+    def magenta_on_white  ; ANSI::Code.magenta_on_white  { to_s } ; end
+
+    def cyan_on_black     ; ANSI::Code.cyan_on_black     { to_s } ; end
+    def cyan_on_red       ; ANSI::Code.cyan_on_red       { to_s } ; end
+    def cyan_on_green     ; ANSI::Code.cyan_on_green     { to_s } ; end
+    def cyan_on_yellow    ; ANSI::Code.cyan_on_yellow    { to_s } ; end
+    def cyan_on_blue      ; ANSI::Code.cyan_on_blue      { to_s } ; end
+    def cyan_on_magenta   ; ANSI::Code.cyan_on_magenta   { to_s } ; end
+    def cyan_on_white     ; ANSI::Code.cyan_on_white     { to_s } ; end
+
+    def white_on_black    ; ANSI::Code.white_on_black    { to_s } ; end
+    def white_on_red      ; ANSI::Code.white_on_red      { to_s } ; end
+    def white_on_green    ; ANSI::Code.white_on_green    { to_s } ; end
+    def white_on_yellow   ; ANSI::Code.white_on_yellow   { to_s } ; end
+    def white_on_blue     ; ANSI::Code.white_on_blue     { to_s } ; end
+    def white_on_magenta  ; ANSI::Code.white_on_magenta  { to_s } ; end
+    def white_on_cyan     ; ANSI::Code.white_on_cyan     { to_s } ; end
+
+  end
+
+end
+

data/lib/ansi/progressbar.rb

@@ -7,264 +7,272 @@
 
 require 'ansi/code'
 
-# = Progressbar
-#
-# Progressbar is a text-based progressbar library.
-#
-#   pbar = Progressbar.new( "Demo", 100 )
-#   100.times { pbar.inc }
-#   pbar.finish
-#
-class ANSI::Progressbar
-  #
-  def initialize(title, total, out=STDERR)
-    @title = title
-    @total = total
-    @out   = out
+module ANSI
 
-    @bar_length = 80
-    @bar_mark = "o"
-    @total_overflow = true
-    @current = 0
-    @previous = 0
-    @is_finished = false
-    @start_time = Time.now
-    @format = "%-14s %3d%% %s %s"
-    @format_arguments = [:title, :percentage, :bar, :stat]
-    @styles = {}
-    #
-    yield self if block_given?
+  # = Progressbar
+  #
+  # Progressbar is a text-based progressbar library.
+  #
+  #   pbar = Progressbar.new( "Demo", 100 )
+  #   100.times { pbar.inc }
+  #   pbar.finish
+  #
+  class ProgressBar
     #
-    show_progress
-  end
+    def initialize(title, total, out=STDERR)
+      @title = title
+      @total = total
+      @out   = out
 
-  public
+      @bar_length = 80
+      @bar_mark = "o"
+      @total_overflow = true
+      @current = 0
+      @previous = 0
+      @is_finished = false
+      @start_time = Time.now
+      @format = "%-14s %3d%% %s %s"
+      @format_arguments = [:title, :percentage, :bar, :stat]
+      @styles = {}
+      #
+      yield self if block_given?
+      #
+      show_progress
+    end
 
-  attr_accessor :format
-  attr_accessor :format_arguments
-  attr_accessor :styles
+    public
 
-  #
-  def title=(str)
-    @title = str
-  end
-  #
-  def bar_mark=(mark)
-    @bar_mark = String(mark)[0..0]
-  end
+    attr_accessor :format
+    attr_accessor :format_arguments
+    attr_accessor :styles
 
-  def total_overflow=(boolv)
-    @total_overflow = boolv ? true : false
-  end
+    #
+    def title=(str)
+      @title = str
+    end
+    #
+    def bar_mark=(mark)
+      @bar_mark = String(mark)[0..0]
+    end
 
-  # Set format and format arguments.
-  def format(format, *arguments)
-    @format = format
-    @format_arguments = *arguments unless arguments.empty?
-  end
+    def total_overflow=(boolv)
+      @total_overflow = boolv ? true : false
+    end
 
-  # Set ANSI styling options.
-  def style(options)
-    @styles = options
-  end
+    # Set format and format arguments.
+    def format(format, *arguments)
+      @format = format
+      @format_arguments = *arguments unless arguments.empty?
+    end
 
-  #
-  def standard_mode
-    @format = "%-14s %3d%% %s %s"
-    @format_arguments = [:title, :percentage, :bar, :stat]
-  end
+    # Set ANSI styling options.
+    def style(options)
+      @styles = options
+    end
 
-  #
-  def transfer_mode
-    @format = "%-14s %3d%% %s %s"
-    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
-  end
+    #
+    def standard_mode
+      @format = "%-14s %3d%% %s %s"
+      @format_arguments = [:title, :percentage, :bar, :stat]
+    end
 
-  # For backward compatability
-  alias_method :file_transfer_mode, :transfer_mode
+    #
+    def transfer_mode
+      @format = "%-14s %3d%% %s %s"
+      @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
+    end
 
-  def finish
-    @current = @total
-    @is_finished = true
-    show_progress
-  end
+    # For backward compatability
+    alias_method :file_transfer_mode, :transfer_mode
 
-  def flush
-    @out.flush
-  end
+    def finish
+      @current = @total
+      @is_finished = true
+      show_progress
+    end
 
-  def halt
-    @is_finished = true
-    show_progress
-  end
+    def flush
+      @out.flush
+    end
 
-  def set(count)
-    if count < 0
-      raise "invalid count less than zero: #{count}"
-    elsif count > @total
-      if @total_overflow
-        @total = count + 1
-      else
-        raise "invalid count greater than total: #{count}"
+    def halt
+      @is_finished = true
+      show_progress
+    end
+
+    def set(count)
+      if count < 0
+        raise "invalid count less than zero: #{count}"
+      elsif count > @total
+        if @total_overflow
+          @total = count + 1
+        else
+          raise "invalid count greater than total: #{count}"
+        end
       end
+      @current = count
+      show_progress
+      @previous = @current
     end
-    @current = count
-    show_progress
-    @previous = @current
-  end
 
-  #
-  def reset
-    @current = 0
-    @is_finished = false
-  end
+    #
+    def reset
+      @current = 0
+      @is_finished = false
+    end
 
-  def inc(step = 1)
-    @current += step
-    @current = @total if @current > @total
-    show_progress
-    @previous = @current
-  end
+    def inc(step = 1)
+      @current += step
+      @current = @total if @current > @total
+      show_progress
+      @previous = @current
+    end
 
-  def inspect
-    "(ProgressBar: #{@current}/#{@total})"
-  end
+    def inspect
+      "(ProgressBar: #{@current}/#{@total})"
+    end
 
-  private
+    private
 
-  #
-  def convert_bytes(bytes)
-    if bytes < 1024
-      sprintf("%6dB", bytes)
-    elsif bytes < 1024 * 1000 # 1000kb
-      sprintf("%5.1fKB", bytes.to_f / 1024)
-    elsif bytes < 1024 * 1024 * 1000  # 1000mb
-      sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
-    else
-      sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
+    #
+    def convert_bytes(bytes)
+      if bytes < 1024
+        sprintf("%6dB", bytes)
+      elsif bytes < 1024 * 1000 # 1000kb
+        sprintf("%5.1fKB", bytes.to_f / 1024)
+      elsif bytes < 1024 * 1024 * 1000  # 1000mb
+        sprintf("%5.1fMB", bytes.to_f / 1024 / 1024)
+      else
+        sprintf("%5.1fGB", bytes.to_f / 1024 / 1024 / 1024)
+      end
     end
-  end
-  #
-  def transfer_rate
-    bytes_per_second = @current.to_f / (Time.now - @start_time)
-    sprintf("%s/s", convert_bytes(bytes_per_second))
-  end
-  #
-  def bytes
-    convert_bytes(@current)
-  end
-  #
-  def format_time(t)
-    t = t.to_i
-    sec = t % 60
-    min  = (t / 60) % 60
-    hour = t / 3600
-    sprintf("%02d:%02d:%02d", hour, min, sec);
-  end
-  #
-  # ETA stands for Estimated Time of Arrival.
-  def eta
-    if @current == 0
-      "ETA:  --:--:--"
-    else
+    #
+    def transfer_rate
+      bytes_per_second = @current.to_f / (Time.now - @start_time)
+      sprintf("%s/s", convert_bytes(bytes_per_second))
+    end
+    #
+    def bytes
+      convert_bytes(@current)
+    end
+    #
+    def format_time(t)
+      t = t.to_i
+      sec = t % 60
+      min  = (t / 60) % 60
+      hour = t / 3600
+      sprintf("%02d:%02d:%02d", hour, min, sec);
+    end
+    #
+    # ETA stands for Estimated Time of Arrival.
+    def eta
+      if @current == 0
+        "ETA:  --:--:--"
+      else
+        elapsed = Time.now - @start_time
+        eta = elapsed * @total / @current - elapsed;
+        sprintf("ETA:  %s", format_time(eta))
+      end
+    end
+    #
+    def elapsed
       elapsed = Time.now - @start_time
-      eta = elapsed * @total / @current - elapsed;
-      sprintf("ETA:  %s", format_time(eta))
+      sprintf("Time: %s", format_time(elapsed))
     end
-  end
-  #
-  def elapsed
-    elapsed = Time.now - @start_time
-    sprintf("Time: %s", format_time(elapsed))
-  end
-  #
-  def stat
-    if @is_finished then elapsed else eta end
-  end
-  #
-  def stat_for_file_transfer
-    if @is_finished then
-      sprintf("%s %s %s", bytes, transfer_rate, elapsed)
-    else
-      sprintf("%s %s %s", bytes, transfer_rate, eta)
+    #
+    def stat
+      if @is_finished then elapsed else eta end
     end
-  end
-  #
-  def eol
-    if @is_finished then "\n" else "\r" end
-  end
-  #
-  def bar
-    len = percentage * @bar_length / 100
-    sprintf("|%s%s|", @bar_mark * len, " " *  (@bar_length - len))
-  end
-  #
-  def percentage
-    if @total.zero?
-      100
-    else
-      @current  * 100 / @total
+    #
+    def stat_for_file_transfer
+      if @is_finished then
+        sprintf("%s %s %s", bytes, transfer_rate, elapsed)
+      else
+        sprintf("%s %s %s", bytes, transfer_rate, eta)
+      end
     end
-  end
-  #
-  def title
-    @title[0,13] + ":"
-  end
-  #
-  def get_width
-    # FIXME: I don't know how portable it is.
-    default_width = 80
-    begin
-      tiocgwinsz = 0x5413
-      data = [0, 0, 0, 0].pack("SSSS")
-      if @out.ioctl(tiocgwinsz, data) >= 0 then
-        rows, cols, xpixels, ypixels = data.unpack("SSSS")
-        if cols >= 0 then cols else default_width end
+    #
+    def eol
+      if @is_finished then "\n" else "\r" end
+    end
+    #
+    def bar
+      len = percentage * @bar_length / 100
+      sprintf("|%s%s|", @bar_mark * len, " " *  (@bar_length - len))
+    end
+    #
+    def percentage
+      if @total.zero?
+        100
       else
+        @current  * 100 / @total
+      end
+    end
+    #
+    def title
+      @title[0,13] + ":"
+    end
+    #
+    def get_width
+      # FIXME: I don't know how portable it is.
+      default_width = 80
+      begin
+        tiocgwinsz = 0x5413
+        data = [0, 0, 0, 0].pack("SSSS")
+        if @out.ioctl(tiocgwinsz, data) >= 0 then
+          rows, cols, xpixels, ypixels = data.unpack("SSSS")
+          if cols >= 0 then cols else default_width end
+        else
+          default_width
+        end
+      rescue Exception
         default_width
       end
-    rescue Exception
-      default_width
     end
-  end
 
-  #
-  def show
-    arguments = @format_arguments.map do |method|
-      colorize(send(method), styles[method])
-    end
-    line      = sprintf(@format, *arguments)
-    width     = get_width
-    length    = ANSI::Code.uncolored(line).length
-    if length == width - 1
-      @out.print(line + eol)
-    elsif length >= width
-      @bar_length = [@bar_length - (length - width + 1), 0].max
-      @bar_length == 0 ?  @out.print(line + eol) : show
-    else #line.length < width - 1
-      @bar_length += width - length + 1
-      show
+    #
+    def show
+      arguments = @format_arguments.map do |method|
+        colorize(send(method), styles[method])
+      end
+      line      = sprintf(@format, *arguments)
+      width     = get_width
+      length    = ANSI::Code.uncolor{line}.length
+      if length == width - 1
+        @out.print(line + eol)
+      elsif length >= width
+        @bar_length = [@bar_length - (length - width + 1), 0].max
+        @bar_length == 0 ?  @out.print(line + eol) : show
+      else #line.length < width - 1
+        @bar_length += width - length + 1
+        show
+      end
     end
-  end
 
-  #
-  def show_progress
-    if @total.zero?
-      cur_percentage = 100
-      prev_percentage = 0
-    else
-      cur_percentage  = (@current  * 100 / @total).to_i
-      prev_percentage = (@previous * 100 / @total).to_i
+    #
+    def show_progress
+      if @total.zero?
+        cur_percentage = 100
+        prev_percentage = 0
+      else
+        cur_percentage  = (@current  * 100 / @total).to_i
+        prev_percentage = (@previous * 100 / @total).to_i
+      end
+      if cur_percentage > prev_percentage || @is_finished
+        show
+      end
     end
-    if cur_percentage > prev_percentage || @is_finished
-      show
+
+    #
+    def colorize(part, style)
+      return part unless style
+      [style].flatten.inject(part){ |pt, st| ANSI::Code.send(st){pt} }
     end
+
   end
 
   #
-  def colorize(part, style)
-    return part unless style
-    [style].flatten.inject(part){ |pt, st| ANSI::Code.send(st){ pt } }
-  end
+  Progressbar = ProgressBar
 
 end
+