stdiotrap 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stdiotrap.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :cli => '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 moe@busyloop.net
+
+MIT License
+
+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/README.md

@@ -0,0 +1,48 @@
+# StdioTrap [![Build Status](https://travis-ci.org/busyloop/stdiotrap.png?branch=master)](https://travis-ci.org/busyloop/stdiotrap) [![Dependency Status](https://gemnasium.com/busyloop/stdiotrap.png)](https://gemnasium.com/busyloop/stdiotrap)
+
+StdioTrap lets you capture stdout, stderr at runtime,
+e.g. for inspection inside a unit-test. It can also fake stdin.
+
+## Example (rspec)
+
+```ruby
+require 'stdiotrap'
+
+describe StdioTrap do
+
+  describe 'capture' do
+    it "captures stdout and stderr" do
+      trapped = StdioTrap.capture {
+        $stdout.puts "Hello world!"
+        $stderr.puts "Hello other world!"
+      }
+      trapped[:stdout].should == "Hello world!\n"
+      trapped[:stderr].should == "Hello other world!\n"
+    end
+  end
+
+  describe 'trap!, release!' do
+    before :each do
+      StdioTrap.trap!
+    end
+
+    after :each do
+      StdioTrap.release!
+    end
+
+    it "captures stdout and stderr" do
+      puts "Hello world!"
+      $stderr.puts "Hello other world!"
+      StdioTrap.stdout.should == "Hello world!\n"
+      StdioTrap.stderr.should == "Hello other world!\n"
+    end
+  end
+
+end
+```
+
+For more usage examples please refer to the [spec suite](https://github.com/busyloop/stdiotrap/blob/master/spec/stdiotrap_spec.rb).
+
+## Credits
+
+StdioTrap is based on [this code snippet](http://rails-bestpractices.com/questions/1-test-stdin-stdout-in-rspec) (bottom of page) by [Ng Tze Yang](http://tyenglog.blogspot.de)

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+task :default => :test
+
+RSpec::Core::RakeTask.new("test:spec") do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    #t.rspec_opts = '-b -c -f progress --tag ~benchmark'
+    t.rspec_opts = '--fail-fast -b -c -f documentation --tag ~benchmark'
+end
+
+desc 'Run full test suite'
+#task :test => [ 'test:spec', 'test:coverage' ]
+task :test => [ 'test:spec' ]

data/lib/stdiotrap.rb

@@ -0,0 +1,50 @@
+require "stdiotrap/version"
+
+module StdioTrap
+  require 'stringio'
+
+  $stdio_trap = nil
+  class << self
+    def trap!(stdin='', mode=:trap)
+      raise RuntimeError, "Stdio is already trapped" unless $stdio_trap.nil?
+      $stdio_trap, $o_stdin, $o_stdout, $o_stderr = mode, $stdin, $stdout, $stderr
+      $stdin, $stdout, $stderr = StringIO.new(stdin), StringIO.new, StringIO.new
+    end
+
+    def release!(force=false)
+      raise RuntimeError, "Stdio is not currently trapped" if $stdio_trap.nil?
+      raise RuntimeError, "Can not release inside capture{}" if $stdio_trap == :capture and !force
+      $stdio_trap, $stdin, $stdout, $stderr = nil, $o_stdin, $o_stdout, $o_stderr
+    end
+
+    def status
+      !$stdio_trap.nil?
+    end
+
+    def capture(stdin='')
+      begin
+        require 'stringio'
+        trap!(stdin, :capture)
+        yield
+        {:stdout => $stdout.string, :stderr => $stderr.string}
+      ensure
+        release!(true)
+      end
+    end
+
+    def stdout
+      raise RuntimeError, "Stdio is not currently trapped" if $stdio_trap.nil?
+      $stdout.string
+    end
+
+    def stderr
+      raise RuntimeError, "Stdio is not currently trapped" if $stdio_trap.nil?
+      $stderr.string
+    end
+
+    def to_h
+      raise RuntimeError, "Stdio is not currently trapped" if $stdio_trap.nil?
+      { :stdout => $stdout.string, :stderr => $stderr.string }
+    end
+  end
+end

data/lib/stdiotrap/version.rb

@@ -0,0 +1,3 @@
+module StdioTrap
+  VERSION = "1.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'simplecov'
+SimpleCov.start
+

data/spec/stdiotrap_spec.rb

@@ -0,0 +1,194 @@
+require 'spec_helper'
+
+require 'stdiotrap'
+
+describe StdioTrap do
+  describe 'trap!' do
+    it "raises RuntimeError when called twice" do
+      lambda {
+        begin
+          StdioTrap.trap!
+          StdioTrap.trap!
+        ensure
+          StdioTrap.release!
+        end
+      }.should raise_error RuntimeError
+    end
+
+    it "raises RuntimeError when called inside capture{}" do
+      lambda {
+        begin
+          StdioTrap.trap!
+          StdioTrap.trap!
+        ensure
+          StdioTrap.release!
+        end
+      }.should raise_error RuntimeError
+    end
+
+    it "can fake stdin" do
+      StdioTrap.trap!('foobar')
+      input = $stdin.read
+      StdioTrap.release!
+      input.should == 'foobar'
+    end
+  end
+
+  describe 'release!' do
+    it "raises RuntimeError when called twice" do
+      lambda {
+        begin
+          StdioTrap.trap!
+          StdioTrap.release!
+          StdioTrap.release!
+        ensure
+          StdioTrap.release!
+        end
+      }.should raise_error RuntimeError
+    end
+
+    it "raises RuntimeError when called before trap!" do
+      lambda {
+        StdioTrap.release!
+      }.should raise_error RuntimeError
+    end
+
+    it "raises RuntimeError when called inside capture{}" do
+      lambda {
+        trapped = StdioTrap.capture {
+          puts "Hello world!"
+          StdioTrap.release!
+        }
+      }.should raise_error RuntimeError
+    end
+  end
+
+  describe 'trap!, release!' do
+    before :each do
+      StdioTrap.trap!
+    end
+
+    after :each do
+      StdioTrap.release!
+    end
+
+    it "captures stdout" do
+      puts "Hello world!"
+      StdioTrap.stdout.should == "Hello world!\n"
+    end
+
+    it "captures stderr" do
+      $stderr.puts "Hello world!"
+      StdioTrap.stderr.should == "Hello world!\n"
+    end
+
+    it "captures stdout and stderr" do
+      puts "Hello world!"
+      $stderr.puts "Hello other world!"
+      StdioTrap.stdout.should == "Hello world!\n"
+      StdioTrap.stderr.should == "Hello other world!\n"
+    end
+  end
+
+  describe 'capture' do
+    it "captures stdout" do
+      trapped = StdioTrap.capture {
+        puts "Hello world!"
+      }
+      trapped[:stdout].should == "Hello world!\n"
+    end
+
+    it "captures stderr" do
+      trapped = StdioTrap.capture {
+        $stderr.puts "Hello world!"
+      }
+      trapped[:stderr].should == "Hello world!\n"
+    end
+
+    it "captures stdout and stderr" do
+      trapped = StdioTrap.capture {
+        $stdout.puts "Hello world!"
+        $stderr.puts "Hello other world!"
+      }
+      trapped[:stdout].should == "Hello world!\n"
+      trapped[:stderr].should == "Hello other world!\n"
+    end
+
+    it "can fake stdin" do
+      trapped = StdioTrap.capture('foobar') {
+        input = $stdin.read
+        input.should == 'foobar'
+      }
+    end
+  end
+
+  describe 'status' do
+    it "returns correct status before trap!" do
+      StdioTrap.status.should == false
+    end
+
+    it "returns correct status after trap!" do
+      StdioTrap.trap!
+      StdioTrap.status.should == true
+      StdioTrap.release!
+    end
+
+    it "returns correct status after trap!, release!" do
+      StdioTrap.trap!
+      StdioTrap.release!
+      StdioTrap.status.should == false
+    end
+
+    it "returns correct status inside capture{}" do
+      StdioTrap.capture {
+        StdioTrap.status.should == true
+      }
+    end
+
+    it "returns correct status after capture{}" do
+      StdioTrap.capture {
+      }
+      StdioTrap.status.should == false
+    end
+  end
+
+  describe 'to_h' do
+    it "works inside capture{}" do
+      StdioTrap.capture {
+        puts "Hello world!"
+        $stderr.puts "Hello other world!"
+        state = StdioTrap.to_h
+        state.keys.length.should == 2
+        state[:stdout].should == "Hello world!\n"
+        state[:stderr].should == "Hello other world!\n"
+      }
+    end
+
+    it "works between trap! and release!" do
+      StdioTrap.trap!
+      puts "Hello world!"
+      $stderr.puts "Hello other world!"
+      state = StdioTrap.to_h
+      state.keys.length.should == 2
+      state[:stdout].should == "Hello world!\n"
+      state[:stderr].should == "Hello other world!\n"
+      StdioTrap.release!
+    end
+
+    it "raises RuntimeError when called before trap!" do
+      lambda {
+        StdioTrap.to_h
+      }.should raise_error RuntimeError
+    end
+
+    it "raises RuntimeError when called after release!" do
+      lambda {
+        StdioTrap.trap!
+        puts "Hello world!"
+        StdioTrap.release!
+        StdioTrap.to_h
+      }.should raise_error RuntimeError
+    end
+  end
+end
+

data/stdiotrap.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stdiotrap/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stdiotrap"
+  gem.version       = StdioTrap::VERSION
+  gem.authors       = ["Moe"]
+  gem.email         = ["moe@busyloop.net"]
+  gem.description   = %q{Easily capture stdout, stderr at runtime}
+  gem.summary       = %q{Easily capture stdout, stderr at runtime}
+  gem.homepage      = "https://github.com/busyloop/stdiotrap"
+  gem.has_rdoc      = false
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rb-inotify'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: stdiotrap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Moe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily capture stdout, stderr at runtime
+email:
+- moe@busyloop.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stdiotrap.rb
+- lib/stdiotrap/version.rb
+- spec/spec_helper.rb
+- spec/stdiotrap_spec.rb
+- stdiotrap.gemspec
+homepage: https://github.com/busyloop/stdiotrap
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2260607833105567468
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2260607833105567468
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Easily capture stdout, stderr at runtime
+test_files:
+- spec/spec_helper.rb
+- spec/stdiotrap_spec.rb