plymouth 0.2.0 → 0.3.0

data/README.md

@@ -3,22 +3,24 @@ plymouth
 
 (C) John Mair (banisterfiend) 2012
 
-_Start an interactive session when a test fails_
+_Start an interactive session on test failure_
 
 **Warning BETA software: Please file an [issue](https://github.com/banister/plymouth) if you have any problems**
 
 `plymouth` is a gem to automatically start a [Pry](http://pry.github.com) session when a test fails, putting you in the context of the failure.
 It currently supports [Bacon](https://github.com/chneukirchen/bacon), [Minitest](https://github.com/seattlerb/minitest), and [RSpec](https://github.com/rspec/rspec). 
-Support for other testing libraries is (usually) trivial to add.
+Support for other testing libraries is (usually) trivial to add.  
 
-plymouth currently only supports **MRI 1.9.2+ (including 1.9.3)**
+`plymouth` utilizes the powerful [pry-exception_explorer](https://github.com/pry/pry-exception_explorer) gem.
+
+plymouth currently only runs on **MRI 1.9.2+ (including 1.9.3)**
 
 * Install the [gem](https://rubygems.org/gems/plymouth): `gem install plymouth`
 * See the [source code](http://github.com/banister/plymouth)
  
 **How to use:**
 
-Simply add the following line to your test files:
+Simply add the following line to your test suite:
 
 `require 'plymouth'` 
 
@@ -47,6 +49,9 @@ end
 And here is the result of running the above test with the `rspec` executable:
 
 ```ruby
+Test failure: expected: true
+     got: false (using ==)
+
 Frame number: 0/14
 Frame type: block
 
@@ -82,6 +87,13 @@ Failed examples:
 rspec ./rspec_intercept.rb:8 # Array should be empty
 ```
 
+The 'USE_PLYMOUTH' Environment variable
+-------
+
+To make it easier to run your test suite normally (without plymouth's intervention) a `USE_PLYMOUTH` environment variable
+can be defined. If the `USE_PLYMOUTH` environment variable is set to `"false"`, `"0"`, or `"no"` plymouth will not intercept test failures.
+If `USE_PLYMOUTH` is not defined at all, plymouth will be used by default.
+
 Limitations
 -------------------------
 

data/lib/plymouth.rb

@@ -4,7 +4,13 @@
 require "plymouth/version"
 require 'pry-exception_explorer'
 
-EE.enabled = true
+if !ENV.has_key?("USE_PLYMOUTH")
+  EE.enabled = true
+elsif ["0", "false", "no"].include?(ENV["USE_PLYMOUTH"].downcase)
+  EE.enabled = false
+else
+  EE.enabled = true
+end
 
 message = nil
 
@@ -23,6 +29,7 @@ if defined?(Bacon)
     else
       false
     end
+
   end.skip_until { |frame| frame.klass == Bacon::Context }
 
 elsif defined?(RSpec)

data/lib/plymouth/version.rb

@@ -1,3 +1,3 @@
 module Plymouth
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/plymouth.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "plymouth"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plymouth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-exception_explorer
-  requirement: &70323999883060 !ruby/object:Gem::Requirement
+  requirement: &70204289865000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323999883060
+  version_requirements: *70204289865000
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &70323999880480 !ruby/object:Gem::Requirement
+  requirement: &70204289862340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70323999880480
+  version_requirements: *70204289862340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70323999864420 !ruby/object:Gem::Requirement
+  requirement: &70204289733740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323999864420
+  version_requirements: *70204289733740
 description: Start an interactive session when a test fails
 email: jrmair@gmail.com
 executables: []