command_utils 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0751ad0ace2f2c6163ce2f9063983bec3a144235
-  data.tar.gz: 4b4d127135dedce36e4797d2ed6afb8520ee8fc9
+  metadata.gz: 4991e3855f226e37e49caf964e057ba3344dba28
+  data.tar.gz: df365e0070852ec25222cc916631bbd8a3f16b0b
 SHA512:
-  metadata.gz: 8c8b90bacde267555dd47922c3de5e5ec4ccd18076d73e759aacffde9dc50e82b884812c40846dbd24282ff841a1ace9dcabc14d34e5456eb16f5d638d0e8425
-  data.tar.gz: 4fae3852a2c9f830f18cc662100410b4427ea5589e06ff2b4d73fe092dd51463616781b74f0888b93773511ab506e8f0be9dc986cb99f728b3dd3bf67c3a602e
+  metadata.gz: e0709414a5649afbd1999eeb46daf7e940c246fdc111aa7df37bd5c83a907fce11f162aee29faeb57c6f7ec5dcdade4e68cd29194b1f94f58dd931aa9d54c830
+  data.tar.gz: 43aee5e4542f6c67df965151797cda5513ec140512ec03a7e16e157140be82182e2197f7e3d26775fd942130e0a2a0298fec0455c9438ca7344e696766f02a75

data/lib/command_utils/line_buffer.rb

@@ -0,0 +1,37 @@
+class CommandUtils
+
+  # Line buffers writes, and calls method at each line
+  class LineBuffer
+    # Receive a method to call passing each line received. Optionally, specify a prefix.
+    def initialize method, prefix=''
+      @method = method
+      @prefix = prefix
+      @buffer = nil
+    end
+
+    # Receive a new chunk, and if a line is formed, call method.
+    def write str
+      @buffer ||= ''
+      @buffer += str
+      return unless @buffer.include? "\n"
+      lines = @buffer.split("\n")
+      @buffer = if @buffer.match("\n$")
+        nil
+      else
+        lines.pop
+      end
+      lines.each do |line|
+        @method.call(@prefix + line)
+      end
+    end
+
+    # Send all buffer to method
+    def flush
+      return unless @buffer
+      @method.call(@prefix + @buffer)
+      @buffer = nil
+    end
+
+  end
+
+end

data/lib/command_utils.rb

@@ -1,4 +1,5 @@
 require_relative 'command_utils/non_zero_status'
+require_relative 'command_utils/line_buffer'
 
 # Class to assist calling external commands, while processing its output and return code.
 # All methods which execute given command, raise NonZeroStatus if its return is not 0.
@@ -10,7 +11,7 @@ class CommandUtils
     yield self if block_given?
   end
 
-  # Execute command, yielding to given block, each time there is output.
+  # Execute command, yielding to given block, each time there is output available.
   # stream:: either +:stdout+ or +:stderr+.
   # data:: data read from respective stream.
   def each_output # :yields: stream, data
@@ -35,15 +36,43 @@ class CommandUtils
     end
   end
 
-  # Takes command in same format supported by Process#spawn.
-  # Execute command, yielding to given block, each time there is output.
-  # stream:: either +:stdout+ or +:stderr+.
-  # data:: data read from respective stream.
+  # Wrapper for CommandUtils#each_output
   def self.each_output *command, &block # :yields: stream, data
     self.new(*command).each_output(&block)
   end
 
-  # Execute command, logging its output to given Logger object.
+  # Execute command, yielding to given block, each time there is a new line available.
+  # stream:: either +:stdout+ or +:stderr+.
+  # data:: data read from respective stream.
+  def each_line &block # :yields: stream, data
+    stdout_lb = LineBuffer.new(
+      proc do |data|
+        block.call :stdout, data
+      end
+      )
+    stderr_lb = LineBuffer.new(
+      proc do |data|
+        block.call :stderr, data
+      end
+      )
+    each_output do |stream, data|
+      case stream
+      when :stdout
+        stdout_lb.write data
+      when :stderr
+        stderr_lb.write data
+      end
+    end
+    stdout_lb.flush
+    stderr_lb.flush
+  end
+
+  # Wrapper for CommandUtils#each_line
+  def self.each_line *command, &block # :yields: stream, data
+    self.new(*command).each_line(&block)
+  end
+
+  # Execute command, logging its output, line buffered, to given Logger object.
   # Must receive a hash, containing at least:
   # +:logger+:: Logger instance.
   # +:stdout_level+:: Logger level to log stdout.
@@ -52,23 +81,14 @@ class CommandUtils
   # +:stdout_prefix+:: Prefix to use for all stdout messages.
   # +:stderr_prefix+:: Prefix to use for all stderr messages.
   def logger_exec options
-    logger = options[:logger]
-    each_output do |stream, data|
+    each_line do |stream, data|
       level = options["#{stream}_level".to_sym]
       prefix = options["#{stream}_prefix".to_sym]
-      logger.send(level, "#{prefix}#{data}")
+      options[:logger].send(level, "#{prefix}#{data}")
     end
   end
 
-  # Takes command in same format supported by Process#spawn.
-  # Execute command, logging its output to given Logger object.
-  # Must receive a hash, containing at least:
-  # +:logger+:: Logger instance.
-  # +:stdout_level+:: Logger level to log stdout.
-  # +:stderr_level+:: Logger level to log stderr.
-  # and optionally:
-  # +:stdout_prefix+:: Prefix to use for all stdout messages.
-  # +:stderr_prefix+:: Prefix to use for all stderr messages.
+  # Wrapper for CommandUtils@logger_exec
   def self.logger_exec command, options
     self.new(command).logger_exec(options)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Fabio Pugliese Ornellas
@@ -66,6 +66,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/command_utils.rb
+- lib/command_utils/line_buffer.rb
 - lib/command_utils/non_zero_status.rb
 homepage: https://github.com/fornellas/command_utils
 licenses: