right_popen 1.0.5 → 1.0.6

data/README.rdoc

@@ -41,8 +41,13 @@ to report issues.
 
   EM.run do
     EM.next_tick do
-      cmd = "ruby -e \"puts 'some stdout text'; $stderr.puts 'some stderr text'\; exit 99\""
-      RightScale.popen3(cmd, self, :on_read_stdout, :on_read_stderr, :on_exit)
+      command = "ruby -e \"puts 'some stdout text'; $stderr.puts 'some stderr text'\; exit 99\""
+      RightScale.popen3(:command        => command,
+                        :target         => self,
+                        :environment    => nil,
+                        :stdout_handler => :on_read_stdout,
+                        :stderr_handler => :on_read_stderr,
+                        :exit_handler   => :on_exit)
     end
     timer = EM::PeriodicTimer.new(0.1) do
       if @exit_status
@@ -90,7 +95,7 @@ The build can be tested using the RSpec gem. Create a link to the installed
 under Windows) and run the following command from the gem directory to execute
 the RightPopen tests:
 
-  spec spec/right_popen_spec.rb
+  rake spec
 
 
 == LICENSE

data/lib/linux/right_popen.rb

@@ -34,16 +34,18 @@ module RightScale
   module StdOutHandler
 
     # === Parameters
-    # target(Object):: Object defining handler methods to be called.
-    # stdout_handler(String):: Token for stdout handler method name.
-    # exit_handler(String):: Token for exit handler method name.
+    # options[:target](Object):: Object defining handler methods to be called.
+    # options[:stdout_handler(String):: Token for stdout handler method name.
+    # options[:exit_handler(String):: Token for exit handler method name.
+    # options[:exec_file](String):: Path to executed file
     # stderr_eventable(Connector):: EM object representing stderr handler.
     # read_fd(IO):: Standard output read file descriptor.
     # write_fd(IO):: Standard output write file descriptor.
-    def initialize(target, stdout_handler, exit_handler, stderr_eventable, read_fd, write_fd)
-      @target = target
-      @stdout_handler = stdout_handler
-      @exit_handler = exit_handler
+    def initialize(options, stderr_eventable, read_fd, write_fd)
+      @target = options[:target]
+      @stdout_handler = options[:stdout_handler]
+      @exit_handler = options[:exit_handler]
+      @exec_file = options[:exec_file]
       @stderr_eventable = stderr_eventable
       # Just so they don't get GCed before the process goes away
       @read_fd = read_fd
@@ -59,6 +61,7 @@ module RightScale
     def unbind
       # We force the attached stderr handler to go away so that
       # we don't end up with a broken pipe
+      File.delete(@exec_file) if File.file?(@exec_file)
       @stderr_eventable.force_detach if @stderr_eventable
       @target.method(@exit_handler).call(get_status) if @exit_handler
     end
@@ -99,9 +102,19 @@ module RightScale
   # Forks process to run given command asynchronously, hooking all three
   # standard streams of the child process.
   #
+  # === Parameters
+  # options[:temp_dir]:: Path to temporary directory where executable files are
+  #                      created, default to /tmp if not specified
+  #
   # See RightScale.popen3
   def self.popen3_imp(options)
-    cmd = options[:command].dup
+    # First write command to file so that it's possible to use popen3 with
+    # a bash command line (e.g. 'for i in 1 2 3 4 5; ...')
+    temp_dir = options[:temp_dir] || '/tmp'
+    exec_file = File.join(temp_dir, Time.new.to_i.to_s)
+    options[:exec_file] = exec_file
+    File.open(exec_file, 'w') { |f| f.puts options[:command] }
+    File.chmod(0700, exec_file)
     GC.start # To garbage collect open file descriptors from passed executions
     EM.next_tick do
       saved_stderr = $stderr.dup
@@ -120,7 +133,7 @@ module RightScale
       end
 
       # Launch child process
-      EM.popen(cmd, StdOutHandler, options[:target], options[:stdout_handler], options[:exit_handler], c, r, w)
+      EM.popen(exec_file, StdOutHandler, options, c, r, w)
 
       # Restore environment variables
       unless envs.empty?

data/right_popen.gemspec

@@ -1,14 +1,16 @@
 require 'rubygems'
 
-spec = Gem::Specification.new do |spec|
-  is_windows = RUBY_PLATFORM =~ /mswin/
+def is_windows?
+  return RUBY_PLATFORM =~ /mswin/
+end
 
+spec = Gem::Specification.new do |spec|
   spec.name      = 'right_popen'
-  spec.version   = '1.0.5'
+  spec.version   = '1.0.6'
   spec.authors   = ['Scott Messier', 'Raphael Simon']
   spec.email     = 'scott@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_popen'
-  if is_windows
+  if is_windows?
     spec.platform = 'x86-mswin32-60'
   else
     spec.platform  = Gem::Platform::RUBY
@@ -27,7 +29,7 @@ of its internal mechanisms. The Linux implementation is valid for any Linux
 platform but there is also a native implementation for Windows platforms.
 EOF
 
-  if is_windows
+  if is_windows?
     extension_dir = "ext,"
   else
     extension_dir = ""
@@ -38,7 +40,7 @@ EOF
     item.include?("Makefile") || item.include?(".obj") || item.include?(".pdb") || item.include?(".def") || item.include?(".exp") || item.include?(".lib")
   end
   candidates = candidates.delete_if do |item|
-    if is_windows
+    if is_windows?
       item.include?("/linux/")
     else
       item.include?("/win32/")
@@ -46,9 +48,13 @@ EOF
   end
   spec.files = candidates.sort!
 
-  # Current implementation supports > 0.12.8
+  # Current implementation supports >= 0.12.8
   spec.add_runtime_dependency(%q<eventmachine>, [">= 0.12.8"])
-  if is_windows
+  if is_windows?
+    # Windows implementation currently depends on deprecated behavior from
+    # 0.12.8, but we also need to support the 0.12.8.1 patch version. the Linux
+    # side is free to use 0.12.10+
+    spec.add_runtime_dependency(%q<eventmachine>, ["< 0.12.9"])
     spec.add_runtime_dependency(%q<win32-process>, [">= 0.6.1"])
   end
 end

data/spec/print_env.rb

@@ -1 +1,2 @@
-ENV.each { |k, v| $stdout.puts "#{k}=#{v}\n" }
+puts "__test__=#{ENV['__test__']}" if ENV['__test__']
+puts "PATH=#{ENV['PATH']}"

data/spec/right_popen_spec.rb

@@ -12,6 +12,10 @@ LARGE_OUTPUT_COUNTER = 1000
 # bump up count for most exhaustive leak detection.
 REPEAT_TEST_COUNTER = 256
 
+def is_windows?
+  return RUBY_PLATFORM =~ /mswin/
+end
+
 describe 'RightScale::popen3' do
 
   module RightPopenSpec
@@ -191,6 +195,26 @@ describe 'RightScale::popen3' do
     old_envs.each { |k, v| ENV[k].should == v }
   end
 
+  if is_windows?
+    # FIX: this behavior is currently specific to Windows but should probably be
+    # implemented for Linux.
+    it 'should merge the PATH variable instead of overriding it' do
+      command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'print_env.rb'))}\""
+      runner = RightPopenSpec::Runner.new
+      runner.run_right_popen(command, 'PATH' => "c:/bogus\\bin")
+      runner.status.exitstatus.should == 0
+      runner.output_text.should include('PATH=c:\\bogus\\bin;')
+    end
+  else
+    it 'should allow running bash command lines starting with a built-in command' do
+      command = "for i in 1 2 3 4 5; do echo $i;done"
+      runner = RightPopenSpec::Runner.new
+      runner.run_right_popen(command)
+      runner.status.exitstatus.should == 0
+      runner.output_text.should == "1\n2\n3\n4\n5\n"
+    end
+  end
+
   it 'should run repeatedly without leaking resources' do
     command = "\"#{RUBY_CMD}\" \"#{File.expand_path(File.join(File.dirname(__FILE__), 'produce_output.rb'))}\" \"#{STANDARD_MESSAGE}\" \"#{ERROR_MESSAGE}\""
     runner = RightPopenSpec::Runner.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: right_popen
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors: 
 - Scott Messier
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-19 00:00:00 -08:00
+date: 2010-03-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency