pry-rescue 0.7 → 0.8

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+.rbx
+.yardoc
+doc

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.md

@@ -11,6 +11,12 @@ instead of `ruby`:
 rescue <script.rb> [arguments..]
 ```
 
+If you're using Rack, you should use the middleware instead (though be careful to only
+include it in development!)
+```
+use PryRescue::Rack
+```
+
 If you want more fine-grained control over which parts of your code are rescued, you can
 also use the block form:
 

data/lib/pry-rescue.rb

@@ -4,29 +4,38 @@ require 'pry'
 
 require File.expand_path('../pry-rescue/core_ext', __FILE__)
 require File.expand_path('../pry-rescue/commands', __FILE__)
+require File.expand_path('../pry-rescue/rack', __FILE__)
 
 begin
   require 'pry-stack_explorer'
 rescue LoadError
 end
 
+# PryRescue provides the ability to open a Pry shell whenever an unhandled exception is
+# raised in your code.
+#
+# The main API is exposed via the Pry object, but here are a load of helpers that I didn't
+# want to pollute the Pry namespace with.
+#
+# @see {Pry::rescue}
 class PryRescue
   class << self
 
     # Start a Pry session in the context of the exception.
-    # @param [Exception] exception The exception.
-    # @param [Array<Binding>] bindings The call stack.
+    # @param [Array<Exception, Array<Binding>>] raised  The exceptions raised
     def enter_exception_context(raised)
 
       raised = raised.map do |e, bs|
         [e, without_bindings_below_raise(bs)]
       end
+      raised = without_gem_reraises(raised)
 
       raised.pop if phantom_load_raise?(*raised.last)
       exception, bindings = raised.last
+      bindings = without_duplicates(bindings)
 
       if defined?(PryStackExplorer)
-        pry :call_stack => without_duplicates(bindings),
+        pry :call_stack => bindings,
             :hooks => pry_hooks(exception, raised),
             :initial_frame => initial_frame(bindings)
       else
@@ -35,7 +44,7 @@ class PryRescue
     end
 
     # Load a script wrapped in Pry::rescue{ }
-    # @param [String] The name of the script
+    # @param [String] script  The name of the script
     def load(script)
       Pry::rescue{ Kernel.load script }
     end
@@ -46,7 +55,9 @@ class PryRescue
     #
     # This is designed to remove the extra raise that is caused by PryRescue.load.
     # TODO: we should figure out why it happens...
-    # @param [Array<Binding>]
+    #
+    # @param [Exception] e  The raised exception
+    # @param [Array<Binding>] bindings  The call stack
     def phantom_load_raise?(e, bindings)
       bindings.any? && bindings.first.eval("__FILE__") == __FILE__
     end
@@ -54,7 +65,7 @@ class PryRescue
     # When using pry-stack-explorer we want to start the rescue session outside of gems
     # and the standard library, as that is most helpful for users.
     #
-    # @param [Array<Bindings>]  All bindings
+    # @param [Array<Bindings>] bindings  All bindings
     # @return [Fixnum]  The offset of the first binding of user code
     def initial_frame(bindings)
       bindings.each_with_index do |binding, i|
@@ -66,7 +77,7 @@ class PryRescue
 
     # Is this path likely to be code the user is working with right now?
     #
-    # @param [String] the absolute path
+    # @param [String] file  the absolute path
     # @return [Boolean]
     def user_path?(file)
       !file.start_with?(RbConfig::CONFIG['libdir']) &&
@@ -76,7 +87,7 @@ class PryRescue
     # Remove bindings that are part of Interception/Pry.rescue's internal
     # event handling that happens as part of the exception hooking process.
     #
-    # @param [Array<Binding>] bindings The call stack.
+    # @param [Array<Binding>] bindings  The call stack.
     def without_bindings_below_raise(bindings)
       return bindings if bindings.size <= 1
       bindings.drop_while do |b|
@@ -88,7 +99,7 @@ class PryRescue
 
     # Remove multiple bindings for the same function.
     #
-    # @param [Array<Bindings>]
+    # @param [Array<Bindings>] bindings  The call stack
     # @return [Array<Bindings>]
     def without_duplicates(bindings)
       bindings.zip([nil] + bindings).reject do |b, c|
@@ -99,9 +110,29 @@ class PryRescue
       end.map(&:first)
     end
 
+    # Remove any re-raises of the exact exception object that happened from within
+    # a gem, and show you only the raise that happened in your code.
+    #
+    # @param [Array<Exception, Array<Binding>>] raised  The exceptions raised
+    def without_gem_reraises(raised)
+      seen = {}
+      raised.select do |(e, bindings)|
+        if seen[e] && !user_path?(bindings.first.eval("__FILE__"))
+          false
+        elsif user_path?(bindings.first.eval("__FILE__"))
+          seen[e] = true
+        else
+          true
+        end
+      end
+    end
+
     # Define the :before_session hook for the Pry instance.
     # This ensures that the `_ex_` and `_raised_` sticky locals are
     # properly set.
+    #
+    # @param [Exception] ex  The exception we're currently looking at
+    # @param [Array<Exception, Array<Binding>>] raised  The exceptions raised
     def pry_hooks(ex, raised)
       hooks = Pry.config.hooks.dup
       hooks.add_hook(:before_session, :save_captured_exception) do |_, _, _pry_|

data/lib/pry-rescue/core_ext.rb

@@ -1,5 +1,5 @@
+# Additional methods provided by pry-rescue.
 class Pry
-
   # Start a pry session on any unhandled exceptions within this block.
   #
   # @example

data/lib/pry-rescue/rack.rb

@@ -0,0 +1,19 @@
+require 'pry-rescue'
+
+class PryRescue
+  # A Rack middleware that wraps each web request in Pry::rescue.
+  class Rack
+    # Instantiate the middleware
+    #
+    # @param [#call] app
+    def initialize(app)
+      @app = app
+    end
+
+    # Handle a web request
+    # @param [Rack::Env] env
+    def call(env)
+      Pry::rescue{ @app.call(env) }
+    end
+  end
+end

data/pry-rescue.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'pry-rescue'
-  s.version       = '0.7'
+  s.version       = '0.8'
   s.summary       = 'Open a pry session on any unhandled exceptions'
   s.description   = 'Allows you to wrap code in Pry::rescue{ } to open a pry session at any unhandled exceptions'
   s.homepage      = 'https://github.com/ConradIrwin/pry-rescue'
@@ -12,4 +12,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'pry'
   s.add_dependency 'interception'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'redcarpet'
 end

data/spec/fixtures/initial.rb

@@ -0,0 +1,13 @@
+eval <<EOF, TOPLEVEL_BINDING, File.join(RbConfig::CONFIG['rubylibdir'], 'fake.rb'), 1
+
+module Test
+  def self.foo(*args)
+    args.each do |a|
+      raise ArgumentError, "no :baz please" if a == :baz
+    end
+  end
+end
+
+EOF
+
+Test.foo(:baz)

data/spec/fixtures/raiseother.rb

@@ -0,0 +1,13 @@
+eval <<EOF, TOPLEVEL_BINDING, File.join(RbConfig::CONFIG['rubylibdir'], 'fake.rb'), 1
+
+module Test
+  def self.baz(*args)
+    yield
+  rescue => e
+    raiseother_exception
+  end
+end
+
+EOF
+
+Test.baz{ raise "reraise-exception" }

data/spec/fixtures/reraise.rb

@@ -0,0 +1,13 @@
+eval <<EOF, TOPLEVEL_BINDING, File.join(RbConfig::CONFIG['rubylibdir'], 'fake.rb'), 1
+
+module Test
+  def self.bar(*args)
+    yield
+  rescue => e
+    raise e
+  end
+end
+
+EOF
+
+Test.bar{ raise "reraise-exception" }

data/spec/fixtures/simple.rb

@@ -1 +1 @@
-raise "fixtures/simple"
+raise "simple-exception"

data/spec/fixtures/super.rb

@@ -0,0 +1,17 @@
+class A
+  def a
+    loop do
+      raise "super-exception"
+    end
+  end
+end
+
+class B < A
+  def a
+    loop do
+      super
+    end
+  end
+end
+
+B.new.a

data/spec/pry_rescue_spec.rb

@@ -9,7 +9,7 @@ describe "PryRescue.load" do
       }
       lambda{
         PryRescue.load("spec/fixtures/simple.rb")
-      }.should raise_error(/fixtures.simple/)
+      }.should raise_error(/simple-exception/)
     end
 
     it "should open above the standard library" do
@@ -55,7 +55,35 @@ describe "PryRescue.load" do
       end
       lambda{
         PryRescue.load("spec/fixtures/super.rb")
-      }.should raise_error(/fixtures.super/)
+      }.should raise_error(/super-exception/)
+    end
+
+    it "should calculate correct initial frame even when duplicates are present" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack][0].eval("__FILE__").should end_with('fake.rb')
+        opts[:call_stack][opts[:initial_frame]].eval("__FILE__").should end_with('spec/fixtures/initial.rb')
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/initial.rb")
+      }.should raise_error(/no :baz please/)
+    end
+
+    it "should skip over reraises from within gems" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack][0].eval("__FILE__").should end_with('spec/fixtures/reraise.rb')
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/reraise.rb")
+      }.should raise_error(/reraise-exception/)
+    end
+
+    it "should not skip over independent raises within gems" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack][0].eval("__FILE__").should end_with('fake.rb')
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/raiseother.rb")
+      }.should raise_error(/raiseother_exception/)
     end
   else
     it "should open at the correct point" do
@@ -64,7 +92,7 @@ describe "PryRescue.load" do
       }
       lambda{
         PryRescue.load("spec/fixtures/simple.rb")
-      }.should raise_error(/fixtures.simple/)
+      }.should raise_error(/simple-exception/)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-rescue
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2012-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -45,6 +45,54 @@ dependencies:
     - - ! '>='
       - !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: yard
+  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: redcarpet
+  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: Allows you to wrap code in Pry::rescue{ } to open a pry session at any
   unhandled exceptions
 email:
@@ -56,6 +104,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
 - LICENSE.MIT
 - README.md
 - Rakefile
@@ -67,11 +117,16 @@ files:
 - lib/pry-rescue/cli.rb
 - lib/pry-rescue/commands.rb
 - lib/pry-rescue/core_ext.rb
+- lib/pry-rescue/rack.rb
 - lib/pry/rescue.rb
 - pry-rescue.gemspec
 - spec/core_ext_spec.rb
 - spec/fixtures/coderay.rb
+- spec/fixtures/initial.rb
+- spec/fixtures/raiseother.rb
+- spec/fixtures/reraise.rb
 - spec/fixtures/simple.rb
+- spec/fixtures/super.rb
 - spec/fixtures/uri.rb
 - spec/pry_rescue_spec.rb
 homepage: https://github.com/ConradIrwin/pry-rescue
@@ -94,8 +149,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Open a pry session on any unhandled exceptions
 test_files: []
+has_rdoc: