plymouth 0.1.0 → 0.1.1

data/README.md

@@ -3,25 +3,91 @@ plymouth
 
 (C) John Mair (banisterfiend) 2012
 
-FIXME: _tagline_
+_Start an interactive session when a test fails_
 
-FIXME: _description goes here_
+**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.
+
+plymouth currently only supports **MRI 1.9.2+ (including 1.9.3)**
 
 * Install the [gem](https://rubygems.org/gems/plymouth): `gem install plymouth`
-* Read the [documentation](http://rdoc.info/github/banister/plymouth/master/file/README.md)
 * See the [source code](http://github.com/banister/plymouth)
+ 
+**How to use:**
+
+Simply add the following line to your test files:
+
+`require 'plymouth'` 
+
+plymouth should auto-detect which testing library you're using, and 'just work' :)
 
-Example: Example description
+
+Example: Intercept a failing test in RSpec
 --------
 
-Example preamble
+Inside the test file:
+
+```ruby
+require 'plymouth'
+
+describe Array do
+  before do
+    @array = [1]
+  end
+
+  it 'should be empty' do
+    @array.empty?.should == true
+  end
+end
+```
+
+And here is the result of running the above test with the `rspec` executable:
+
+```ruby
+Frame number: 0/14
+Frame type: block
+
+From: /Users/john/ruby/play/rspec_intercept.rb @ line 9:
+
+     4:   before do
+     5:     @array = [1]
+     6:   end
+     7: 
+     8:   it 'should be empty' do
+ =>  9:     @array.empty?.should == true
+    10:   end
+    11: end
+
+[1] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> @array.size                                                                                                                           
+=> 1
+[2] (pry) #<RSpec::Core::ExampleGroup::Nested_1>: 0> ^D
+F
+
+Failures:
+
+  1) Array should be empty
+     Failure/Error: @array.empty?.should == true
+       expected: true
+            got: false (using ==)
+     # ./rspec_intercept.rb:9:in `block (2 levels) in <top (required)>'
+
+Finished in 7.74 seconds
+1 example, 1 failure
+
+Failed examples:
 
-    puts "example code"
+rspec ./rspec_intercept.rb:8 # Array should be empty
+```
 
-Features and limitations
+Limitations
 -------------------------
 
-Feature List Preamble
+* Occasional segfault on 1.9.3 (seems to work fine on 1.9.2). Please [report](https://github.com/banister/plymouth) 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.
 
 Contact
 -------

data/Rakefile

@@ -1,75 +1,85 @@
-$:.unshift 'lib'
-
-PROJECT_NAME = "plymouth"
-
-require "#{PROJECT_NAME}/version"
-
-CLASS_NAME = Plymouth
-
-require 'rake/clean'
-require 'rake/gempackagetask'
-
-CLOBBER.include("**/*~", "**/*#*", "**/*.log", "**/*.o")
-CLEAN.include("ext/**/*.log", "ext/**/*.o",
-              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
-              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
-
-def apply_spec_defaults(s)
-  s.name = PROJECT_NAME
-  s.summary = "FIX ME"
-  s.version = CLASS_NAME::VERSION
-  s.date = Time.now.strftime '%Y-%m-%d'
-  s.author = "John Mair (banisterfiend)"
-  s.email = 'jrmair@gmail.com'
-  s.description = s.summary
-  s.require_path = 'lib'
-  s.add_development_dependency("bacon","~>1.1.0")
-  s.homepage = "http://github.com/banister/#{PROJECT_NAME}"
-  s.has_rdoc = 'yard'
-  s.add_dependency('pry-exception_explorer')
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- test/*`.split("\n")
-end
-
-desc "Run tests"
-task :test do
-  sh "bacon -Itest -rubygems test.rb -q"
-end
-
-namespace :ruby do
-  spec = Gem::Specification.new do |s|
-    apply_spec_defaults(s)
-    s.platform = Gem::Platform::RUBY
-  end
-
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = false
-    pkg.need_tar = false
-  end
-end
-
-desc "Show version"
-task :version do
-  puts "Plymouth version: #{Plymouth::VERSION}"
-end
-
-desc  "Generate gemspec file"
-task :gemspec => "ruby:gemspec"
-
-desc "build all platform gems at once"
-task :gems => [:clean, :rmgems, "ruby:gem"]
-
-task :gem => [:gems]
-
-desc "remove all platform gems"
-task :rmgems => ["ruby:clobber_package"]
-
-desc "build and push latest gems"
-task :pushgems => :gems do
-  chdir("./pkg") do
-    Dir["*.gem"].each do |gemfile|
-      sh "gem push #{gemfile}"
-    end
-  end
-end
-
+$:.unshift 'lib'
+
+PROJECT_NAME = "plymouth"
+
+require "#{PROJECT_NAME}/version"
+
+CLASS_NAME = Plymouth
+
+require 'rake/clean'
+require 'rake/gempackagetask'
+
+CLOBBER.include("**/*~", "**/*#*", "**/*.log", "**/*.o")
+CLEAN.include("ext/**/*.log", "ext/**/*.o",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
+              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
+
+def apply_spec_defaults(s)
+  s.name = PROJECT_NAME
+  s.summary = "FIX ME"
+  s.version = CLASS_NAME::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.add_development_dependency("bacon","~>1.1.0")
+  s.homepage = "http://github.com/banister/#{PROJECT_NAME}"
+  s.has_rdoc = 'yard'
+  s.add_dependency('pry-exception_explorer')
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+end
+
+desc "Run tests"
+task :test do
+  sh "bacon -Itest -rubygems test.rb -q"
+end
+
+desc "generate gemspec"
+task :gemspec => "ruby:gemspec"
+
+namespace :ruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)
+    s.platform = Gem::Platform::RUBY
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  desc  "Generate gemspec file"
+  task :gemspec do
+    File.open("#{spec.name}.gemspec", "w") do |f|
+      f << spec.to_ruby
+    end
+  end
+end
+
+desc "Show version"
+task :version do
+  puts "Plymouth version: #{Plymouth::VERSION}"
+end
+
+desc  "Generate gemspec file"
+task :gemspec => "ruby:gemspec"
+
+desc "build all platform gems at once"
+task :gems => [:clean, :rmgems, "ruby:gem"]
+
+task :gem => [:gems]
+
+desc "remove all platform gems"
+task :rmgems => ["ruby:clobber_package"]
+
+desc "build and push latest gems"
+task :pushgems => :gems do
+  chdir("./pkg") do
+    Dir["*.gem"].each do |gemfile|
+      sh "gem push #{gemfile}"
+    end
+  end
+end
+

data/lib/plymouth/version.rb

@@ -1,3 +1,3 @@
 module Plymouth
-  VERSION = "0.1.0"
-end     
+  VERSION = "0.1.1"
+end

data/lib/plymouth.rb

@@ -8,7 +8,9 @@ EE.enabled = true
 
 if defined?(Bacon)
 
-  EE.intercept(Bacon::Error).skip_until { |frame| frame.klass == Bacon::Context }
+  EE.intercept do |frame, ex|
+    ex.is_a?(Bacon::Error) && frame.method_name != :run_requirement
+  end.skip_until { |frame| frame.klass == Bacon::Context }
 
 elsif defined?(RSpec)
 

data/plymouth.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "plymouth"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mair (banisterfiend)"]
+  s.date = "2012-02-08"
+  s.description = "FIX ME"
+  s.email = "jrmair@gmail.com"
+  s.files = [".gemtest", ".gitignore", ".yardopts", "CHANGELOG", "Gemfile", "LICENSE", "README.md", "Rakefile", "lib/plymouth.rb", "lib/plymouth/version.rb", "plymouth.gemspec", "test/test.rb"]
+  s.homepage = "http://github.com/banister/plymouth"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "FIX ME"
+  s.test_files = ["test/test.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
+      s.add_runtime_dependency(%q<pry-exception_explorer>, [">= 0"])
+    else
+      s.add_dependency(%q<bacon>, ["~> 1.1.0"])
+      s.add_dependency(%q<pry-exception_explorer>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bacon>, ["~> 1.1.0"])
+    s.add_dependency(%q<pry-exception_explorer>, [">= 0"])
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: plymouth
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-03 00:00:00 Z
+date: 2012-02-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bacon
@@ -53,6 +53,7 @@ files:
 - Rakefile
 - lib/plymouth.rb
 - lib/plymouth/version.rb
+- plymouth.gemspec
 - test/test.rb
 homepage: http://github.com/banister/plymouth
 licenses: []