pry-exception_explorer 0.1.9 → 0.2.0pre1

data/README.md

@@ -7,7 +7,10 @@ _Enter the context of exceptions_
 
 `pry-exception_explorer` is an interactive error console for MRI Ruby 1.9.2+ inspired by the [Hammertime](https://github.com/avdi/hammertime)
 gem, which was in turn inspired by consoles found in the Lisp and Smalltalk environments. `pry-exception_explorer` is a plugin
-for the [Pry REPL](http://pry.github.com).
+for the [Pry REPL](http://pry.github.com). 
+
+**Note**, like the hammertime gem, `pry-exception_explorer` can only really intercept exceptions that are explicitly raised (using the `raise` method) from Ruby code. 
+This means that exceptions raised by syntax errors or from code such as `1/0` cannot be intercepted. Though experimental support for intercepting such deep (c-level) exceptions is provided by invoking with `pry --c-exceptions`.
 
 Using `pry-exception_explorer` we can automatically pull up a [Pry](http://pry.github.com) session at the point an exception arises and use `Pry`
 to inspect the state there to debug (and fix) the problem. We also get access to the entire call stack of the exception and can walk the stack to interactively examine the state in
@@ -18,7 +21,9 @@ parent frames (using [pry-stack_explorer](https://github.com/pry/pry-stack_explo
 * Install the [gem](https://rubygems.org/gems/pry-exception_explorer): `gem install pry-exception_explorer`
 * Read the [documentation](http://rdoc.info/github/banister/pry-exception_explorer/master/file/README.md)
 * See the [source code](http://github.com/banister/pry-exception_explorer)
-* See the [wiki](https://github.com/pry/pry-exception_explorer/wiki) for in-depth usage information.
+* See the [**WIKI**](https://github.com/pry/pry-exception_explorer/wiki) for in-depth usage information.
+
+Also look at the [plymouth](https://github.com/banister/plymouth) project which utilizes `pry-exception_explorer` to intercept test failures.
 
 Example:
 --------

data/Rakefile

@@ -23,7 +23,7 @@ def apply_spec_defaults(s)
   s.description = s.summary
   s.require_path = 'lib'
   s.homepage = "https://github.com/banister/pry-exception_explorer"
-  s.add_dependency('pry-stack_explorer', ">=0.3.9")
+  s.add_dependency('pry-stack_explorer', ">=0.4.6")
   s.add_development_dependency("bacon","~>1.1.0")
   s.add_development_dependency('rake', '~> 0.9')
   s.executables = ['pry-shim']
@@ -68,7 +68,7 @@ end
 
 desc "run tests"
 task :test do
-  sh "bacon -Itest -rubygems -a -q"
+ sh "bacon -Itest -rubygems -a -q"
 end
 
 desc "Build gemspec"

data/lib/pry-exception_explorer/commands.rb

@@ -5,8 +5,13 @@ module PryExceptionExplorer
     include PryStackExplorer::FrameHelpers
 
     private
+
+    def exception
+      frame_manager.user[:exception]
+    end
+
     def in_exception?
-      frame_manager && frame_manager.user[:exception]
+      frame_manager && exception
     end
 
     def last_exception
@@ -14,17 +19,20 @@ module PryExceptionExplorer
     end
 
     def enterable_exception?
-      last_exception && last_exception.exception_call_stack
+      PryExceptionExplorer.enabled && last_exception && last_exception.exception_call_stack
     end
 
     def inline_exception?
-      frame_manager && frame_manager.user[:exception] &&
+      in_exception? &&
         frame_manager.user[:inline_exception]
     end
 
+    def internal_exception?
+      in_exception? && exception.internal_exception?
+    end
+
     def normal_exception?
-      frame_manager && frame_manager.user[:exception] &&
-        frame_manager.user[:exception].continuation
+      in_exception? && frame_manager.user[:exception].continuation
     end
   end
 
@@ -84,7 +92,9 @@ module PryExceptionExplorer
       BANNER
 
       def process
-        if inline_exception?
+        if internal_exception?
+          raise Pry::CommandError, "Internal exceptions (C-level exceptions) cannot be continued!"
+        elsif inline_exception?
           PryStackExplorer.pop_frame_manager(_pry_)
           run "exit-all PryExceptionExplorer::CONTINUE_INLINE_EXCEPTION"
         elsif normal_exception?

data/lib/pry-exception_explorer/core_ext.rb

@@ -16,6 +16,11 @@ class Exception
   #   (Only relevant for wrapped exceptions).
   attr_accessor :should_intercept
 
+  # @return [Boolean] Whether this exception was raised internally.
+  #   i.e from the C-level using `rb_raise`
+  attr_accessor :internal_exception
+  alias_method :internal_exception?, :internal_exception
+
   # This method enables us to continue an exception (using
   # `callcc` internally)
   def continue
@@ -23,6 +28,33 @@ class Exception
     continuation.call
   end
 
+  alias_method :old_exception, :exception
+
+  def exception(*args, &block)
+    $e = binding.callers.drop(1)
+    if PryExceptionExplorer.enabled? &&
+        PryExceptionExplorer.should_intercept_exception?(binding.of_caller(1), self) &&
+        !caller.any? { |t| t.include?("raise") } && !exception_call_stack
+      
+      ex = old_exception(*args, &block)
+
+      ex.exception_call_stack = binding.callers.drop(1)
+      ex.set_backtrace(caller.drop(1)) if !ex.backtrace
+
+      PryExceptionExplorer.amend_exception_call_stack!(ex)
+      ex.should_intercept   = true
+      ex.internal_exception = true
+
+      if PryExceptionExplorer.inline?
+        retval = PryExceptionExplorer.enter_exception(ex, :inline => true)
+      end
+
+      ex
+    else
+      old_exception(*args, &block)
+    end
+  end
+
   alias_method :should_intercept?, :should_intercept
 end
 
@@ -71,18 +103,14 @@ module PryExceptionExplorer
 
       intercept_object = PryExceptionExplorer.intercept_object
 
-      # FIXME: CodeRay stuff is a hack because CodeRay generates a bunch of
-      # exceptions that would cause EE to infiniloop on
-      # intercept(Exception), find a better solution.
-      if PryExceptionExplorer.should_intercept_exception?(binding.of_caller(1), ex) &&
-          binding.of_caller(1).eval('[__method__, self.to_s]') != [:make_plugin_hash, "CodeRay::Encoders"]
+      if PryExceptionExplorer.should_intercept_exception?(binding.of_caller(1), ex)
 
         ex.exception_call_stack = binding.callers.tap { |v| v.shift(1 + intercept_object.skip_num) }
         PryExceptionExplorer.amend_exception_call_stack!(ex)
 
         ex.should_intercept  = true
 
-        if !PryExceptionExplorer.wrap_active?
+        if PryExceptionExplorer.inline?
           retval = PryExceptionExplorer.enter_exception(ex, :inline => true)
         end
       end
@@ -97,7 +125,6 @@ module PryExceptionExplorer
   end
 end
 
-
 class Object
   include PryExceptionExplorer::CoreExtensions
 end

data/lib/pry-exception_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryExceptionExplorer
-  VERSION = "0.1.9"
+  VERSION = "0.2.0pre1"
 end

data/lib/pry-exception_explorer.rb

@@ -27,6 +27,19 @@ module PryExceptionExplorer
       @hash ||= {}
     end
 
+    # @return [Boolean] Whether exceptions are to be intercepted
+    #   inline (at the raise site).
+    attr_accessor :inline
+    attr_accessor :post_mortem
+
+    # Ensure exceptions are intercepted at the raise site.
+    def inline!
+      self.inline = true
+    end
+
+    alias_method :inline?, :inline
+    alias_method :post_mortem?, :post_mortem
+
     # Enable Exception Explorer.
     # @return [Boolean]
     def enable!
@@ -71,8 +84,10 @@ module PryExceptionExplorer
     # @yield The block to wrap.
     def wrap
       old_enabled, old_wrap_active = enabled, wrap_active
+      old_inline = inline
       self.enabled     = true
       self.wrap_active = true
+      self.inline      = false
       yield
     rescue Exception => ex
       if ex.should_intercept?
@@ -83,6 +98,7 @@ module PryExceptionExplorer
     ensure
       self.enabled     = old_enabled
       self.wrap_active = old_wrap_active
+      self.inline      = old_inline
     end
 
     # This method allows the user to assert the situations where an
@@ -134,7 +150,13 @@ module PryExceptionExplorer
     # @param [Exception] ex The exception that was raised.
     # @return [Boolean] Whether the exception should be intercepted.
     def should_intercept_exception?(frame, ex)
-      if intercept_object
+      # special case, or we go into infinite loop. CodeRay uses
+      # exceptions for flow control :/
+      if defined?(CodeRay::Encoders) && frame.eval('self') == CodeRay::Encoders
+        false
+
+        # normal case
+      elsif intercept_object
         intercept_object.call(LazyFrame.new(frame), ex)
       else
         false
@@ -174,8 +196,8 @@ module PryExceptionExplorer
     # @option options [Boolean] :inline Whether the exception is being
     #   entered inline (i.e within the `raise` method itself)
     def setup_exception_context(ex, _pry_, options={})
-      _pry_.last_exception = ex
-      _pry_.backtrace = ex.backtrace
+      _pry_.last_exception = ex 
+      _pry_.backtrace = (ex.backtrace || [])
 
       PryStackExplorer.frame_manager(_pry_).user[:exception]        = ex
       PryStackExplorer.frame_manager(_pry_).user[:inline_exception] = !!options[:inline]
@@ -190,37 +212,47 @@ module PryExceptionExplorer
       hooks = Pry.config.hooks.dup.add_hook(:before_session, :set_exception_flag) do |_, _, _pry_|
         setup_exception_context(ex, _pry_, options)
       end.add_hook(:before_session, :manage_intercept_recurse) do
-        PryExceptionExplorer.intercept_object.disable! if !PryExceptionExplorer.intercept_object.intercept_recurse?
+        PryExceptionExplorer.intercept_object.disable! if PryExceptionExplorer.inline? && !PryExceptionExplorer.intercept_object.intercept_recurse?
       end.add_hook(:after_session, :manage_intercept_recurse) do
         PryExceptionExplorer.intercept_object.enable! if !PryExceptionExplorer.intercept_object.active?
       end
 
-      #   Pry.load_plugins
-      #   binding.pry    # if we have this here and step through with  pry-nav sometimes we get segfaults :/
-
       Pry.start binding, :call_stack => ex.exception_call_stack, :hooks => hooks
     end
 
     # Set initial state
     def init
+      PryExceptionExplorer.post_mortem = true
+      PryExceptionExplorer.enabled = true
+      
       # disable by default (intercept exceptions inline)
-      PryExceptionExplorer.wrap_active = false
+      PryExceptionExplorer.wrap_active = true
 
       # default is to capture all exceptions
       PryExceptionExplorer.intercept { true }
 
       # disable by default
-      PryExceptionExplorer.enabled = false
+      PryExceptionExplorer.inline = false
+      at_exit do
+        ex = $!
+        
+        next if !PryExceptionExplorer.post_mortem? || !ex
+        
+        if ex.should_intercept?
+          enter_exception(ex)
+        else
+          raise ex
+        end
+      end
     end
   end
 end
 
 # Add a hook to enable EE when invoked via `pry` executable
 Pry.config.hooks.add_hook(:when_started, :try_enable_exception_explorer) do
-  if Pry.cli
-    PryExceptionExplorer.wrap_active = true
-    PryExceptionExplorer.enabled     = true
-  end
+  PryExceptionExplorer.wrap_active = true
+  PryExceptionExplorer.enabled     = true
+  PryExceptionExplorer.inline      = false
 end
 
 # Bring in commands

data/pry-exception_explorer.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = "pry-exception_explorer"
-  s.version = "0.1.9"
+  s.version = "0.2.0pre1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2012-02-21"
+  s.date = "2012-09-29"
   s.description = "Enter the context of exceptions"
   s.email = "jrmair@gmail.com"
   s.executables = ["pry-shim"]
   s.files = [".gemtest", ".gitignore", ".travis.yml", ".yardopts", "CHANGELOG", "Gemfile", "LICENSE", "README.md", "Rakefile", "bin/pry-shim", "examples/example_c_inline.rb", "examples/example_inline.rb", "examples/example_wrap.rb", "lib/pry-exception_explorer.rb", "lib/pry-exception_explorer/cli.rb", "lib/pry-exception_explorer/commands.rb", "lib/pry-exception_explorer/core_ext.rb", "lib/pry-exception_explorer/intercept.rb", "lib/pry-exception_explorer/lazy_frame.rb", "lib/pry-exception_explorer/shim_builder.rb", "lib/pry-exception_explorer/version.rb", "pry-exception_explorer.gemspec", "test/helper.rb", "test/test_exceptions_in_pry.rb", "test/test_inline_exceptions.rb", "test/test_raise.rb", "test/test_wrapped_exceptions.rb"]
   s.homepage = "https://github.com/banister/pry-exception_explorer"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.16"
+  s.rubygems_version = "1.8.15"
   s.summary = "Enter the context of exceptions"
   s.test_files = ["test/helper.rb", "test/test_exceptions_in_pry.rb", "test/test_inline_exceptions.rb", "test/test_raise.rb", "test/test_wrapped_exceptions.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-stack_explorer>, [">= 0.3.9"])
+      s.add_runtime_dependency(%q<pry-stack_explorer>, [">= 0.4.6"])
       s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_development_dependency(%q<rake>, ["~> 0.9"])
     else
-      s.add_dependency(%q<pry-stack_explorer>, [">= 0.3.9"])
+      s.add_dependency(%q<pry-stack_explorer>, [">= 0.4.6"])
       s.add_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_dependency(%q<rake>, ["~> 0.9"])
     end
   else
-    s.add_dependency(%q<pry-stack_explorer>, [">= 0.3.9"])
+    s.add_dependency(%q<pry-stack_explorer>, [">= 0.4.6"])
     s.add_dependency(%q<bacon>, ["~> 1.1.0"])
     s.add_dependency(%q<rake>, ["~> 0.9"])
   end

data/test/helper.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'pry'
 
 unless Object.const_defined? 'PryExceptionExplorer'
   $:.unshift File.expand_path '../../lib', __FILE__
@@ -17,6 +18,8 @@ class OpenStruct
   end
 end
 
+Pad = OpenStruct.new
+
 class Ratty
   def ratty
     Weasel.new.weasel

data/test/test_exceptions_in_pry.rb

@@ -15,6 +15,42 @@ describe PryExceptionExplorer do
   end
 
   describe "Exceptions caught by Pry" do
+
+    describe "internal exceptions (C-level)" do
+      before do
+        O.klass = Class.new do
+          def alpha
+            beta
+          end
+          def beta
+            1 / 0
+          end
+        end
+      end
+      
+      it 'should be able to enter internal exceptions' do
+        redirect_pry_io(InputTester.new("O.klass.new.alpha",
+                                        "enter-exception",
+                                        "O.method_name = __method__",
+                                        "exit")) do
+          Pry.start
+        end
+
+        O.method_name.should == :beta
+      end
+
+      it 'should have the full call-stack available' do
+        redirect_pry_io(InputTester.new("O.klass.new.alpha",
+                                        "enter-exception",
+                                        "show-stack",
+                                        "exit"), out=StringIO.new) do
+          Pry.start
+        end
+
+        out.string.should =~ /alpha/
+      end
+    end
+    
     describe "enter-exception" do
       it  "should be able to enter an exception caught by pry" do
         # there are 3 types of situations where exception_explorer is invoked:

data/test/test_inline_exceptions.rb

@@ -6,6 +6,7 @@ O = OpenStruct.new
 
 prev_wrap_state = PryExceptionExplorer.wrap_active
 PryExceptionExplorer.wrap_active = false
+PryExceptionExplorer.inline!
 
 prev_intercept_state = PryExceptionExplorer.intercept_object
 
@@ -32,6 +33,23 @@ describe PryExceptionExplorer do
     O.clear
   end
 
+  describe "internal exceptions" do
+    it 'should intercept internal exceptions inline' do
+      redirect_pry_io(StringIO.new("O.exception_intercepted = true\nexit-all\n"), out=StringIO.new) do
+        (1 / 0) rescue nil
+      end
+      
+      O.exception_intercepted.should == true
+    end
+
+    it 'should be un-continuable' do
+      redirect_pry_io(StringIO.new("O.exception_intercepted = true\ncontinue-exception\n"), out=StringIO.new) do
+        (1 / 0) rescue nil
+      end
+      out.string.should =~ /cannot be continued/
+    end
+  end
+
   describe "enabled = false" do
     it 'should prevent interception of an exception' do
       old_e = PryExceptionExplorer.enabled

data/test/test_wrapped_exceptions.rb

@@ -14,6 +14,7 @@ describe PryExceptionExplorer do
   end
 
   after do
+    Pad.clear
     Pry.config.hooks.delete_hook(:when_started, :save_caller_bindings)
     Pry.config.hooks.delete_hook(:after_session, :delete_frame_manager)
   end
@@ -56,11 +57,42 @@ describe PryExceptionExplorer do
       end
     end
 
+    describe "internal exceptions" do
+      it 'should be able to intercept internal exceptions' do
+        redirect_pry_io(InputTester.new("Pad.ex = _ex_", "exit-all")) do
+          PryExceptionExplorer.wrap do
+            (1 / 0)
+          end rescue nil
+        end
+
+        Pad.ex.is_a?(ZeroDivisionError).should == true
+      end
+
+      it 'should not intercept rescued exceptions' do
+        redirect_pry_io(InputTester.new("Pad.ex = _ex_", "exit-all")) do
+          PryExceptionExplorer.wrap do
+            (1 / 0) rescue nil
+          end 
+        end
+
+        Pad.ex.should == nil
+      end
+
+      it 'should not be able to continue exceptions' do
+        redirect_pry_io(InputTester.new("continue-exception"), out=StringIO.new) do
+          PryExceptionExplorer.wrap do
+            (1 / 0) 
+          end 
+        end
+
+        out.string.should =~ /cannot be continued/
+      end
+    end
+
     describe "enabled = false" do
       it 'should have no effect for wrap block (which sets enabled=true internally)' do
         old_e = PryExceptionExplorer.enabled
         PryExceptionExplorer.enabled = false
-
         PryExceptionExplorer.wrap do
           raise CaughtException, "catch me if u can"
         end.should == :caught

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: pry-exception_explorer
 version: !ruby/object:Gem::Version
-  version: 0.1.9
-  prerelease: 
+  version: 0.2.0pre1
+  prerelease: 5
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000 Z
+date: 2012-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
-  requirement: &70215207746240 !ruby/object:Gem::Requirement
+  requirement: &70293402053520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: 0.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70215207746240
+  version_requirements: *70293402053520
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &70215207745780 !ruby/object:Gem::Requirement
+  requirement: &70293401916160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70215207745780
+  version_requirements: *70293401916160
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70215207745320 !ruby/object:Gem::Requirement
+  requirement: &70293401915540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70215207745320
+  version_requirements: *70293401915540
 description: Enter the context of exceptions
 email: jrmair@gmail.com
 executables:
@@ -93,12 +93,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Enter the context of exceptions