facets 2.4.5 → 2.5.0

data/lib/more/facets/stash.rb

@@ -0,0 +1,66 @@
+require 'facets/hash/rekey'
+
+# = Hash
+#
+# Stash is just like Hash, except that all keys are
+# converted to Strings.
+#
+# This is rather fresh code, so is not yet complete.
+# For instnace, it currently does not ensure that default
+# keys are strings when using default_proc.
+#
+class Stash < Hash
+
+  def fetch(k)
+    super(k.to_s)
+  end
+
+  def store(k, v)
+    super(k.to_s, v)
+  end
+
+  def has_key?(k)
+    super(k.to_s)
+  end
+
+  def key?(k)
+    super(k.to_s)
+  end
+
+  def [](k)
+    super(k.to_s)
+  end
+
+  def []=(k,v)
+    super(k.to_s, v)
+  end
+
+  def <<(other)
+    cash other
+    when Hash
+      super(other.rekey(&:to_s))
+    when Array
+      self[other[0].to_s] = other[1]
+    else
+      raise ArgumentError
+    end
+  end
+
+  def update(other)
+    super(other.rekey(&:to_s))
+  end
+
+  def merge!(other)
+    super(other.rekey(&:to_s))
+  end
+  
+  def replace
+    super(other.rekey(&:to_s))
+  end
+
+  def values_at(*keys)
+    super(keys.map{|k|k.to_s})
+  end
+
+end
+

data/lib/more/facets/string/words.rb

@@ -7,7 +7,7 @@ class String
     # Returns an array of characters.
     #
     #   "abc 123".words  #=> ["abc","123"]
-
+    #
     def words
       self.split(/\s+/)
     end
@@ -15,7 +15,7 @@ class String
     # Iterate through each word of a string.
     #
     #   "a string".each_word { |word, range| ... }
-
+    #
     def each_word( &yld )
       rest_of_string = self
       wordfind = /([-'\w]+)/
@@ -38,8 +38,8 @@ class String
     #
     #   "a string".word_filter { |word| word =~ /^a/ }  #=> "string"
     #
-    #   CREDIT: George Moschovitis
-
+    # CREDIT: George Moschovitis
+    #
     def word_filter( &blk )
       s = self.dup
       s.word_filter!( &blk )
@@ -49,7 +49,7 @@ class String
     #
     #   "a string".word_filter { |word| ... }
     #
-    #   CREDIT: George Moschovitis
+    # CREDIT: George Moschovitis
 
     def word_filter! #:yield:
       rest_of_string = self
@@ -104,8 +104,7 @@ class String
     #   is a
     #   test
     #
-    #   CREDIT: Gavin Kistner
-    #   CREDIT: Dayne Broderson
+    # CREDIT: Gavin Kistner, Dayne Broderson
 
     def word_wrap( col_width=80 )
       self.dup.word_wrap!( col_width )
@@ -113,8 +112,7 @@ class String
 
     # As with #word_wrap, but modifies the string in place.
     #
-    #   CREDIT: Gavin Kistner
-    #   CREDIT: Dayne Broderson
+    # CREDIT: Gavin Kistner, Dayne Broderson
 
     def word_wrap!( col_width=80 )
       self.gsub!( /(\S{#{col_width}})(?=\S)/, '\1 ' )
@@ -142,8 +140,7 @@ class String
     # if possible, and appended by +ellipsis+, which defaults
     # to '...'.
     #
-    #   CREDIT: George Moschovitis
-    #   CREDIT: Trans
+    # CREDIT: George Moschovitis, Trans
 
     def brief(range=76, ellipsis="...")
       if Range===range

data/lib/more/facets/succ.rb

@@ -4,7 +4,7 @@ class Integer
   #
   #   3.succ(2)  #=> 5
   #
-  #   CREDIT Trans
+  # CREDIT: Trans
 
   def succ(n=1)
     self + n
@@ -14,7 +14,7 @@ class Integer
   #
   #   3.pred(2)  #=> 1
   #
-  #   CREDIT Trans
+  # CREDIT: Trans
 
   def pred(n=1)
     self - n
@@ -32,7 +32,7 @@ class String
   #   "abc".succ(4)   #=> "abg"
   #   "abc".succ(24)  #=> "aca"
   #
-  #  CREDIT Trans
+  # CREDIT: Trans
 
   def succ(n=1)
     s = self

data/lib/more/facets/thread.rb

@@ -32,7 +32,7 @@ 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 +41,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 }

data/lib/more/facets/ziputils.rb

@@ -1,60 +1,35 @@
-# = ZipUtils
-#
-# Function module for compression methods.
-#
-# == Authors
-#
-# * Thomas Sawyer
-#
-# == Todo
-#
-# * Most of this shells out. It would be best to internalize.
-#
-# == Copyright
-#
-# 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 'facets/minitar'
-require 'zlib'
+#require 'zlib'
+#require 'facets/minitar'
 
 # = ZipUtils
 #
 # Function module for compression methods.
 #
+# TODO: Much of this shells out. It would be best to internalize.
+#
 module ZipUtils
 
   COMPRESS_FORMAT = {
-    'tar.gz'  => 'tar_gzip',
-    'tgz'     => 'tar_gzip',
-    'tar.bz2' => 'tar_bzip',
-    'zip'     => 'zip',
-
     '.tar.gz'  => 'tar_gzip',
     '.tgz'     => 'tar_gzip',
-    '.tar.bz2' => 'tar_bzip',
+    '.tar.bz2' => 'tar_bzip2',
     '.zip'     => 'zip'
   }
 
+  ###############
   module_function
+  ###############
 
-  # Compress based on given extension.
+  # Compress folder or file based on given extension.
   # Supported extensions are:
-  # * tar.gz
-  # * tgz
-  # * tar.bz2
-  # * zip
-
-  def compress(format_extension, folder, file=nil, options={})
-    format = COMPRESS_FORMAT[format_extension.to_s]
+  # * .tar.gz
+  # * .tgz
+  # * .tar.bz2
+  # * .zip
+  #
+  # TODO: support gzip and bzip2 as well.
+  def compress(folder, file, options={})
+    format = COMPRESS_FORMAT[File.extname(file)]
     if format
       send(format, folder, file, options)
     else
@@ -62,109 +37,162 @@ module ZipUtils
     end
   end
 
-  # Tar Gzip
+  #
+  #
+  def gzip(file, option={})
+    require 'zlib'
+    fname = File.basename(file) + '.gz'
+    if options[:dryrun] or options[:verbose]
+      puts "gzip #{file}"
+    end
+    Zlib::GzipWriter.open(fname) do |gz|
+      gz.write(File.read(file))
+    end unless options[:dryrun] or options[:noop]
+    return File.expand_path(fname)
+  end
 
-  def tar_gzip(folder, file=nil, options={})
+  #
+  #
+  def ungzip(file, options={})
     require 'zlib'
-    # name of file to create
-    file ||= File.basename(File.expand_path(folder)) + '.tar.gz'
-    cmd = "tar --gzip -czf #{file} #{folder}"
-    # display equivalent commandline
-    if options[:verbose] or options[:dryrun]
-      puts cmd
+    fname = File.basename(file).chomp(File.extname(file))
+    if options[:dryrun] or options[:verbose]
+      puts "ungzip #{file}"
     end
-    # create tar.gzip file
+    Zlib::GzipReader.open(file) do |gz|
+      File.open(fname, 'wb'){ |f| f << gz.read }
+    end unless options[:dryrun] or options[:noop]
+    return File.expand_path(fname)
+  end
+
+  #
+  #
+  def bzip2(file, option={})
+    cmd = "bzip2 #{file}"
+    puts   cmd if     options[:dryrun] or options[:verbose]
+    system cmd unless options[:dryrun] or options[:noop]
+    return File.expand_path(file + '.bz2')
+  end
+
+  alias_method :bzip, :bzip2
+
+  #
+  #
+  def unbzip2(file, options={})
+    cmd = "unbzip2 #{file}"
+    puts   cmd if     options[:dryrun] or options[:verbose]
+    system cmd unless options[:dryrun] or options[:noop]
+    return File.expand_path(file.chomp(File.extname(file)))
+  end
+
+  alias_method :unbzip, :unbzip2
+
+  #
+  #
+  def tar(folder, file=nil, options={})
+    require 'facets/minitar'
+    file ||= File.basename(File.expand_path(folder)) + '.tar'
+    cmd = "tar -cf #{file} #{folder}"
+    puts cmd if options[:verbose] or options[:dryrun]
     unless options[:noop] or options[:dryrun]
-      gzIO = Zlib::GzipWriter.new(File.open(file, 'wb'))
+      gzIO = File.open(file, 'wb')
       Archive::Tar::Minitar.pack(folder, gzIO)
     end
     return File.expand_path(file)
   end
-  alias_method :tar_z, :tar_gzip
 
   #
+  #
+  def untar(file, options={})
+    require 'facets/minitar'
+    #file ||= File.basename(File.expand_path(folder)) + '.tar'
+    cmd = "untar #{file}"
+    puts cmd if options[:verbose] or options[:dryrun]
+    unless options[:noop] or options[:dryrun]
+      gzIO = File.open(file, 'wb')
+      Archive::Tar::Minitar.unpack(gzIO)
+    end
+    return File.expand_path(file)
+  end
 
-  def tgz(folder, file=nil, options={})
-    file ||= File.basename(File.expand_path(folder)) + '.tgz'
-    tar_gzip(folder, file, options)
+  # Tar Gzip
+  #
+  def tar_gzip(folder, file=nil, options={})
+    require 'zlib'
+    require 'facets/minitar'
+    file ||= File.basename(File.expand_path(folder)) + '.tar.gz' # '.tgz' which ?
+    cmd = "tar --gzip -czf #{file} #{folder}"
+    puts cmd if options[:verbose] or options[:dryrun]
+    unless options[:noop] or options[:dryrun]
+      gzIO = Zlib::GzipWriter.new(File.open(file, 'wb'))
+      Archive::Tar::Minitar.pack(folder, gzIO)
+    end
+    return File.expand_path(file)
   end
 
-  # Untar Gzip
+  alias_method :tar_z, :tar_gzip
 
-  def untar_gzip(file, options={})
-    require 'zlib'
-    # TODO Write internalized untar_gzip function.
+  #def tgz(folder, file=nil, options={})
+  #  file ||= File.basename(File.expand_path(folder)) + '.tgz'
+  #  tar_gzip(folder, file, options)
+  #end
 
+  # Untar Gzip
+  #
+  # TODO: Write unified untar_gzip function.
+  def untar_gzip(file, options={})
+    untar(ungzip(file, options), options)
   end
+
   alias_method :untar_z, :untar_gzip
 
   # Tar Bzip2
-
+  #
   def tar_bzip2(folder, file=nil, options={})
     # name of file to create
     file ||= File.basename(File.expand_path(folder)) + '.tar.bz2'
     cmd = "tar --bzip2 -cf #{file} #{folder}"
-    # display equivalent commandline
-    if options[:verbose] or options[:dryrun]
-      puts cmd
-    end
-    # create tar.bzip2 file
-    unless options[:noop] or options[:dryrun]
-      system cmd
-    end
+    puts   cmd if     options[:dryrun] or options[:verbose]
+    system cmd unless options[:dryrun] or options[:noop]
     return File.expand_path(file)
   end
+
   alias_method :tar_bzip, :tar_bzip2
+
   alias_method :tar_j, :tar_bzip2
 
   # Untar Bzip2
-
+  #
   def untar_bzip2(file, options={})
     cmd = "tar --bzip2 -xf #{file}"
-    # display equivalent commandline
-    if options[:verbose] or options[:dryrun]
-      puts cmd
-    end
-    # untar/bzip2 file
-    unless options[:noop] or options[:dryrun]
-      system cmd
-    end
+    puts   cmd if     options[:dryrun] or options[:verbose]
+    system cmd unless options[:dryrun] or options[:noop]
   end
+
   alias_method :untar_bzip, :untar_bzip2
+
   alias_method :untar_j, :untar_bzip2
 
   # Zip
-
+  #
   def zip(folder, file=nil, options={})
     raise ArgumentError if folder == '.*'
-    # name of file to create
     file ||= File.basename(File.expand_path(folder)) + '.zip'
     cmd = "zip -rqu #{file} #{folder}"
-    # display equivalent commandline
-    if options[:verbose] or options[:dryrun]
-      puts cmd
-    end
-    # create zip file
-    unless options[:noop] or options[:dryrun]
-      system cmd
-    end
+    puts   cmd if     options[:dryrun] or options[:verbose]
+    system cmd unless options[:dryrun] or options[:noop]
     return File.expand_path(file)
   end
 
   # Unzip
-
+  #
   def unzip(file, options={})
     cmd = "unzip #{file}"
-    # display equivalent commandline
-    if options[:verbose] or options[:dryrun]
-      puts cmd
-    end
-    # unzip file
-    unless options[:noop] or options[:dryrun]
-      system cmd
-    end
+    puts   cmd if     options[:dryrun] or options[:verbose]
+    system cmd unless options[:dryrun] or options[:noop]
   end
-end
+
+end #module ZipUtils
 
 # Verbose version of ZipUtils.
 #
@@ -178,6 +206,40 @@ module ZipUtils::Verbose
     ZipUtils.tar_gzip(format_extension, folder, file, options)
   end
 
+  def gzip(file, options={})
+    options[:verbose] = true
+    ZipUtils.gzip(file, options)
+  end
+
+  def ungzip(file, options={})
+    options[:verbose] = true
+    ZipUtils.ungzip(file, options)
+  end
+
+  def bzip2(file, options={})
+    options[:verbose] = true
+    ZipUtils.bzip2(file, options)
+  end
+
+  alias_method :bzip, :bzip2
+
+  def unbzip2(file, options={})
+    options[:verbose] = true
+    ZipUtils.unbzip2(file, options)
+  end
+
+  alias_method :unbzip, :unbzip2
+
+  def tar(folder, file=nil, options={})
+    options[:verbose] = true
+    ZipUtils.tar(folder, file, options)
+  end
+
+  def untar(file, options={})
+    options[:verbose] = true
+    ZipUtils.untar(file, options)
+  end
+
   def tar_gzip(folder, file=nil, options={})
     options[:verbose] = true
     ZipUtils.tar_gzip(folder, file, options)
@@ -221,6 +283,40 @@ module ZipUtils::NoWrite
     ZipUtils.tar_gzip(format_extension, folder, file, options)
   end
 
+  def gzip(file, options={})
+    options[:noop] = true
+    ZipUtils.gzip(file, options)
+  end
+
+  def ungzip(file, options={})
+    options[:noop] = true
+    ZipUtils.ungzip(file, options)
+  end
+
+  def bzip2(file, options={})
+    options[:noop] = true
+    ZipUtils.bzip2(file, options)
+  end
+
+  alias_method :bzip, :bzip2
+
+  def unbzip2(file, options={})
+    options[:noop] = true
+    ZipUtils.unbzip2(file, options)
+  end
+
+  alias_method :unbzip, :unbzip2
+
+  def tar(folder, file=nil, options={})
+    options[:noop] = true
+    ZipUtils.tar(folder, file, options)
+  end
+
+  def untar(file, options={})
+    options[:noop] = true
+    ZipUtils.untar(file, options)
+  end
+
   def tar_gzip(folder, file=nil, options={})
     options[:noop] = true
     ZipUtils.tar_gzip(folder, file, options)
@@ -236,11 +332,15 @@ module ZipUtils::NoWrite
     ZipUtils.untar_bzip2(folder, file, options)
   end
 
+  alias_method :tar_bzip, :tar_bzip2
+
   def untar_bzip2(file, options={})
     options[:noop] = true
     ZipUtils.untar_bzip2(file, options)
   end
 
+  alias_method :untar_bzip, :untar_bzip2
+
   def zip(folder, file=nil, options={})
     options[:noop] = true
     ZipUtils.unzip(folder, file, options)
@@ -265,6 +365,40 @@ module ZipUtils::DryRun
     ZipUtils.tar_gzip(format_extension, folder, file, options)
   end
 
+  def gzip(file, options={})
+    options[:dryrun] = true
+    ZipUtils.gzip(file, options)
+  end
+
+  def ungzip(file, options={})
+    options[:dryrun] = true
+    ZipUtils.ungzip(file, options)
+  end
+
+  def bzip2(file, options={})
+    options[:dryrun] = true
+    ZipUtils.bzip2(file, options)
+  end
+
+  alias_method :bzip, :bzip2
+
+  def unbzip2(file, options={})
+    options[:dryrun] = true
+    ZipUtils.unbzip2(file, options)
+  end
+
+  alias_method :unbzip, :unbzip2
+
+  def tar(folder, file=nil, options={})
+    options[:dryrun] = true
+    ZipUtils.tar(folder, file, options)
+  end
+
+  def untar(file, options={})
+    options[:dryrun] = true
+    ZipUtils.untar(file, options)
+  end
+
   def tar_gzip(folder, file=nil, options={})
     options[:dryrun] = true
     ZipUtils.tar_gzip(folder, file, options)
@@ -280,11 +414,15 @@ module ZipUtils::DryRun
     ZipUtils.untar_bzip2(folder, file, options)
   end
 
+  alias_method :tar_bzip, :tar_bzip2
+
   def untar_bzip2(file, options={})
     options[:dryrun] = true
     ZipUtils.untar_bzip2(file, options)
   end
 
+  alias_method :untar_bzip, :untar_bzip2
+
   def zip(folder, file=nil, options={})
     options[:dryrun] = true
     ZipUtils.unzip(folder, file, options)
@@ -296,6 +434,9 @@ module ZipUtils::DryRun
   end
 end
 
+
+
+# OLD VERSION
 #   #
 #   # DryRun version of ZipUtils.
 #   #