fakeout 0.0.1 → 0.0.2

data/README.textile

@@ -1,46 +1,55 @@
 h1. Fakeout
 
-Fakeout helps you test your command line libraries. It captures all output to @STDOUT@ and @STDERR@ during test execution so you can ensure your library is yelling the right things at the user.
+Fakeout is an easy way of testing the output of your command line tools and libraries.
 
-h2. Install
+It catches all output to @$stdout@ and @$stderr@ while activated so you can test the correct output is given by your library or script. It also has the nice side-effect of keeping your test results from being crapped up with non test result text and data.
 
-    gem install fakeout
+h2. Usage
 
-h2. RSpec
+To load and activate Fakeout:
 
-h3. Activate (before) and Deactivate (after) In All Specs
+bc.. require "fakeout"
 
-bc.. require "fakeout/spec_helpers"
+h3. Manually Activate and Deactivate
 
-RSpec.config do |c|
-  c.include Fakeout::SpecHelpers
-end
+If you want to control when Fakeout starts and stops capturing output:
 
-h3. Only Certain Specs
+bc.. require "fakeout/safe"
 
-bc.. require "fakeout/spec_helpers"
+Fakeout.activate!
+# your code
+Fakeout.deactivate!
 
-describe "Something" do
-  include Fakeout::SpecHelpers
+p. Both of the approaches above work for RSpec, UnitTest, or whatever.
+
+h2. Helpers
+
+Including the @Fakeout::TestHelpers@ module into your spec or test class exposes two objects, @stdout@ and @stderr@, each containing any output sent, while Fakeout is activated, to @$stdout@ and @$stderr@, respectively.
+
+bc.. it "should rawr to $stdout" do
+  lion.rawr_to_stdout
+  stdout.should include "RAWR!!"
 end
 
-h3. Manually Activate and Deactivate
+h2. RSpec
 
-bc.. require "fakeout/spec_helpers"
+@Fakeout::SpecHelpers@ will automatically activate before each example and deactivate after each one when included. It can be included into individual Example Groups:
 
-describe "Something" do
+bc.. describe "Something" do
   include Fakeout::SpecHelpers
+end
+
+p. or included into all Example Groups:
 
-  before { Fakeout.activate! }
-  after  { Fakeout.deactivate! }
+bc.. RSpec.config do |c|
+  c.include Fakeout::SpecHelpers
 end
 
-h2. Test::Unit
+p. * Note that if you use @SpecHelpers@ with RSpec, you DO NOT need to include @TestHelpers@.
 
-bc.. # something_test.rb
-require "fakeout/test_helpers"
+h2. Test::Unit
 
-class SomethingTest < Test::Unit::TestCase
+bc.. class SomethingTest < Test::Unit::TestCase
   include Fakeout::TestHelpers
   
   def setup
@@ -52,14 +61,17 @@ class SomethingTest < Test::Unit::TestCase
   end
 end
 
-h2. Helpers
+h2. Installation
 
-Fakeout exposes two string-like objects:
+bc.. $ gem install fakeout
 
-@stdout@ : Anything sent to @$stdout@.
-@stderr@ : Anything sent to @$stderr@.
+h2. Contribution
 
-bc.. it "should write output" do
-  thing.that_outputs_to_stdout
-  stdout.should include "ohai"
-end
+1. Fork Fakeout
+2. Create a topic branch - @git checkout -b branch_name@
+3. Push branch to your fork - @git push origin branch_name@
+4. Send a pull request
+
+h2. Thanks
+
+Defunkt for FakeFS, which much of Fakeout is modeled after.

data/lib/fakeout.rb

@@ -1,2 +1,2 @@
-require "stringio"
-require "fakeout/base"
+require "fakeout/safe"
+Fakeout.activate!

data/lib/fakeout/base.rb

@@ -14,6 +14,6 @@ module Fakeout
   end
 
   def self.is_active?
-    @is_active
+    !!@is_active
   end
 end

data/lib/fakeout/safe.rb

@@ -0,0 +1,4 @@
+require "stringio"
+require "fakeout/base"
+require "fakeout/test_helpers"
+require "fakeout/spec_helpers"

data/lib/fakeout/spec_helpers.rb

@@ -1,5 +1,3 @@
-require "fakeout/test_helpers"
-
 module Fakeout
   module SpecHelpers
     include TestHelpers

data/lib/fakeout/test_helpers.rb

@@ -1,5 +1,3 @@
-require "fakeout"
-
 module Fakeout
   module TestHelpers
     def stdout

data/lib/fakeout/version.rb

@@ -1,3 +1,3 @@
 module Fakeout
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: fakeout
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.1
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Matte Noble
@@ -10,7 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-29 00:00:00 Z
+date: 2011-04-29 00:00:00 -04:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -20,6 +25,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
         version: 2.5.0
   type: :development
   version_requirements: *id001
@@ -40,11 +49,13 @@ files:
 - fakeout.gemspec
 - lib/fakeout.rb
 - lib/fakeout/base.rb
+- lib/fakeout/safe.rb
 - lib/fakeout/spec_helpers.rb
 - lib/fakeout/test_helpers.rb
 - lib/fakeout/version.rb
 - spec/fakeout_spec.rb
 - test/fakeout_test.rb
+has_rdoc: true
 homepage: http://github.com/mnoble/fakeout
 licenses: []
 
@@ -58,17 +69,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Fakeout captures STDOUT and STDERR for command line testing.