capture_io 0.1.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-10-02
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/capture_io
+lib/capture_io.rb
+test/test_capture_io.rb

data/README.txt

@@ -0,0 +1,54 @@
+= capture_io
+
+* http://cyberconnect.biz/opensource
+
+== DESCRIPTION:
+
+Capture STDOUT given a start/stop interface
+
+== FEATURES/PROBLEMS:
+
+* Often times one needs the ability to capture standard output around
+  a section of code.  And there are times required when this needs
+  to be done transparently without storing the output in variables
+  in the code requiring logging.
+
+== SYNOPSIS:
+
+capture_io = CaptureIO.new
+capture_io.start
+puts "some stdout should be captured here"
+out = capture_io.stop
+
+== REQUIREMENTS:
+
+* platform_helpers
+
+== INSTALL:
+
+* gem install capture_io
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'capture_io' do
+  developer('Cliff Cyphers', 'cliff.cyphers@gmail.com')
+  extra_deps << 'platform_helpers'
+  extra_deps << 'minitest'
+end
+
+# vim: syntax=ruby

data/bin/capture_io

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/capture_io.rb

@@ -0,0 +1,75 @@
+# TODO add support for stderr
+require 'fileutils'
+require 'platform_helpers'
+class CaptureIO
+  VERSION = '0.1.0'
+
+  attr_reader :stdout_file, :stderr_file
+  def initialize
+     unless File.directory?('io_redirect')
+       FileUtils.mkdir 'io_redirect'
+     end
+
+     base = "#{__FILE__}".gsub("#{File.dirname(__FILE__)}/", "")
+     
+     @stdout_file = "io_redirect/#{Time.to_md5}_#{base}_stdout"
+     @stderr_file = "io_redirect/#{Time.to_md5}_#{base}_stderr"
+     @stdout_fd = File.open(@stdout_file, 'w+')
+     @stderr_fd = File.open(@stderr_file, 'w+')
+  end
+  
+  def start
+     begin
+       @orig_stdout = $stdout
+       @orig_stderr = $stderr
+       
+       @new_stdout = IO.new(@stdout_fd.fileno, 'w+')
+       @new_stderr = IO.new(@stderr_fd.fileno, 'w+')
+       
+       $stdout = @new_stdout
+       $stderr = @new_stderr
+     rescue => e
+       p e
+     end
+   end
+   def stop(delete_tmp=true)
+     begin
+       @new_stdout.flush
+       @new_stderr.flush
+  
+       $stdout = @orig_stdout   
+       $stderr = @orig_stderr
+       
+       stdout_content = File.readlines(@stdout_file)
+       stderr_content = File.readlines(@stderr_file)     
+
+    rescue => e
+      p e
+    ensure
+      @new_stdout.close
+      @new_stderr.close
+      FileUtils.rm_rf 'io_redirect' if delete_tmp
+    end
+     
+     {:stdout => stdout_content, :stderr => stderr_content }       
+   end
+end
+
+module WrapIO
+  def self.auto(to=30, &blk)
+    raise ArgumentError, "No Block Given" unless block_given?
+    c = CaptureIO.new
+    c.start
+
+    results = blk.call
+    
+    timeout(to) {
+      while results.kind_of?(Proc) 
+        results = results.call
+      end
+    }
+    
+    out = c.stop
+    out
+  end
+end

data/test/test_capture_io.rb

@@ -0,0 +1,119 @@
+base = File.expand_path(File.dirname(__FILE__))
+require 'platform_helpers'
+require 'fileutils'
+require "#{base}/../lib/capture_io"
+require 'timeout'
+require 'minitest/unit'
+
+# NOTE: There are times when something might fail and if the
+# 'io_redirect' directory has been removed by CaptureIO.stop it
+# will be impossible to know what went wrong as the error may be in 
+# the re-directed out.  For debug purposes set 'delete_tmp=false'
+
+MiniTest::Unit.autorun
+
+class TestCaptureIO < MiniTest::Unit::TestCase
+  
+  def setup
+    @capture_io = CaptureIO.new
+    @capture_io.start
+  end
+  
+  def teardown
+  end
+
+  def test_puts
+    
+    expected = 'testing puts'
+    puts "<TEST_PUTS>#{expected}</TEST_PUTS>"
+    
+    # stop capture so we see results
+    stdout = @capture_io.stop(delete_tmp=true)[:stdout]    
+    assert_equal expected, stdout.to_s.scan(/<TEST_PUTS>(.*)<\/TEST_PUTS>/m).pp
+  end
+  
+  def test_p
+    expected = 'testing p'
+    p "<TEST_P>#{expected}</TEST_P>"
+    
+    # stop capture so we see results
+    stdout = @capture_io.stop(delete_tmp=true)[:stdout]    
+    assert_equal expected, stdout.to_s.scan(/<TEST_P>(.*)<\/TEST_P>/m).pp
+    
+  end
+  
+  def test_print
+    expected = 'testing print'
+    puts "<TEST_PRINT>#{expected}</TEST_PRINT>"
+    
+    # stop capture so we see results
+    stdout = @capture_io.stop(delete_tmp=true)[:stdout]
+    assert_equal expected, stdout.to_s.scan(/<TEST_PRINT>(.*)<\/TEST_PRINT>/m).pp
+    
+  end
+  
+  def test_auto_block
+    # stop instance created during setup
+    @capture_io.stop
+    
+    # test auto
+    out = WrapIO.auto { puts 'in blk with puts' ; p 'in blk with p'}
+    puts out.inspect
+    
+    assert out[:stdout].grep(/in blk with puts/m).nitems == 1 , "Could not find IO.puts"
+    
+    # account for both p and puts in the grep..KISS (keeping it simple)
+    assert out[:stdout].grep(/in blk with p/m).nitems == 2, "Could not find IO.p"
+  end
+  
+  def test_auto_block_with_loaded_code
+    
+    # here we want to ensure that vars set are seen by block
+    $global_= '$global test'
+    
+    # stop instance created during setup
+    @capture_io.stop
+    FileUtils.rm_rf 'io_redirect'
+    
+    code =<<-EOF
+      base = File.expand_path(File.dirname(__FILE__))
+      require 'platform_helpers'
+      require 'capture_io'
+      c = CaptureIO.new
+      c.start
+      p 'in blk with p'
+      p "with global: \#{$global_}"
+      $new_var=Time.now
+      $captured_out = c.stop(delete_tmp=true)
+    EOF
+    
+    proc = Proc.new do
+      eval code
+    end
+    
+    proc.call
+    
+    assert_equal $captured_out[:stdout].grep(/in blk with p/m).nitems, 1, "could not find IO.p"
+    assert_equal $captured_out[:stdout].grep(/with global: \$global test/m).nitems, 1, "could not find $global"
+    
+    # test that the var set inside of the code exec by proc is available here
+    assert $new_var.kind_of?(Time)
+  end
+
+  # FIXME: update capture_io.rb to handle STDERR
+  def ntest_stderr
+    expected = 'testing puts'
+    $stderr.puts "<TEST_P>#{expected}</TEST_P>"
+    # stop capture so we see results
+    stderr = @capture_io.stop(delete_tmp=false)[:stderr]    
+    assert_equal expected, stderr.to_s.scan(/<TEST_P>(.*)<\/TEST_P>/m).to_s
+  end
+  
+  def ntest_std_error_auto_block
+    raise StandardError, "Testing redefine of stderr"
+
+    @capture_io.stop(delete_tmp=true)
+    assert false, "TODO add test with supporting code in CaptureIO"    
+  end
+    
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: capture_io
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cliff Cyphers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: platform_helpers
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.12"
+  type: :development
+  version_requirements: *id003
+description: Capture STDOUT given a start/stop interface
+email: 
+- cliff.cyphers@gmail.com
+executables: 
+- capture_io
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/capture_io
+- lib/capture_io.rb
+- test/test_capture_io.rb
+- .gemtest
+homepage: http://cyberconnect.biz/opensource
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: capture_io
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Capture STDOUT given a start/stop interface
+test_files: 
+- test/test_capture_io.rb