facets 2.8.4 → 2.9.0.pre.1

data/lib/more/facets/rbconfig.rb

@@ -1,34 +1,29 @@
-# = Ruby Configuration Extensions
-#
-# An extended rendition of the Ruby's standard Config module.
-#
-# == Authors
-#
-# * Thomas Sawyer
-#
-# == Copying
-#
-# Copyright (c) 2006 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.
-
-require 'rbconfig'
-
-module Config
+require 'facets/platform'
 
+# An extended rendition of the Ruby's standard RbConfig module.
+module RbConfig
+
+  #
   def self.inspect
     CONFIG.inspect
   end
 
+  # Methodized lookup of config.
+  def self.method_missing(s,*a,&b)
+    s = s.to_s
+    if CONFIG.key?(s)
+      CONFIG[s]
+    elsif CONFIG.key?(s.upcase)
+      CONFIG[s.upcase]
+    else
+      super(s,*a,&b)
+    end
+  end
+
+  # TODO: parse configure_args into methods too?
+
   # In case rubygems has already defined it.
-  unless self.respond_to?(:datadir)
+  unless method_defined?(:datadir)
     # Return the path to the data directory associated with the
     # given library/package name. Normally this is just
     #
@@ -42,4 +37,114 @@ module Config
     end
   end
 
+  # Determine byte order of underlying machine.
+  # Examines the byte order of the underlying machine.
+  # Returns <code>:big</code> if Big Endian and
+  # <code>:little</code> if Little Endian.
+  def self.byte_order
+    if [0x12345678].pack("L") == "\x12\x34\x56\x78"
+      :big
+    else
+      :little
+    end
+  end
+
+  def self.byteorder
+    byte_order
+  end
+
+  #
+  def self.little_endian?
+    byte_order == :little
+  end
+
+  #
+  def self.big_endian?
+    byte_order == :big
+  end
+
+  #
+  def self.platform
+    Platform.local
+  end
+
+  #
+  def self.cpu
+    platform.cpu
+  end
+
+  #
+  def self.os
+    platform.os
+  end
+
+  #
+  def self.java?
+    !(/java/.match(RUBY_PLATFORM).nil?)
+  end
+
+  #
+  def self.jruby?
+    !! /jruby/.match(arch)
+  end
+
+  #
+  def self.windows?
+    !! /mswin/.match(arch)
+  end
+
+  #
+  def self.linux?
+    !! /linux/.match(arch)
+  end
+
+=begin
+  # platform
+  def current_platform
+    arch = Config::CONFIG['arch']
+    #cpu, os = arch.split '-', 2
+    return match_platform(arch)
+  end
+
+  #
+  def match_platform(arch)
+    cpu, os = arch.split '-', 2
+    cpu, os = nil, cpu if os.nil? # java
+
+    cpu = case cpu
+          when /i\d86/ then 'x86'
+          else cpu
+          end
+
+    os  = case os
+          when /cygwin/ then            [ 'cygwin',  nil ]
+          when /darwin(\d+)?/ then      [ 'darwin',  $1  ]
+          when /freebsd(\d+)/ then      [ 'freebsd', $1  ]
+          when /^java$/ then            [ 'java',    nil ]
+          when /^java([\d.]*)/ then     [ 'java',    $1  ]
+          when /linux/ then             [ 'linux',   $1  ]
+          when /mingw32/ then           [ 'mingw32', nil ]
+          when /mswin32/ then           [ 'mswin32', nil ]
+          when /openbsd(\d+\.\d+)/ then [ 'openbsd', $1  ]
+          when /solaris(\d+\.\d+)/ then [ 'solaris', $1  ]
+          else                          [ 'unknown', nil ]
+          end
+
+    [cpu, os].flatten.compact.join("-")
+  end
+=end
+
 end
+
+# Current CPU's Byte Order
+BYTE_ORDER = Config.byte_order
+
+# Current CPU
+CPU = Config.platform.cpu
+
+# Current Operating System
+OS  = Config.platform.os
+
+# Current Operating System Version
+OS_VERSION = Config.platform.version
+

data/lib/more/facets/reference.rb

@@ -7,10 +7,10 @@
 #
 #   a = "HELLO"
 #   b = ref(a)
-#   puts b    #=> "HELLO"
+#   b.to_s    #=> "HELLO"
 #   c = 10
 #   b.become(c)
-#   puts b    #=> "10"
+#   b.to_s    #=> "10"
 #
 # == Authors
 #
@@ -36,15 +36,16 @@
 #
 #   a = "HELLO"
 #   b = ref(a)
-#   puts b    #=> "HELLO"
+#   b.to_s    #=> "HELLO"
 #   c = 10
 #   b.become(c)
-#   puts b    #=> "10"
+#   b.to_s    #=> "10"
 #
-class Reference
+# TODO: Use BasicObject for Ruby 1.9.
 
-  # Privatize most Kernel methods.
+class Reference #< BasicObject
 
+  # Privatize most Kernel methods.
   private *instance_methods
 
   def self.new(obj)
@@ -74,26 +75,9 @@ end
 module Kernel
 
   # Shortcut reference constructor.
-
   def ref(x)
     Reference.new(x)
   end
 
 end
 
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-
-=begin #test
-
-  require 'test/unit'
-
-  # TODO
-
-=end

data/lib/more/facets/set.rb

@@ -1,6 +1,8 @@
 require 'set'
 
 class Set
+
+  #
   def power_set
     if empty?
       Set[ self ]
@@ -13,6 +15,8 @@ class Set
 end
 
 class Array
+
+  #
   def power_set
     if empty?
       [self]
@@ -23,5 +27,6 @@ class Array
       subsubs.concat( subsubs.map{ |subset| subset + value } )
     end
   end
+
 end
 

data/lib/more/facets/shellwords.rb

@@ -4,13 +4,31 @@ module Shellwords
 
   module_function
 
-  # Escape special characters used in most
-  # unix shells to use it, eg. with system().
-
-  def escape(cmdline)
+  # Escape special characters used in most unix shells
+  # to use it, eg. with system().
+  #
+  # This differs from Ruby's #escape in that it does not
+  # escape shell variables, e.g. $0.
+  def alt_escape(cmdline)
     cmdline.gsub(/([\\\t\| &`<>)('"])/) { |s| '\\' << s }
   end
 
+  unless method_defined?(:escape)
+    def escape(cmdline)
+      cmdline.gsub(/([\\\t\| &`<>)('"])/) { |s| '\\' << s }
+    end
+  end
+
+  # Escape special character used in DOS-based shells.
+  #
+  # TODO: How to integrate with rest of system?
+  # 1. Use platform condition?
+  # 2. Use separate dos_xxx methods?
+  # 3. Put in separate PowerShellwords module?
+  def dos_escape(cmdline)
+    '"' + cmdline.gsub(/\\(?=\\*\")/, "\\\\\\").gsub(/\"/, "\\\"").gsub(/\\$/, "\\\\\\").gsub("%", "%%") + '"'
+  end
+
 end
 
 class Array

data/lib/more/facets/thread.rb

@@ -1,38 +1,60 @@
 # = Thread Related Extensions
 #
-# Thread extensions, in particular for Enumerable --send
-# a message to each member via a thread and collect the results.
-#
-# == Authors
-#
-# * Sean O'Halpin
-#
-# == Todo
-#
-# * Better names for these methods ?
-#
-# == Copying
-#
-# Copyright (c) 2006 Sean O'Halpin
-#
-# 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.
+# This a small colleciton of thread-related extensions.
 
 require 'thread'
+
+require 'facets/binding/eval'
+require 'facets/kernel/__method__'
+
+# This is the non-threaded form of #threaded_map_send.
 require 'facets/enumerable/map_send'
 
+module Kernel
+
+  $MEMO_MUTEX = Mutex.new
+
+  $MEMO ||= {}
+
+  # Thead-safe instance-level memoization.
+  # 
+  #   class MemoExample
+  #     attr_accessor :a
+  #     def m
+  #       safe_memo{ @a }
+  #     end
+  #   end
+  #
+  #   ex = MemoExample.new
+  #
+  #   ex.a = 10
+  #   ex.m  #=> 10
+  #
+  #   ex.a = 20
+  #   ex.m  #=> 10
+  #
+  def safe_memo(*args, &block)
+    if args.empty?
+      args = block.binding.eval('[self, __method__]')
+    end
+    $MEMO_MUTEX.synchronize do
+      if $MEMO.key?(args)
+        $MEMO[args]
+      else
+        $MEMO[args] = block.call
+      end
+    end
+  end
+
+end
+
+
 module Enumerable
 
   # Like Enumerable#map but each iteration is processed via
   # a separate thread.
   #
-  # CREDIT Sean O'Halpin
+  # CREDIT: Sean O'Halpin
 
   def threaded_map #:yield:
     map{ |e| Thread.new(e){ |t| yield(t) } }.map{ |t| t.value }
@@ -41,7 +63,7 @@ module Enumerable
   # Like Enumerable#map_send but each iteration is processed via
   # a separate thread.
   #
-  # CREDIT Sean O'Halpin
+  # CREDIT: Sean O'Halpin
 
   def threaded_map_send(meth, *args, &block)
     map{ |e| Thread.new(e){ |t| t.send(meth, *args, &block) } }.map{ |t| t.value }
@@ -49,3 +71,4 @@ module Enumerable
 
 end
 
+# Copyright (c) 2006 Sean O'Halpin, Thomas Sawyer

data/lib/more/facets/timer.rb

@@ -1,9 +1,9 @@
+require 'timeout'  # for TimeoutError
+
 # = Timer
 #
 # Provides a strightforward means for controlling time critical execution.
-# Can be used as a "stop watch" timer or as a "time bomb" timer.
-#
-# == Usage
+# Can be used as a "stop watch" timer or as a "time bomb" timer:
 #
 #   t = Timer.new(10) { raise TimeoutError, "timeout!" }
 #   t.start
@@ -15,99 +15,34 @@
 #     t.reset       #--> restart timer
 #   end
 #
-# A Kernel method is also provided for easily timing the exectuion of a block.
-#
-#   timed { |timer|
-#
-#      timer.total_time.round #=> 0
+# A class method is also provided for easily timing the exectuion of a block.
 #
-#      sleep 1
-#      timer.total_time.round #=> 1
+#   Timer.time do |timer|
+#    timer.total_time.round  #=> 0
 #
-#      timer.stop
-#      timer.total_time.round #=> 1
+#    sleep 1
+#    timer.total_time.round  #=> 1
 #
-#      sleep 2
-#      timer.total_time.round #=> 1
+#    timer.stop
+#    timer.total_time.round  #=> 1
 #
-#      timer.start
-#      timer.total_time.round #=> 1
+#    sleep 1
+#    timer.total_time.round  #=> 1
 #
-#      sleep 1
-#      timer.total_time.round #=> 2
+#    timer.start
+#    timer.total_time.round  #=> 1
 #
-#   }
-#
-# == HISTORY
+#    sleep 1
+#    timer.total_time.round  #=> 2
+#   end
 #
 # Thanks to Paul Brannan for TimeLimit and Minero Aoki for Timer.
 # These two libraries served as models for building this class.
-#
-# == AUTHORS
-#
-# * Thomas Sawyer
-# * Minero Aoki
-# * Paul Brannan
-#
-# == COPYRIGHT
-#
-#   Copyright (c) 2004 Thomas Sawyer
-#
-# == LICENSE
-#
-#   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.
-
-require 'timeout'  # for TimeoutError
-
-# = Timer
-#
-# Provides a strightforward means for controlling time critical execution.
-# Can be used as a "stop watch" timer or as a "time bomb" timer.
-#
-#   t = Timer.new(10) { raise TimeoutError, "timeout!" }
-#   t.start
-#     :      # done within 10sec timeout
-#   t.stop
-#   t.start
-#     :
-#   if condition then
-#     t.reset       #--> restart timer
-#   end
-#
-# A Kernel method is also provided for easily timing the exectuion of a block.
-#
-#   timed { |timer|
-#      timer.total_time.round #=> 0
-#
-#      sleep 1
-#      timer.total_time.round #=> 1
-#
-#      timer.stop
-#      timer.total_time.round #=> 1
-#
-#      sleep 2
-#      timer.total_time.round #=> 1
-#
-#      timer.start
-#      timer.total_time.round #=> 1
-#
-#      sleep 1
-#      timer.total_time.round #=> 2
-#   }
 
 class Timer
 
-  attr_reader :start_time, :end_time
-  attr_accessor :time_limit
-
-  def initialize( time_limit=nil, &block )
+  #
+  def initialize(time_limit=nil, &block)
     # standard timer
     @start_time = nil
     @end_time = nil
@@ -120,6 +55,20 @@ class Timer
     @timer_thread = nil
   end
 
+  #
+  attr_accessor :time_limit
+
+  #
+  def start_time
+    @start_time
+  end
+
+  #
+  def end_time
+    @end_time
+  end
+
+  #
   def on_timeout( &block )
     if block then
       @on_timeout = block
@@ -130,7 +79,6 @@ class Timer
   end
 
   # Start the timer.
-
   def start
     @running = true
     @start_time = Time.now
@@ -139,19 +87,18 @@ class Timer
 
     self
 
-    #if block_given? then
-    #  begin
-    #    yield( self )
-    #  ensure
-    #    stop
-    #  end
-    #else
-    #  @time_limit
-    #end
+    ##if block_given? then
+    ##  begin
+    ##    yield( self )
+    ##  ensure
+    ##    stop
+    ##  end
+    ##else
+    ##  @time_limit
+    ##end
   end
 
   # Establish a time limit on execution.
-
   def limit( time_limit=nil )
     if @time_limit || time_limit
       @current_thread = Thread.current
@@ -167,7 +114,6 @@ class Timer
   end
 
   # Kill time limit thread, if any.
-
   def defuse
     if @timer_thread
       Thread.kill @timer_thread
@@ -177,7 +123,6 @@ class Timer
 
   # Stops timer and returns total time.
   # If timer was not running returns false.
-
   def stop
     if @running
       defuse
@@ -192,7 +137,6 @@ class Timer
 
   # Stops and resets the timer. If the timer was running
   # returns the total time. If not returns 0.
-
   def reset
     if running?
       r = stop
@@ -208,7 +152,6 @@ class Timer
   #   t.stop
   #   t.start
   #
-
   def reset_limit
     #stop
     #start
@@ -217,19 +160,16 @@ class Timer
   end
 
   # Queries whether the timer is still running.
-
   def running?
     return @running
   end
 
   # Queries whether the timer is still not running.
-
   def stopped?
     return !@running
   end
 
   # Queries total recorded time of timer.
-
   def total_time
     if running? then
       return @total_time + (Time.now - @start_time)
@@ -238,12 +178,16 @@ class Timer
     end
   end
 
-  #
+  # Takes a block and returns the total time it took to execute.
+  def self.time
+    yield( timer = Timer.new.start )
+    return timer.total_time
+  end
+
   # Timer::Dummy - Dummy Timer (i.e. no real time limit)
   #--
-  # NEEDS WORK!
+  # TODO: Timer::Dummy needs some work.
   #++
-
   class Dummy < self
     def start
       if block_given? then
@@ -260,15 +204,4 @@ class Timer
 
 end #class Timer
 
-
-module Kernel
-
-  # Takes a block and returns the total time it took to execute.
-
-  def timed
-    yield( timer = Timer.new.start )
-    return timer.total_time
-  end
-
-end
-
+# Copyright (c) 2004 Thomas Sawyer (Ruby License)