facets 2.8.4 → 2.9.0.pre.1

data/lib/more/facets/fileutils/cp_rx.rb

@@ -2,7 +2,7 @@ module FileUtils
 
   # Both of these are modified from the implementations in fileutils.rb from Ruby 1.9.1p378.
 
-  # Like FileUtils.cp_r, but takes a filter proc that can return false to skip a file.
+  # Like FileUtils.cp_r, but takes a filter proc that can return false to skip a file:
   #
   #   cp_rx "bigDirectoryTree", "dest", {:noop => true} do |name|
 	#     /dontCopyThis$/.match(name)

data/lib/more/facets/fileutils/safe_ln.rb

@@ -9,8 +9,7 @@ module FileUtils
   # Attempt to do a normal file link, but fall back
   # to a copy if the link fails.
   #
-  # CREDIT Jim Weirich
-
+  # CREDIT: Jim Weirich
   def safe_ln(*args)
     unless LINKING_SUPPORTED[0]
       cp(*args)

data/lib/more/facets/fileutils/slice.rb

@@ -2,13 +2,13 @@ require 'fileutils'
 
 module FileUtils
 
-  # In block form, yields the first number of ((*lines*)) of file ((*filename*)).
-  # In non-block form, it returns an array of the first number of ((*lines*)).
+  # In block form, yields the first number of +lines+ of file +filename+.
+  # In non-block form, it returns an array of the first number of +lines+:
   #
   #   # Returns first 10 lines of 'myfile'
-  #   FileUtils.head("myfile")
+  #   FileUtils.head("myfile", 10)
   #
-  def head(filename,lines=10) #:yield:
+  def head(filename,lines) #:yield:
     a = []
     IO.foreach(filename){|line|
         break if lines <= 0
@@ -22,23 +22,23 @@ module FileUtils
     return a.empty? ? nil : a
   end
 
-  # In block form, yields the last number of ((*lines*)) of file ((*filename*)).
+  # In block form, yields the last number of +lines+ of file +filename+.
   # In non-block form, it returns the lines as an array.
   #
   # Note that this method slurps the entire file, so I don't recommend it
-  # for very large files.  If you want an advanced form of ((*tail*)), I
-  # suggest using file-tail, by Florian Frank (available on the RAA).
-  # And no tail -f.
+  # for very large files. If you want an advanced form of +tail+, I
+  # suggest using file-tail, by Florian Frank (available on the RAA):
   #
   #   # Returns last 3 lines of 'myfile'
   #   FileUtils.tail("myfile",3)
   #
-  def tail(filename,lines=10) #:yield
+  # And no tail -f.
+  def tail(filename,lines) #:yield
     IO.readlines(filename).reverse[0..lines-1].reverse
   end
 
-  # In block form, yields lines ((*from*))-((*to*)).  In non-block form,
-  # returns an array of lines ((*from*))-((*to*)).
+  # In block form, yields lines +from+-+to+.  In non-block form, returns
+  # an array of lines +from+-+to+:
   #
   #   # Returns lines 8-12 of 'myfile'
   #   FileUtils.body("myfile",8,12)
@@ -51,91 +51,3 @@ module FileUtils
 
 end
 
-
-# TODO This test have been remarked out until such time
-#      as a mock FileSystem can be used to test it against.
-
-=begin #test
-
-  require 'test/unit'
-
-  # FIND TEST DIRECTORY
-  paths = File.expand_path(File.dirname(__FILE__)).split('/')
-  paths.size.downto(1) do |i|
-    f = (paths.slice(0..i)+['test']).join('/')
-    $TESTDIR = File.join(f,'FIXTURE') if File.directory?(f)
-  end
-  raise unless $TESTDIR
-
-  class TC_FileUtils_HeadTail < Test::Unit::TestCase
-
-    def setup
-      @workdir = Dir.getwd
-      @thisdir = $TESTDIR
-
-      @tfile = 'test_file.txt'
-
-      @expected_head1 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
-      @expected_head1.push("line6\n","line7\n","line8\n","line9\n","line10\n")
-      @expected_head2 = ["line1\n","line2\n","line3\n","line4\n","line5\n"]
-
-      @expected_tail1 = ["line16\n","line17\n","line18\n","line19\n","line20\n"]
-      @expected_tail1.push("line21\n","line22\n","line23\n","line24\n","line25\n")
-      @expected_tail2 = ["line21\n","line22\n","line23\n","line24\n","line25\n"]
-
-      @expected_body1 = ["line10\n", "line11\n", "line12\n", "line13\n", "line14\n"]
-      @expected_body1.push("line15\n","line16\n", "line17\n", "line18\n", "line19\n","line20\n")
-      @expected_body2 = ["line14\n","line15\n","line16\n","line17\n","line18\n","line19\n","line20\n"]
-      @expected_body3 = ["line5\n","line6\n","line7\n","line8\n","line9\n","line10\n"]
-    end
-
-    def test_method
-      assert_respond_to( FileUtils, :head )
-      assert_respond_to( FileUtils, :tail )
-      assert_respond_to( FileUtils, :slice )
-    end
-
-    # head
-
-    def test_head
-      Dir.chdir @thisdir
-      begin
-      assert_nothing_raised{ FileUtils.head(@tfile) }
-      assert_nothing_raised{ FileUtils.head(@tfile,5) }
-      assert_equal(@expected_head1,FileUtils.head(@tfile))
-      assert_equal(@expected_head2,FileUtils.head(@tfile,5))
-      ensure
-        Dir.chdir @workdir
-      end
-    end
-
-    # slice
-
-    def test_slice
-      Dir.chdir @thisdir
-      begin
-        assert_nothing_raised{ FileUtils.slice(@tfile,5,10) }
-        assert_equal(@expected_body3,FileUtils.slice(@tfile,5,10))
-      ensure
-        Dir.chdir @workdir
-      end
-    end
-
-    # tail
-
-    def test_tail
-      Dir.chdir @thisdir
-      begin
-        assert_nothing_raised{ FileUtils.tail(@tfile) }
-        assert_nothing_raised{ FileUtils.tail(@tfile,5) }
-        assert_equal(@expected_tail1,FileUtils.tail(@tfile))
-        assert_equal(@expected_tail2,FileUtils.tail(@tfile,5))
-      ensure
-        Dir.chdir @workdir
-      end
-    end
-
-  end
-
-=end
-

data/lib/more/facets/fileutils/wc.rb

@@ -2,17 +2,18 @@ require 'fileutils'
 
 module FileUtils
 
+  module_function
+
   # With no arguments, returns a four element array consisting of the number
   # of bytes, characters, words and lines in _filename_, respectively.
   #
-  # Valid options are <tt>bytes</tt>, <tt>characters</tt> (or just 'chars'),
-  # <tt>words</tt> and <tt>lines</tt>.
+  # Valid options are +bytes+, +characters+ (or just 'chars'),
+  # +words+ and +lines+:
   #
   #   # Return the number of words in 'myfile'
   #   FileUtils.wc("myfile",'words')
   #
-  # CREDIT Daniel J. Berger
-
+  # CREDIT: Daniel J. Berger
   def wc(filename,option='all')
     option.downcase!
     valid = %w/all bytes characters chars lines words/
@@ -60,55 +61,3 @@ module FileUtils
 
 end
 
-
-# TODO FileUtils#wc test needs needs a Mock File.
-
-=begin #no test yet
-
-  require 'test/unit'
-
-  class TC_FileUtils_WC < Test::Unit::TestCase
-
-    def setup
-      @workdir = Dir.getwd
-      @thisdir = $TESTDIR
-
-      @file = 'test_file.txt'
-    end
-
-    def test_method
-      assert_respond_to( FileUtils, :wc )
-    end
-
-    def test_wc
-      Dir.chdir @thisdir
-      begin
-        assert_nothing_raised{ FileUtils.wc(@file) }
-        assert_nothing_raised{ FileUtils.wc(@file,'bytes') }
-        assert_nothing_raised{ FileUtils.wc(@file,'chars') }
-        assert_nothing_raised{ FileUtils.wc(@file,'words') }
-        assert_nothing_raised{ FileUtils.wc(@file,'lines') }
-        assert_raises(RuntimeError){ FileUtils.wc(@file,'bogus') }
-      ensure
-        Dir.chdir @workdir
-      end
-    end
-
-    def test_wc_results
-      Dir.chdir @thisdir
-      begin
-        assert_equal([166,166,25,25],FileUtils.wc(@file))
-        assert_equal(166,FileUtils.wc(@file,'bytes'),"Wrong number of bytes")
-        assert_equal(166,FileUtils.wc(@file,'chars'),"Wrong number of chars")
-        assert_equal(25,FileUtils.wc(@file,'words'),"Wrong number of words")
-        assert_equal(25,FileUtils.wc(@file,'lines'),"Wrong number of lines")
-      ensure
-        Dir.chdir @workdir
-      end
-    end
-
-  end
-
-=end
-
-

data/lib/more/facets/fileutils/whereis.rb

@@ -2,24 +2,26 @@ require 'fileutils'
 
 module FileUtils
 
-  if defined?(Win32Exts)
-    Win32Exts |= %w{.exe .com .bat .cmd}
+  if const_defined?(:Win32Exts)
+    Win32Exts.concat %w{.exe .com .bat .cmd}
+    Win32Exts.uniq!
   else
     Win32Exts = %w{.exe .com .bat .cmd}
   end
 
+  module_function
+
   # In block form, yields each ((*program*)) within ((*path*)).  In non-block
   # form, returns an array of each ((*program*)) within ((*path*)).  Returns
   # (({nil})) if not found.
   #
   # On the MS Windows platform, it looks for executables ending with .exe,
-  # .bat and .com, which you may optionally include in the program name.
+  # .bat and .com, which you may optionally include in the program name:
   #
-  #    FileUtils.whereis("ruby") -> ['/usr/local/bin/ruby','/opt/bin/ruby']
+  #    FileUtils.whereis("ruby")  #=> ['/usr/local/bin/ruby','/opt/bin/ruby']
   #
-  # CREDIT Daniel J. Berger
+  # CREDIT: Daniel J. Berger
 
-  module_function
   def whereis(prog, path=ENV['PATH']) #:yield:
     dirs = []
     path.split(File::PATH_SEPARATOR).each{|dir|

data/lib/more/facets/fileutils/which.rb

@@ -2,8 +2,9 @@ require 'fileutils'
 
 module FileUtils
 
-  if defined?(Win32Exts)
-    Win32Exts |= %w{.exe .com .bat .cmd}
+  if const_defined?(:Win32Exts)
+    Win32Exts.concat %w{.exe .com .bat .cmd}
+    Win32Exts.uniq!
   else
     Win32Exts = %w{.exe .com .bat .cmd}
   end
@@ -14,13 +15,13 @@ module FileUtils
   # .bat and .com, which you may optionally include in the program name.
   # Returns <tt>nil</tt> if not found.
   #
-  # CREDIT Daniel J. Berger & Michael Granger
+  # CREDIT: Daniel J. Berger, Michael Granger
+  #
   #--
   # The which() method was adopted from Daniel J. Berger, via PTools
   # which in in turn was adopted fromt the FileWhich code posted by
   # Michael Granger on http://www.rubygarden.org.
   #++
-
   def which(prog, path=ENV['PATH'])
     path.split(File::PATH_SEPARATOR).each {|dir|
       # Windows checks against specific extensions
@@ -55,47 +56,3 @@ module FileUtils
 
 end
 
-
-# TODO FileUtils#which This test needs a mock File.
-
-=begin #no test yet
-
-  require 'test/unit'
-  require 'rbconfig'
-
-  class TC_FileUtils_Which < Test::Unit::TestCase
-    include Config
-
-    def setup
-      @workdir = Dir.getwd
-      @thisdir = $TESTDIR
-
-      @expected_ruby_exe = File.join( CONFIG['bindir'], CONFIG['ruby_install_name'] )
-      if File::ALT_SEPARATOR
-          @expected_ruby_exe.gsub!(/\//,'\\')
-          @expected_ruby_exe += ".exe"
-      end
-    end
-
-    def test_method
-      assert_respond_to( FileUtils, :which )
-    end
-
-    # which
-
-    def test_which
-      Dir.chdir @thisdir
-      begin
-        ruby_exe = nil
-        assert_nothing_raised { ruby_exe = FileUtils.which(CONFIG['ruby_install_name']) }
-        assert_equal(@expected_ruby_exe, ruby_exe)
-        assert_equal(nil, FileUtils.which("blahblah"))
-      ensure
-        Dir.chdir @workdir
-      end
-    end
-
-  end
-
-=end
-

data/lib/more/facets/find.rb

@@ -0,0 +1,16 @@
+require 'facets/enumerator'
+
+module Find
+  # Identical to find except select returns the matching files as an array.
+  # (find returns nil, which is not very useful if you actually wanted an array.)
+  # Calls the associated block with the name of every file and directory listed
+  # as arguments, then recursively on their subdirectories, and so on.
+  # Return a true (non-false) value from the block for every path that
+  # you want to be returned in the resulting array. You can still use Find.prune.
+  #
+  # CREDIT: Tyler Rick
+  def self.select(*paths, &block)
+    Enumerator.new(self, :find, *paths).select{|value| yield value}
+  end
+end
+

data/lib/more/facets/getoptlong.rb

@@ -1,3 +1,5 @@
+require 'getoptlong'
+
 # = GetoptLong
 #
 # Ruby's standard GetoptLong class with an added DSL.
@@ -7,33 +9,13 @@
 #     flag '--help', '-h'
 #   end
 #
-#   opts.each { |opt, arg|
-#     ...
-#   }
-#
-# == Authors
-#
-# * Thomas Sawuer
-#
-# == Copying
-#
-# Copyright (c) 2007 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 'getoptlong'
+# See GetoptLong::DSL for details.
 
 class GetoptLong
 
   alias :init :initialize
 
+  #
   def initialize(*arguments, &block)
     if block_given?
       raise ArgumentError unless arguments.empty?
@@ -43,7 +25,6 @@ class GetoptLong
   end
 
   # DSL-mode parser.
-
   class DSL
     attr :arguments
 
@@ -52,18 +33,25 @@ class GetoptLong
       instance_eval(&block)
     end
 
+    #
     def flag(*opts)
       @arguments << (opts << GetoptLong::NO_ARGUMENT)
     end
 
+    #
     def required(*opts)
       @arguments << (opts <<  GetoptLong::REQUIRED_ARGUMENT)
     end
+
+    #
     alias :reqs :required
 
+    #
     def optional(*opts)
       @arguments << (opts << GetoptLong::OPTIONAL_ARGUMENT)
     end
+
+    #
     alias :opts :optional
   end
 

data/lib/more/facets/main.rb

@@ -1,15 +1,4 @@
-# Main as Module
-# 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.
-#
-# == Description
+# = Main as Module
 #
 # Main, ie. the top-level object, is not fully in-sync with
 # Module. So, certain methods like #define_method do not work.
@@ -23,26 +12,35 @@
 # On the other hand. It is probably best to never use the toplevel
 # except as a jumping in point to youre own namespace.
 #
-# == Note
-#
-# Noen of this would be needed if Main were just a self extended module.
-#
-#  == Authors
-#
-#  * Thomas Sawyer
+# Note that none of this would be needed if Main were just a self extended
+# module.
+
+def_meth = Proc.new do |m|
+  if /=$/ =~ m.to_s
+    eval <<-END
+      def self.#{m}(arg)
+        Object.class_eval do
+          #{m}(arg)
+        end
+      end
+    END
+  else
+    eval <<-END
+      def self.#{m}( *args, &block )
+        Object.class_eval do
+          #{m}( *args, &block )
+        end
+      end
+    END
+  end
+end
 
 public
 
 (Module.public_instance_methods - public_methods).each do |m|
   next if m == "initialize"
   next if m =~ /^\W+$/
-  eval <<-END
-    def self.#{m}( *args, &block )
-      Object.class_eval do
-        #{m}( *args, &block )
-      end
-    end
-  END
+  def_meth[m]
 end
 
 private
@@ -50,13 +48,7 @@ private
 (Module.private_instance_methods - private_methods).each do |m|
   next if m == "initialize"
   next if m =~ /^\W+$/
-  eval <<-END
-    def self.#{m}( *args, &block )
-      Object.class_eval do
-        #{m}( *args, &block )
-      end
-    end
-  END
+  def_meth[m]
 end
 
 protected
@@ -64,12 +56,7 @@ protected
 (Module.protected_instance_methods - protected_methods).each do |m|
   next if m == "initialize"
   next if m =~ /^\W+$/
-  eval <<-END
-    def self.#{m}( *args, &block )
-      Object.class_eval do
-        #{m}( *args, &block )
-      end
-    end
-  END
+  def_meth[m]
 end
 
+# Copyright (c) 2006 Thomas Sawyer (Ruby License)