webmat-capture_fu 0.0.1

data/README

@@ -0,0 +1,27 @@
+capture_fu is a small library that facilitates capture of stdout and stderr outputs. 
+
+This can be useful for testing console output of command-line tools or to wrap the use of another command-line tool inside your program.
+
+
+Usage
+
+Let's simply go by example:
+out = capture_output{ puts 'normal output' ; $stderr.puts 'error' ; 'the return value of the block' }
+#=> ["the return value of the block", "normal output\n", "error\n"]
+
+Or if you prefer:
+ret, out, err = capture_output{ puts 'normal output' ; $stderr.puts 'error' ; 'the return value of the block' }
+
+
+Note that the output generated inside capture_output's block is not displayed at the console.
+
+
+Installation
+
+gem install webmat-capture_fu --source=http://gems.github.com
+and
+require 'capture_fu'
+
+
+Authors
+- Mathieu Martin, webmat@gmail.com

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+require 'yaml'
+
+require "#{File.dirname(__FILE__)}/lib/capture_fu"
+
+
+NAME = 'capture_fu'
+
+windows = (RUBY_PLATFORM =~ /win32|cygwin/) rescue nil
+install_home = ENV['GEM_HOME'] ? "-i #{ENV['GEM_HOME']}" : ""
+SUDO = windows ? "" : "sudo"
+
+
+spec = Gem::Specification.new do |s|
+  s.name        = NAME
+  s.version     = CaptureFu::VERSION
+  s.summary     = "capture_fu facilitates the capture of stdout and stderr output"
+
+  s.authors     << "Mathieu Martin"
+  s.email       = "webmat@gmail.com"
+  s.homepage    = "http://github.com/webmat/capture_fu"
+  s.description = "capture_fu is a small library that facilitates capture of stdout " +
+    "and stderr output, of either subprocesses or plain old Ruby code."
+
+  s.files       = Dir['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*.rb']
+  s.test_files  = Dir['test/**/*.rb']
+
+  s.has_rdoc    = false
+end
+
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test
+
+
+namespace :gem do
+
+  ##Friggin' task doesn't work! wtf?
+  #task(:update_gemspec) do
+  #  File.open("#{NAME}.gemspec", 'w') do |f| 
+  #    f.write(spec.to_yaml)
+  #  end
+  #end
+
+  #Creates clobber_package, gem,  package, repackage tasks
+  #Note on clobber_package: fortunately, this will clobber the CODE package
+  Rake::GemPackageTask.new(spec) do |pkg| 
+    pkg.need_tar = true 
+  end
+
+  #Tasks gleaned from merb-core's Rakefile
+
+  desc "Run :package and install the resulting .gem"
+  task :install => :gem do
+    sh %{#{SUDO} gem install #{install_home} --local pkg/#{NAME}-#{CaptureFu::VERSION}.gem --no-rdoc --no-ri}
+  end
+
+  desc "Run :clean and uninstall the .gem"
+  task :uninstall do
+    sh %{#{SUDO} gem uninstall #{NAME}}
+  end
+end

data/TODO

@@ -0,0 +1,12 @@
+- capture_warnings(&block)
+
+- ability to capture stdout and stderr separately
+  - use pipe & filter to have them both separate as well as the final result in order :-)
+- make it possible to call in verbose mode and display the output at the console
+  in addition to capturing it
+
+- Documentation
+
+- For subprocess stderr redirect detection:
+  - add flexibility related to spaces between elements describing the redirect?
+- check out http://tldp.org/LDP/abs/html/io-redirection.html for more info on redirection

data/lib/capture_fu.rb

@@ -0,0 +1,58 @@
+module CaptureFu
+  VERSION = '0.0.1'
+
+  def capture_output(&block)
+    real_out, real_err = $stdout, $stderr
+    result = fake_out = fake_err = nil
+    begin
+      fake_out, fake_err = Helpers::PipeStealer.new, Helpers::PipeStealer.new
+      $stdout, $stderr = fake_out, fake_err
+      result = yield
+    ensure
+      $stdout, $stderr = real_out, real_err
+    end
+    return result, fake_out.captured, fake_err.captured
+  end
+
+  # This first implementation is only intended for batch executions.
+  # You can't pipe stuff programmatically to the child process.
+  def capture_process_output(command)
+
+    #capture stderr in the same stream
+    command << ' 2>&1' unless Helpers.stderr_already_redirected(command)
+
+    out = `#{command}`
+    return $?.exitstatus, out
+  end
+
+
+  private
+
+  module Helpers
+    
+    def self.stderr_already_redirected(command)
+      #Already redirected to stdout (valid for Windows)
+      return true if command =~ /2>&1\s*\Z/
+
+      #Redirected to /dev/null (this is clearly POSIX-dependent)
+      return true if command =~ /2>\/dev\/null\s*\Z/
+
+      return false
+    end
+
+    class PipeStealer < File
+      attr_reader :captured
+      def initialize
+        @captured = ''
+      end
+      def write(s)
+        @captured << s
+      end
+      def captured
+        return nil if @captured.empty?
+        @captured.dup
+      end
+    end
+
+  end #Helper module
+end

data/test/functional/capture_output_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CaptureOutputTest < Test::Unit::TestCase
+  include CaptureFu
+
+  def setup
+    super
+  end
+
+  def test_stdout
+    res, out, err = capture_output do 
+      puts 'jeez'
+    end
+    assert_nil res
+    assert_equal "jeez\n", out
+    assert_nil err
+  end
+
+  def test_stderr
+    res, out, err = capture_output do 
+      $stderr.puts 'jeez'
+    end
+    assert_nil res
+    assert_nil out
+    assert_equal "jeez\n", err
+  end
+
+  def test_return_value
+    res, out, err = capture_output do 
+      'jeez'
+    end
+    assert_equal 'jeez', res
+    assert_nil out
+    assert_nil err
+  end
+
+  def test_all_outputs_at_the_same_time
+    res, out, err = capture_output do 
+      puts 'jeez'
+      $stderr.puts 'jeez'
+      'jeez'
+    end
+    assert_equal 'jeez', res
+    assert_equal "jeez\n", out
+    assert_equal "jeez\n", err
+  end
+end

data/test/functional/capture_process_output_test.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CaptureProcessOutputTest < Test::Unit::TestCase
+  include CaptureFu
+
+  def setup
+    super
+  end
+
+  def test_successful_execution
+    res, out = capture_process_output('echo jeez')
+    assert_equal 0, res
+    assert_equal "jeez\n", out
+  end
+
+  def test_when_output_to_stderr
+    res, out = capture_process_output('ewrewrtegfdghg')  #This shouldn't be a valid command on too many OSes
+
+    # Should be reasonably OS-independent
+    assert_not_equal 0, res
+    assert_instance_of String, out
+
+    # Some of the following is probably strongly OS-dependent.
+    # I'm developing on OSX.
+    # Comments welcome.
+    assert_equal 127, res
+    assert !out.empty?
+    assert_match /ewrewrtegfdghg/, out
+  end
+
+  def test_ignored_stderr
+    res, out = capture_process_output('ewrewrtegfdghg  2>/dev/null')
+
+    #May not be OS-independent
+    assert out.empty?
+  end
+
+  def test_already_redirected_stderr
+    res, out = capture_process_output('ewrewrtegfdghg 2>&1')
+
+    #May not be OS-independent
+    assert !out.empty?
+    assert_match /ewrewrtegfdghg/, out
+  end
+end

data/test/unit/intrusiveness_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+#These test names are made for rSpec, I know.
+
+class CaptureFuNotIncludedByDefaultTest < Test::Unit::TestCase
+
+  def test__method__not_polluting_namespace_when_not_explicitly_included
+    assert_raise(NoMethodError) do
+      res, out, err = capture_output do 
+        puts 'jeez'
+      end
+    end
+  end
+end
+
+class CaptureFuNotIntrusiveWhenIncludedTest < Test::Unit::TestCase
+  include CaptureFu
+
+  def test__utility_classes__not_polluting_namespace_when_not_explicitly_included
+    assert_raise(NameError) do
+      PipeStealer.new
+    end
+  end
+
+  def test__utility_methods__not_polluting_namespace
+    assert_raise(NoMethodError) do 
+      stderr_already_redirected('echo jeez')
+    end
+  end
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: webmat-capture_fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mathieu Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: capture_fu is a small library that facilitates capture of stdout and stderr output, of either subprocesses or plain old Ruby code.
+email: webmat@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README
+- TODO
+- lib/capture_fu.rb
+- test/capture_output_test.rb
+- test/functional/capture_output_test.rb
+- test/functional/capture_process_output_test.rb
+- test/unit/capture_output_test.rb
+- test/unit/intrusiveness_test.rb
+has_rdoc: false
+homepage: http://github.com/webmat/capture_fu
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: capture_fu facilitates the capture of stdout and stderr output
+test_files: 
+- test/capture_output_test.rb
+- test/functional/capture_output_test.rb
+- test/functional/capture_process_output_test.rb
+- test/unit/capture_output_test.rb
+- test/unit/intrusiveness_test.rb