pry-debugger 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.0 (2012-06-07)
+
+* First release. **step**, **next**, and **continue** commands.
+  [pry-remote 0.1.4][pry-remote] support.
+
+
+[pry-remote]:  https://github.com/Mon-Ouie/pry-remote

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+MIT/Expat License
+
+Copyright (c) 2012 by Gopal Patel
+
+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/README.md

@@ -0,0 +1,54 @@
+pry-debugger
+============
+
+_Fast execution control in Pry_
+
+Adds **step**, **next**, and **continue** commands to [Pry][pry] using
+[debugger][debugger].
+
+To use, invoke pry normally:
+
+```ruby
+def some_method
+  binding.pry          # Execution will stop here.
+  puts 'Hello World'   # Run 'step' or 'next' in the console to move here.
+end
+```
+
+**pry-debugger** is not yet thread-safe, so only use in single-threaded
+environments.
+
+Only supports MRI 1.9.2 and 1.9.3. For a pure-ruby approach not reliant on
+[debugger][debugger], check out [pry-nav][pry-nav]. Note: *pry-nav* and
+*pry-debugger* cannot be loaded together.
+
+Support for [pry-remote][pry-remote] (>= 0.1.4) is also included. Requires
+explicity requiring pry-nav, not just relying on pry's plugin loader. For
+example, in a Gemfile:
+
+```ruby
+gem 'pry'
+gem 'pry-nav'
+```
+
+Stepping through code often? Add the following shortcuts to `~/.pryrc`:
+
+```ruby
+Pry.commands.alias_command 'c', 'continue'
+Pry.commands.alias_command 's', 'step'
+Pry.commands.alias_command 'n', 'next'
+```
+
+## Contributions
+
+Patches and bug reports are welcome. Just send a [pull request][pullrequests] or
+file an [issue][issues]. [Project changelog][changelog].
+
+
+[pry]:            http://pry.github.com
+[debugger]:       https://github.com/cldwalker/debugger
+[pry-nav]:        https://github.com/nixme/pry-nav
+[pry-remote]:     https://github.com/Mon-Ouie/pry-remote
+[pullrequests]:   https://github.com/nixme/pry-debugger/pulls
+[issues]:         https://github.com/nixme/pry-debugger/issues
+[changelog]:      https://github.com/nixme/pry-debugger/blob/master/CHANGELOG.md

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/pry-debugger.rb

@@ -0,0 +1,7 @@
+require 'pry-debugger/cli'
+
+# Load pry-remote monkey patches if pry-remote's available
+begin
+  require 'pry-debugger/pry_remote_ext'
+rescue LoadError
+end

data/lib/pry-debugger/base.rb

@@ -0,0 +1,15 @@
+module PryDebugger
+  TRACE_IGNORE_FILES = Dir[File.join(File.dirname(__FILE__), '..', '**', '*.rb')].map { |f| File.expand_path(f) }
+
+  extend self
+
+  # Checks that a binding is in a local file context. Extracted from
+  # https://github.com/pry/pry/blob/master/lib/pry/default_commands/context.rb
+  def check_file_context(target)
+    file = target.eval('__FILE__')
+    file == Pry.eval_path || (file !~ /(\(.*\))|<.*>/ && file != '' && file != '-e')
+  end
+
+  # Reference to currently running pry-remote server. Used by the processor.
+  attr_accessor :current_remote_server
+end

data/lib/pry-debugger/cli.rb

@@ -0,0 +1,15 @@
+# Pry's new plugin loading system ensures this file runs before pry-remote. So
+# attempting to load everything directly from lib/pry-debugger.rb and
+# referencing that here causes a circular dependency when running
+# bin/pry-remote.
+#
+# So delay loading our monkey-patch to when someone explicity does a:
+#
+#   require 'pry-debugger'
+#
+# Load everything else here.
+#
+
+require 'pry-debugger/base'
+require 'pry-debugger/pry_ext'
+require 'pry-debugger/commands'

data/lib/pry-debugger/commands.rb

@@ -0,0 +1,39 @@
+require 'pry'
+
+module PryDebugger
+  Commands = Pry::CommandSet.new do
+    block_command 'step', 'Step execution into the next line or method.' do |steps|
+      check_file_context
+      breakout_navigation :step, steps
+    end
+
+    block_command 'next', 'Execute the next line within the same stack frame.' do |lines|
+      check_file_context
+      breakout_navigation :next, lines
+    end
+
+    block_command 'continue', 'Continue program execution and end the Pry session.' do
+      check_file_context
+      run 'exit-all'
+    end
+
+    helpers do
+      def breakout_navigation(action, times)
+        _pry_.binding_stack.clear     # Clear the binding stack.
+        throw :breakout_nav, {        # Break out of the REPL loop and
+          :action => action,          #   signal the tracer.
+          :times =>  times
+        }
+      end
+
+      # Ensures that a command is executed in a local file context.
+      def check_file_context
+        unless PryDebugger.check_file_context(target)
+          raise Pry::CommandError, 'Cannot find local context. Did you use `binding.pry`?'
+        end
+      end
+    end
+  end
+end
+
+Pry.commands.import PryDebugger::Commands

data/lib/pry-debugger/processor.rb

@@ -0,0 +1,69 @@
+require 'pry'
+require 'debugger'
+
+module PryDebugger
+  class Processor
+    def initialize(pry_start_options = {}, &block)
+      Debugger.handler = self
+      @pry_start_options = pry_start_options
+    end
+
+    def run(&block)
+      return_value = nil
+      command = catch(:breakout_nav) do  # Throws from PryDebugger::Commands
+        return_value = yield
+        {}    # Nothing thrown == no navigational command
+      end
+
+      times = (command[:times] || 1).to_i   # Command argument
+      times = 1 if times <= 0
+
+      remote = @pry_start_options[:pry_remote] && PryDebugger.current_remote_server
+
+      if [:step, :next].include? command[:action]
+        Debugger.start
+        if Debugger.current_context.frame_self.is_a? Debugger::Context
+          # The first binding.pry call will have a frame inside Debugger. If we
+          # step normally, it'll stop inside this Processor instead. So jump it
+          # out to the above frame.
+          #
+          # TODO: times isn't respected
+          Debugger.current_context.stop_frame = 1 # (remote ? 2 : 1)
+        else
+          if :next == command[:action]
+            Debugger.current_context.step_over(times, 0)
+          else  # step
+            Debugger.current_context.step(times)
+          end
+        end
+      elsif remote  # Continuing execution... cleanup DRb remote if running
+        PryDebugger.current_remote_server.teardown
+      end
+
+      return_value
+    end
+
+
+    # --- Callbacks from debugger C extension ---
+
+    def at_line(context, file, line)
+      return if file && TRACE_IGNORE_FILES.include?(File.expand_path(file))
+      start_pry context
+    end
+
+    def at_breakpoint(context, breakpoint)
+      # TODO
+    end
+
+    def at_catchpoint(context, exception)
+      # TODO
+    end
+
+
+   private
+
+    def start_pry(context)
+      Pry.start(context.frame_binding(0), @pry_start_options)
+    end
+  end
+end

data/lib/pry-debugger/pry_ext.rb

@@ -0,0 +1,21 @@
+require 'pry'
+require 'pry-debugger/processor'
+
+class << Pry
+  alias_method :start_existing, :start
+
+  def start(target = TOPLEVEL_BINDING, options = {})
+    old_options = options.reject { |k, _| k == :pry_remote }
+
+    if target.is_a?(Binding) && PryDebugger.check_file_context(target)
+      # Wrap the processer around the usual Pry.start to catch navigation
+      # commands.
+      PryDebugger::Processor.new(options).run do
+        start_existing(target, old_options)
+      end
+    else
+      # No need for the tracer unless we have a file context to step through
+      start_existing(target, old_options)
+    end
+  end
+end

data/lib/pry-debugger/pry_remote_ext.rb

@@ -0,0 +1,42 @@
+require 'pry-remote'
+
+module PryRemote
+  class Server
+    # Override the call to Pry.start to save off current Server, pass a
+    # pry_remote flag so pry-debugger knows this is a remote session, and not
+    # kill the server right away.
+    def run
+      if PryDebugger.current_remote_server
+        raise 'Already running a pry-remote session!'
+      else
+        PryDebugger.current_remote_server = self
+      end
+
+      setup
+      Pry.start @object, {
+        :input  => client.input_proxy,
+        :output => client.output,
+        :pry_remote => true
+      }
+    end
+
+    # Override to reset our saved global current server session.
+    alias_method :teardown_existing, :teardown
+    def teardown
+      return if @torn
+
+      teardown_existing
+      PryDebugger.current_remote_server = nil
+      @torn = true
+    end
+  end
+end
+
+# Ensure cleanup when a program finishes without another break. For example,
+# 'next' on the last line of a program won't hit PryDebugger::Processor#run,
+# which normally handles cleanup.
+at_exit do
+  if PryDebugger.current_remote_server
+    PryDebugger.current_remote_server.teardown
+  end
+end

data/lib/pry-debugger/version.rb

@@ -0,0 +1,3 @@
+module PryDebugger
+  VERSION = '0.1.0'
+end

data/pry-debugger.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/pry-debugger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'pry-debugger'
+  gem.version       = PryDebugger::VERSION
+  gem.author        = 'Gopal Patel'
+  gem.email         = 'nixme@stillhope.com'
+  gem.license       = 'MIT'
+  gem.homepage      = 'https://github.com/nixme/pry-debugger'
+  gem.summary       = 'Fast debugging with Pry.'
+  gem.description   = "Combine 'pry' with 'debugger'. Adds 'step', 'next', and 'continue' commands to control execution."
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  # Dependencies
+  gem.required_ruby_version = '>= 1.9.2'
+  gem.add_runtime_dependency 'pry', '~> 0.9.9'
+  gem.add_runtime_dependency 'debugger', '~> 1.1.3'
+  gem.add_development_dependency 'pry-remote', '~> 0.1.4'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: pry-debugger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gopal Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+description: Combine 'pry' with 'debugger'. Adds 'step', 'next', and 'continue' commands
+  to control execution.
+email: nixme@stillhope.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pry-debugger.rb
+- lib/pry-debugger/base.rb
+- lib/pry-debugger/cli.rb
+- lib/pry-debugger/commands.rb
+- lib/pry-debugger/processor.rb
+- lib/pry-debugger/pry_ext.rb
+- lib/pry-debugger/pry_remote_ext.rb
+- lib/pry-debugger/version.rb
+- pry-debugger.gemspec
+homepage: https://github.com/nixme/pry-debugger
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fast debugging with Pry.
+test_files: []