shell-executer 1.0.0 → 1.0.1

data/Rakefile

@@ -12,7 +12,7 @@ DESCRIPTION  = <<-EOS
 EOS
 AUTHOR       = 'Holger Kohnen'
 AUTHOR_EMAIL = 'h.kohnen@gmail.com'
-GEM_VERSION  = '1.0.0'
+GEM_VERSION  = '1.0.1'
 HOMEPAGE     = "http://#{TITLE}.rubyforge.org/"
 PROJECT_NAME = TITLE
 

data/lib/shell/executer.rb

@@ -15,7 +15,7 @@ module Shell
   end
 
   class Executer
-    # Holds last executed commands standard output if executed without block.
+    # Holds last executed commands standard output.
     attr_reader :stdout
 
     # Holds last executed commands error output.
@@ -27,9 +27,14 @@ module Shell
     #   In lines-mode every line of the output is passed to the block.
     #   In chars-mode every char of the output is passed to the block.
     #   (default is: <tt>:lines</tt>)
+    # * <tt>:no_buffer</tt> - Specifies the output mode.
+    #   Can be <tt>false</tt> or <tt>true</tt>.
+    #   If true no output is collected, stdout and stderr properties are empty.
+    #   (default is: <tt>false</tt>)
     def initialize(options={})
       @options = {
-        :mode => :lines # :chars|:lines <- output mode
+        :mode => :lines, # :chars|:lines <- output mode
+        :no_buffer => false
       }.merge(options)
 
       @reader = (@options[:mode] == :chars) ? proc {|s| s.getc } : proc {|s| s.gets }
@@ -49,10 +54,6 @@ module Shell
     # In the first form(<tt>execute(command)</tt>) the +command+ ist executed
     # and the +stdout+, +stderr+ and +success+ attributes are populated.
     #
-    # In the second and third form the +stdout+ attribute is *not* populated. The +stdout+
-    # is passed to the specified block instead. The block is invoked for
-    # every char or line of output depending on the specified <tt>options</tt>.
-    #
     # In the second form only the stdout is passed to the block.
     #
     # In the third form either stdout or stderr is filled. The opposite is allways nil.
@@ -69,45 +70,58 @@ module Shell
       @stderr = ''
       @success = nil
 
-      begin
-        threads = []
-        pid, stdin, stdout, stderr = Open4::popen4(command)
-        [[:stdout, stdout], [:stderr, stderr]].each do |type, stream|
-          threads << Thread.new(type, stream) do |type, stream|
-            Thread.current.abort_on_exception = true
-            while data = @reader.call(stream)
-              data = ((@options[:mode] == :chars) ? data.chr : data)
-              @mutex.synchronize do
-                if type == :stdout
-                  if block_given?
-                    if block.arity == 2
-                      yield data, nil
-                    else
-                      yield data
-                    end
-                  else
-                    @stdout += data
-                  end
+      pid, stdin, stdout, stderr = Open4::popen4(command)
+
+      status = nil
+      Thread.start do
+        status = Process.waitpid2(pid).last
+      end
+
+      streams = [stdout, stderr]
+      until streams.empty?
+        selected, = select(streams, nil, nil, 0.1)
+        next if selected.nil? or selected.empty?
+        selected.each do |stream|
+          if stream.eof?
+            streams.delete(stream) if status
+            next
+          end
+
+          while data = @reader.call(stream)
+            data = ((@options[:mode] == :chars) ? data.chr : data)
+            if block_given?
+              if block.arity == 2
+                args = [nil, nil]
+                if stream == stdout
+                  args[0] = data
                 else
-                  yield nil, data if block_given? && block.arity == 2
-                  @stderr += data
+                  args[1] = data
                 end
+                yield *args
+              else
+                if stream == stdout
+                  yield data
+                end
+              end
+            end
+            unless @options[:no_buffer]
+              if stream == stdout
+                @stdout += data
+              else
+                @stderr += data
               end
             end
           end
         end
-
-        ignored, status = Process::waitpid2 pid
-        @success = (status.exitstatus == 0)
-
-      ensure
-        threads.each(&:join)
-        stdin.close if stdin
-        stdout.close if stdout
-        stderr.close if stderr
       end
 
+      @success = (status.exitstatus == 0)
+
       self
+    ensure
+      stdin.close rescue nil
+      stdout.close rescue nil
+      stderr.close rescue nil
     end
 
     # :call-seq: execute!(command) -> Shell::Executer

data/test/test_executer.rb

@@ -1,4 +1,5 @@
 require 'expectations'
+
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/shell/executer.rb'))
 
 Expectations do
@@ -47,4 +48,12 @@ Expectations do
     Shell.execute!('ls /does_not_exist')
   end
 
+  expect false do
+    Shell.execute('ls /does_not_exist').success?
+  end
+
+  expect '' do
+    Shell.execute('echo test', no_buffer: true).stdout
+  end
+
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shell-executer
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Holger Kohnen
@@ -9,30 +14,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-30 00:00:00 +02:00
+date: 2010-11-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: open4
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: expectations
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Shell::Executer provides an easy and robust way to execute shell commands. The stdout and stderr data can be read completly after the execution or in chunks during the execution.
+  type: :runtime
+  version_requirements: *id002
+description: "  Shell::Executer provides an easy and robust way to execute shell commands.\n  The stdout and stderr data can be read completly after the execution or\n  in chunks during the execution.\n"
 email: h.kohnen@gmail.com
 executables: []
 
@@ -47,6 +58,8 @@ files:
 - README
 has_rdoc: true
 homepage: http://shell-executer.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -58,23 +71,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: shell-executer
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Shell::Executer provides an easy and robust way to execute shell commands. The stdout and stderr data can be read completly after the execution or in chunks during the execution.
 test_files: []