plymouth 0.3.1 → 0.3.2

data/README.md

@@ -11,16 +11,13 @@ _Start Pry in the context of a failed test_
 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.  
 
-`plymouth` utilizes the powerful [pry-exception_explorer](https://github.com/pry/pry-exception_explorer) gem.
+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:**
 
-After installing the gem, simply add the following line to your test suite:
+After installing the [gem](https://rubygems.org/gems/plymouth), simply add the following line to your test suite:
 
 `require 'plymouth'` 
 
@@ -68,7 +65,9 @@ From: /Users/john/ruby/play/rspec_intercept.rb @ line 9:
 
 [1] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> @array.size                                                                                                                           
 => 1
-[2] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> ^D
+[2] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> edit --current
+=> nil
+[3] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> ^D
 F
 
 Failures:
@@ -87,6 +86,14 @@ Failed examples:
 rspec ./rspec_intercept.rb:8 # Array should be empty
 ```
 
+Edit the failing test code in an editor
+---
+
+Notice the line `edit --current` from the example above. Entering this command will take you to the line in the test file
+where the failing test was defined. Once here you can modify the test code as you please. Note that the file will not be
+reloaded after editing is complete, instead any modifications you make will only take effect the next time you run the test suite.
+
+
 The 'USE_PLYMOUTH' Environment variable
 -------
 
@@ -94,12 +101,22 @@ To make it easier to run your test suite normally (without plymouth's interventi
 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.
 
+Travis Compatibility
+---
+
+To prevent plymouth messing up testing on [travis](http://travis-ci.org/), add the following line to your `.travis.yml` file: 
+
+```
+env: USE_PLYMOUTH="no"
+```
+
 Limitations
 -------------------------
 
 * Occasional (very rare) segfault on 1.9.3 (seems to work fine on 1.9.2). Please [report](https://github.com/banister/plymouth/issues) all segfaults with a full backtrace!
 * Only supports MRI.
 * Currently limited to just Bacon, RSpec and Minitest. Support for more testing libraries will be added in the future.
+* Only intercepts test **failures**, does not yet (generally) intercept test **errors**. Support for this will be added soon.
 
 Contact
 -------

data/Rakefile

@@ -28,7 +28,7 @@ def apply_spec_defaults(s)
   s.require_path = 'lib'
   s.homepage = "http://github.com/banister/#{PROJECT_NAME}"
   s.has_rdoc = 'yard'
-  s.add_dependency('pry-exception_explorer', '>=0.1.6')
+  s.add_dependency('pry-exception_explorer', '>=0.1.7')
   s.add_development_dependency("bacon","~>1.1.0")
   s.add_development_dependency('rspec')
   s.required_ruby_version = '>= 1.9.2'

data/examples/example_bacon.rb

@@ -12,4 +12,12 @@ describe Array do
   it 'should be empty' do
     @array.empty?.should == true
   end
+
+  it 'should have 3 items' do
+    [1, 2, 3].size.should == 3
+  end
+
+  it 'should contain only numbers' do
+     [1, "2", 3].all? { |v| v.is_a?(Fixnum).should == true }
+  end
 end

data/lib/plymouth.rb

@@ -1,23 +1,35 @@
 # plymouth.rb
 # (C) 2012 John Mair (banisterfiend); MIT license
 
-require "plymouth/version"
 require 'pry-exception_explorer'
+require "plymouth/version"
+require 'plymouth/commands'
 
-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
+module Plymouth
+
+  # Enable plymouth.
+  # @return [Boolean]
+  def self.enable!
+    ::EE.enabled = true
+  end
 
+  # Disable plymouth.
+  # @return [Boolean]
+  def self.disable!
+    ::EE.enabled = false
+  end
+
+  # @return [Boolean] Whether Plymouth is enabled.
+  def self.enabled?
+    ::EE.enabled?
+  end
+end
 
 message = nil
 
 # Ensure auto-reloading is off, so that `edit --current` does not try
 # to reload the test file
-Pry.config.disable_auto_reload
+Pry.config.disable_auto_reload = true
 
 # Decorate `whereami` command to include test failure information
 Pry.config.commands.before_command("whereami") do
@@ -30,7 +42,7 @@ if defined?(Bacon)
   EE.intercept do |frame, ex|
 
     if ex.is_a?(Bacon::Error) && frame.method_name != :run_requirement
-      message = ex
+      message = ex.message
       true
     else
       false
@@ -43,7 +55,7 @@ elsif defined?(RSpec)
   EE.intercept do |frame, ex|
 
     if ex.class.name =~ /RSpec::Expectations::ExpectationNotMetError/
-      message = ex
+      message = ex.message
       true
     else
       false
@@ -58,7 +70,7 @@ elsif defined?(MiniTest)
   EE.intercept do |frame, ex|
 
     if ex.is_a?(MiniTest::Assertion)
-      message = ex
+      message = ex.message
       true
     else
       false
@@ -69,4 +81,11 @@ elsif defined?(MiniTest)
   end
 end
 
+# Disable Plymouth if USE_PLYMOUTH environment variable is falsy
+Plymouth.enable!
+if ['0', 'false', 'no'].include?(ENV['USE_PLYMOUTH'].to_s.downcase)
+  Plymouth.disable!
+end
 
+# Bring in plymouth commands
+Pry.commands.import Plymouth::Commands

data/lib/plymouth/commands.rb

@@ -0,0 +1,28 @@
+module Plymouth
+  Commands = Pry::CommandSet.new do
+    create_command "plymouth-off", "Disable Plymouth." do
+      banner <<-BANNER
+        Usage: plymouth-off
+        Exit the REPL and turn Plymouth off for the duration of the test suite.
+      BANNER
+
+      def process
+        Plymouth.disable!
+
+        # exit the REPL
+        run "exit-all"
+      end
+    end
+
+    create_command "plymouth-on", "Enable Plymouth." do
+      banner <<-BANNER
+        Usage: plymouth-off
+        Enable Plymouth.
+      BANNER
+
+      def process
+        Plymouth.enable!
+      end
+    end
+  end
+end

data/lib/plymouth/version.rb

@@ -1,3 +1,3 @@
 module Plymouth
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/plymouth.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "plymouth"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2012-02-09"
+  s.date = "2012-02-10"
   s.description = "Start an interactive session when a test fails"
   s.email = "jrmair@gmail.com"
   s.files = [".gemtest", ".gitignore", ".yardopts", "CHANGELOG", "Gemfile", "LICENSE", "README.md", "Rakefile", "examples/example_bacon.rb", "examples/example_minitest.rb", "examples/example_rspec.rb", "lib/plymouth.rb", "lib/plymouth/version.rb", "plymouth.gemspec", "test/test.rb"]
@@ -21,16 +21,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<pry-exception_explorer>, [">= 0.1.6"])
+      s.add_runtime_dependency(%q<pry-exception_explorer>, [">= 0.1.7"])
       s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<pry-exception_explorer>, [">= 0.1.6"])
+      s.add_dependency(%q<pry-exception_explorer>, [">= 0.1.7"])
       s.add_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<pry-exception_explorer>, [">= 0.1.6"])
+    s.add_dependency(%q<pry-exception_explorer>, [">= 0.1.7"])
     s.add_dependency(%q<bacon>, ["~> 1.1.0"])
     s.add_dependency(%q<rspec>, [">= 0"])
   end

metadata

@@ -2,7 +2,7 @@
 name: plymouth
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-09 00:00:00 Z
+date: 2012-02-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: pry-exception_explorer
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.6
+        version: 0.1.7
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,7 @@ files:
 - examples/example_minitest.rb
 - examples/example_rspec.rb
 - lib/plymouth.rb
+- lib/plymouth/commands.rb
 - lib/plymouth/version.rb
 - plymouth.gemspec
 - test/test.rb