pry-capture 0.1 → 1.0

data/README.md

@@ -1,94 +1,9 @@
-pry-capture allows you to start a Pry session on any unhandled exceptions in your code.
 
+Renamed
+=======
 
-Installation
-============
-Either `gem install pry-capture`, or add it to the development section of your Gemfile:
-
-```ruby
-source :rubygems
-group :development do
-  gem 'pry-capture'
-  gem 'pry-stack_explorer' # if you're using MRI 1.9 and you want it to be awesome.
-end
-```
-
-Usage
-=====
-
-In development, wrap your code in `Pry::capture{ }`; then any exceptions that are raised
-but not rescued will open a pry session.
-
-```ruby
-require 'pry-capture'
-
-def test
-  raise "foo"
-rescue => e
-  raise "bar"
-end
-
-Pry.capture do
-  test
-end
-```
-
-This will land you in a pry-session:
-
-```
-From: examples/example.rb @ line 4 Object#test:
-
-    4: def test
-    5:   raise "foo"
-    6: rescue => e
- => 7:   raise "bar"
-    8: end
-
-RuntimeError: bar
-from examples/example.rb:7:in `rescue in test'
-[1] pry(main)>
-```
-
-If you need to find the reason that the exception happened, you can use the `cd-cause`
-command:
-
-```
-[1] pry(main)> cd-cause
-From: examples/example.rb @ line 4 Object#test:
-
-    4: def test
- => 5:   raise "foo"
-    6: rescue => e
-    7:   raise "bar"
-    8: end
-
-RuntimeError: foo
-from examples/example.rb:5:in `test'
-[1] pry(main)>
-```
-
-To get back from `cd-cause` you can either type `<ctrl+d>` or `cd ..`.
-
-pry-stack explorer
-==================
-
-If you're running rubinius, or ruby-1.9, then you can use `pry-capture` alongside
-`pry-stack_explorer`. This gives you the ability to move `up` or `down` the stack so that
-you can get a better idea of why your function ended up in a bad state. Run
-[example2.rb](https://github.com/ConradIrwin/pry-capture/blob/master/examples/example2.rb) to get a feel for what this is like.
-
-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.
-
-On rbx we are unable to intercept some exceptions thrown from inside the C++ VM, for
-example the ZeroDivisionError in `1 / 0`.
+The `pry-capture` gem has been renamed to `pry-rescue` by popular demand. This stub exists
+so that people already using `pry-capture` can continue doing so without problem.
 
-Meta-fu
-=======
+For further information, please look at [pry-rescue on Github](https://github.com/ConradIrwin/pry-rescue).
 
-Released under the MIT license, see LICENSE.MIT for details. Contributions and bug-reports
-are welcome.

data/lib/pry-capture.rb

@@ -1,54 +1 @@
-require 'rubygems'
-require 'interception'
-require 'pry'
-
-require File.expand_path('../pry-capture/core_ext', __FILE__)
-require File.expand_path('../pry-capture/commands', __FILE__)
-
-begin
-  require 'pry-stack_explorer'
-rescue LoadError
-end
-
-class PryCapture
-  class << self
-
-    # Start a Pry session in the context of the exception.
-    # @param [Exception] exception The exception.
-    # @param [Array<Binding>] bindings The call stack.
-    def enter_exception_context(raised)
-      exception, bindings = raised.last
-
-      prune_call_stack!(bindings)
-
-      if defined?(PryStackExplorer)
-        pry :call_stack => bindings, :hooks => pry_hooks(exception, raised)
-      else
-        bindings.first.pry :hooks => pry_hooks(exception, raised)
-      end
-    end
-
-    private
-
-    # Define the :before_session hook for the Pry instance.
-    # This ensures that the `_ex_` and `_raised_` sticky locals are
-    # properly set.
-    def pry_hooks(ex, raised)
-      hooks = Pry.config.hooks.dup
-      hooks.add_hook(:before_session, :save_captured_exception) do |_, _, _pry_|
-        _pry_.last_exception = ex
-        _pry_.backtrace = ex.backtrace
-        _pry_.sticky_locals.merge!({ :_raised_ => raised })
-        _pry_.exception_handler.call(_pry_.output, ex, _pry_)
-      end
-
-      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
+require 'pry-rescue'

data/pry-capture.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name          = 'pry-capture'
-  s.version       = '0.1'
+  s.version       = '1.0'
   s.summary       = 'Open a pry session on any unhandled exceptions'
-  s.description   = 'Allows you to wrap code in Pry::capture{ } to open a pry session at any unhandled exceptions'
-  s.homepage      = 'https://github.com/ConradIrwin/pry-capture'
-  s.email         = ['conrad.irwin@gmail.com', 'jrmair@gmail.com']
-  s.authors       = ['Conrad Irwin', 'banisterfiend']
+  s.description   = 'This gem just installs pry-rescue. Please prefer that gem.'
+  s.homepage      = 'https://github.com/ConradIrwin/pry-rescue'
+  s.email         = ['conrad.irwin@gmail.com']
+  s.authors       = ['Conrad Irwin']
   s.files         = `git ls-files`.split("\n")
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_dependency 'interception'
+  s.add_dependency 'pry-rescue'
 end

metadata

@@ -1,90 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pry-capture
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: '1.0'
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
 platform: ruby
-authors: 
+authors:
 - Conrad Irwin
-- banisterfiend
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: interception
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: Allows you to wrap code in Pry::capture{ } to open a pry session at any unhandled exceptions
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem just installs pry-rescue. Please prefer that gem.
+email:
 - conrad.irwin@gmail.com
-- jrmair@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- LICENSE.MIT
+files:
 - README.md
-- Rakefile
-- examples/example.rb
-- examples/example2.rb
 - lib/pry-capture.rb
-- lib/pry-capture/cli.rb
-- lib/pry-capture/commands.rb
-- lib/pry-capture/core_ext.rb
 - pry-capture.gemspec
-homepage: https://github.com/ConradIrwin/pry-capture
+homepage: https://github.com/ConradIrwin/pry-rescue
 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 
-      hash: 3
-      segments: 
-      - 0
-      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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Open a pry session on any unhandled exceptions
 test_files: []
-
 has_rdoc: 

data/LICENSE.MIT

@@ -1,19 +0,0 @@
-Copyright (c) 2012 Conrad Irwin <conrad.irwin@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

@@ -1,16 +0,0 @@
-desc "Run example"
-task :example do
-  sh "ruby -I./lib/ ./examples/example.rb "
-end
-
-desc "Run example 2"
-task :example2 do
-  sh "ruby -I./lib/ ./examples/example2.rb "
-end
-
-desc "Run tests"
-task :test do
-  sh 'rspec spec -r ./spec/spec_helpers.rb'
-end
-
-

data/examples/example.rb

@@ -1,21 +0,0 @@
-$:.unshift File.expand_path '../../lib', __FILE__
-require 'pry-capture'
-
-Pry.capture do
-
-  def a
-    begin
-      begin
-        raise "foo"
-
-      rescue => e
-        raise "bar"
-      end
-
-    rescue => e
-      1 / 0
-
-    end
-  end
-  a
-end

data/examples/example2.rb

@@ -1,20 +0,0 @@
-$:.unshift File.expand_path '../../lib', __FILE__
-require 'pry-capture'
-
-def alpha
-  x = 1
-  beta
-end
-
-def beta
-  y = 30
-  gamma(1, 2)
-end
-
-def gamma(x)
-  greeting = x
-end
-
-Pry.capture do
-  alpha
-end

data/lib/pry-capture/cli.rb

@@ -1 +0,0 @@
-require 'pry-capture'

data/lib/pry-capture/commands.rb

@@ -1,44 +0,0 @@
-Pry::Commands.create_command "cd-cause", "Move to the previously raised exception"  do
-
-  banner <<-BANNER
-    Usage: cd-cause
-
-    Starts a new pry session at the previously raised exception.
-
-    This is useful if you've caught one exception, and raised another,
-    if you need to find out why the original was raised.
-
-    @example
-      5.    def foo
-      6.      raise "one"
-      7.    rescue
-      8. =>    raise "two"
-      9.    end
-
-      pry> cd-cause
-
-      5.    def foo
-      6. =>    raise "one"
-      7.    rescue
-      8.       raise "two"
-      9.    end
-
-    Once you have finished with the internal exception type <ctrl+d> or cd .. to
-    return to where you were.
-
-    If you have many layers of exceptions that are rescued and then re-raised, you
-    can repeat cd-cause as many times as you need.
-  BANNER
-
-  def process
-    raised = target.eval("_raised_ rescue nil")
-    raise Pry::CommandError, "cd-cause only works in a pry session created by Pry::capture{}" unless raised
-    raised.pop
-
-    if raised.any?
-      PryCapture.enter_exception_context(raised)
-    else
-      raise Pry::CommandError, "No previous exception detected"
-    end
-  end
-end

data/lib/pry-capture/core_ext.rb

@@ -1,26 +0,0 @@
-class Pry
-
-  # Start a pry session on any unhandled exceptions within this block.
-  #
-  # @example
-  #   Pry::capture do
-  #     raise "foo"
-  #   end
-  #
-  # @return [Object] The return value of the block
-  def self.capture(&block)
-    raised = []
-
-    Interception.listen(block) do |exception, binding|
-      if defined?(PryStackExplorer)
-        raised << [exception, binding.callers]
-      else
-        raised << [exception, Array(binding)]
-      end
-    end
-
-  rescue Exception => e
-    PryCapture.enter_exception_context(raised)
-    raise
-  end
-end