pry-rescue 0.3 → 0.4

data/README.md

@@ -1,38 +1,18 @@
 
-**pry-rescue** helps you quickly figure out why your code broke; when an exception is raised that would normally kill your program, Pry comes to the rescue, opening a Pry session in the context of code that raised the exception.
-
-Installation
-============
-
-Either `gem install pry-rescue`, or add it to the development section of your Gemfile:
-
-```ruby
-source :rubygems
-group :development do
-  gem 'pry-rescue'
-  gem 'pry-stack_explorer' # if you're using MRI 1.9 and you want it to be awesome.
-end
-```
+**pry-rescue** super-fast, painless, debugging for the (ruby) masses. (See [Pry to the rescue!](https://cirw.in/blog/pry-to-the-rescue))
 
 Usage
 =====
 
-There are *two ways* to use pry-rescue:
-
-Wrap an entire script
----------------------
-
-Use the launcher script:
+First `gem install pry-rescue pry-stack_explorer`. Then run your program with `rescue`
+instead of `ruby`:
 
 ```
 rescue <script.rb> [arguments..]
 ```
 
-Wrap a block in your code
--------------------------
-In development, wrap your code in `Pry::rescue{ }`; then any exceptions that are raised
-but not rescued will open a pry session. This is particularly useful for debugging
-servers and other long-running processes.
+If you want more fine-grained control over which parts of your code are rescued, you can
+also use the block form:
 
 ```ruby
 require 'pry-rescue'
@@ -47,7 +27,6 @@ Pry.rescue do
   test
 end
 ```
-
 This will land you in a pry-session:
 
 ```
@@ -119,9 +98,8 @@ you can get a better idea of why your function ended up in a bad state. Run
 Known bugs
 ==========
 
-Occasionally, when using ruby-1.8 or jruby, the value for `self` will be incorrect. You
-will still be able to access local variables, but calling methods will not work as you
-expect.
+Occasionally, when using ruby-1.8 the value for `self` will be incorrect. You will still
+be able to access local variables, but calling methods will not work as you expect.
 
 On rbx we are unable to intercept some exceptions thrown from inside the C++ VM, for
 example the ZeroDivisionError in `1 / 0`.

data/lib/pry-rescue/commands.rb

@@ -31,7 +31,7 @@ Pry::Commands.create_command "cd-cause", "Move to the previously raised exceptio
   BANNER
 
   def process
-    raised = target.eval("_raised_ rescue nil")
+    raised = target.eval("_raised_.dup rescue nil")
     raise Pry::CommandError, "cd-cause only works in a pry session created by Pry::rescue{}" unless raised
     raised.pop
 
@@ -60,6 +60,6 @@ Pry::Commands.create_command "try-again", "Re-try the code that caused this exce
   BANNER
 
   def process
-    run "exit", ":try_again"
+    throw :try_again
   end
 end

data/lib/pry-rescue/core_ext.rb

@@ -10,21 +10,47 @@ class Pry
   # @return [Object] The return value of the block
   def self.rescue(&block)
     raised = []
+    (@raised_stack ||= []) << raised
 
-    Interception.listen(block) do |exception, binding|
-      if defined?(PryStackExplorer)
-        raised << [exception, binding.callers]
-      else
-        raised << [exception, Array(binding)]
+    loop do
+      catch(:try_again) do
+        raised.clear
+        begin
+          return Interception.listen(block) do |exception, binding|
+                    if defined?(PryStackExplorer)
+                      raised << [exception, binding.callers]
+                    else
+                      raised << [exception, Array(binding)]
+                    end
+                  end
+        rescue Exception => e
+          PryRescue.enter_exception_context(raised)
+          raise e
+        end
       end
     end
+  ensure
+    @raised_stack.pop
+  end
 
-  rescue Exception => e
-    case PryRescue.enter_exception_context(raised)
-    when :try_again
-      retry
-    else
-      raise
-    end
+  # Start a pry session on an exception that you rescued within a Pry::rescue{ }.
+  #
+  # @example
+  #   Pry::rescue do
+  #     begin
+  #       raise "foo"
+  #     rescue => e
+  #       Pry::rescued(e)
+  #     end
+  #   end
+  #
+  def self.rescued(e=$!)
+    raise "Tried to inspect rescued exception outside Pry::rescue{ } block" unless @raised_stack.any?
+
+    raised = @raised_stack.last.dup
+    raised.pop until raised.empty? || raised.last.first == e
+    raise "Tried to inspect an exception that was not raised in this Pry::rescue{ } block" unless raised.any?
+
+    PryRescue.enter_exception_context(raised)
   end
 end

data/lib/pry-rescue.rb

@@ -17,10 +17,16 @@ class PryRescue
     # @param [Exception] exception The exception.
     # @param [Array<Binding>] bindings The call stack.
     def enter_exception_context(raised)
-      exception, bindings = raised.last
 
+      exception, bindings = raised.last
       prune_call_stack!(bindings)
 
+      if bindings.size > 1 && internal_binding?(bindings.first)
+        raised.pop
+        exception, bindings = raised.last
+        prune_call_stack!(bindings)
+      end
+
       if defined?(PryStackExplorer)
         pry :call_stack => bindings, :hooks => pry_hooks(exception, raised)
       else
@@ -30,6 +36,12 @@ class PryRescue
 
     private
 
+    # Is this binding within pry-rescue?
+    def internal_binding?(binding)
+      binding.eval("__FILE__").start_with?(File.expand_path('../../lib', __FILE__)) ||
+      binding.eval("__FILE__").start_with?(File.expand_path('../../bin', __FILE__))
+    end
+
     # Define the :before_session hook for the Pry instance.
     # This ensures that the `_ex_` and `_raised_` sticky locals are
     # properly set.

data/pry-rescue.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'pry-rescue'
-  s.version       = '0.3'
+  s.version       = '0.4'
   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'

data/spec/core_ext_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path('../../lib/pry-rescue.rb', __FILE__)
+
+describe 'Pry.rescue' do
+  it 'should call PryRescue.enter_exception_context' do
+    lambda{
+      PryRescue.should_receive(:enter_exception_context).once
+      Pry::rescue{ raise "foobar" }
+    }.should raise_error(/foobar/)
+  end
+
+  it "should retry on try-again" do
+    @called = 0
+    PryRescue.should_receive(:enter_exception_context).once{ throw :try_again }
+    Pry::rescue do
+      @called += 1
+      raise "foobar" if @called == 1
+    end
+    @called.should == 2
+  end
+
+  it "should try-again from innermost block" do
+    @outer = @inner = 0
+    PryRescue.should_receive(:enter_exception_context).once{ throw :try_again }
+    Pry::rescue do
+      @outer += 1
+      Pry::rescue do
+        @inner += 1
+        raise "oops" if @inner == 1
+      end
+    end
+
+    @outer.should == 1
+    @inner.should == 2
+  end
+
+  it "should clear out exceptions between retrys at the same level" do
+    @outer = @inner = 0
+    PryRescue.should_receive(:enter_exception_context).once{ |raised| raised.size.should == 1; throw :try_again }
+    PryRescue.should_receive(:enter_exception_context).once{ |raised| raised.size.should == 1; throw :try_again }
+    Pry::rescue do
+      @outer += 1
+      Pry::rescue do
+        @inner += 1
+        raise "oops" if @inner <= 2
+      end
+    end
+  end
+
+  it "should preserve exceptions between retrys at a higher level" do
+    @outer = @inner = 0
+    PryRescue.should_receive(:enter_exception_context).once{ |raised| raised.size.should == 1; throw :try_again }
+    PryRescue.should_receive(:enter_exception_context).once{ |raised| raised.size.should == 1; throw :try_again }
+    PryRescue.should_receive(:enter_exception_context).once{ |raised| raised.size.should == 3; throw :try_again }
+    Pry::rescue do
+      @outer += 1
+      Pry::rescue do
+        @inner += 1
+        raise "oops" if @inner <= 2
+      end
+      raise "foops" if @outer == 1
+    end
+  end
+end
+
+describe "Pry.rescued" do
+
+  it "should raise an error if used outwith Pry::rescue" do
+    begin
+      raise "foo"
+    rescue => e
+      lambda{
+        Pry.rescued(e)
+      }.should raise_error(/outside Pry::rescue/)
+    end
+  end
+
+  it "should raise an error if used on an exception not raised" do
+    Pry::rescue do
+      lambda{
+        Pry.rescued(RuntimeError.new("foo").exception)
+      }.should raise_error(/not raised/)
+    end
+  end
+
+  it "should call Pry.enter_exception_context" do
+    Pry::rescue do
+      begin
+        raise "foo"
+      rescue => e
+        PryRescue.should_receive(:enter_exception_context).once
+        Pry::rescued(e)
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-rescue
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interception
@@ -51,6 +51,7 @@ files:
 - lib/pry-rescue/commands.rb
 - lib/pry-rescue/core_ext.rb
 - pry-rescue.gemspec
+- spec/core_ext_spec.rb
 homepage: https://github.com/ConradIrwin/pry-rescue
 licenses: []
 post_install_message: