pry-nav 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.0.4 (2011-12-03)
+
+* Performance improvement, primarily for 1.9.2: Don't trace unless in a file
+  context. `rails console` or standard `pry` shouldn't experience a slowdown
+  anymore.
+* The overriden `Pry.start` now returns the output of the original method, not a
+  `PryNav::Tracer` instance.
+* For consistency with the other nav commands, **continue** now checks for a
+  local file context.
+
+
 ## 0.0.3 (2011-12-01)
 
 * Performance improvement: Don't trace while in the Pry console. Only works in

data/LICENSE

@@ -0,0 +1,20 @@
+MIT/Expat License
+
+Copyright (c) 2011 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

@@ -3,11 +3,22 @@ pry-nav
 
 _Simple execution control in Pry_
 
-Adds **step**, **next**, and **continue** commands to your [Pry][pry]
-console. Makes for a simple but ghetto debugger.
+Teaches [Pry][pry] about **step**, **next**, and **continue** to create a simple
+debugger.
 
-Rudimentary support for [pry-remote][pry-remote] is included. Ensure pry-remote
-is loaded or required before pry-nav. For example, in a Gemfile:
+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-nav** is not yet thread-safe, so only use in single-threaded environments.
+
+Rudimentary support for [pry-remote][pry-remote] is also included. Ensure
+pry-remote is loaded or required before pry-nav. For example, in a Gemfile:
 
 ```ruby
 gem 'pry'
@@ -15,8 +26,11 @@ gem 'pry-remote'
 gem 'pry-nav'
 ```
 
-Note: In order to get correct flow control, `Pry.start` is overriden. Use at
-your own risk.
+Debugging functionality is implemented through
+[`set_trace_func`][set_trace_func], which imposes a large performance
+penalty. **pry-nav** traces only when necessary, but due to a workaround for a
+[bug in 1.9.2][ruby-bug], the console will feel sluggish. Use 1.9.3 for best
+results and almost no performance penalty.
 
 
 ## Contributing
@@ -31,16 +45,13 @@ file an [issue][issues]. [Project changelog][changelog].
 - [@Mon-Ouie][Mon-Ouie]'s [pry_debug][pry_debug]
 
 
-## TODO
-
-- Thread safety
-
-
-[pry]:          http://pry.github.com
-[pry-remote]:   https://github.com/Mon-Ouie/pry-remote
-[changelog]:    https://github.com/nixme/pry-nav/blob/master/CHANGELOG.md
-[issues]:       https://github.com/nixme/pry-nav/issues
-[pullrequests]: https://github.com/nixme/pry-nav/pulls
-[debug.rb]:     https://github.com/ruby/ruby/blob/trunk/lib/debug.rb
-[Mon-Ouie]:     https://github.com/Mon-Ouie
-[pry_debug]:    https://github.com/Mon-Ouie/pry_debug
+[pry]:            http://pry.github.com
+[pry-remote]:     https://github.com/Mon-Ouie/pry-remote
+[set_trace_func]: http://www.ruby-doc.org/core-1.9.3/Kernel.html#method-i-set_trace_func
+[ruby-bug]:       http://redmine.ruby-lang.org/issues/3921
+[pullrequests]:   https://github.com/nixme/pry-nav/pulls
+[issues]:         https://github.com/nixme/pry-nav/issues
+[changelog]:      https://github.com/nixme/pry-nav/blob/master/CHANGELOG.md
+[debug.rb]:       https://github.com/ruby/ruby/blob/trunk/lib/debug.rb
+[Mon-Ouie]:       https://github.com/Mon-Ouie
+[pry_debug]:      https://github.com/Mon-Ouie/pry_debug

data/lib/pry-nav.rb

@@ -8,4 +8,13 @@ require 'pry-nav/pry_remote_ext' if defined? PryRemote
 
 module PryNav
   TRACE_IGNORE_FILES = Dir[File.join(File.dirname(__FILE__), '**', '*.rb')]
+
+  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
 end

data/lib/pry-nav/commands.rb

@@ -3,16 +3,17 @@ require 'pry'
 module PryNav
   Commands = Pry::CommandSet.new do
     command 'step', 'Step execution into the next line or method.' do |steps|
-      check_local_context
+      check_file_context
       breakout_navigation :step, steps
     end
 
     command 'next', 'Execute the next line within the same stack frame.' do |lines|
-      check_local_context
+      check_file_context
       breakout_navigation :next, lines
     end
 
     command 'continue', 'Continue program execution and end the Pry session.' do
+      check_file_context
       run 'exit-all'
     end
 
@@ -29,11 +30,9 @@ module PryNav
         }
       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')
+      # Ensures that a command is executed in a local file context.
+      def check_file_context
+        unless PryNav.check_file_context(target)
           raise Pry::CommandError, 'Cannot find local context. Did you use `binding.pry`?'
         end
       end

data/lib/pry-nav/pry_ext.rb

@@ -5,8 +5,16 @@ class << Pry
   alias_method :start_existing, :start
 
   def start(target = TOPLEVEL_BINDING, options = {})
-    PryNav::Tracer.new(options) do
-      start_existing(target, options.reject { |k, _| k == :pry_remote })
+    old_options = options.reject { |k, _| k == :pry_remote }
+
+    if PryNav.check_file_context(target)
+      # Wrap the tracer around the usual Pry.start
+      PryNav::Tracer.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-nav/tracer.rb

@@ -7,8 +7,6 @@ module PryNav
       @frames_when_stepping = nil              # Only break at this frame level
       @frames = 0                              # Traced stack frame level
       @pry_start_options = pry_start_options   # Options to use for Pry.start
-
-      run &block
     end
 
     def run(&block)

data/lib/pry-nav/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-nav
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-01 00:00:00.000000000Z
+date: 2011-12-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70332078184900 !ruby/object:Gem::Requirement
+  requirement: &70226772578740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.9.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *70332078184900
+  version_requirements: *70226772578740
 description: Turn Pry into a primitive debugger. Adds 'step' and 'next' commands to
   control execution.
 email: nixme@stillhope.com
@@ -32,6 +32,7 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/pry-nav.rb