pry-nav 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.0.3 (2011-12-01)
+
+* Performance improvement: Don't trace while in the Pry console. Only works in
+  >= 1.9.3-p0 because 1.9.2 segfaults: http://redmine.ruby-lang.org/issues/3921
+* Always cleanup pry-remote DRb server and trace function when a program
+  ends. Fixes [#1](https://github.com/nixme/pry-nav/issues/1).
+* **step** and **next** now check for a local file context. Prevents errors and
+  infinite loops when called from outside `binding.pry`, e.g. `rails console`.
+* More resilient cleanup when [pry-remote][pry-remote] CLI disconnects.
+
+
 ## 0.0.2 (2011-11-30)
 
 * Rudimentary [pry-remote][pry-remote] support. Still a bit buggy.

data/lib/pry-nav.rb

@@ -5,3 +5,7 @@ require 'pry-nav/tracer'
 
 # Optionally load pry-remote monkey patches
 require 'pry-nav/pry_remote_ext' if defined? PryRemote
+
+module PryNav
+  TRACE_IGNORE_FILES = Dir[File.join(File.dirname(__FILE__), '**', '*.rb')]
+end

data/lib/pry-nav/commands.rb

@@ -3,10 +3,12 @@ require 'pry'
 module PryNav
   Commands = Pry::CommandSet.new do
     command 'step', 'Step execution into the next line or method.' do |steps|
+      check_local_context
       breakout_navigation :step, steps
     end
 
     command 'next', 'Execute the next line within the same stack frame.' do |lines|
+      check_local_context
       breakout_navigation :next, lines
     end
 
@@ -26,6 +28,15 @@ module PryNav
           times:  times
         }
       end
+
+      # Checks that a command is executed in a local file context. Extracted
+      # from https://github.com/pry/pry/blob/master/lib/pry/default_commands/context.rb
+      def check_local_context
+        file = target.eval('__FILE__')
+        if file != Pry.eval_path && (file =~ /(\(.*\))|<.*>/ || file == '' || file == '-e')
+          raise Pry::CommandError, 'Cannot find local context. Did you use `binding.pry`?'
+        end
+      end
     end
   end
 end

data/lib/pry-nav/pry_remote_ext.rb

@@ -1,4 +1,5 @@
 require 'pry-remote'
+require 'drb'
 
 module PryRemote
 
@@ -13,6 +14,7 @@ module PryRemote
       uri = "druby://#{host}:#{port}"
 
       @client = PryRemote::Client.new
+      @started = true
       DRb.start_service uri, @client
 
       puts "[pry-remote] Waiting for client on #{uri}"
@@ -45,6 +47,8 @@ module PryRemote
     end
 
     def stop
+      return unless @started
+
       # Reset output streams
       $stdout = @old_stdout
       $stderr = @old_stderr
@@ -55,10 +59,16 @@ module PryRemote
       # Reset system
       Pry.config.system = @old_system
 
-      puts "[pry-remote] Remote sesion terminated"
-      @client.kill
+      begin
+        @client.kill
+      rescue DRb::DRbConnError
+        # Ignore connection errors. The CLI client may have killed itself.
+      ensure
+        DRb.stop_service
+      end
 
-      DRb.stop_service
+      @started = false
+      puts "[pry-remote] Remote sesion terminated"
     end
   end
 end
@@ -76,3 +86,11 @@ class Object
     }
   end
 end
+
+# Ensure cleanup when a program finishes without another break. For example,
+# 'next' on the last line of a program never hits the tracer proc, and thus
+# PryNav::Tracer#run doesn't have a chance to cleanup.
+END {
+  set_trace_func nil
+  PryRemote::Server.stop
+}

data/lib/pry-nav/tracer.rb

@@ -2,27 +2,34 @@ require 'pry'
 
 module PryNav
   class Tracer
-    FILE = File.expand_path(__FILE__)
-
     def initialize(pry_start_options = {}, &block)
       @step_in_lines = -1                      # Break after this many lines
       @frames_when_stepping = nil              # Only break at this frame level
-      @frames = []                             # Traced stack frames
+      @frames = 0                              # Traced stack frame level
       @pry_start_options = pry_start_options   # Options to use for Pry.start
 
       run &block
     end
 
     def run(&block)
-      start    # Set the trace function
+      # For performance, disable any tracers while in the console.
+      # Unfortunately, only works in >= 1.9.3 because of
+      # http://redmine.ruby-lang.org/issues/3921
+      stop if RUBY_VERSION >= '1.9.3'
 
       return_value = nil
-      command = catch(:breakout_nav) do      # Coordinate with PryNav::Commands
+      command = catch(:breakout_nav) do      # Coordinates with PryNav::Commands
         return_value = yield
         {}    # Nothing thrown == no navigational command
       end
 
-      process_command command
+      # Adjust tracer based on command
+      if process_command(command)
+        start
+      else
+        stop unless RUBY_VERSION >= '1.9.3'
+        PryRemote::Server.stop if @pry_start_options[:pry_remote]
+      end
 
       return_value
     end
@@ -43,12 +50,13 @@ module PryNav
       when :step
         @step_in_lines = times
         @frames_when_stepping = nil
+        true
       when :next
         @step_in_lines = times
-        @frames_when_stepping = @frames.size
+        @frames_when_stepping = @frames
+        true
       else
-        stop
-        PryRemote::Server.stop if @pry_start_options[:pry_remote]
+        false
       end
     end
 
@@ -57,18 +65,18 @@ module PryNav
 
     def tracer(event, file, line, id, binding, klass)
       # Ignore traces inside pry-nav code
-      return if (file && File.expand_path(file) == FILE)
+      return if file && TRACE_IGNORE_FILES.include?(File.expand_path(file))
 
       case event
       when 'line'
         # Are we stepping? Or continuing by line ('next') and we're at the right
         # frame? Then decrement our line counter cause this line counts.
-        if !@frames_when_stepping || @frames.size == @frames_when_stepping
+        if !@frames_when_stepping || @frames == @frames_when_stepping
           @step_in_lines -= 1
           @step_in_lines = -1 if @step_in_lines < 0
 
         # Did we go up a frame and not break for a 'next' yet?
-        elsif @frames.size < @frames_when_stepping
+        elsif @frames < @frames_when_stepping
           @step_in_lines = 0   # Break right away
         end
 
@@ -76,10 +84,11 @@ module PryNav
         Pry.start(binding, @pry_start_options) if @step_in_lines == 0
 
       when 'call', 'class'
-        @frames.unshift [binding, file, line, id]   # Track entering a frame
+        @frames += 1         # Track entering a frame
 
       when 'return', 'end'
-        @frames.shift                          # Track leaving a stack frame
+        @frames -= 1         # Track leaving a stack frame
+        @frames = 0 if @frames < 0
       end
     end
   end

data/lib/pry-nav/version.rb

@@ -1,3 +1,3 @@
 module PryNav
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-nav
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70264352532260 !ruby/object:Gem::Requirement
+  requirement: &70332078184900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.9.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *70264352532260
+  version_requirements: *70332078184900
 description: Turn Pry into a primitive debugger. Adds 'step' and 'next' commands to
   control execution.
 email: nixme@stillhope.com
@@ -62,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple execution navigation for Pry.
 test_files: []
-has_rdoc: