unix_utils 0.0.14 → 0.0.15

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.0.15 / 2012-11-09
+
+* Enhancements
+
+  * Back to stdlib open3 because C extension support is not enabled by default in JRuby 1.7+
+
+* Known issues
+
+  * stderr is not captured in JRuby 1.7.0 because of https://jira.codehaus.org/browse/JRUBY-6986
+
 0.0.14 / 2012-07-06
 
 * Breaking changes

data/Gemfile

@@ -1,9 +1,3 @@
 source :rubygems
 
 gemspec
-
-# development dependencies
-gem 'minitest'
-gem 'minitest-reporters'
-gem 'yard'
-# gem 'ruby-prof'

data/README.markdown

@@ -2,7 +2,9 @@
 
 Like FileUtils, but provides zip, unzip, bzip2, bunzip2, tar, untar, sed, du, md5sum, shasum, cut, head, tail, wc, unix2dos, dos2unix, iconv, curl, perl, etc.
 
-Works in MRI 1.8.7+, MRI 1.9.2+, and JRuby 1.6.7+
+You must have these binaries in your `PATH`. _Not_ a pure-ruby implementation of all these UNIX greats!
+
+Works in MRI 1.8.7+, MRI 1.9.2+, and JRuby 1.6.7+. No gem dependencies; uses stdlib
 
 ## Real-world usage
 
@@ -79,13 +81,18 @@ This will load an entire file into memory before it can be processed...
 
 You get the same low memory footprint with
 
-    str = UnixUtils.shasum('kittens.zip', 256)
+    str = UnixUtils.shasum 'kittens.zip', 256
 
 ## Compatibility
 
-Now using [`posix-spawn`](https://github.com/rtomayko/posix-spawn) for speed. Thanks for the suggestion [jjb](https://github.com/jjb)!
+Uses `open3` because it's in the Ruby stdlib and is consistent across MRI and JRuby.
+
+## Wishlist
 
-Previously used `open3` because it's in the Ruby stdlib and is consistent across MRI and JRuby.
+* cheat sheet based on [GNU Coreutils cheat sheet](www.catonmat.net/download/gnu-coreutils-cheat-sheet.pdf)
+* yarddocs
+* properly use Dir.tmpdir(name), etc.
+* smarter tmp file name generation - don't include url params for curl, etc.
 
 ## Authors
 
@@ -93,4 +100,4 @@ Previously used `open3` because it's in the Ruby stdlib and is consistent across
 
 ## Copyright
 
-Copyright (c) 2012 Brighter Planet. See LICENSE for details.
+Copyright (c) 2012 Seamus Abshere

data/lib/unix_utils.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 require 'tmpdir'
 require 'uri'
 require 'stringio'
-require 'posix/spawn'
+require 'open3'
 require 'securerandom'
 require "unix_utils/version"
 
@@ -14,14 +14,14 @@ module UnixUtils
     outfile = tmp_path url
     if url.start_with?('file://') or not url.include?('://')
       # deal with local files
-      infile = ::File.expand_path url.sub('file://', '')
+      infile = File.expand_path url.sub('file://', '')
       unless File.readable?(infile)
         raise "[unix_utils] #{url.inspect} does not exist or is not readable on the local filesystem."
       end
-      ::FileUtils.cp infile, outfile
+      FileUtils.cp infile, outfile
       return outfile
     end
-    uri = ::URI.parse url
+    uri = URI.parse url
     argv = [ 'curl', '--location', '--show-error', '--silent', '--compressed', '--header', 'Expect: ' ]
     if form_data
       argv += [ '--data', form_data ]
@@ -42,7 +42,7 @@ module UnixUtils
   # $ sha256sum --binary .bash_profile
   # 01b1210962b3d1e5e1ccba26f93d98efbb7b315b463f9f6bdb40ab496728d886 *.bash_profile
   def self.shasum(infile, algorithm)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     if available?('shasum')
       argv = ['shasum', '--binary', '-a', algorithm.to_s, infile]
       stdout = spawn argv
@@ -62,7 +62,7 @@ module UnixUtils
   # $ md5sum --binary .mysql_history
   # 8d01e54ab8142d6786850e22d55a1b6c *.mysql_history
   def self.md5sum(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     if available?('md5sum')
       argv = ['md5sum', '--binary', infile]
       stdout = spawn argv
@@ -75,14 +75,14 @@ module UnixUtils
   end
 
   def self.du(srcdir)
-    srcdir = ::File.expand_path srcdir
+    srcdir = File.expand_path srcdir
     argv = ['du', '-sk', srcdir]
     stdout = spawn argv
     stdout.strip.split(/\s+/).first.to_i
   end
 
   def self.wc(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     argv = ['wc', infile]
     stdout = spawn argv
     stdout.strip.split(/\s+/)[0..2].map { |s| s.to_i }
@@ -91,25 +91,25 @@ module UnixUtils
   # --
 
   def self.unzip(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     destdir = tmp_path infile
-    ::FileUtils.mkdir destdir
+    FileUtils.mkdir destdir
     argv = ['unzip', '-qq', '-n', infile, '-d', destdir]
     spawn argv
     destdir
   end
 
   def self.untar(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     destdir = tmp_path infile
-    ::FileUtils.mkdir destdir
+    FileUtils.mkdir destdir
     argv = ['tar', '-xf', infile, '-C', destdir]
     spawn argv
     destdir
   end
 
   def self.gunzip(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = ['gunzip', '--stdout', infile]
     spawn argv, :write_to => outfile
@@ -117,7 +117,7 @@ module UnixUtils
   end
 
   def self.bunzip2(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = ['bunzip2', '--stdout', infile]
     spawn argv, :write_to => outfile
@@ -127,7 +127,7 @@ module UnixUtils
   # --
 
   def self.bzip2(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile, '.bz2'
     argv = ['bzip2', '--keep', '--stdout', infile]
     spawn argv, :write_to => outfile
@@ -135,7 +135,7 @@ module UnixUtils
   end
 
   def self.tar(srcdir)
-    srcdir = ::File.expand_path srcdir
+    srcdir = File.expand_path srcdir
     outfile = tmp_path srcdir, '.tar'
     argv = ['tar', '-cf', outfile, '-C', srcdir, '.']
     spawn argv
@@ -143,7 +143,7 @@ module UnixUtils
   end
 
   def self.zip(srcdir)
-    srcdir = ::File.expand_path srcdir
+    srcdir = File.expand_path srcdir
     outfile = tmp_path srcdir, '.zip'
     argv = ['zip', '-rq', outfile, '.']
     spawn argv, :chdir => srcdir
@@ -151,7 +151,7 @@ module UnixUtils
   end
 
   def self.gzip(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile, '.gz'
     argv = ['gzip', '--stdout', infile]
     spawn argv, :write_to => outfile
@@ -161,7 +161,7 @@ module UnixUtils
   # --
 
   def self.awk(infile, *expr)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     bin = available?('gawk') ? 'gawk' : 'awk'
     argv = [bin, expr, infile].flatten
@@ -171,7 +171,7 @@ module UnixUtils
 
   # Yes, this is a very limited use of perl.
   def self.perl(infile, *expr)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = [ 'perl', expr.map { |e| ['-pe', e] }, infile ].flatten
     spawn argv, :write_to => outfile
@@ -179,7 +179,7 @@ module UnixUtils
   end
 
   def self.unix2dos(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     if available?('gawk') or available?('awk')
       awk infile, '{ sub(/\r/, ""); printf("%s\r\n", $0) }'
     else
@@ -188,7 +188,7 @@ module UnixUtils
   end
 
   def self.dos2unix(infile)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     if available?('gawk') or available?('awk')
       awk infile, '{ sub(/\r/, ""); printf("%s\n", $0) }'
     else
@@ -198,7 +198,7 @@ module UnixUtils
 
   # POSIX sed, whether it's provided by sed or gsed
   def self.sed(infile, *expr)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     bin = available?('sed') ? 'sed' : ['gsed', '--posix']
     argv = [ bin, expr.map { |e| ['-e', e] }, infile ].flatten
@@ -207,7 +207,7 @@ module UnixUtils
   end
 
   def self.tail(infile, lines)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = ['tail', '-n', lines.to_s, infile]
     spawn argv, :write_to => outfile
@@ -215,7 +215,7 @@ module UnixUtils
   end
 
   def self.head(infile, lines)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = ['head', '-n', lines.to_s, infile]
     spawn argv, :write_to => outfile
@@ -224,7 +224,7 @@ module UnixUtils
 
   # specify character_positions as a string like "3-5" or "3,9-10"
   def self.cut(infile, character_positions)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = ['cut', '-c', character_positions, infile]
     spawn argv, :write_to => outfile
@@ -232,7 +232,7 @@ module UnixUtils
   end
 
   def self.iconv(infile, to, from)
-    infile = ::File.expand_path infile
+    infile = File.expand_path infile
     outfile = tmp_path infile
     argv = ['iconv', '-c', '-t', to, '-f', from, infile]
     spawn argv, :write_to => outfile
@@ -241,7 +241,7 @@ module UnixUtils
 
   def self.available?(bin) # :nodoc:
     bin = bin.to_s
-    return @@available_query[bin] if defined?(@@available_query) and @@available_query.is_a?(::Hash) and @@available_query.has_key?(bin)
+    return @@available_query[bin] if defined?(@@available_query) and @@available_query.is_a?(Hash) and @@available_query.has_key?(bin)
     @@available_query ||= {}
     `which #{bin}`
     @@available_query[bin] = $?.success?
@@ -249,84 +249,93 @@ module UnixUtils
 
   def self.tmp_path(ancestor, extname = nil) # :nodoc:
     ancestor = ancestor.to_s
-    extname ||= ::File.extname ancestor
-    basename = ::File.basename ancestor.gsub(/unix_utils_[a-f0-9]{8,}_/, '')
+    extname ||= File.extname ancestor
+    basename = File.basename ancestor.gsub(/unix_utils_[a-f0-9]{8,}_/, '')
     basename.gsub! /\W+/, '_'
-    ::File.join ::Dir.tmpdir, "unix_utils_#{::SecureRandom.hex(4)}_#{basename[0..(234-extname.length)]}#{extname}"
+    File.join Dir.tmpdir, "unix_utils_#{SecureRandom.hex(4)}_#{basename[0..(234-extname.length)]}#{extname}"
   end
 
   def self.spawn(argv, options = {}) # :nodoc:
-    options = options.dup
-
-    input = if (read_from = options.delete(:read_from))
-      ::File.open(read_from, 'r')
+    input = if (read_from = options[:read_from])
+      if RUBY_DESCRIPTION =~ /jruby 1.7.0/
+        raise "[unix_utils] Can't use `#{argv.first}` since JRuby 1.7.0 has a broken IO implementation!"
+      end
+      File.open(read_from, 'r')
     end
-
-    output = if (write_to = options.delete(:write_to))
+    output = if (write_to = options[:write_to])
       output_redirected = true
-      ::File.open(write_to, 'wb')
+      File.open(write_to, 'wb')
     else
       output_redirected = false
-      ::StringIO.new
-    end
-
-    error = ::StringIO.new
-
-    pid, stdin, stdout, stderr = ::POSIX::Spawn.popen4(*(argv+[options]))
-    
-    # lifted from posix-spawn
-    # https://github.com/rtomayko/posix-spawn/blob/master/lib/posix/spawn/child.rb
-    readers = [stdout, stderr]
-    writers = if input
-      [stdin]
-    else
-      stdin.close
-      []
+      StringIO.new
     end
-    while readers.any? or writers.any?
-      ready = ::IO.select(readers, writers, readers + writers)
-      # write to stdin stream
-      ready[1].each do |fd|
-        begin
-          boom = nil
-          size = fd.write(input.read(BUFSIZE))
-        rescue ::Errno::EPIPE => boom
-        rescue ::Errno::EAGAIN, ::Errno::EINTR
-        end
-        if boom || size < BUFSIZE
-          stdin.close
-          input.close
-          writers.delete(stdin)
-        end
-      end
-      # read from stdout and stderr streams
-      ready[0].each do |fd|
-        buf = (fd == stdout) ? output : error
-        begin
-          buf << fd.readpartial(BUFSIZE)
-        rescue ::Errno::EAGAIN, ::Errno::EINTR
-        rescue ::EOFError
-          readers.delete(fd)
-          fd.close
-        end
+    error = StringIO.new
+    if (chdir = options[:chdir])
+      Dir.chdir(chdir) do
+        _spawn argv, input, output, error
       end
+    else
+      _spawn argv, input, output, error
     end
-    # thanks @tmm1 and @rtomayko for showing how it's done!
-
-    ::Process.waitpid pid
-
     error.rewind
     unless (whole_error = error.read).empty?
       $stderr.puts "[unix_utils] `#{argv.join(' ')}` STDERR:"
       $stderr.puts whole_error
     end
-
     unless output_redirected
       output.rewind
       output.read
     end
   ensure
-    [stdin, stdout, stderr, input, output, error].each { |io| io.close if io and not io.closed? }
+    [input, output, error].each { |io| io.close if io and not io.closed? }
+  end
+
+  def self._spawn(argv, input, output, error)
+    # lifted from posix-spawn
+    # https://github.com/rtomayko/posix-spawn/blob/master/lib/posix/spawn/child.rb
+    Open3.popen3(*argv) do |stdin, stdout, stderr|
+      readers = [stdout, stderr]
+      if RUBY_DESCRIPTION =~ /jruby 1.7.0/
+        readers.delete stderr
+      end
+      writers = if input
+        [stdin]
+      else
+        stdin.close
+        []
+      end
+      while readers.any? or writers.any?
+        ready = IO.select(readers, writers, readers + writers)
+        # write to stdin stream
+        ready[1].each do |fd|
+          begin
+            boom = nil
+            size = fd.write input.read(BUFSIZE)
+          rescue Errno::EPIPE => boom
+          rescue Errno::EAGAIN, Errno::EINTR
+          end
+          if boom || size < BUFSIZE
+            stdin.close
+            input.close
+            writers.delete stdin
+          end
+        end
+        # read from stdout and stderr streams
+        ready[0].each do |fd|
+          buf = (fd == stdout) ? output : error
+          if fd.eof?
+            readers.delete fd
+            fd.close
+          else
+            begin
+              buf << fd.readpartial(BUFSIZE)
+            rescue Errno::EAGAIN, Errno::EINTR
+            end
+          end
+        end
+      end
+      # thanks @tmm1 and @rtomayko for showing how it's done!
+    end
   end
 
   def self.method_missing(method_id, *args)
@@ -334,9 +343,9 @@ module UnixUtils
     if respond_to?(base_method_id)
       begin
         outfile = send(*([base_method_id]+args))
-        ::File.read outfile
+        File.read outfile
       ensure
-        ::FileUtils.rm_f outfile
+        FileUtils.rm_f outfile
       end
     else
       super

data/lib/unix_utils/version.rb

@@ -1,3 +1,3 @@
 module UnixUtils
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/test/helper.rb

@@ -1,11 +1,13 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'pry'
 
 require 'minitest/spec'
 require 'minitest/autorun'
-require 'minitest/reporters'
-MiniTest::Unit.runner = MiniTest::SuiteRunner.new
-MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+if RUBY_VERSION >= '1.9'
+  require 'minitest/reporters'
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+end
 
 require 'unix_utils'
 

data/unix_utils.gemspec

@@ -17,5 +17,10 @@ Gem::Specification.new do |gem|
   gem.version       = UnixUtils::VERSION
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency 'posix-spawn'
+  gem.add_development_dependency 'minitest'
+  if RUBY_VERSION >= '1.9'
+    gem.add_development_dependency 'minitest-reporters'
+  end
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'pry'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unix_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,65 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-06 00:00:00.000000000 Z
+date: 2012-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: posix-spawn
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false