ptools 1.1.9-x86-mingw32

data/CHANGES

@@ -0,0 +1,105 @@
+== 1.1.9 - 25-Mar-2010
+* Refactored File.which and File.whereis and added additional tests for each.
+* Removed the block form of File.whereis.
+* Reorganized the Rakefile a bit and put the test tasks under the 'test'
+  namespace, and the gem tasks under the 'gem' namespace.
+* Updated the test-unit development dependency.
+* Updates the README.
+
+== 1.1.8 - 6-Oct-2009
+* Fixed some bad variable names that crept into the File.nl_convert method.
+* Added the File.null_device alias for File.null.
+* Added cygwin and mingw to Windows detection code.
+* One of the nlconvert tests is now skipped on Windows.
+* Two text files that were previously bundled as part of this library for
+  testing purposes have been removed. Those are now dynamically generated
+  within the tests themselves.
+* Gemspec updates.
+* Documentation updates.
+* Added the :gem rake task.
+
+== 1.1.7 - 28-Jul-2009
+* Now compatible with Ruby 1.9.x.
+* Replaced RUBY_PLATFORM with rbconfig check for the sake of other
+  implementations, such as JRuby.
+* Updated the tests to be more friendly to JRuby.
+* Added Test::Unit 2.x as a development dependency.
+* Renamed the test files.
+
+== 1.1.6 - 31-Aug-2007
+* Fixed the File.touch method so that it doesn't whack existing files. Thanks
+  go to Thomas Preymesser for the spot.
+* Added corresponding tests to the tc_touch.rb file.
+
+== 1.1.5 - 19-Jul-2007
+* Added the File.image? method. Inspired by ruby-talk: 260487. 
+
+== 1.1.4 - 21-May-2007
+* Removed the install.rb file. Installation is now handled exclusively by the
+  rake install task.
+* Updated the MANIFEST file, and made it rdoc friendly.
+* Manual installation corrections in the README file.
+
+== 1.1.3 - 29-Apr-2007
+* I changed the way that the constants IS_WINDOWS and WIN32EXTS are defined.
+* The IS_WINDOWS and WIN32EXTS are no long documented publically. They were
+  never meant for public use.
+* The tc_constants.rb file was modified to only run certain tests on Windows.
+
+== 1.1.2 - 28-Apr-2007
+* Fixed a require line that could cause problems on MS Windows.
+* Added a Rakefile which includes tasks for installation and testing.
+* Some cleanup and improvement in the various test files.
+
+== 1.1.1 - 24-Aug-2006
+* Added the File.binary? method, based on code from Ryan Davis.
+
+== 1.1.0 - 23-Aug-2006
+* Added the File.null method which returns the bit bucket on your platform.
+* The suffixes on MS Windows are now based on the PATHEXT environment variable,
+  and defaults to '.com', '.bat' and '.exe' only if it's not defined.
+* The File.which and File.whereis methods were tweaked a bit for Windows so
+  that they ignore the case of suffixes.
+* Modified the platform checking and path separator handling.
+* Added and tweaked some tests.
+
+== 1.0.0 - 2-Jun-2005
+* Modified the File.middle method to accept an optional block.
+* File.whereis is now limited to unique values so that redundant PATH entries
+  do not cause redundant entries in the returned array (or block).
+* File.nl_convert and File.touch now return self.
+* File.nl_convert now raises ArgumentError (instead of StandardError) if
+  an unknown platform is provided.
+* File.wc now raises ArgumentError (instead of RuntimeError) if a bad option
+  is provided.
+* Made documentation rdoc friendly.
+* Test suite updates, corrections and additions.
+* Removed the INSTALL file.  See the README instead.
+* Moved project to RubyForge.
+
+== 0.1.3 - 5-Dec-2003
+* Modified File#which and File#whereis for Win32 to handle extensions better,
+  i.e. you can send "ruby" or "ruby.exe" and get back the same result.
+* Minor test changes to tc_which.rb and tc_whereis.rb.
+
+== 0.1.2 - 14-May-2003
+* Modified nl_convert() to allow the destination filename to be the same as the
+  source file.  In that case, a tempfile is used and copied back over the
+  original file.
+* The target file name for nl_convert() now defaults to the source file name and
+  the default format is now "dos".
+* Added a tc_constants.rb test suite.
+* Test suite additions/fixes.
+* Updates to MANIFEST.
+
+== 0.1.1 - 21-Mar-2003
+* Modified File.tail to return data in the same order that 'tail' does.
+* Modified File.which to return nil if the program is not found.
+* Modified File.whereis now uses '\' instead of '/' on MS Windows.
+* Added File.middle class method.
+* Test suite modification & additions.
+* Thanks go to Shanko for both the spot and patch for tail, which, whereis
+  and middle.
+
+== 0.1.0 - 18-Mar-2003
+* Initial release

data/MANIFEST

@@ -0,0 +1,17 @@
+* CHANGES
+* README
+* MANIFEST
+* Rakefile
+* ptools.gemspec
+* lib/ptools.rb
+* test/test_constants.rb
+* test/test_head.rb
+* test/test_image.rb
+* test/test_middle.rb
+* test/test_nlconvert.rb
+* test/test_null.rb
+* test/test_tail.rb
+* test/test_touch.rb
+* test/test_wc.rb
+* test/test_which.rb
+* test/test_whereis.rb

data/README

@@ -0,0 +1,64 @@
+== Description
+  The ptools (power tools) library is an additional set of commands for the
+  File class based on Unix command line tools.
+   
+== Prerequisites
+  On MS Windows you will need win32-file 0.5.4 or later.
+
+== Installation
+  gem install ptools
+
+== Synopsis
+  require "ptools"
+
+  File.which("ruby")         # '/usr/local/bin/ruby'
+  File.whereis("ruby")       # ['/usr/local/bin/ruby','/opt/bin/ruby']
+
+  File.head("myfile")        # Returns first 10 lines of 'myfile'
+  File.middle("myfile",8,12) # Returns lines 8-12 of 'myfile'
+  File.tail("myfile",3)      # Returns last 3 lines of 'myfile'
+  File.wc("myfile",'words')  # Returns the number of words in 'myfile'
+
+  File.touch("newfile")      # "newfile" now exists
+  File.null                  # '/dev/null' on Unix, 'NUL' on Windows
+  File.binary?('some_file')  # true or false
+
+  # Creates a copy of 'myfile' called 'newfile', in DOS format
+  File.nl_convert("myfile", "newfile", "dos")
+   
+== Known Bugs
+  None known. Please report any bugs on the github or RubyForge project page.
+
+  http://www.rubyforge.org/projects/shards
+  http://www.github.com/djberg96/ptools
+
+== Acknowledgements
+  The File.which method was originally adopted from the FileWhich code posted
+  by Michael Granger on the now defunct rubygarden.org website. That code was
+  later replaced by a version based on the ruby-which library.
+
+  The File.nl_convert method is based on the nlcvt program found at
+  http://www.perl.com/language/ppt/src/nlcvt/nlcvt, written by Tom Christiansen.
+    
+  The middle() method was provided by Shashank Date.
+
+  The binary?() method was based almost entirely on a blog post by Ryan
+  Davis (who, in turn, based his code on Perl's -B switch).
+
+== Future Plans
+  Add whatever other tools people think might be useful.
+   
+== License
+  Artistic 2.0
+    
+== Copyright
+  (C) 2003-2010 Daniel J. Berger
+  All Rights Reserved.
+    
+== Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+== Author
+  Daniel J. Berger

data/Rakefile

@@ -0,0 +1,110 @@
+require 'rake'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+desc 'Install the ptools package (non-gem)'
+task :install do
+   sitelibdir = CONFIG["sitelibdir"]
+   file = "lib/ptools.rb"
+   FileUtils.cp(file, sitelibdir, :verbose => true)
+end
+
+namespace 'gem' do
+  desc 'Create the ptools gem'
+  task :create do
+    Dir["*.gem"].each{ |f| File.delete(f) } # Clean first
+    spec = eval(IO.read('ptools.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Install the ptools gem'
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+end
+
+namespace 'test' do
+  Rake::TestTask.new('binary') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_binary.rb']
+  end
+
+  Rake::TestTask.new('constants') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_constants.rb']
+  end
+
+  Rake::TestTask.new('head') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_head.rb']
+  end
+
+  Rake::TestTask.new('middle') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_middle.rb']
+  end
+
+  Rake::TestTask.new('nlconvert') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_nlconvert.rb']
+  end
+
+  Rake::TestTask.new('null') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_null.rb']
+  end
+
+  Rake::TestTask.new('tail') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_tail.rb']
+  end
+
+  Rake::TestTask.new('touch') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_touch.rb']
+  end
+
+  Rake::TestTask.new('wc') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_wc.rb']
+  end
+
+  Rake::TestTask.new('whereis') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_whereis.rb']
+  end
+
+  Rake::TestTask.new('which') do |t|
+    t.libs << 'test'
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_which.rb']
+  end
+end

data/lib/ptools.rb

@@ -0,0 +1,406 @@
+require 'rbconfig'
+
+if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i
+  require 'win32/file'
+end
+
+class File
+  # The version of the ptools library.
+  PTOOLS_VERSION = '1.1.9'
+
+  # :stopdoc:
+
+  # The WIN32EXTS string is used as part of a Dir[] call in certain methods.
+  if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i
+    MSWINDOWS = true
+    if ENV['PATHEXT']
+      WIN32EXTS = ('.{' + ENV['PATHEXT'].tr(';', ',').tr('.','') + '}').downcase
+    else
+      WIN32EXTS = '.{exe,com,bat}'
+    end
+  else
+    MSWINDOWS = false
+  end
+
+  IMAGE_EXT = %w/.bmp .gif .jpg .jpeg .png/
+
+  # :startdoc:
+
+  # Returns whether or not the file is an image. Only JPEG, PNG, BMP and
+  # GIF are checked against.
+  #
+  # This method does some simple read and extension checks. For a version
+  # that is more robust, but which depends on a 3rd party C library (and is
+  # difficult to build on MS Windows), see the 'filemagic' library, available
+  # on the RAA.
+  #
+  # Examples:
+  #
+  #    File.image?('somefile.jpg') # => true
+  #    File.image?('somefile.txt') # => true
+  #--
+  # The approach I used here is based on information found at
+  # http://en.wikipedia.org/wiki/Magic_number_(programming) 
+  #
+  def self.image?(file)
+    bool = IMAGE_EXT.include?(File.extname(file).downcase)      # Match ext
+    bool = bmp?(file) || jpg?(file) || png?(file) || gif?(file) # Check data
+    bool
+  end
+
+  # Returns the name of the null device (aka bitbucket) on your platform.
+  #
+  # Examples:
+  #
+  #   # On Linux
+  #   File.null # => '/dev/null'
+  #
+  #   # On MS Windows
+  #   File.null # => 'NUL'
+  #--
+  # The values I used here are based on information from
+  # http://en.wikipedia.org/wiki//dev/null
+  #
+  def self.null
+    case Config::CONFIG['host_os']
+      when /mswin|win32|msdos|cygwin|mingw/i
+        'NUL'
+      when /amiga/i
+        'NIL:'
+      when /openvms/i
+        'NL:'
+      else
+        '/dev/null'
+    end
+  end
+
+  class << self
+    alias null_device null
+  end
+
+  # Returns whether or not +file+ is a binary file.  Note that this is
+  # not guaranteed to be 100% accurate.  It performs a "best guess" based
+  # on a simple test of the first +File.blksize+ characters.
+  #
+  # Example:
+  #
+  #   File.binary?('somefile.exe') # => true
+  #   File.binary?('somefile.txt') # => false
+  #--
+  # Based on code originally provided by Ryan Davis (which, in turn, is
+  # based on Perl's -B switch).
+  #
+  def self.binary?(file)
+    s = (File.read(file, File.stat(file).blksize) || "").split(//)
+    ((s.size - s.grep(" ".."~").size) / s.size.to_f) > 0.30
+  end
+   
+  # Looks for the first occurrence of +program+ within +path+.
+  # 
+  # On Windows, it looks for executables ending with the suffixes defined
+  # in your PATHEXT environment variable, or '.exe', '.bat' and '.com' if
+  # that isn't defined, which you may optionally include in +program+.
+  #
+  # Returns nil if not found. 
+  #
+  # Examples:
+  #
+  #   File.which('ruby') # => '/usr/local/bin/ruby'
+  #   File.which('foo')  # => nil
+  #
+  def self.which(program, path=ENV['PATH'])
+    if path.nil? || path.empty?
+      raise ArgumentError, "path cannot be empty"
+    end
+
+    # Bail out early if an absolute path is provided.
+    if program =~ /^\/|^[a-z]:[\\\/]/i
+      program += WIN32EXTS if MSWINDOWS && File.extname(program).empty?
+      found = Dir[program].first
+      if found && File.executable?(found) && !File.directory?(found)
+        return found
+      else
+        return nil
+      end
+    end
+
+    # Iterate over each path glob the dir + program.
+    path.split(File::PATH_SEPARATOR).each{ |dir|
+      next unless File.exists?(dir) # In case of bogus second argument
+      file = File.join(dir, program)
+
+      # Dir[] doesn't handle backslashes properly, so convert them. Also, if
+      # the program name doesn't have an extension, try them all.
+      if MSWINDOWS
+        file = file.tr("\\", "/")
+        file += WIN32EXTS if File.extname(program).empty?
+      end
+
+      found = Dir[file].first
+
+      # Convert all forward slashes to backslashes if supported
+      if found && File.executable?(found) && !File.directory?(found)
+        found.tr!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+        return found
+      end
+    }
+
+    nil
+  end
+
+  # Returns an array of each +program+ within +path+, or nil if it cannot
+  # be found.
+  #
+  # On Windows, it looks for executables ending with the suffixes defined
+  # in your PATHEXT environment variable, or '.exe', '.bat' and '.com' if
+  # that isn't defined, which you may optionally include in +program+.
+  #
+  # Examples:
+  #
+  #   File.whereis('ruby') # => ['/usr/bin/ruby', '/usr/local/bin/ruby']
+  #   File.whereis('foo')  # => nil
+  #
+  def self.whereis(program, path=ENV['PATH'])
+    if path.nil? || path.empty?
+      raise ArgumentError, "path cannot be empty"
+    end
+
+    paths = []
+
+    # Bail out early if an absolute path is provided.
+    if program =~ /^\/|^[a-z]:[\\\/]/i
+      program += WIN32EXTS if MSWINDOWS && File.extname(program).empty?
+      found = Dir[program]
+      if found[0] && File.executable?(found[0]) && !File.directory?(found[0])
+        return found
+      else
+        return nil
+      end
+    end
+
+    # Iterate over each path glob the dir + program.
+    path.split(File::PATH_SEPARATOR).each{ |dir|
+      next unless File.exists?(dir) # In case of bogus second argument
+      file = File.join(dir, program)
+
+      # Dir[] doesn't handle backslashes properly, so convert them. Also, if
+      # the program name doesn't have an extension, try them all.
+      if MSWINDOWS
+        file = file.tr("\\", "/")
+        file += WIN32EXTS if File.extname(program).empty?
+      end
+
+      found = Dir[file].first
+
+      # Convert all forward slashes to backslashes if supported
+      if found && File.executable?(found) && !File.directory?(found)
+        found.tr!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+        paths << found
+      end
+    }
+
+    paths.empty? ? nil : paths.uniq
+  end
+
+   # In block form, yields the first +num_lines+ from +filename+.  In non-block
+   # form, returns an Array of +num_lines+
+   #
+   # Examples:
+   #
+   #   # Return an array
+   #   File.head('somefile.txt') # => ['This is line1', 'This is line2', ...]
+   #
+   #   # Use a block
+   #   File.head('somefile.txt'){ |line| puts line }
+   #
+   def self.head(filename, num_lines=10)
+      a = []
+      IO.foreach(filename){ |line|
+         break if num_lines <= 0
+         num_lines -= 1
+         if block_given?
+            yield line
+         else
+            a << line
+         end
+      }
+      return a.empty? ? nil : a # Return nil in block form
+   end
+
+   # In block form, yields line +from+ up to line +to+.  In non-block form
+   # returns an Array of lines from +from+ to +to+.
+   #
+   def self.middle(filename, from=10, to=20)
+      if block_given?
+         IO.readlines(filename)[from-1..to-1].each{ |line| yield line }
+      else
+         IO.readlines(filename)[from-1..to-1]
+      end
+   end
+
+  # In block form, yields the last +num_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. Also note that 'tail -f' functionality is not
+  # present. See the 'file-tail' library for that.
+  #
+  # Example:
+  #
+  #   File.tail('somefile.txt') # => ['This is line7', 'This is line8', ...]
+  #
+  def self.tail(filename, num_lines=10)
+    if block_given?
+      IO.readlines(filename).reverse[0..num_lines-1].reverse.each{ |line|
+        yield line
+      }
+    else
+      IO.readlines(filename).reverse[0..num_lines-1].reverse
+    end
+  end
+
+   # Converts a text file from one OS platform format to another, ala
+   # 'dos2unix'. The possible values for +platform+ include:
+   #
+   # * MS Windows -> dos, windows, win32, mswin
+   # * Unix/BSD   -> unix, linux, bsd
+   # * Mac        -> mac, macintosh, apple, osx
+   #
+   # Note that this method is only valid for an ftype of "file".  Otherwise a
+   # TypeError will be raised.  If an invalid format value is received, an
+   # ArgumentError is raised.
+   #
+   def self.nl_convert(old_file, new_file = old_file, platform = 'dos')
+      unless File.file?(old_file)
+         raise ArgumentError, 'Only valid for plain text files'
+      end
+
+      if platform =~ /dos|windows|win32|mswin|cygwin|mingw/i
+         format = "\cM\cJ"
+      elsif platform =~ /unix|linux|bsd/i
+         format = "\cJ"
+      elsif platform =~ /mac|apple|macintosh|osx/i
+         format = "\cM"
+      else
+         raise ArgumentError, "Invalid platform string"
+      end
+
+      orig = $\
+      $\ = format
+
+      if old_file == new_file
+         require 'fileutils'
+         require 'tempfile'
+
+         begin
+            temp_name = Time.new.strftime("%Y%m%d%H%M%S")
+            tf = Tempfile.new('ruby_temp_' + temp_name)
+            tf.open
+
+            IO.foreach(old_file){ |line|
+               line.chomp!
+               tf.print line
+            }
+         ensure
+            tf.close if tf && !tf.closed?
+         end
+         File.delete(old_file)
+         FileUtils.cp(tf.path, old_file)
+      else
+         begin
+            nf = File.new(new_file, 'w')  
+            IO.foreach(old_file){ |line|
+               line.chomp!
+               nf.print line
+            }
+         ensure
+            nf.close if nf && !nf.closed?
+         end
+      end
+
+      $\ = orig
+      self
+   end
+
+  # Changes the access and modification time if present, or creates a 0
+  # byte file +filename+ if it doesn't already exist.
+  #
+  def self.touch(filename)
+    if File.exists?(filename)
+      time = Time.now
+      File.utime(time, time, filename)
+    else
+      File.open(filename, 'w'){}
+    end
+    self
+  end
+
+  # With no arguments, returns a four element array consisting of the number
+  # of bytes, characters, words and lines in filename, respectively.
+  #
+  # Valid options are 'bytes', 'characters' (or just 'chars'), 'words' and
+  # 'lines'.
+  #
+  def self.wc(filename, option='all')
+    option.downcase!
+    valid = %w/all bytes characters chars lines words/
+
+    unless valid.include?(option)
+      raise ArgumentError, "Invalid option: '#{option}'"
+    end
+
+    n = 0
+    if option == 'lines'
+      IO.foreach(filename){ n += 1 }
+      return n
+    elsif option == 'bytes'
+      File.open(filename){ |f|
+        f.each_byte{ n += 1 }
+      }
+      return n
+    elsif option == 'characters' || option == 'chars'
+      File.open(filename){ |f|
+        while f.getc
+          n += 1
+        end
+      }
+      return n
+    elsif option == 'words'
+      IO.foreach(filename){ |line|
+        n += line.split.length
+      }
+      return n
+    else
+      bytes,chars,lines,words = 0,0,0,0
+      IO.foreach(filename){ |line|
+        lines += 1
+        words += line.split.length
+        chars += line.split('').length
+      }
+      File.open(filename){ |f|
+        while f.getc
+          bytes += 1
+        end
+      }
+      return [bytes,chars,words,lines]
+    end
+  end
+
+  private
+
+  def self.bmp?(file)
+    IO.read(file, 3) == "BM6"
+  end
+
+  def self.jpg?(file)
+    IO.read(file, 10) == "\377\330\377\340\000\020JFIF"
+  end
+
+  def self.png?(file)
+    IO.read(file, 4) == "\211PNG"
+  end
+
+  def self.gif?(file)
+     ['GIF89a', 'GIF97a'].include?(IO.read(file, 6))
+  end
+end