pipe-run 0.1.0 → 0.2.0

data/README.md

@@ -1,12 +1,24 @@
 Pipe Run
-===============
+========
 
 **Pipe Run** runs command and returns its standard output in one call:
 
     require "pipe-run"
-    output = Pipe.run("date")
+    output = Pipe.run("date")       # blocking
     
-    puts output     # will print out for example 'Thu Feb 17 17:22:18 CET 2011'
+    puts output         # will print out for example 'Thu Feb 17 17:22:18 CET 2011'
+    
+### Asynchronous Use
+
+In case, `eventmachine` is available, non-blocking run of the command is 
+possible using `#run_nonblock` or `#run` with block given, defined in 
+`em-pipe-run` file. So for example:
+
+    require "em-pipe-run"
+    
+    Pipe.run("date") do |output|    # non-blocking
+        puts output     # will print out for example 'Thu Feb 17 17:22:18 CET 2011'
+    end
     
 Contributing
 ------------

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "pipe-run"
   gem.homepage = "https://github.com/martinkozak/pipe-run"
   gem.license = "MIT"
-  gem.summary = 'Runs command and returns its standard output in one call.'
+  gem.summary = 'Runs command and returns its standard output in one call. Both synchronous and asynchronous (with eventmachine) running is supported.'
   gem.email = "martinkozak@martinkozak.net"
   gem.authors = ["Martin Kozák"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/em-pipe-run.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "eventmachine"
+require "pipe-run"
+
+##
+# Pipe class of the +pipe-run+. Currently with one static method only.
+#
+
+class Pipe
+    
+    ##
+    # EventMachine connection to pipe.
+    # @since 0.2.0
+    # 
+    
+    
+    class Receiver < EM::Connection
+    
+        ##
+        # Holds pipe output buffer.
+        #
+        
+        @buffer
+        
+        ##
+        # Holds callback for giving back the results.
+        #
+        
+        @callback
+        
+        ##
+        # Constructor.
+        # @param [Proc] callback callback for giving back the results
+        #
+        
+        def initialize(callback = nil)
+            @callback = callback
+            @buffer = ""
+        end
+        
+        ##
+        # Receives data from pipe.
+        # @param [String] data output from pipe
+        #
+        
+        def receive_data(data)
+            @buffer << data
+        end
+        
+        ##
+        # Action after terminating the connection. Calls callback.
+        #
+        
+        def unbind
+            if not @callback.nil?
+                @callback.call(@buffer)
+            end
+        end
+    end
+    
+    ##
+    # Runs the command and returns its standard output.
+    # Blocking.
+    #
+    # @param [String] command command for run
+    # @param [Proc] block callback for giving back the results
+    # @since 0.2.0
+    #
+
+    def self.run_nonblock(command, &block)
+        pipe = File.popen(command, "r")
+        EM::attach(pipe, Receiver, block)
+    end
+    
+end

data/lib/pipe-run.rb

@@ -9,13 +9,22 @@ class Pipe
 
     ##
     # Runs the command and returns its standard output.
-    # Blocking.
+    #
+    # If block is given, treat call as non-blocking. In that case, 
+    # +em-pipe-run+ file must be loaded.
     #
     # @param [String] command command for run
+    # @param [Proc] block block for giving back the results
     # @return [String] command output
     #
 
-    def self.run(command)
+    def self.run(command, &block)
+        if not block.nil?
+            return self.run_nonblock(command, &block)
+        end
+        
+        ###
+        
         pipe = File.popen(command, "r")
         
         result = pipe.read

data/pipe-run.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pipe-run}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Kozák"]
-  s.date = %q{2011-02-17}
+  s.date = %q{2011-02-22}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "lib/em-pipe-run.rb",
     "lib/pipe-run.rb",
     "pipe-run.gemspec"
   ]
@@ -30,7 +31,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Runs command and returns its standard output in one call.}
+  s.summary = %q{Runs command and returns its standard output in one call. Both synchronous and asynchronous (with eventmachine) running is supported.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -2,7 +2,7 @@
 name: pipe-run
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +01:00
+date: 2011-02-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- lib/em-pipe-run.rb
 - lib/pipe-run.rb
 - pipe-run.gemspec
 has_rdoc: true
@@ -68,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3787895221996818874
+      hash: -1865702309634779703
       segments: 
       - 0
       version: "0"
@@ -84,6 +85,6 @@ rubyforge_project:
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Runs command and returns its standard output in one call.
+summary: Runs command and returns its standard output in one call. Both synchronous and asynchronous (with eventmachine) running is supported.
 test_files: []