pry-rescue 0.5 → 0.6

data/bin/rescue

@@ -23,7 +23,7 @@ if script = ARGV.shift
     begin; require 'pry-stack_explorer'; rescue LoadError; end
 
     $0 = File.expand_path script
-    Pry.rescue { load script }
+    PryRescue.load script
   else
     $stderr.puts "Error: #{script.inspect} not found."
   end

data/lib/pry-rescue.rb

@@ -18,28 +18,85 @@ class PryRescue
     # @param [Array<Binding>] bindings The call stack.
     def enter_exception_context(raised)
 
-      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)
+      raised = raised.map do |e, bs|
+        [e, without_bindings_below_raise(bs)]
       end
 
+      raised.pop if phantom_load_raise?(*raised.last)
+      exception, bindings = raised.last
+
       if defined?(PryStackExplorer)
-        pry :call_stack => bindings, :hooks => pry_hooks(exception, raised)
+        pry :call_stack => without_duplicates(bindings),
+            :hooks => pry_hooks(exception, raised),
+            :initial_frame => initial_frame(bindings)
       else
-        bindings.first.pry :hooks => pry_hooks(exception, raised)
+        Pry.start bindings.first, :hooks => pry_hooks(exception, raised)
       end
     end
 
+    # Load a script wrapped in Pry::rescue{ }
+    # @param [String] The name of the script
+    def load(script)
+      Pry::rescue{ Kernel.load script }
+    end
+
     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__))
+    # Did this raise happen within pry-rescue?
+    #
+    # 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>]
+    def phantom_load_raise?(e, bindings)
+      bindings.any? && bindings.first.eval("__FILE__") == __FILE__
+    end
+
+    # 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
+    # @return [Fixnum]  The offset of the first binding of user code
+    def initial_frame(bindings)
+      bindings.each_with_index do |binding, i|
+        return i if user_path?(binding.eval("__FILE__"))
+      end
+
+      0
+    end
+
+    # Is this path likely to be code the user is working with right now?
+    #
+    # @param [String] the absolute path
+    # @return [Boolean]
+    def user_path?(file)
+      !file.start_with?(RbConfig::CONFIG['libdir']) &&
+      !Gem::Specification.any?{ |gem| file.start_with?(gem.full_gem_path) }
+    end
+
+    # 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.
+    def without_bindings_below_raise(bindings)
+      return bindings if bindings.size <= 1
+      bindings.drop_while do |b|
+        b.eval("__FILE__") == File.expand_path("../pry-rescue/core_ext.rb", __FILE__)
+      end.drop_while do |b|
+        b.eval("self") == Interception
+      end
+    end
+
+    # Remove multiple bindings for the same function.
+    #
+    # @param [Array<Bindings>]
+    # @return [Array<Bindings>]
+    def without_duplicates(bindings)
+      bindings.zip([nil] + bindings).reject do |b, c|
+        # The eval('__method__') is there as a shortcut as loading a method
+        # from a binding is very slow.
+        c && (b.eval("__method__") == c.eval("__method__")) &&
+                    Pry::Method.from_binding(b) == Pry::Method.from_binding(c)
+      end.map(&:first)
     end
 
     # Define the :before_session hook for the Pry instance.
@@ -56,11 +113,5 @@ class PryRescue
 
       hooks
     end
-
-    # Sanitize the call stack.
-    # @param [Array<Binding>] bindings The call stack.
-    def prune_call_stack!(bindings)
-      bindings.delete_if { |b| [Pry, Interception].include?(b.eval("self")) }
-    end
   end
 end

data/pry-rescue.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'pry-rescue'
-  s.version       = '0.5'
+  s.version       = '0.6'
   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/fixtures/coderay.rb

@@ -0,0 +1,3 @@
+require 'coderay'
+
+CodeRay.scan(123,123).tokens

data/spec/fixtures/simple.rb

@@ -0,0 +1 @@
+raise "fixtures/simple"

data/spec/fixtures/uri.rb

@@ -0,0 +1,2 @@
+require 'uri'
+URI.parse(0)

data/spec/pry_rescue_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path('../../lib/pry-rescue.rb', __FILE__)
+require 'uri'
+
+describe "PryRescue.load" do
+  if defined?(PryStackExplorer)
+    it "should open at the correct point" do
+      PryRescue.should_receive(:pry).once{ |opts|
+        opts[:call_stack].first.eval("__FILE__").should end_with('spec/fixtures/simple.rb')
+      }
+      lambda{
+        PryRescue.load("spec/fixtures/simple.rb")
+      }.should raise_error(/fixtures.simple/)
+    end
+
+    it "should open above the standard library" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack][opts[:initial_frame]].eval("__FILE__").should end_with('spec/fixtures/uri.rb')
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/uri.rb")
+      }.should raise_error(URI::InvalidURIError)
+    end
+
+    it "should keep the standard library on the binding stack" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack].first.eval("__FILE__").should start_with(RbConfig::CONFIG['libdir'])
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/uri.rb")
+      }.should raise_error(URI::InvalidURIError)
+    end
+
+    it "should open above gems" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack][opts[:initial_frame]].eval("__FILE__").should end_with('spec/fixtures/coderay.rb')
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/coderay.rb")
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should open above gems" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack].first.eval("__FILE__").should start_with(Gem::Specification.detect{|x| x.name == 'coderay' }.full_gem_path)
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/coderay.rb")
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should filter out duplicate stack frames" do
+      PryRescue.should_receive(:pry).once do |opts|
+        opts[:call_stack][0].eval("__LINE__").should == 4
+        opts[:call_stack][1].eval("__LINE__").should == 12
+      end
+      lambda{
+        PryRescue.load("spec/fixtures/super.rb")
+      }.should raise_error(/fixtures.super/)
+    end
+  else
+    it "should open at the correct point" do
+      Pry.should_receive(:start).once{ |binding, h|
+        binding.eval("__FILE__").should end_with('spec/fixtures/simple.rb')
+      }
+      lambda{
+        PryRescue.load("spec/fixtures/simple.rb")
+      }.should raise_error(/fixtures.simple/)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-rescue
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors:
@@ -70,6 +70,10 @@ files:
 - lib/pry/rescue.rb
 - pry-rescue.gemspec
 - spec/core_ext_spec.rb
+- spec/fixtures/coderay.rb
+- spec/fixtures/simple.rb
+- spec/fixtures/uri.rb
+- spec/pry_rescue_spec.rb
 homepage: https://github.com/ConradIrwin/pry-rescue
 licenses: []
 post_install_message: