open4 1.0.1 → 1.3.4

data/rakefile

@@ -0,0 +1,394 @@
+This.rubyforge_project = 'codeforpeople'
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "https://github.com/ahoward/#{ This.lib }"
+
+task :license do
+  open('LICENSE', 'w'){|fd| fd.puts "Ruby"}
+end
+
+task :default do
+  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 } -rubygems -w -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_files = ['test/log']
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        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')
+  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"
+  license     = object.respond_to?(:license) ? object.license : "Ruby"
+
+  if This.extensions.nil?
+    This.extensions = []
+    extensions = This.extensions
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  if This.dependencies.nil?
+    dependencies = []
+  else
+    case This.dependencies
+      when Hash
+        dependencies = This.dependencies.values
+      when Array
+        dependencies = This.dependencies
+    end
+  end
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## <%= lib %>.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = <%= lib.inspect %>
+            spec.version = <%= version.inspect %>
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = <%= lib.inspect %>
+            spec.description = <%= description.inspect %>
+            spec.license = <%= license.inspect %>
+
+            spec.files =\n<%= files.sort.pretty_inspect %>
+            spec.executables = <%= executables.inspect %>
+            
+            spec.require_path = "lib"
+
+            spec.test_files = <%= test_files.inspect %>
+
+            <% dependencies.each do |lib_version| %>
+              spec.add_dependency(*<%= Array(lib_version).flatten.inspect %>)
+            <% end %>
+
+            spec.extensions.push(*<%= extensions.inspect %>)
+
+            spec.rubyforge_project = <%= This.rubyforge_project.inspect %>
+            spec.author = <%= This.author.inspect %>
+            spec.email = <%= This.email.inspect %>
+            spec.homepage = <%= This.homepage.inspect %>
+          end
+        __
+      }
+    end
+
+  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)
+  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.join(This.pkgdir, File.basename(gem))
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -I ./lib #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'README.erb')
+      Template{ IO.read('README.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+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 = "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
+  puts
+  system(cmd)
+  abort("cmd(#{ cmd }) failed with (#{ $?.inspect })") unless $?.exitstatus.zero?
+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).sub(/[-].*$/, '')
+  end
+  This.lib = lib
+
+# grok version
+#
+  version = ENV['VERSION']
+  unless version
+    require "./lib/#{ This.lib }"
+    This.name = lib.capitalize
+    This.object = eval(This.name)
+    version = This.object.send(:version)
+  end
+  This.version = version
+
+# see if dependencies are export by the module
+#
+  if This.object.respond_to?(:dependencies)
+    This.dependencies = This.object.dependencies
+  end
+
+# 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)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each_line do |line|
+      next if line =~ %r/^\s*$/
+      indent = line[%r/^\s*/] and break
+    end
+    indent ? s.gsub(%r/^#{ indent }/, "") : s
+  end
+    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).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/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)

data/samples/pfork4.rb

@@ -0,0 +1,24 @@
+require 'open4'
+
+echo = lambda do
+  $stdout.write $stdin.read
+  raise 'finish implementing me'
+end
+
+org_message = "hello, world!"
+got_message = nil
+exception   = nil
+
+begin
+  Open4.pfork4(echo) do |cid, stdin, stdout, stderr|
+    stdin.write org_message
+    stdin.close
+    got_message = stdout.read
+  end
+rescue RuntimeError => e
+  exception = e.to_s
+end
+
+puts "org_message: #{org_message}"
+puts "got_message: #{got_message}"
+puts "exception  : #{exception}"

data/test/lib/test_case.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+require 'minitest/autorun'
+require 'open4'
+require 'rbconfig'
+
+module Open4
+  class TestCase < MiniTest::Unit::TestCase
+    include Open4
+
+    # Custom exception class for tests so we don't shadow possible
+    # programming errors.
+    class MyError < RuntimeError; end
+
+    def on_mri?
+      ::RbConfig::CONFIG['ruby_install_name'] == 'ruby'
+    end
+
+    def wait_status(cid)
+      Process.waitpid2(cid).last.exitstatus
+    end
+  end
+end