em-systemcommand 2.0.0 → 2.0.1

data/lib/em-systemcommand/pipe.rb

@@ -1,18 +1,23 @@
+# -*- coding: utf-8 -*-
 module EventMachine
   class SystemCommand
     class Pipe < EM::Connection
 
-      def initialize(master, name)
+      def initialize master, name
         @master             = master
         @name               = name
         @master.pipes[name] = self
         begin
-          @outputbuffer     = StringIO.new()
+          @outputbuffer     = StringIO.new
         rescue Exception => e
           puts "Uninitialized constant StringIO. This may happen when you forgot to use bundler. Use `bundle exec`."
         end
       end
 
+      ##
+      # The content of the output buffer as string.
+      #
+      # @return [String] The connections output
       def output
         @outputbuffer.string
       end
@@ -20,6 +25,10 @@ module EventMachine
       ##
       # Convenience method to create a callback that matches a regular
       # expression
+      #
+      # @param [Regexp] regexp The regular expression that should be matched
+      # @option opt [Symbol] :in Match either in `:line` or `:output`
+      # @option opt [Symbol] :match Match either `:first` or `:last`
       def match regexp, opt = {}, &block
         opt = { in: :line, match: :first }.merge opt
         (opt[:in] == :output ? receive_update_callbacks : receive_line_callbacks) << lambda do |data|
@@ -35,68 +44,115 @@ module EventMachine
         end
       end
 
+      ##
       # Invoked when line was received
+      #
+      # @param [String] line The line that´s received
       def receive_line line
         receive_line_callbacks.each do |callback|
           callback.call line.dup
         end
       end
 
+      ##
       # Adds a callback for `receive_line` events.
+      #
+      # @yield The callback that should be added to callback array for line events
+      # @yieldparam [String] line The line that has been received
       def line &block
         receive_line_callbacks << block
       end
 
+      ##
       # Invoked when a line was written, but `\r` was received without
       # a line-break in the end.
+      #
+      # @param [String] buffer The complete buffer content of this connection
       def receive_update buffer
         receive_update_callbacks.each do |callback|
           callback.call buffer.dup
         end
       end
 
+      ##
       # Adds a callback for `receive_update` events.
+      #
+      # @yield The callback that should be added to callback array for update events
+      # @yieldparam [String] buffer The complete buffer content of this connection
       def update &block
         receive_update_callbacks << block
       end
 
+      ##
       # Invoked when data was received.
+      #
+      # @param [String] data The received data
       def receive_data data, recursive = false
+        # if recursive is true we already invoked the receive data callbacks!
         unless recursive
           receive_data_callbacks.each do |callback|
             callback.call data.dup
           end
         end
         @linebuffer ||= []
-        @cr_offset    = 0
+        @lf_offset  ||= 0
 
         parse_crlf data
 
         receive_update @outputbuffer.string unless recursive
       end
 
+      ##
+      # Parses carriage return when data is received.
+      #
+      # @param [String] data The received data
+      # @param [Integer] ix The index of the carriage return
       def parse_cr data, ix
         ln = (@linebuffer << data[0...ix]).join
         @linebuffer.clear
+
         receive_line ln
         @outputbuffer.print ln
-        @outputbuffer.pos = @cr_offset
-        parse_crlf data[(ix+1)..-1] # receive rest data
+
+        # jump back to the last line feed
+        @outputbuffer.pos = @lf_offset
+
+        # parse rest of the data
+        parse_crlf data[(ix+1)..-1]
       end
 
+      ##
+      # Parses line feed when data is received.
+      #
+      # @param [String] data The received data
+      # @param [Integer] ix The index of the line feed
       def parse_lf data, ix
         ln = (@linebuffer << data[0...ix]).join
         @linebuffer.clear
         ln.chomp!
+
         receive_line ln
         @outputbuffer.print ln
+
+        # jump to the end of the buffer to keep the characters, that
+        # may already have been written
         @outputbuffer.pos = @outputbuffer.length
+        # print the line feed
         @outputbuffer.puts
-        @cr_offset = @outputbuffer.pos
-        parse_crlf data[(ix+1)..-1] # receive rest data
+        # set last line feed to the current cursor position, so we
+        # know where we have to jump back, when a carriage return occurs
+        @lf_offset = @outputbuffer.pos
+
+        # parse rest of the data
+        parse_crlf data[(ix+1)..-1]
       end
 
+      ##
+      # Parse received data for line feeds or carriage returns.
+      #
+      # @param [String] data The received data
       def parse_crlf data
+        return if data == ''
         if ilf = data.index("\n")
           # if we find a LF and that LF is after a CR we first handle
           # the CR
@@ -115,11 +171,16 @@ module EventMachine
         end
       end
 
+      ##
       # Adds a callback for `receive_data` events.
+      #
+      # @yield The callback that´s to be added to the data callback array
+      # @yieldparam [String] data The data that´s received
       def data &block
         receive_data_callbacks << block
       end
 
+      ##
       # Close the attached IO object.
       def close
         begin

data/lib/em-systemcommand/version.rb

@@ -1,5 +1,5 @@
 module Em
   module Systemcommand
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
   end
 end

data/spec/em-systemcommand/pipe_spec.rb

@@ -2,6 +2,27 @@ require 'spec_helper'
 
 describe 'Pipe' do
 
+  context 'parsing' do
+
+    it 'should handle carriage returns' do
+      cmd = EM::SystemCommand.new 'exit 0;'
+      pipe = EM::SystemCommand::Pipe.new(nil, cmd, :stdout)
+      pipe.receive_data "test\n"
+      pipe.receive_data "       32768   0%    0.00kB/s    0:00:00\r"
+      pipe.receive_data "   131235840  12%  125.12MB/s    0:00:06\r"
+      pipe.receive_data "   261619712  25%  124.80MB/s    0:00:05\r"
+      pipe.receive_data "   391544832  38%  124.54MB/s    0:00:04\r"
+      pipe.receive_data "   522616832  51%  124.69MB/s    0:00:03\r"
+      pipe.receive_data "   652738560  63%  124.43MB/s    0:00:02\r"
+      pipe.receive_data "   783056896  76%  124.41MB/s    0:00:01\r"
+      pipe.receive_data "   906657792  88%  122.90MB/s    0:00:00\r"
+      pipe.receive_data "  1024000000 100%  123.67MB/s    0:00:07 (xfer#1, to-check=0/1)\n"
+      pipe.receive_data "\n"
+      pipe.receive_data "sent 1024125065 bytes  received 31 bytes  120485305.41 bytes/sec\ntotal size is 1024000000  speedup is 1.00\n"
+      pipe.output.should == "test\n  1024000000 100%  123.67MB/s    0:00:07 (xfer#1, to-check=0/1)\n\nsent 1024125065 bytes  received 31 bytes  120485305.41 bytes/sec\ntotal size is 1024000000  speedup is 1.00\n"
+    end
+  end
+
   context '#receive_data' do
     it 'should correctly do a carriage return in the output buffer' do
       EM.run do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-systemcommand
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -163,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1829514624315752226
+      hash: -2179568276682517415
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1829514624315752226
+      hash: -2179568276682517415
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24