open4 1.0.1 → 1.1.0

data/LICENSE

@@ -0,0 +1,3 @@
+same as Ruby's
+
+http://www.ruby-lang.org/en/LICENSE.txt

data/Rakefile

@@ -1,18 +1,66 @@
-
 This.rubyforge_project = 'codeforpeople'
 This.author = "Ara T. Howard"
 This.email = "ara.t.howard@gmail.com"
-This.homepage = "http://github.com/ahoward/#{ This.lib }/tree/master"
+This.homepage = "https://github.com/ahoward/#{ This.lib }"
 
 
 task :default do
-  puts(Rake::Task.tasks.map{|task| task.name} - ['default'])
+  puts((Rake::Task.tasks.map{|task| task.name.gsub(/::/,':')} - ['default']).sort)
+end
+
+task :test do
+  run_tests!
+end
+
+namespace :test do
+  task(:unit){ run_tests!(:unit) }
+  task(:functional){ run_tests!(:functional) }
+  task(:integration){ run_tests!(:integration) }
+end
+
+def run_tests!(which = nil)
+  which ||= '**'
+  test_dir = File.join(This.dir, "test")
+  test_glob ||= File.join(test_dir, "#{ which }/**_test.rb")
+  test_rbs = Dir.glob(test_glob).sort
+        
+  div = ('=' * 119)
+  line = ('-' * 119)
+
+  test_rbs.each_with_index do |test_rb, index|
+    testno = index + 1
+    command = "#{ This.ruby } -I ./lib -I ./test/lib #{ test_rb }"
+
+    puts
+    say(div, :color => :cyan, :bold => true)
+    say("@#{ testno } => ", :bold => true, :method => :print)
+    say(command, :color => :cyan, :bold => true)
+    say(line, :color => :cyan, :bold => true)
+
+    system(command)
+
+    say(line, :color => :cyan, :bold => true)
+
+    status = $?.exitstatus
+
+    if status.zero? 
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("SUCCESS", :color => :green, :bold => true)
+    else
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("FAILURE", :color => :red, :bold => true)
+    end
+    say(line, :color => :cyan, :bold => true)
+
+    exit(status) unless status.zero?
+  end
 end
 
 
 task :gemspec do
-  ignore_extensions = 'git', 'svn', 'tmp', /sw./, 'bak', 'gem'
-  ignore_directories = 'pkg'
+  ignore_extensions = ['git', 'svn', 'tmp', /sw./, 'bak', 'gem']
+  ignore_directories = ['pkg']
+  ignore_files = ['test/log']
 
   shiteless = 
     lambda do |list|
@@ -26,17 +74,26 @@ task :gemspec do
         dirname = File.expand_path(entry)
         ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
       end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
     end
 
   lib         = This.lib
+  object      = This.object
   version     = This.version
   files       = shiteless[Dir::glob("**/**")]
   executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
-  has_rdoc    = true #File.exist?('doc')
+  #has_rdoc    = true #File.exist?('doc')
   test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+  summary     = object.respond_to?(:summary) ? object.summary : "summary: #{ lib } kicks the ass"
+  description = object.respond_to?(:description) ? object.description : "description: #{ lib } kicks the ass"
 
-  extensions = This.extensions
-  if extensions.nil?
+  if This.extensions.nil?
+    This.extensions = []
+    extensions = This.extensions
     %w( Makefile configure extconf.rb ).each do |ext|
       extensions << ext if File.exists?(ext)
     end
@@ -57,18 +114,17 @@ task :gemspec do
             spec.version = #{ version.inspect }
             spec.platform = Gem::Platform::RUBY
             spec.summary = #{ lib.inspect }
+            spec.description = #{ description.inspect }
 
-            spec.description = "manage child processes and their io handles easily"
-
-            spec.files = #{ files.inspect }
+            spec.files =\n#{ files.sort.pretty_inspect }
             spec.executables = #{ executables.inspect }
             
             spec.require_path = "lib"
 
-            spec.has_rdoc = #{ has_rdoc.inspect }
             spec.test_files = #{ test_files.inspect }
-            #spec.add_dependency 'lib', '>= version'
-            #spec.add_dependency 'fattr'
+
+          ### spec.add_dependency 'lib', '>= version'
+          #### spec.add_dependency 'map'
 
             spec.extensions.push(*#{ extensions.inspect })
 
@@ -81,22 +137,23 @@ task :gemspec do
       }
     end
 
-  open("#{ lib }.gemspec", "w"){|fd| fd.puts template}
-  This.gemspec = "#{ lib }.gemspec"
+  Fu.mkdir_p(This.pkgdir)
+  gemspec = "#{ lib }.gemspec"
+  open(gemspec, "w"){|fd| fd.puts(template)}
+  This.gemspec = gemspec
 end
 
 task :gem => [:clean, :gemspec] do
-  Fu.mkdir_p This.pkgdir
+  Fu.mkdir_p(This.pkgdir)
   before = Dir['*.gem']
   cmd = "gem build #{ This.gemspec }"
   `#{ cmd }`
   after = Dir['*.gem']
   gem = ((after - before).first || after.first) or abort('no gem!')
-  Fu.mv gem, This.pkgdir
-  This.gem = File.basename(gem)
+  Fu.mv(gem, This.pkgdir)
+  This.gem = File.join(This.pkgdir, File.basename(gem))
 end
 
-
 task :readme do
   samples = ''
   prompt = '~ > '
@@ -113,7 +170,7 @@ task :readme do
     cmd = "ruby #{ sample }"
     samples << Util.indent(prompt + cmd, 2) << "\n\n"
 
-    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -Ilib #{ sample })'"
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -I ./lib #{ sample })'"
     samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
   end
 
@@ -150,9 +207,18 @@ task :release => [:clean, :gemspec, :gem] do
   gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
   raise "which one? : #{ gems.inspect }" if gems.size > 1
   raise "no gems?" if gems.size < 1
-  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.pkgdir }/#{ This.gem }"
+
+  cmd = "gem push #{ This.gem }"
+  puts cmd
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
+
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.gem }"
   puts cmd
-  system cmd
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
 end
 
 
@@ -160,37 +226,63 @@ end
 
 
 BEGIN {
+# support for this rakefile
+#
   $VERBOSE = nil
 
   require 'ostruct'
   require 'erb'
   require 'fileutils'
+  require 'rbconfig'
+  require 'pp'
 
+# fu shortcut
+#
   Fu = FileUtils
 
+# cache a bunch of stuff about this rakefile/environment
+#
   This = OpenStruct.new
 
   This.file = File.expand_path(__FILE__)
   This.dir = File.dirname(This.file)
   This.pkgdir = File.join(This.dir, 'pkg')
 
+# grok lib
+#
   lib = ENV['LIB']
   unless lib
-    lib = File.basename(Dir.pwd)
+    lib = File.basename(Dir.pwd).sub(/[-].*$/, '')
   end
   This.lib = lib
 
+# grok version
+#
   version = ENV['VERSION']
   unless version
-    name = lib.capitalize
-    require "./lib/#{ lib }"
-    version = eval(name).send(:version)
+    require "./lib/#{ This.lib }"
+    This.name = lib.capitalize
+    This.object = eval(This.name)
+    version = This.object.send(:version)
   end
   This.version = version
 
+# we need to know the name of the lib an it's version
+#
   abort('no lib') unless This.lib
   abort('no version') unless This.version
 
+# discover full path to this ruby executable
+#
+  c = Config::CONFIG
+  bindir = c["bindir"] || c['BINDIR']
+  ruby_install_name = c['ruby_install_name'] || c['RUBY_INSTALL_NAME'] || 'ruby'
+  ruby_ext = c['EXEEXT'] || ''
+  ruby = File.join(bindir, (ruby_install_name + ruby_ext))
+  This.ruby = ruby
+
+# some utils
+#
   module Util
     def indent(s, n = 2)
       s = unindent(s)
@@ -200,7 +292,7 @@ BEGIN {
 
     def unindent(s)
       indent = nil
-      s.each do |line|
+      s.each_line do |line|
       next if line =~ %r/^\s*$/
       indent = line[%r/^\s*/] and break
     end
@@ -209,17 +301,71 @@ BEGIN {
     extend self
   end
 
+# template support
+#
   class Template
     def initialize(&block)
       @block = block
       @template = block.call.to_s
     end
     def expand(b=nil)
-      ERB.new(Util.unindent(@template)).result(b||@block)
+      ERB.new(Util.unindent(@template)).result((b||@block).binding)
     end
     alias_method 'to_s', 'expand'
   end
   def Template(*args, &block) Template.new(*args, &block) end
 
+# colored console output support
+#
+  This.ansi = {
+    :clear      => "\e[0m",
+    :reset      => "\e[0m",
+    :erase_line => "\e[K",
+    :erase_char => "\e[P",
+    :bold       => "\e[1m",
+    :dark       => "\e[2m",
+    :underline  => "\e[4m",
+    :underscore => "\e[4m",
+    :blink      => "\e[5m",
+    :reverse    => "\e[7m",
+    :concealed  => "\e[8m",
+    :black      => "\e[30m",
+    :red        => "\e[31m",
+    :green      => "\e[32m",
+    :yellow     => "\e[33m",
+    :blue       => "\e[34m",
+    :magenta    => "\e[35m",
+    :cyan       => "\e[36m",
+    :white      => "\e[37m",
+    :on_black   => "\e[40m",
+    :on_red     => "\e[41m",
+    :on_green   => "\e[42m",
+    :on_yellow  => "\e[43m",
+    :on_blue    => "\e[44m",
+    :on_magenta => "\e[45m",
+    :on_cyan    => "\e[46m",
+    :on_white   => "\e[47m"
+  }
+  def say(phrase, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options[:color] = args.shift.to_s.to_sym unless args.empty?
+    keys = options.keys
+    keys.each{|key| options[key.to_s.to_sym] = options.delete(key)}
+
+    color = options[:color]
+    bold = options.has_key?(:bold)
+
+    parts = [phrase]
+    parts.unshift(This.ansi[color]) if color
+    parts.unshift(This.ansi[:bold]) if bold
+    parts.push(This.ansi[:clear]) if parts.size > 1
+
+    method = options[:method] || :puts
+
+    Kernel.send(method, parts.join)
+  end
+
+# always run out of the project dir
+#
   Dir.chdir(This.dir)
 }

data/lib/open4.rb

@@ -4,14 +4,12 @@ require 'timeout'
 require 'thread'
 
 module Open4
-#--{{{
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
   def self.version() VERSION end
 
   class Error < ::StandardError; end
 
   def popen4(*cmd, &b)
-#--{{{
     pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe
 
     verbose = $VERBOSE
@@ -74,14 +72,12 @@ module Open4
     else
       [cid, pw.last, pr.first, pe.first]
     end
-#--}}}
   end
   alias open4 popen4
   module_function :popen4
   module_function :open4
 
   class SpawnError < Error
-#--{{{
     attr 'cmd'
     attr 'status'
     attr 'signals'
@@ -98,11 +94,9 @@ module Open4
       sigs = @signals.map{|k,v| "#{ k }:#{ v.inspect }"}.join(' ')
       super "cmd <#{ cmd }> failed with status <#{ exitstatus.inspect }> signals <#{ sigs }>"
     end
-#--}}}
   end
 
   class ThreadEnsemble
-#--{{{
     attr 'threads'
 
     def initialize cid
@@ -154,18 +148,14 @@ module Open4
     def all_done
       @threads.size.times{ @done.pop }
     end
-#--}}}
   end
 
   def to timeout = nil
-#--{{{
     Timeout.timeout(timeout){ yield }
-#--}}}
   end
   module_function :to
 
   def new_thread *a, &b
-#--{{{
     cur = Thread.current
     Thread.new(*a) do |*a|
       begin
@@ -174,34 +164,32 @@ module Open4
         cur.raise e
       end
     end
-#--}}}
   end
   module_function :new_thread
 
   def getopts opts = {}
-#--{{{
     lambda do |*args|
       keys, default, ignored = args
-      catch('opt') do
+      catch(:opt) do
         [keys].flatten.each do |key|
           [key, key.to_s, key.to_s.intern].each do |key|
-            throw 'opt', opts[key] if opts.has_key?(key)
+            throw :opt, opts[key] if opts.has_key?(key)
           end
         end
         default
       end
     end
-#--}}}
   end
   module_function :getopts
 
   def relay src, dst = nil, t = nil
-#--{{{
     send_dst =
       if dst.respond_to?(:call)
         lambda{|buf| dst.call(buf)}
+      elsif dst.respond_to?(:<<)
+        lambda{|buf| dst << buf }
       else
-        lambda{|buf| dst << buf}
+        lambda{|buf| buf }
       end
 
     unless src.nil?
@@ -242,12 +230,10 @@ module Open4
         send_dst[buf]
       end
     end
-#--}}}
   end
   module_function :relay
 
   def spawn arg, *argv 
-#--{{{
     argv.unshift(arg)
     opts = ((argv.size > 1 and Hash === argv.last) ? argv.pop : {})
     argv.flatten!
@@ -323,7 +309,6 @@ module Open4
       (ignore_exit_failure or (status.nil? and ignore_exec_failure) or exitstatus.include?(status.exitstatus))
 
     status
-#--}}}
   end
   module_function :spawn
 
@@ -334,7 +319,6 @@ module Open4
   module_function :chdir
 
   def background arg, *argv 
-#--{{{
     require 'thread'
     q = Queue.new
     opts = { 'pid' => q, :pid => q }
@@ -352,14 +336,12 @@ module Open4
       define_method(:exitstatus){ @exitstatus ||= spawn_status.exitstatus }
     }
     thread
-#--}}}
   end
   alias bg background
   module_function :background
   module_function :bg
 
   def maim pid, opts = {}
-#--{{{
     getopt = getopts opts
     sigs = getopt[ 'signals', %w(SIGTERM SIGQUIT SIGKILL) ]
     suspend = getopt[ 'suspend', 4 ]
@@ -377,12 +359,10 @@ module Open4
       return true unless alive? pid
     end
     return(not alive?(pid)) 
-#--}}}
   end
   module_function :maim
 
   def alive pid
-#--{{{
     pid = Integer pid
     begin
       Process.kill 0, pid
@@ -390,12 +370,10 @@ module Open4
     rescue Errno::ESRCH
       false
     end
-#--}}}
   end
   alias alive? alive
   module_function :alive
   module_function :'alive?'
-#--}}}
 end
 
 def open4(*cmd, &b) cmd.size == 0 ? Open4 : Open4::popen4(*cmd, &b) end

data/open4.gemspec

@@ -3,26 +3,44 @@
 
 Gem::Specification::new do |spec|
   spec.name = "open4"
-  spec.version = "1.0.1"
+  spec.version = "1.1.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "open4"
+  spec.description = "description: open4 kicks the ass"
 
-  spec.description = "manage child processes and their io handles easily"
+  spec.files =
+["LICENSE",
+ "README",
+ "README.erb",
+ "Rakefile",
+ "lib",
+ "lib/open4.rb",
+ "open4.gemspec",
+ "samples",
+ "samples/bg.rb",
+ "samples/block.rb",
+ "samples/exception.rb",
+ "samples/jesse-caldwell.rb",
+ "samples/simple.rb",
+ "samples/spawn.rb",
+ "samples/stdin_timeout.rb",
+ "samples/timeout.rb",
+ "white_box",
+ "white_box/leak.rb"]
 
-  spec.files = ["lib", "lib/open4.rb", "open4.gemspec", "Rakefile", "README", "README.erb", "samples", "samples/bg.rb", "samples/block.rb", "samples/exception.rb", "samples/simple.rb", "samples/spawn.rb", "samples/stdin_timeout.rb", "samples/timeout.rb", "white_box", "white_box/leak.rb"]
   spec.executables = []
   
   spec.require_path = "lib"
 
-  spec.has_rdoc = true
   spec.test_files = nil
-  #spec.add_dependency 'lib', '>= version'
-  #spec.add_dependency 'fattr'
+
+### spec.add_dependency 'lib', '>= version'
+#### spec.add_dependency 'map'
 
   spec.extensions.push(*[])
 
   spec.rubyforge_project = "codeforpeople"
   spec.author = "Ara T. Howard"
   spec.email = "ara.t.howard@gmail.com"
-  spec.homepage = "http://github.com/ahoward/open4/tree/master"
+  spec.homepage = "https://github.com/ahoward/open4"
 end

data/samples/jesse-caldwell.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+require 'open4'
+require 'pp'
+
+# define a function we can call later. the function will take two
+# arguments:
+#     command   which we will run via open4 and be able to
+#               send stdin as well as collect the pid, stderr and stdout.
+#     input     optional data string to send to command on stdin
+#
+# this returns a hash of the command's pid, stderr, stdout, and status.
+def run_cmd(command, input = nil)
+
+ # we will use open4 in block form, which means that the variables
+ # used inside the block will not be available once open4 has
+ # finished. as long as variables are declared outside of the
+ # block, they can be set inside the block and are available after
+ # the block has finished.
+ err = out = procid = status = verbose = nil
+
+ # using a begin so we can use rescue later on.
+ begin
+
+   # run our command with open4 in block form.
+   stat = Open4::popen4(command) do |pid, stdin, stdout, stderr|
+
+     # the default behavior of ruby is to internally buffer I/O
+     # ports when they are opened. open4 may not detect that stderr
+     # and/or stdout has closed because ruby is helpfully buffering
+     # the pipe for us. if open4 hangs, try uncommenting the next
+     # two lines.
+     # stderr.sync = true
+     # stdout.sync = true
+
+     # set procid to pid so we can see it outside of the block.
+     procid = pid
+
+     # if you want to use stdin, talk to stdin here. i tried it
+     # with bc. generally i only need to capture output, not
+     # interact with commands i'm running.
+     stdin.puts input if input
+
+     # stdin is opened write only. you'll raise an exception if
+     # you try to read anything from it. here you can try to read
+     # the first character from stdin.
+     # stdin.gets(1)
+
+     # now close stdin.
+     stdin.close
+
+     # make stderr and stdout available outside the block as well.
+     # removing the read will return pointers to objects rather
+     # than the data that the objects contain.
+     out = stdout.read
+     err = stderr.read
+
+     # as stdin is write-only, stderr and stdout are read only.
+     # you'll raise an exception if you try to write to either.
+     # stderr.puts 'building appears to be on fire'
+
+   # end of open4 block. pid, stdin, stdout and stderr are no
+   # longer accessible.
+   end
+
+   # now outside of the open4 block, we can get the exit status
+   # of our command by calling stat.exitstatus.
+   status = stat.exitstatus
+
+ # our function returns status from a command. however, if you
+ # tell the function to run a command that does not exist, ruby
+ # will raise an exception. we will trap that exception here, make
+ # up a non-zero exit status, convert the ruby error to a string,
+ # and populate err with it.
+ rescue Errno::ENOENT => stderr
+   status = 1
+   err = stderr.to_s
+
+ # handle null commands gracefully
+ rescue TypeError => stderr
+   status = 2
+   err = 'Can\'t execute null command.'
+
+ # done calling and/or rescuing open4.
+ end
+
+ # uncomment to make function print output.
+ verbose = true
+
+ # print the values if verbose is not nil.
+ print "\n============================================================" if verbose
+ print "\ncommand: #{ command }" if verbose
+ print "\ninput  : \n\n#{ input }\n" if (verbose and input)
+ print "\npid    : #{ procid }" if verbose
+ print "\nstatus : #{ status }" if verbose
+ print "\nstdout : #{ out }\n" if verbose
+ print "\nstderr : #{ err }\n" if verbose
+ print "============================================================\n" if verbose
+
+ # now that (we think) we have handled everything, return a hash
+ # with the process id, standard error, standard output, and the
+ # exit status.
+ return {
+   :pid => procid,     # integer
+   :stderr => err,     # string
+   :stdout => out,     # string
+   :status => status,  # integer
+ }
+
+ # return terminates function. code here will not run!
+ print 'this will never show up.'
+
+# end of run_cmd function.
+end
+
+# this will raise an exception which our function will trap,
+# complaining that the command does not exist.
+cmd = run_cmd('/bin/does/not/exist')
+
+# something that will produce a fair amount of output. you do have
+# an nmap source tree lying around, right?
+cmd = run_cmd('cd nmap-5.51 ; ./configure')
+
+# bc, to illustrate using stdin.
+cmd = run_cmd('bc', "2^16\nquit")
+
+# uncomment to see hash returned by run_cmd function.
+# pp cmd
+
+# test function with null command
+cmd = run_cmd(nil)

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: open4
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -9,11 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-18 00:00:00 -06:00
-default_executable: 
+date: 2011-06-24 00:00:00 Z
 dependencies: []
 
-description: manage child processes and their io handles easily
+description: "description: open4 kicks the ass"
 email: ara.t.howard@gmail.com
 executables: []
 
@@ -22,21 +22,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/open4.rb
-- open4.gemspec
-- Rakefile
+- LICENSE
 - README
 - README.erb
+- Rakefile
+- lib/open4.rb
+- open4.gemspec
 - samples/bg.rb
 - samples/block.rb
 - samples/exception.rb
+- samples/jesse-caldwell.rb
 - samples/simple.rb
 - samples/spawn.rb
 - samples/stdin_timeout.rb
 - samples/timeout.rb
 - white_box/leak.rb
-has_rdoc: true
-homepage: http://github.com/ahoward/open4/tree/master
+homepage: https://github.com/ahoward/open4
 licenses: []
 
 post_install_message: 
@@ -45,21 +46,21 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: codeforpeople
-rubygems_version: 1.3.5
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: open4