pry-exception_explorer 0.1.1pre8 → 0.1.3pre1

data/README.md

@@ -3,25 +3,108 @@ pry-exception_explorer
 
 (C) John Mair (banisterfiend) 2011
 
-FIXME: _tagline_
+_Enter the context of exceptions_
 
-FIXME: _description goes here_
+**Please note, this is a first release for pry-exception_explorer and as such it may still have teething 
+problems. If you encounter any quirks or crashes please [file an issue](https://github.com/pry/pry-exception_explorer/issues)**
+
+`pry-exception_explorer` is an interactive error console for 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).
+
+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
+parent frames (using [pry-stack_explorer](https://github.com/pry/pry-stack_explorer)).
+
+**Watch the mini-screencast:** http://vimeo.com/35953694
 
 * 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)
-
-Example: Example description
+ 
+Example: 
 --------
 
-Example preamble
+In the Ruby file:
+
+```ruby
+require 'pry-exception_explorer'
+
+PryExceptionExplorer.enabled = true
+PryExceptionExplorer.intercept(ArgumentError)
+
+def alpha
+  name = "john"
+  beta
+  puts name
+end
+
+def beta
+  x = "john"
+  gamma(x)
+end
+
+def gamma(x)
+  raise ArgumentError, "x must be a number!" if !x.is_a?(Numeric)
+  puts "2 * x = #{2 * x}"
+end
+
+alpha
+
+```
 
-    puts "example code"
+The following session starts up:
+
+```ruby
+Frame number: 0/4
+Frame type: method
+
+From: /Users/john/ruby/projects/pry-exception_explorer/examples/example_inline.rb @ line 23 in Object#gamma:
+
+    18:   x = "john"
+    19:   gamma(x)
+    20: end
+    21: 
+    22: def gamma(x)
+ => 23:   raise ArgumentError, "x must be a number!" if !x.is_a?(Numeric)
+    24:   puts "2 * x = #{2 * x}"
+    25: end
+    26: 
+    27: alpha
+
+[1] (pry) main: 0> x
+=> "john"
+[2] (pry) main: 0> x = 7
+=> 7
+[3] (pry) main: 0> continue-exception
+```
+
+Since we fixed the problem (invalid type for `x` local) we can `continue-exception`, and have the method continue with the 
+amended `x`:
+
+**PROGRAM OUTPUT:**
+
+>> 2 * x = 14
+
+>> john
 
 Features and limitations
 -------------------------
 
-Feature List Preamble
+### Features
+
+* Puts you in context of exception.
+* Makes entire call stack accessible (useful for drilling down to precise cause of error).
+* Allows you to 'continue' from exception, recovering from error (`continue-exception` command)
+* Has limited/experimental ability to intercept exceptions that arise from C code (use `pry --c-exceptions` to enable).
+* Let's you assert over state of entire stack when determining whether an exception should be intercepted.
+* Let's you start the session on any stack frame.
+
+### Limitations
+
+* Only works on Ruby 1.9.2+ (including 1.9.3) MRI. 
+* Limited support for `C` exceptions -- only some exceptions that arise from C code are caught.
+* Wiki documentation coming soon ;)
 
 Contact
 -------

data/Rakefile

@@ -2,8 +2,8 @@ $:.unshift 'lib'
 
 dlext = RbConfig::CONFIG['DLEXT']
 direc = File.dirname(__FILE__)
-
 PROJECT_NAME = "pry-exception_explorer"
+$VERBOSE = nil
 
 require 'rake/clean'
 require 'rake/gempackagetask'

data/examples/example_inline.rb

@@ -6,7 +6,7 @@ end
 require 'pry-exception_explorer'
 
 PryExceptionExplorer.enabled = true
-PryExceptionExplorer.intercept(RuntimeError)
+PryExceptionExplorer.intercept(ArgumentError)
 
 def alpha
   name = "john"
@@ -15,13 +15,13 @@ def alpha
 end
 
 def beta
-  x = 20
-  gamma
-  puts x
+  x = "john"
+  gamma(x)
 end
 
-def gamma
-  raise "oh my, an exception"
+def gamma(x)
+  raise ArgumentError, "x must be a number!" if !x.is_a?(Numeric)
+  puts "2 * x = #{2 * x}"
 end
 
 alpha

data/lib/pry-exception_explorer/core_ext.rb

@@ -19,28 +19,38 @@ end
 # `PryExceptionExplorer` monkey-patches to `Object`
 class Object
 
-  # We monkey-patch the `raise` method so we can intercept exceptions
-  def raise(exception = RuntimeError, string = nil, array = caller)
-
+  #  We monkey-patch the `raise` method so we can intercept exceptions
+  def raise(*args)
+    exception, string, array = args
     if exception.is_a?(String)
       string = exception
       exception = RuntimeError
     end
 
-    ex = exception.exception(string)
-    ex.set_backtrace(array)
+    if exception.is_a?(Exception)
+      return super(*args)
+    elsif exception.nil?
+      if $!
+        return super($!)
+      else
+        return super(RuntimeError)
+      end
+    else
+      ex = exception.exception(string)
+      ex.set_backtrace(array ? array : caller)
+    end
 
     # revert to normal exception behaviour if EE not enabled.
-    if !PryExceptionExplorer.enabled? 
-      return super(ex)
+    if !PryExceptionExplorer.enabled?
+      return super(*args)
     end
 
     intercept_object = PryExceptionExplorer.intercept_object
-    
+
     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) }      
+      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?

data/lib/pry-exception_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryExceptionExplorer
-  VERSION = "0.1.1pre8"
+  VERSION = "0.1.3pre1"
 end

data/pry-exception_explorer.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pry-exception_explorer"
-  s.version = "0.1.1pre8"
+  s.version = "0.1.2"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2012-01-31"
+  s.date = "2012-02-01"
   s.description = "Enter the context of exceptions"
   s.email = "jrmair@gmail.com"
   s.files = [".gemtest", ".gitignore", ".travis.yml", ".yardopts", "CHANGELOG", "Gemfile", "LICENSE", "README.md", "Rakefile", "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_wrapped_exceptions.rb"]

metadata

@@ -1,59 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pry-exception_explorer
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.3pre1
   prerelease: 5
-  version: 0.1.1pre8
 platform: ruby
-authors: 
+authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-31 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: pry-stack_explorer
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70366152724100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bacon
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70366152724100
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &70366152723200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70366152723200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70366152722480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70366152722480
 description: Enter the context of exceptions
 email: jrmair@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gemtest
 - .gitignore
 - .travis.yml
@@ -81,32 +77,29 @@ files:
 - test/test_wrapped_exceptions.rb
 homepage: https://github.com/banister/pry-exception_explorer
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Enter the context of exceptions
-test_files: 
+test_files:
 - test/helper.rb
 - test/test_exceptions_in_pry.rb
 - test/test_inline_exceptions.rb