clio 0.0.1 → 0.2.0

data/lib/clio/consoleutils.rb

@@ -1,19 +1,3 @@
-# = Console Utilities
-#
-# ConsoleUtils provides methods that are
-# generally useful in the context of
-# creating console output.
-#
-# = Authors
-#
-# * Thomas Sawyer
-#
-# == Copying
-#
-# Copyright (c) 2006,2007 Thomas Sawyer
-# Ruby/GPL
-
-
 module Clio
 
   # = Termninal

data/lib/clio/facets/kernel.rb

@@ -0,0 +1,13 @@
+module Kernel
+
+  # Anything that can be marshaled can be copied in totality.
+  # This is also commonly called a deep_copy.
+  #
+  #   "ABC".copy  #=> "ABC"
+  #
+  def deep_copy
+    Marshal::load(Marshal::dump(self))
+  end
+
+end
+

data/lib/clio/facets/string.rb

@@ -0,0 +1,25 @@
+class String
+
+  # Indent left or right by n spaces.
+  # (This used to be called #tab and aliased as #indent.)
+
+  def indent(n)
+    if n >= 0
+      gsub(/^/, ' ' * n)
+    else
+      gsub(/^ {0,#{-n}}/, "")
+    end
+  end
+
+  # Preserves relative tabbing.
+  # The first non-empty line ends up with n spaces before nonspace.
+
+  def tabto(n)
+    if self =~ /^( *)\S/
+      indent(n - $1.length)
+    else
+      self
+    end
+  end
+
+end

data/lib/clio/layout.rb

@@ -0,0 +1,14 @@
+require 'clio/consoleutils'
+
+module Clio
+
+  class Layout
+
+    def screen_width
+      @screen_width ||= Terminal.screen_width
+    end
+
+  end
+
+end
+

data/lib/clio/layout/flow.rb

@@ -0,0 +1 @@
+require 'clio/layout'

data/lib/clio/layout/line.rb

@@ -0,0 +1,23 @@
+module Clio
+
+  class Layout
+
+    # Draws a horizonal line.
+    class Line < Layout
+
+      attr :fill
+
+      def initialize(fill='-')
+        @fill = '-'
+      end
+
+      def to_s
+        fill * screen_width
+      end
+
+    end
+
+  end
+
+end
+

data/lib/clio/layout/list.rb

@@ -0,0 +1,33 @@
+require 'clio/layout'
+
+module Clio
+
+  class Layout
+
+    # List of items.
+    class List < Layout
+
+      attr :items
+
+      def initialize(*items)
+        options = Hash===items.last ? items.pop : {}
+
+        @items  = items
+        @mark   = options[:mark]
+      end
+
+      def to_s
+        s = [""]
+        n = (items.size / 10).to_i + 1
+        items.each_with_index do |item, index|
+          s << "%#{n}s. %s" % [index+1, item]
+        end
+        s << ""
+        s.join("\n")
+      end
+
+    end
+
+  end
+
+end

data/lib/clio/layout/split.rb

@@ -0,0 +1,122 @@
+require 'clio/consoleutils'
+require 'clio/layout'
+
+module Clio
+
+  class Layout
+
+    # TODO: name LeftRight instead?
+    class Split < Layout
+
+      PAD   = ''
+      FILL  = ' '
+      RATIO = 0.8
+
+      attr_accessor :left
+
+      attr_accessor :right
+
+      attr_accessor :fill
+
+      attr_accessor :ratio
+
+      attr_accessor :pad
+
+      ###
+      def initialize(left, right, options={})
+        @left    = left
+        @right   = right
+
+        @fill    = FILL
+        @ratio   = RATIO
+        @pad     = PAD
+
+        options.each do |k,v|
+          send("#{k}=",v) if respond_to?("#{k}=")
+        end
+      end
+
+      def print
+        print_justified(@left, @right)
+      end
+
+      def ratio=(value)
+        if value < 0
+          @ratio = 1 + value
+        else
+          @ratio = value
+        end
+      end
+
+      def fill=(letter)
+        case letter
+        when '', nil
+          letter = ' '
+        else
+          letter = letter[0,1]
+        end
+        @fill = letter
+      end
+
+      def to_s
+        print_justified(left, right)
+      end
+
+    private
+
+      # Print a justified line with left and right entries.
+      #
+      # A fill option can be given to fill in any empty space
+      # between the two. And a ratio option can be given which defaults
+      # to 0.8 (eg. 80/20)
+      #
+      def print_justified(left, rite)
+        left_size = left.size
+        rite_size = rite.size
+
+        left = left.to_s
+        rite = rite.to_s
+
+        width = screen_width
+
+        l = (width * ratio).to_i
+        r = width - l
+
+        left = left[0,l]
+        rite = rite[0,r]
+
+        str = fill * width
+
+        str[0,pad.size] = pad
+        str[pad.size,left_size] = left
+        str[-(pad.size+rite_size), rite_size] = rite
+        str[-pad.size, pad.size] = pad
+
+        Kernel.print(str)
+      end
+
+      ###
+      def screen_width
+        @screen_width ||= Terminal.screen_width
+      end
+
+    end
+
+  end
+
+end
+
+
+__END__
+
+### demo ###
+
+require 'clio/string2'
+
+s1 = Clio.string("Left").color(:red)
+s2 = Clio.string("Right").color(:green)
+
+s = (s1 | s2)
+
+s.print
+

data/lib/clio/layout/stack.rb

@@ -0,0 +1,17 @@
+require 'clio/layout'
+
+module Clio
+
+  class Layout
+
+    class Stack < Layout
+
+      def initialize(&block)
+        instance_eval(&block)
+      end
+
+    end
+
+  end
+
+end

data/lib/clio/layout/table.rb

@@ -0,0 +1,46 @@
+require 'clio/layout'
+
+module Clio
+
+  class Layout
+
+    # = Table
+    #
+    # Currently the table layout class is very
+    # simplistic. Ultimately it will support
+    # headers, footers, and a varity of border
+    # options.
+    class Table < Layout
+
+      attr :rows
+
+      def initialize(*rows_of_cells, &block)
+        @rows = rows_of_cells
+      end
+
+      def row(*cells, &block)
+        @rows << cells
+        instance_eval(&block)
+      end
+
+      def cell(acell)
+        (@rows.last ||= []) << acell
+      end
+
+      def to_s
+        #screen_width
+        rows.collect{ |cells|
+          cells.join(' ')
+        }.join("\n")
+      end
+
+      ###
+      #class Row
+      #end
+
+    end
+
+  end
+
+end
+

data/lib/clio/progressbar.rb

@@ -1,253 +1,232 @@
-# = Progressbar
-#
-# ProgressBar is a text-based progressbar library.
-#
-# == Usage
-#
-#   pbar = ProgressBar.new( "Demo", 100 )
-#   100.times { pbar.inc }
-#   pbar.finish
-#
-# == Copying
-#
-# Copyright (C) 2001 Satoru Takabayashi
-#
-# Ruby License
-#
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-# == Author
-#
-# * Satoru Takabayashi
-
-# = ProgressBar
-#
-# ProgressBar is a text-based progressbar library.
-#
-#   pbar = ProgressBar.new( "Demo", 100 )
-#   100.times { pbar.inc }
-#   pbar.finish
-#
-class ProgressBar
-
-  def initialize(title, total, out = STDERR)
-    @title = title
-    @total = total
-    @out = out
-    @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]
-    show_progress
-  end
-
-  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)
+module Clio
+
+  # = Progressbar
+  #
+  # Progressbar is a console-based progress bar library.
+  #
+  # == Usage
+  #
+  #   pbar = ProgressBar.new( "Demo", 100 )
+  #   100.times { pbar.inc }
+  #   pbar.finish
+  #
+  # == Copying
+  #
+  # Based-on the original ProgressBar library by Satoru Takabayashi
+  #
+  # Copyright (C) 2001 Satoru Takabayashi
+  #
+  class Progressbar
+
+    def initialize(title, total, out = STDERR)
+      @title = title
+      @total = total
+      @out = out
+      @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]
+      show_progress
     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
+    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)
+      end
+    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
+    def transfer_rate
+      bytes_per_second = @current.to_f / (Time.now - @start_time)
+      sprintf("%s/s", convert_bytes(bytes_per_second))
+    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))
+    def bytes
+      convert_bytes(@current)
     end
-  end
 
-  def elapsed
-    elapsed = Time.now - @start_time
-    sprintf("Time: %s", format_time(elapsed))
-  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
 
-  def stat
-    if @is_finished then elapsed else eta end
-  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 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 elapsed
+      elapsed = Time.now - @start_time
+      sprintf("Time: %s", format_time(elapsed))
     end
-  end
 
-  def eol
-    if @is_finished then "\n" else "\r" end
-  end
+    def stat
+      if @is_finished then elapsed else eta end
+    end
 
-  def bar
-    len = percentage * @bar_length / 100
-    sprintf("|%s%s|", @bar_mark * len, " " *  (@bar_length - len))
-  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)
+      end
+    end
 
-  def percentage
-    if @total.zero?
-      100
-    else
-      @current  * 100 / @total
+    def eol
+      if @is_finished then "\n" else "\r" end
     end
-  end
 
-  def title
-    @title[0,13] + ":"
-  end
+    def bar
+      len = percentage * @bar_length / 100
+      sprintf("|%s%s|", @bar_mark * len, " " *  (@bar_length - len))
+    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 percentage
+      if @total.zero?
+        100
       else
-        default_width
+        @current  * 100 / @total
       end
-    rescue Exception
-      default_width
     end
-  end
 
-  def show
-    arguments = @format_arguments.map{|method| send(method)}
-    line = sprintf(@format, *arguments)
+    def title
+      @title[0,13] + ":"
+    end
 
-    width = get_width
-    if line.length == width - 1
-      @out.print(line + eol)
-    elsif line.length >= width
-      @bar_length = [@bar_length - (line.length - width + 1), 0].max
-      if @bar_length == 0 then @out.print(line + eol) else show end
-    else #line.length < width - 1
-      @bar_length += width - line.length + 1
-      show
+    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
     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
+      arguments = @format_arguments.map{|method| send(method)}
+      line = sprintf(@format, *arguments)
+
+      width = get_width
+      if line.length == width - 1
+        @out.print(line + eol)
+      elsif line.length >= width
+        @bar_length = [@bar_length - (line.length - width + 1), 0].max
+        if @bar_length == 0 then @out.print(line + eol) else show end
+      else #line.length < width - 1
+        @bar_length += width - line.length + 1
+        show
+      end
     end
 
-    if cur_percentage > prev_percentage || @is_finished
-      show
+    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
-  end
 
-  public
-  def file_transfer_mode
-    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
-  end
+    public
+    def file_transfer_mode
+      @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]
+    end
 
-  def title=(str)
-    @title = str
-  end
+    def title=(str)
+      @title = str
+    end
 
-  def bar_mark=(mark)
-    @bar_mark = String(mark)[0..0]
-  end
+    def bar_mark=(mark)
+      @bar_mark = String(mark)[0..0]
+    end
 
-  def total_overflow=(boolv)
-    @total_overflow = boolv ? true : false
-  end
+    def total_overflow=(boolv)
+      @total_overflow = boolv ? true : false
+    end
 
-  def format=(format)
-    @format = format
-  end
+    def format=(format)
+      @format = format
+    end
 
-  def format_arguments=(arguments)
-    @format_arguments = arguments
-  end
+    def format_arguments=(arguments)
+      @format_arguments = arguments
+    end
 
-  def finish
-    @current = @total
-    @is_finished = true
-    show_progress
-  end
+    def finish
+      @current = @total
+      @is_finished = true
+      show_progress
+    end
 
-  def flush
-    @out.flush
-  end
+    def flush
+      @out.flush
+    end
 
-  def halt
-    @is_finished = true
-    show_progress
-  end
+    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}"
+    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 inc(step = 1)
-    @current += step
-    @current = @total if @current > @total
-    show_progress
-    @previous = @current
-  end
 
-  def inspect
-    "(ProgressBar: #{@current}/#{@total})"
-  end
+    def inc(step = 1)
+      @current += step
+      @current = @total if @current > @total
+      show_progress
+      @previous = @current
+    end
 
-end
+    def inspect
+      "(ProgressBar: #{@current}/#{@total})"
+    end
 
+  end
 
-module Console #:nodoc:
-  # For backward compatibility
-  ProgressBar = ::ProgressBar
 end