facets 2.8.4 → 2.9.0.pre.1

data/lib/more/facets/atomicfile.rb

@@ -0,0 +1,51 @@
+require 'thread'    unless defined?(Thread)
+require 'tempfile'  unless defined?(Tempfile)
+require 'fileutils' unless defined?(FileUtils)
+
+# This is a precursor to the possibility of a more extensive Atomic File I/O
+# system. For now it simply provides a means for atomic file writing.
+class AtomicFile < File
+
+  # Write to a file atomically. Useful for situations where you don't
+  # want other processes or threads to see half-written files.
+  #
+  #   AtomicFile.write("tmp/important.file") do |file|
+  #     file.write("hello")
+  #   end
+  #
+  # If your temporary directory is not on the same filesystem as the file you're
+  # trying to write, you can provide a different temporary directory.
+  #
+  #   AtomicFile.write("tmp/something.important", "tmp") do |file|
+  #     file.write("hello")
+  #   end
+  #
+  def self.write(file_name, temp_dir=nil)
+
+    temp_dir  = temp_dir || Dir.tmpdir
+    temp_file = Tempfile.new(basename(file_name), temp_dir)
+
+    yield temp_file
+    temp_file.close
+
+    begin
+      ## Get original file permissions
+      old_stat = stat(file_name)
+    rescue Errno::ENOENT
+      ## No old permissions, write a temp file to determine the defaults
+      check_name = join(dirname(file_name), ".permissions_check.#{Thread.current.object_id}.#{Process.pid}.#{rand(1000000)}")
+      open(check_name, "w") { }
+      old_stat = stat(check_name)
+      unlink(check_name)
+    end
+
+    ## Overwrite original file with temp file
+    FileUtils.mv(temp_file.path, file_name)
+
+    ## Set correct permissions on new file
+    chown(old_stat.uid, old_stat.gid, file_name)
+    chmod(old_stat.mode, file_name)
+  end
+
+end
+

data/lib/more/facets/basicobject.rb

@@ -7,7 +7,7 @@
 # Since Ruby 1.9 has a BasicObject class this will of course be
 # deprecated as 1.9 goes mainstream.
 
-unless defined? BasicObject  # just in case it already exists!
+unless defined? BasicObject  # in case it already exists!
 
   # BasicObject provides an abstract base class with no predefined
   # methods (except for <tt>\_\_send__</tt> and <tt>\_\_id__</tt>).
@@ -36,7 +36,7 @@ unless defined? BasicObject  # just in case it already exists!
           name !~ /^(__|respond_to\?|instance_eval$|instance_exec$|equal\?$|\=\=$)/
       end
     end
-    instance_methods.each { |m| hide(m) }
+    instance_methods.each{ |m| hide(m) }
   end
 
   # Since Ruby is very dynamic, methods added to the ancestors of
@@ -45,12 +45,12 @@ unless defined? BasicObject  # just in case it already exists!
   # hook in the Object and Kernel classes that will hide any defined
   module Kernel #:nodoc:
     class << self
-      alias_method :blank_slate_method_added, :method_added
+      alias_method :facets_basic_object_method_added, :method_added
 
       # Detect method additions to Kernel and remove them in the
       # BlankSlate class.
       def method_added(name)
-        blank_slate_method_added(name)
+        facets_basic_object_method_added(name)
         return if self != Kernel
         BasicObject.hide(name)
       end
@@ -59,12 +59,12 @@ unless defined? BasicObject  # just in case it already exists!
 
   class Object #:nodoc:
     class << self
-      alias_method :blank_slate_method_added, :method_added
+      alias_method :facets_basic_object_method_added, :method_added
 
       # Detect method additions to Object and remove them in the
       # BlankSlate class.
       def method_added(name)
-        blank_slate_method_added(name)
+        facets_basic_object_method_added(name)
         return if self != Object
         BasicObject.hide(name)
       end

data/lib/more/facets/cgi.rb

@@ -1,12 +1,5 @@
-# Title:: CGI Extensions
-# Authors:: Trans
-# Copying:: (c)2005 Trans
-# License:: Ruby Licens
-
 require 'cgi'
 
-# = CGI Extensions
-
 class CGI
 
   # Create an hidden input field through which an object can can be marshalled.
@@ -24,9 +17,9 @@ class CGI
     end
   end
 
-  # RENAME!!!!
+  # TODO: Rename CGI#esc ?
 
-  # Are these two good enough to replace CGI.escape?
+  # TODO: Are these two good enough to replace CGI.escape?
 
   # Return an html "safe" version of the string,
   # where every &, < and > are replaced with appropriate entities.
@@ -48,3 +41,4 @@ class CGI
 
 end
 
+# Copyright (c) 2005 Thomas Sawyer (Ruby License)

data/lib/more/facets/continuation.rb

@@ -17,14 +17,14 @@ if defined?(Continuation)
   #
   #   # Count from 0 to 10
   #   cc, counter = Continuation.create(0)
-  #   puts counter
+  #   counter   #~> 0..10
   #   cc.call(counter + 1) if counter < 10
   #
   #   # Implement something similar to Array#inject using Continuations.
   #   # For simplicity's sake, this is not fully compatible with the real
   #   # inject. Make sure that you understand Array#inject before you try
   #   # to understand this.
-  #   class Array
+  #   class ::Array
   #     def cc_inject(value = nil)
   #       copy = self.clone
   #       cc, result, item = Continuation.create(value, nil)

data/lib/more/facets/date.rb

@@ -53,10 +53,9 @@ class Date
   # Converts a Date instance to a DateTime, where the time is set to the beginning of the day
   # and UTC offset is set to 0.
   #
-  # ==== Example:
-  #   date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007
+  #   date = Date.new(2007, 11, 10)  # Sat, 10 Nov 2007
+  #   date.to_datetime               # Sat, 10 Nov 2007 00:00:00 0000
   #
-  #   date.to_datetime               # => Sat, 10 Nov 2007 00:00:00 0000
   def to_datetime
     ::DateTime.civil(year, month, day, 0, 0, 0, 0)
   end unless method_defined?(:to_datetime) # 1.9+ ?
@@ -64,16 +63,16 @@ class Date
   # Converts a Date instance to a Time, where the time is set to the beginning of the day.
   # The timezone can be either :local or :utc (default :local).
   #
-  #   date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007
+  #   date = Date.new(2007, 11, 10)  # Sat, 10 Nov 2007
   #
-  #   date.to_time                   # => Sat Nov 10 00:00:00 0800 2007
-  #   date.to_time(:local)           # => Sat Nov 10 00:00:00 0800 2007
+  #   date.to_time                   # Sat Nov 10 00:00:00 0800 2007
+  #   date.to_time(:local)           # Sat Nov 10 00:00:00 0800 2007
   #
-  #   date.to_time(:utc)             # => Sat Nov 10 00:00:00 UTC 2007
+  #   date.to_time(:utc)             # Sat Nov 10 00:00:00 UTC 2007
   #
   def to_time(form=:local)
     ::Time.send(form, year, month, day)
-    #::Time.send("#{form}_time", year, month, day)
+    ##::Time.send("#{form}_time", year, month, day)
   end
 
   #
@@ -83,10 +82,9 @@ class Date
 
   # Returns the number of days in the date's month.
   #
-  #   Date.new(2004,2).days_in_month #=> 28
+  #   Date.new(2004,2).days_in_month  #=> 29
   #
   # CREDIT: Ken Kunz.
-
   def days_in_month
      Date.civil(year, month, -1).day
   end
@@ -98,7 +96,6 @@ class Date
   # Get the month name for this date object
   #
   # CREDIT: Benjamin Oakes
-
   def month_name
     MONTHNAMES[self.month]
   end
@@ -107,13 +104,12 @@ class Date
   #
   # This method is aliased to <tt>to_s</tt>.
   #
-  # ==== Examples:
-  #   date = Date.new(2007, 11, 10)       # => Sat, 10 Nov 2007
+  #   date = Date.new(2007, 11, 10)   # Sat, 10 Nov 2007
   #
-  #   date.stamp(:db)            # => "2007-11-10"
-  #   date.stamp(:short)         # => "10 Nov"
-  #   date.stamp(:long)          # => "November 10, 2007"
-  #   date.stamp(:rfc822)        # => "10 Nov 2007"
+  #   date.stamp(:db)                 # => "2007-11-10"
+  #   date.stamp(:short)              # => "10 Nov"
+  #   date.stamp(:long)               # => "November 10, 2007"
+  #   date.stamp(:rfc822)             # => "10 Nov 2007"
   #
   # == Adding your own formats to stamp
   # You can add your own formats to the Date::FORMAT hash.
@@ -130,13 +126,14 @@ class Date
     end
   end
 
-  # Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005"
-  #def inspect
-  #  strftime("%a, %d %b %Y")
-  #end
+  ## Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005"
+  ##def inspect
+  ##  strftime("%a, %d %b %Y")
+  ##end
 
-  # Provides precise Date calculations for years, months, and days.  The +options+ parameter takes a hash with 
-  # any of these keys: <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
+  # Provides precise Date calculations for years, months, and days.
+  # The +options+ parameter takes a hash with  any of these keys:
+  # <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
   def advance(options)
     d = self
     d = d >> options.delete(:years) * 12 if options[:years]
@@ -146,12 +143,12 @@ class Date
     d
   end
 
-  # Returns a new Date where one or more of the elements have been changed according to the +options+ parameter.
+  # Returns a new Date where one or more of the elements have been changed
+  # according to the +options+ parameter.
   #
-  # Examples:
+  #   Date.new(2007, 5, 12).change(:day=>1)                 # Date.new(2007, 5, 1)
+  #   Date.new(2007, 5, 12).change(:year=>2005, :month=>1)  # Date.new(2005, 1, 12)
   #
-  #   Date.new(2007, 5, 12).change(:day => 1)                  # => Date.new(2007, 5, 1)
-  #   Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)
   def change(options)
     ::Date.new(
       options[:year]  || self.year,
@@ -160,31 +157,36 @@ class Date
     )
   end
 
-  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
-  # and then subtracts the specified number of seconds
+  # Converts Date to a Time (or DateTime if necessary) with the time portion
+  # set to the beginning of the day (0:00) and then subtracts the specified
+  # number of seconds
   def ago(seconds)
     to_time.since(-seconds)
   end
 
-  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
-  # and then adds the specified number of seconds
+  # Converts Date to a Time (or DateTime if necessary) with the time portion
+  # set to the beginning of the day (0:00) and then adds the specified number
+  # of seconds.
   def since(seconds)
     to_time.since(seconds)
   end
   alias :in :since
 
-  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+  # Converts Date to a Time (or DateTime if necessary) with the time portion
+  # set to the beginning of the day (0:00).
   def beginning_of_day
     to_time
   end
   alias :midnight :beginning_of_day
 
-  # Convenience method which returns a new Date/DateTime representing the time 1 day ago
+  # Convenience method which returns a new Date/DateTime representing the
+  # time 1 day ago.
   def yesterday
     self - 1
   end
 
-  # Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time
+  # Convenience method which returns a new Date/DateTime representing
+  # the time 1 day since the instance time.
   def tomorrow
     self + 1
   end
@@ -229,8 +231,7 @@ class DateTime
   # 
   # This method is aliased to <tt>to_s</tt>.
   # 
-  # === Examples:
-  #   datetime = DateTime.civil(2007, 12, 4, 0, 0, 0, 0)   # => Tue, 04 Dec 2007 00:00:00 +0000
+  #   datetime = DateTime.civil(2007,12,4,0,0,0,0)   # Tue, 04 Dec 2007 00:00:00 +0000
   # 
   #   datetime.stamp(:db)            # => "2007-12-04 00:00:00"
   #   datetime.stamp(:db)            # => "2007-12-04 00:00:00"
@@ -240,6 +241,7 @@ class DateTime
   #   datetime.stamp(:rfc822)        # => "Tue, 04 Dec 2007 00:00:00 +0000"
   #
   # == Adding your own datetime formats to stamp
+  #
   # DateTime formats are shared with Time. You can add your own to the
   # Time::FORMAT hash. Use the format name as the hash key and
   # a strftime string as the value. Eg.
@@ -316,8 +318,8 @@ class DateTime
   #
   # Example:
   #
-  #   DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))       # => Mon, 21 Feb 2005 10:11:12 -0600
-  #   DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc   # => Mon, 21 Feb 2005 16:11:12 +0000
+  #   DateTime.civil(2005,2,21,10,11,12,Rational(-6, 24))      # Mon, 21 Feb 2005 10:11:12 -0600
+  #   DateTime.civil(2005,2,21,10,11,12,Rational(-6, 24)).utc  # Mon, 21 Feb 2005 16:11:12 +0000
   #
   def utc
     new_offset(0)
@@ -373,33 +375,33 @@ class Time
 
   # Converts a Time object to a Date, dropping hour, minute, and second precision.
   #
-  #   my_time = Time.now  # => Mon Nov 12 22:59:51 -0500 2007
-  #   my_time.to_date     # => Mon, 12 Nov 2007
+  #   my_time = Time.now  # Mon Nov 12 22:59:51 -0500 2007
+  #   my_time.to_date     # Mon, 12 Nov 2007
   #
-  #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
-  #   your_time.to_date                                 # => Tue, 13 Jan 2009
+  #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # Tue Jan 13 13:13:03 -0500 2009
+  #   your_time.to_date                                 # Tue, 13 Jan 2009
   #
   def to_date
     ::Date.new(year, month, day)
   end
 
-  #  # Convert a Time to a Date. Time is a superset of Date.
-  #  # It is the year, month and day that are carried over.
-  #
-  #  def to_date
-  #    require 'date' # just in case
-  #    jd = Date.__send__(:civil_to_jd, year, mon, mday, Date::ITALY)
-  #    Date.new!(Date.__send__(:jd_to_ajd, jd, 0, 0), 0, Date::ITALY)
-  #  end
+  ##  # Convert a Time to a Date. Time is a superset of Date.
+  ##  # It is the year, month and day that are carried over.
+  ##
+  ##  def to_date
+  ##    require 'date' # just in case
+  ##    jd = Date.__send__(:civil_to_jd, year, mon, mday, Date::ITALY)
+  ##    Date.new!(Date.__send__(:jd_to_ajd, jd, 0, 0), 0, Date::ITALY)
+  ##  end
 
 
   # Converts a Time instance to a Ruby DateTime instance, preserving UTC offset.
   #
-  #   my_time = Time.now    # => Mon Nov 12 23:04:21 -0500 2007
-  #   my_time.to_datetime   # => Mon, 12 Nov 2007 23:04:21 -0500
+  #   my_time = Time.now    # Mon Nov 12 23:04:21 -0500 2007
+  #   my_time.to_datetime   # Mon, 12 Nov 2007 23:04:21 -0500
   #
-  #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
-  #   your_time.to_datetime                             # => Tue, 13 Jan 2009 13:13:03 -0500
+  #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # Tue Jan 13 13:13:03 -0500 2009
+  #   your_time.to_datetime                             # Tue, 13 Jan 2009 13:13:03 -0500
   #
   def to_datetime
     ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400))

data/lib/more/facets/erb.rb

@@ -5,6 +5,8 @@ require 'erb'
 # The Erb OpenTemplate provides a quick and convenient way to
 # create a clean rendering space with the desired responses.
 #
+# Ruby 1.8.6 or less can't handle object scope methods with blocks.
+#
 # TODO: This might make a good addon library. Just add 
 # require 'erb' to the erb_result method? Call it OpenResponse?
 #
@@ -12,7 +14,7 @@ class ERB::OpenTemplate
 
   # TODO: Should we do this? Perhaps offer it as an option?
   instance_methods.each do |m|
-    undef_method(m) unless /^(__|instance_|inspect$|extend$)/ =~ m.to_s
+    undef_method(m) unless /^(__|instance_|inspect$|extend$|object_id$)/ =~ m.to_s
   end
 
   #
@@ -26,7 +28,8 @@ class ERB::OpenTemplate
       mod = Module.new
       obj.public_methods.each do |m|
         mod.module_eval do
-          define_method(m){ |*a,&b| obj.__send__(m,*a,&b) }
+          #define_method(m){ |*a,&b| obj.__send__(m,*a,&b) }
+          define_method(m, &obj.method(m).to_proc)
         end
       end
       mods << mod
@@ -48,16 +51,16 @@ class ERB::OpenTemplate
     ERB.new(str).result(binding)
   end
 
-  #
-  #def method_missing(sym, *args, &block)
-  #  #if @ioc.key?(sym)
-  #  #  @ioc[sym]
-  #  if obj = @objs.find{ |o| o.respond_to?(sym) }
-  #    obj.__send__(sym, *args, &block)
-  #  else
-  #    super
-  #  end
-  #end
+  ##
+  ##def method_missing(sym, *args, &block)
+  ##  #if @ioc.key?(sym)
+  ##  #  @ioc[sym]
+  ##  if obj = @objs.find{ |o| o.respond_to?(sym) }
+  ##    obj.__send__(sym, *args, &block)
+  ##  else
+  ##    super
+  ##  end
+  ##end
 
 end
 

data/lib/more/facets/fileutils.rb

@@ -1,22 +1,4 @@
-# = FileUtils Extensions
-#
-# General extensions for FileUtils.
-#
-# == Authors
-#
-# * Thomas Sawyer
-# * Jim Weirich
-# * Daniel Burger
-#
-# == Todo
-#
-# * Deprecate #safe_ln, if #ln has been fixed to do this.
-#
-# == Copying
-#
-#   Copyright (C) 2005 Thomas Saywer
-#
-#   Ruby License
+# TODO: Deprecate #safe_ln, if #ln has been fixed to do this.
 
 require 'fileutils'
 require 'facets/fileutils/safe_ln'
@@ -24,4 +6,3 @@ require 'facets/fileutils/slice'    # includes head and tail
 require 'facets/fileutils/wc'
 require 'facets/fileutils/whereis'
 require 'facets/fileutils/which'
-