em-systemcommand 1.0.0 → 1.0.1

data/lib/em-systemcommand/version.rb

@@ -1,5 +1,5 @@
 module Em
   module Systemcommand
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/em-systemcommand.rb

@@ -9,6 +9,9 @@ module EventMachine
   class SystemCommand
     include EM::SystemCommand::PipeHandler
     include EM::Deferrable
+    extend Forwardable
+
+    def_delegators :@command, :<<, :add
 
     pipe_handler :stdin,  EM::SystemCommand::Pipe
     pipe_handler :stdout, EM::SystemCommand::Pipe
@@ -16,6 +19,20 @@ module EventMachine
 
     attr_accessor :pipes, :stdin, :stdout, :stderr
 
+    ##
+    # Prepares a `SystemCommand` object.
+    #
+    # An easy way is to use the `Builder` idea:
+    #
+    #     cmd = EM::SystemCommand.new 'echo'
+    #     cmd << :n
+    #     cmd << 'Some text to put out.'
+    #     cmd.execute do |on|
+    #       on.success do
+    #         puts 'Yay!'
+    #       end
+    #     end
+    #
     def initialize *args, &block
       @pipes = {}
       @command = EM::SystemCommand::Builder.new *args
@@ -23,12 +40,18 @@ module EventMachine
       @execution_proc = block
     end
 
+    ##
+    # Convinience method to quickly execute a command.
     def self.execute *args, &block
       sys_cmd = EM::SystemCommand.new *args, &block
       sys_cmd.execute
     end
 
-    # Executes the command
+    ##
+    # Executes the command from the `Builder` object.
+    # If there had been given a block at instantiation it will be
+    # called after the `popen3` call and after the pipes have been
+    # attached.
     def execute &block
       raise 'Previous process still exists' unless pipes.empty?
 
@@ -50,10 +73,20 @@ module EventMachine
       self
     end
 
+    ##
+    # Returns the command string.
+    def command
+      @command.to_s
+    end
+
+    ##
+    # Returns the pid of the child process.
     def pid
       @wait_thr.pid
     end
 
+    ##
+    # Returns the status object of the popen3 call.
     def status
       @wait_thr.value
     end
@@ -61,6 +94,8 @@ module EventMachine
     alias_method :success, :callback
     alias_method :failure, :errback
 
+    ##
+    # Called by child pipes when they get unbound.
     def unbind name
       pipes.delete name
       if pipes.empty?
@@ -72,6 +107,8 @@ module EventMachine
       end
     end
 
+    ##
+    # Kills the child process.
     def kill signal = 'TERM', wait = false
       Process.kill signal, self.pid
       val = status if wait
@@ -80,6 +117,5 @@ module EventMachine
       @stderr.close
       val
     end
-
   end
 end

data/spec/em-systmcommand_spec.rb

@@ -82,6 +82,17 @@ describe EM::SystemCommand do
     end
   end
 
+  it 'should proxy builder commands' do
+    EM.run do
+      cmd = EM::SystemCommand.new 'echo'
+      cmd << '-n'
+      cmd.add 'Something\n'
+      cmd.execute
+      EM.stop_event_loop
+    end
+  end
+
+
   describe 'subclass' do
     before :all do
       class DummyCmd < EM::SystemCommand;end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-systemcommand
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -147,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1884745858443868072
+      hash: -2860876855106188560
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1884745858443868072
+      hash: -2860876855106188560
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24