cheetah 0.3.0 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.4.0 (2013-11-21)
+------------------
+
+* Implemented incremental logging. The input and both outputs of the executed
+  command are now logged one-by-line by the default recorder. A custom recorder
+  can record them on even finer granularity.
+* Dropped support of Ruby 1.8.7.
+* Added support of Ruby 2.0.0.
+* Internal code improvements.
+
 0.3.0 (2012-06-21)
 ------------------
 

data/README.md

@@ -164,7 +164,7 @@ For more information, see the
 Compatibility
 -------------
 
-Cheetah should run well on any Unix system with Ruby 1.8.7 or 1.9.3. Non-Unix
+Cheetah should run well on any Unix system with Ruby 1.9.3 or 2.0.0. Non-Unix
 systems and different Ruby implementations/versions may work too but they were
 not tested.
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/cheetah.rb

@@ -90,35 +90,36 @@ module Cheetah
     abstract_method :record_commands
 
     # @!method record_stdin(stdin)
-    #   Called to record the executed command input (if it wasn't read from a
-    #   stream).
+    #   Called to record part of the executed command input.
     #
     #   @abstract
-    #   @param [String] stdin the executed command input
+    #   @param [String] stdin part of the executed command input
     abstract_method :record_stdin
 
-    # @!method record_status(status)
-    #   Called to record the executed command exit status.
-    #
-    #   @abstract
-    #   @param [Process::Status] status the executed command exit status
-    abstract_method :record_status
-
     # @!method record_stdout(stdout)
-    #   Called to record the output the executed command wrote to stdout (if it
-    #   wasn't captured into a stream).
+    #   Called to record part of the output the executed command wrote to
+    #   stdout.
     #
     #   @abstract
-    #   @param [String] stdout the output the executed command wrote to stdout
+    #   @param [String] stdout part of the output the executed command wrote to
+    #     stdout
     abstract_method :record_stdout
 
     # @!method record_stderr(stderr)
-    #   Called to record the output the executed command wrote to stderr (if it
-    #   wasn't captured into a stream).
+    #   Called to record part of the output the executed command wrote to
+    #   stderr.
     #
     #   @abstract
-    #   @param [String] stderr the output the executed command wrote to stderr
+    #   @param [String] stderr part of the output the executed command wrote to
+    #     stderr
     abstract_method :record_stderr
+
+    # @!method record_status(status)
+    #   Called to record the executed command exit status.
+    #
+    #   @abstract
+    #   @param [Process::Status] status the executed command exit status
+    abstract_method :record_status
   end
 
   # A recorder that does not record anyting. Used by {Cheetah.run} when no
@@ -126,17 +127,27 @@ module Cheetah
   class NullRecorder < Recorder
     def record_commands(commands); end
     def record_stdin(stdin);       end
-    def record_status(status);     end
     def record_stdout(stdout);     end
     def record_stderr(stderr);     end
+    def record_status(status);     end
   end
 
   # A default recorder. It uses the `Logger::INFO` level for normal messages and
   # the `Logger::ERROR` level for messages about errors (non-zero exit status or
   # non-empty error output). Used by {Cheetah.run} when a logger is passed.
   class DefaultRecorder < Recorder
+    # @private
+    STREAM_INFO = {
+      :stdin  => { :name => "Standard input",  :method => :info  },
+      :stdout => { :name => "Standard output", :method => :info  },
+      :stderr => { :name => "Error output",    :method => :error }
+    }
+
     def initialize(logger)
       @logger = logger
+
+      @stream_used   = { :stdin => false, :stdout => false, :stderr => false }
+      @stream_buffer = { :stdin => "",    :stdout => "",    :stderr => "" }
     end
 
     def record_commands(commands)
@@ -144,32 +155,54 @@ module Cheetah
     end
 
     def record_stdin(stdin)
-      @logger.info "Standard input: #{format_input_output(stdin)}"
-    end
-
-    def record_status(status)
-      @logger.send status.success? ? :info : :error,
-        "Status: #{status.exitstatus}"
+      log_stream_increment(:stdin, stdin)
     end
 
     def record_stdout(stdout)
-      @logger.info "Standard output: #{format_input_output(stdout)}"
+      log_stream_increment(:stdout, stdout)
     end
 
     def record_stderr(stderr)
-      @logger.send stderr.empty? ? :info : :error,
-        "Error output: #{format_input_output(stderr)}"
+      log_stream_increment(:stderr, stderr)
     end
 
-    protected
+    def record_status(status)
+      log_stream_remainder(:stdin)
+      log_stream_remainder(:stdout)
+      log_stream_remainder(:stderr)
 
-    def format_input_output(s)
-      s.empty? ? "(none)" : s
+      @logger.send status.success? ? :info : :error,
+        "Status: #{status.exitstatus}"
     end
 
+    protected
+
     def format_commands(commands)
       '"' + commands.map { |c| Shellwords.join(c) }.join(" | ") + '"'
     end
+
+    def log_stream_increment(stream, data)
+      @stream_buffer[stream] + data =~ /\A((?:.*\n)*)(.*)\z/
+      lines, rest = $1, $2
+
+      lines.each_line { |l| log_stream_line(stream, l) }
+
+      @stream_used[stream] = true
+      @stream_buffer[stream] = rest
+    end
+
+    def log_stream_remainder(stream)
+      if @stream_used[stream] && !@stream_buffer[stream].empty?
+        log_stream_line(stream, @stream_buffer[stream])
+      end
+    end
+
+    def log_stream_line(stream, line)
+      @logger.send(
+        STREAM_INFO[stream][:method],
+        "#{STREAM_INFO[stream][:name]}: #{line.chomp}"
+      )
+    end
   end
 
   # @private
@@ -322,18 +355,15 @@ module Cheetah
       recorder = build_recorder(options)
 
       recorder.record_commands(commands)
-      recorder.record_stdin(streams[:stdin].string) unless streamed[:stdin]
 
       pid, pipes = fork_commands(commands)
-      select_loop(streams, pipes)
+      select_loop(streams, pipes, recorder)
       pid, status = Process.wait2(pid)
 
       begin
         check_errors(commands, status, streams, streamed)
       ensure
         recorder.record_status(status)
-        recorder.record_stdout(streams[:stdout].string) unless streamed[:stdout]
-        recorder.record_stderr(streams[:stderr].string) unless streamed[:stderr]
       end
 
       build_result(streams, options)
@@ -449,7 +479,7 @@ module Cheetah
       [pid, pipes]
     end
 
-    def select_loop(streams, pipes)
+    def select_loop(streams, pipes, recorder)
       # We write the command's input and read its output using a select loop.
       # Why? Because otherwise we could end up with a deadlock.
       #
@@ -465,6 +495,10 @@ module Cheetah
         pipes[:stdout][READ] => streams[:stdout],
         pipes[:stderr][READ] => streams[:stderr]
       }
+      recorder_methods = {
+        pipes[:stdout][READ] => :record_stdout,
+        pipes[:stderr][READ] => :record_stderr
+      }
       pipes_readable = [pipes[:stdout][READ], pipes[:stderr][READ]]
       pipes_writable = [pipes[:stdin][WRITE]]
       loop do
@@ -482,10 +516,14 @@ module Cheetah
 
         ios_read.each do |pipe|
           begin
-            outputs[pipe] << pipe.readpartial(4096)
+            data = pipe.readpartial(4096)
           rescue EOFError
             pipe.close
+            next
           end
+
+          outputs[pipe] << data
+          recorder.send(recorder_methods[pipe], data)
         end
 
         ios_write.each do |pipe|
@@ -496,6 +534,7 @@ module Cheetah
           end
 
           n = pipe.syswrite(stdin_buffer)
+          recorder.record_stdin(stdin_buffer[0...n])
           stdin_buffer = stdin_buffer[n..-1]
         end
       end

metadata

@@ -1,128 +1,118 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cheetah
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - David Majda
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-21 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: abstract_method
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 2
-        version: "1.2"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: redcarpet
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: Your swiss army knife for executing external commands in Ruby safely and conveniently.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Your swiss army knife for executing external commands in Ruby safely
+  and conveniently.
 email: dmajda@suse.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - CHANGELOG
 - LICENSE
 - README.md
 - VERSION
 - lib/cheetah.rb
 - lib/cheetah/version.rb
-has_rdoc: true
 homepage: https://github.com/openSUSE/cheetah
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Your swiss army knife for executing external commands in Ruby safely and conveniently.
+summary: Your swiss army knife for executing external commands in Ruby safely and
+  conveniently.
 test_files: []
-
+has_rdoc: