facets 1.1.0 → 1.2.0

data/lib/facets/more/pathlist.rb

@@ -0,0 +1,105 @@
+#--
+# PathList
+#
+# Copyright (c) 2004,2005 Thomas Sawyer
+#
+# 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.
+#
+# ==========================================================================
+#  Revision History
+# ==========================================================================
+#
+# * Empty
+#
+# ==========================================================================
+#++
+
+#:title: PathList
+#
+# A Path is an array containing 1..n paths. It is useful to regroup paths and
+# make lookups on them.
+#
+# == Usage
+#
+#  path = PathList.new(ENV['PATH'])
+#  path.find 'env'            #=> "/usr/bin/env"
+#
+#  # This is already done when including the library
+#  $:.class                   #=> Array
+#  $:.extend PathList::Finder
+#  $:.find_ext = 'rb'
+#
+#  $:.find 'uri'              #=> "/usr/lib/ruby/1.8/uri.rb"
+#
+# == Author(s)
+#
+# * Jonas Pfenniger
+#
+
+class PathList < Array
+
+  def initialize(paths, default_ext = nil)
+    @find_ext = default_ext
+    if paths.kind_of? String
+      paths = paths.split(File::PATH_SEPARATOR)
+    end
+    super(paths)
+  end
+
+  def to_s
+    join(File::PATH_SEPARATOR)
+  end
+
+  module Finder
+
+    attr_accessor :find_ext
+
+    def find(filename, use_ext=true)
+      filename += '.' + @find_ext if @find_ext and use_ext
+      to_a.each do |path|
+        filepath = File.join(path, filename)
+        return filepath if File.exist?( filepath )
+      end
+      return nil
+    end
+    alias :include? find
+
+  end
+  include Finder
+end
+
+$:.extend PathList::Finder
+$:.find_ext = 'rb'
+
+# Doesn't work
+#ENV['PATH'] = PathList.new(ENV['PATH'])
+
+#++
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin #testing
+
+  require 'test/unit'
+
+  # It is not possible to test file lookups in a platform independent manner
+
+
+  class TC_PathList < Test::Unit::TestCase
+
+  end
+
+=end
+

data/lib/facets/more/pool.rb

@@ -0,0 +1,98 @@
+#--
+# Pool
+#
+# Copyright (c) 2004-2005 Navel, all rights reserved.
+#
+# 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.
+#
+# ==========================================================================
+# Revision History ::
+# --------------------------------------------------------------------------
+#  05.04.11  Trans   * Ported.
+# ==========================================================================
+#
+# INVESTIGATE Could use the SizedQueue/Queue.
+#
+#++
+
+#:title: Pool
+#
+# Generalized object pool implementation. Implemented as a thread 
+# safe stack. Exclusive locking is needed both for push and pop. 
+#
+# == Usage
+#
+#   TODO
+#
+# == Author(s)
+#
+# * George Moschovitis  <gm@navel.gr>
+#
+
+require 'thread'
+require 'monitor'
+
+class Pool < Array
+
+  include MonitorMixin
+
+  def initialize
+    super
+    @cv = new_cond()
+  end
+
+  # Add, restore an object to the pool.
+
+  def push(obj)
+    synchronize do
+      super
+      @cv.signal()
+    end
+  end
+
+  # Obtain an object from the pool.
+
+  def pop
+    synchronize do
+      @cv.wait_while { empty? }
+      super
+    end
+  end
+
+  # Obtains an object, passes it to a block for processing
+  # and restores it to the pool.
+
+  def obtain
+    result = nil
+    begin
+      obj = pop()
+      result = yield(obj)
+    ensure
+      push(obj)
+    end
+    return result
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+# TODO
+
+=begin #testing
+
+=end

data/lib/facets/more/preinitialize.rb

@@ -0,0 +1,152 @@
+#--
+# Preinitialize
+#
+# Copyright (c) 2005 Thomas Sawyer
+#
+# 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.
+#
+#
+# ==========================================================================
+# Revision History ::
+# --------------------------------------------------------------------------
+#  05.10.29  trans   Deprecated default_instance_variables.
+#  05.08.28  trans   Moved default_instance_variables to Module.
+#  05.08.26  trans   Created.
+# ==========================================================================
+#++
+
+require 'facet/kernel/__class__'
+
+#:title: Preinitialize
+#
+# This is an object preinitialize system, which provides
+# an elegant way to initialize an object allowing the
+# class to provide additional default structure to an
+# object prior to calling initialize.
+#
+# In effect it does two things after allocating the object
+# but prior to initializing it.
+#
+# First, it calls the class method #default_instance_variables,
+# which returns a hash and by default returns the hash
+# stored in @default_instance_variables. It uses this to
+# pre-define instance variables.
+#
+# Then it goes to the top of the class hierarchy  and works
+# it's way down calling #preinitialize if defined.
+# WARNING! It is rather useless to use <tt>super</tt>
+# inside the any preinitialize hook.
+#
+#   module M
+#     def preinitialize
+#       @a = 23
+#     end
+#   end
+#
+#   class X
+#     include M
+#     def a ; @a ; end
+#   end
+#
+#   x = X.new
+#   x.a         #=> 23
+#
+# If neded the original new method has been aliased, albeit
+# <tt>postinitialize_new</tt> is probably a bit of a misnomer.
+
+# class Module
+#
+#   def default_instance_variables(complete=false)
+#     @default_instance_variables ||= {}
+#     unless complete
+#       return @default_instance_variables
+#     else
+#       parent = ancestors[1]
+#       if parent
+#         return @default_instance_variables.merge(parent.default_instance_variables)
+#       else
+#         return @default_instance_variables
+#       end
+#     end
+#   end
+#
+# end
+
+class Class
+  alias_method :postinitialize_new, :new
+
+  def new(*args, &blk)
+    o = allocate
+
+    #if respond_to?(:default_instance_variables)
+    #  default_instance_variables.each{|k,v| o.instance_variable_set( "@#{k.to_s.gsub(/\W$/,'')}",v )}
+    #end
+
+    a = ancestors
+    until a.empty?
+      m = a.pop
+      #if m.private_instance_methods.include?('preinitialize') or m.public_instance_methods.include?('preinitialize')
+      if m.method_defined?('preinitialize') or m.private_method_defined?('preinitialize')
+        im = instance_method('preinitialize')
+        im.arity == 0 ? im.bind(o).call : im.bind(o).call(*args, &blk)
+      end
+    end
+
+    o.__send__(:initialize, *args, &blk) if o.__class__.private_method_defined?(:initialize)
+
+    o
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+
+=begin test
+
+  require 'test/unit'
+
+  class TC_Preinitalize < Test::Unit::TestCase
+
+    module M
+      def preinitialize
+        @a = 10
+      end
+    end
+
+    class X
+      include M
+      def a ; @a ; end
+    end
+
+    class Y < X
+      def initialize
+        super
+      end
+    end
+
+    def test_01
+      x = X.new
+      assert_equal( 10, x.a )
+    end
+
+    def test_01
+      y = Y.new
+      assert_equal( 10, y.a )
+    end
+
+  end
+
+=end

data/lib/facets/more/progressbar.rb

@@ -0,0 +1,227 @@
+#--
+# Console::ProgressBar
+#
+# Copyright (C) 2001-2003 Satoru Takabayashi
+# All rights reserved.
+#
+# This is free software with ABSOLUTELY NO WARRANTY.
+#
+# You can redistribute it and/or modify it under the terms
+# of Ruby's licence.
+#++
+
+# :title: Console Progress Bar
+#
+# Console::ProgressBar is a terminal-based progress bar library.
+#
+# == Author(s)
+#
+# * Satoru Takabayashi
+# * Thomas Sawyer
+#
+
+module Console ; end
+
+class Console::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)
+    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
+      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
+    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)
+    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
+    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
+  end
+
+  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
+
+  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
+
+  public
+  def file_transfer_mode
+    @format_arguments = [:title, :percentage, :bar, :stat_for_file_transfer]  
+  end
+
+  def bar_mark= (mark)
+    @bar_mark = String(mark)[0..0]
+  end
+
+  def total_overflow= (boolv)
+    @total_overflow = boolv ? true : false
+  end
+
+  def format= (format)
+    @format = format
+  end
+
+  def format_arguments= (arguments)
+    @format_arguments = arguments
+  end
+
+  def finish
+    @current = @total
+    @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}"
+      end
+    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
+
+end