pry-nav 0.2.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 342150dc2c72e13894b2e824b2e0d3104fdd7bfb345e081b509da4cc865e2533
+  data.tar.gz: 2b94f22aba1710e1202af420e59521f634202e7c327f67f9a358b16c18fb0d98
+SHA512:
+  metadata.gz: edc7473c442feaf082961bf7be9bb341692e9c47ee1128cbcab90c12b3c394121ad40974a6d84f07ca4cf0926d6f50661a9cfa2b2eba0b194d22bc0820edac21
+  data.tar.gz: b3aef7a0f36f115d35ee932f53c5547a98b94ee43637a36f164a996a675465435c514fe824799778dd1f1274f7bf3ebbf4c509e3d404cdbaf910a5df0b2a971f

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 1.0.0
+
+* Drop support for ruby < 2.1.
+* Support Pry 0.14
+* Adding tests
+* Fix warning on ruby 2.7
+
+## 0.3.0 (2019-04-16)
+
+* Fix circular require warning.
+* Support Pry 0.11 & 0.12
+
+## 0.2.4 (2014-06-25)
+
+* Support Pry 0.10
+
+## 0.2.3 (2012-12-26)
+
+* Safer `alias_method_chain`-style patching of `Pry.start` and
+  `PryRemote::Server#teardown`. (@benizi)
+
 ## 0.2.2 (2012-06-14)
 
 * Upgrade to Pry 0.9.10. (@banister)

data/Gemfile

@@ -1,4 +1,7 @@
-source 'http://rubygems.org'
-
-# Specify your gem's dependencies in pry-nav.gemspec
+source 'https://rubygems.org'
 gemspec
+
+gem "test-unit"
+
+gem "pry", "~> 0.14.1"
+gem "pry-remote"

data/README.md

@@ -1,30 +1,33 @@
-**Notice:** Using MRI 1.9.2+? Check out [**pry-debugger**][pry-debugger].
-Includes the same features as **pry-nav** with faster tracing, breakpoints, and
-other additional capabilities.
+### Using MRI? We recommend [**break**][break] or [**pry-byebug**][pry-byebug] instead!
 
+# pry-nav [![Ruby](https://github.com/nixme/pry-nav/actions/workflows/main.yml/badge.svg)](https://github.com/nixme/pry-nav/actions/workflows/main.yml)
 
-pry-nav
-=======
+_A simple execution control add-on for [Pry][pry]._
 
-_Simple execution control in Pry_
+Compatible with MRI >= 2.1.0, JRuby >= 9.1.3.0.
 
-Teaches [Pry][pry] about **step**, **next**, and **continue** to create a simple
+Teaches [Pry][pry] about `step`, `next`, and `continue` to create a simple
 debugger.
 
-To use, invoke pry normally:
+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.
+  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.
+When using JRuby, you also need to run it with the `--debug` flag. You can
+also add the flag to your `JRUBY_OPTS` environment variable for it to apply
+when running any ruby command, but do note that even when not making use of
+`pry` this has a big impact on JRuby performance.
 
-Rudimentary support for [pry-remote][pry-remote] (>= 0.1.1) is also included.
-Ensure pry-remote is loaded or required before pry-nav. For example, in a
-Gemfile:
+`pry-nav` is not yet thread-safe, so only use in single-threaded environments.
+
+Rudimentary support for [`pry-remote`][pry-remote] (>= 0.1.1) is also included.
+Ensure `pry-remote` is loaded or required before `pry-nav`. For example, in a
+`Gemfile`:
 
 ```ruby
 gem 'pry'
@@ -40,37 +43,36 @@ Pry.commands.alias_command 's', 'step'
 Pry.commands.alias_command 'n', 'next'
 ```
 
-Debugging functionality is implemented through
+Please note that 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.
-
+penalty.
 
 ## Contributors
 
-* Gopal Patel (@nixme)
-* John Mair (@banister)
-* Conrad Irwin (@ConradIrwin)
+* Gopal Patel ([@nixme](https://github.com/nixme))
+* John Mair ([@banister](https://github.com/banister))
+* Conrad Irwin ([@ConradIrwin](https://github.com/ConradIrwin))
+* Benjamin R. Haskell ([@benizi](https://github.com/benizi))
+* Jason R. Clark ([@jasonrclark](https://github.com/jasonrclark))
+* Ivo Anjo ([@ivoanjo](https://github.com/ivoanjo))
+* Michael Bianco ([@iloveitaly](https://github.com/iloveitaly))
 
 Patches and bug reports are welcome. Just send a [pull request][pullrequests] or
 file an [issue][issues]. [Project changelog][changelog].
 
-
 ## Acknowledgments
 
-- Ruby stdlib's [debug.rb][debug.rb]
-- [@Mon-Ouie][Mon-Ouie]'s [pry_debug][pry_debug]
-
+* Ruby stdlib's [debug.rb][debug.rb]
+* [@Mon-Ouie][Mon-Ouie]'s [pry_debug][pry_debug]
 
-[pry-debugger]:   https://github.com/nixme/pry-debugger
-[pry]:            http://pry.github.com
+[pry]:            http://pryrepl.org/
 [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
+[pry-byebug]:     https://github.com/deivid-rodriguez/pry-byebug
+[break]:          https://github.com/gsamokovarov/break

data/Rakefile

@@ -1,2 +1,10 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |task|
+  task.libs << 'test'
+  task.test_files = FileList['test/*_test.rb']
+  task.verbose = true
+end

data/lib/pry-nav/commands.rb

@@ -1,4 +1,4 @@
-require 'pry'
+require 'pry' unless defined? Pry
 
 module PryNav
   Commands = Pry::CommandSet.new do
@@ -19,11 +19,12 @@ module PryNav
 
     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
-        }
+        pry_instance.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.

data/lib/pry-nav/pry_ext.rb

@@ -1,20 +1,22 @@
-require 'pry'
+require 'pry' unless defined? Pry
 require 'pry-nav/tracer'
 
 class << Pry
-  alias_method :start_existing, :start
+  alias start_without_pry_nav start
 
-  def start(target = TOPLEVEL_BINDING, options = {})
+  def start_with_pry_nav(target = TOPLEVEL_BINDING, options = {})
     old_options = options.reject { |k, _| k == :pry_remote }
 
     if target.is_a?(Binding) && PryNav.check_file_context(target)
       # Wrap the tracer around the usual Pry.start
       PryNav::Tracer.new(options).run do
-        start_existing(target, old_options)
+        start_without_pry_nav(target, old_options)
       end
     else
       # No need for the tracer unless we have a file context to step through
-      start_existing(target, old_options)
+      start_without_pry_nav(target, old_options)
     end
   end
+
+  alias start start_with_pry_nav
 end

data/lib/pry-nav/pry_remote_ext.rb

@@ -1,3 +1,4 @@
+require 'pry' unless defined? Pry
 require 'pry-remote'
 
 module PryRemote
@@ -13,19 +14,21 @@ module PryRemote
       end
 
       setup
-      Pry.start @object, {
-        :input  => client.input_proxy,
-        :output => client.output,
-        :pry_remote => true
-      }
+      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
-      teardown_existing
+    alias teardown_without_pry_nav teardown
+    def teardown_with_pry_nav
+      teardown_without_pry_nav
       PryNav.current_remote_server = nil
     end
+    alias teardown teardown_with_pry_nav
   end
 end
 
@@ -34,7 +37,5 @@ end
 # PryNav::Tracer#run doesn't have a chance to cleanup.
 at_exit do
   set_trace_func nil
-  if PryNav.current_remote_server
-    PryNav.current_remote_server.teardown
-  end
+  PryNav.current_remote_server.teardown if PryNav.current_remote_server
 end

data/lib/pry-nav/tracer.rb

@@ -1,19 +1,17 @@
-require 'pry'
+require 'pry' unless defined? Pry
 
 module PryNav
   class Tracer
-    def initialize(pry_start_options = {}, &block)
+    def initialize(pry_start_options = {})
       @step_in_lines = -1                      # Break after this many lines
       @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
     end
 
-    def run(&block)
+    def run
       # For performance, disable any tracers while in the console.
-      # Unfortunately doesn't work in 1.9.2 because of
-      # http://redmine.ruby-lang.org/issues/3921. Works fine in 1.8.7 and 1.9.3.
-      stop unless RUBY_VERSION == '1.9.2'
+      stop
 
       return_value = nil
       command = catch(:breakout_nav) do      # Coordinates with PryNav::Commands
@@ -25,7 +23,6 @@ module PryNav
       if process_command(command)
         start
       else
-        stop if RUBY_VERSION == '1.9.2'
         if @pry_start_options[:pry_remote] && PryNav.current_remote_server
           PryNav.current_remote_server.teardown
         end
@@ -60,10 +57,9 @@ module PryNav
       end
     end
 
+    private
 
-   private
-
-    def tracer(event, file, line, id, binding, klass)
+    def tracer(event, file, _line, _id, binding, _klass)
       # Ignore traces inside pry-nav code
       return if file && TRACE_IGNORE_FILES.include?(File.expand_path(file))
 
@@ -81,7 +77,7 @@ module PryNav
         end
 
         # Break on this line?
-        Pry.start(binding, @pry_start_options) if @step_in_lines == 0
+        Pry.start(binding, @pry_start_options) if @step_in_lines.zero?
 
       when 'call', 'class'
         @frames += 1         # Track entering a frame

data/lib/pry-nav/version.rb

@@ -1,3 +1,3 @@
 module PryNav
-  VERSION = '0.2.2'
+  VERSION = '1.0.0'
 end

data/lib/pry-nav.rb

@@ -14,7 +14,12 @@ module PryNav
   # 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 = if target.respond_to?(:source_location)
+      target.source_location.first
+    else
+      target.eval('__FILE__')
+    end
+
     file == Pry.eval_path || (file !~ /(\(.*\))|<.*>/ && file != '' && file != '-e')
   end
 

data/pry-nav.gemspec

@@ -12,13 +12,12 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Simple execution navigation for Pry.'
   gem.description   = "Turn Pry into a primitive debugger. Adds 'step' and 'next' commands to control execution."
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  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"]
+  gem.require_paths = ['lib']
 
-  # Dependencies
-  gem.required_ruby_version = '>= 1.8.7'
-  gem.add_runtime_dependency 'pry', '~> 0.9.10'
-  gem.add_development_dependency 'pry-remote', '~> 0.1.1'
+  gem.required_ruby_version = '>= 2.1.0'
+  gem.add_runtime_dependency 'pry', '>= 0.9.10', '< 0.15'
+  gem.add_development_dependency 'rake'
 end

data/test/pry_nav_test.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("test_helper", __dir__)
+
+class PryNavTest < Test::Unit::TestCase
+  # removing color makes string matching easier
+  def setup
+    Pry.color = false
+  end
+
+  # lifted from:
+  # https://github.com/pry/pry-stack_explorer/blob/e3e6bd202e092712900f0d5f239ee21ab2f32b2b/test/support/io_utils.rb
+  def with_pry_output_captured(new_in, new_out = StringIO.new)
+    old_in = Pry.input
+    old_out = Pry.output
+
+    # direct stdout so we can test against `puts` in the method we defined above
+    old_stdout = $stdout
+    $stdout = new_out
+
+    Pry.input = new_in
+    Pry.output = new_out
+
+    begin
+      yield
+    ensure
+      Pry.input = old_in
+      Pry.output = old_out
+      $stdout = old_stdout
+    end
+
+    new_out
+  end
+
+  # `step` will step into the frames, while `next` keeps the debugging execution within the frame
+  def test_step
+    o = NavSample.new
+
+    r = with_pry_output_captured(
+      InputTester.new(
+        "step",
+
+        "step",
+        "step",
+
+        "continue"
+      )
+    ){ o.nested_bind_with_call }
+
+    # initial binding display
+    assert(r.string.include?("def nested_bind_with_call"))
+
+    # after two steps, we are in the second frame, let's make sure we get there
+    assert(r.string.include?("def nested_bind_call"))
+
+    assert(/nested_puts\n/ =~ r.string)
+    assert(/root_puts\n/ =~ r.string)
+  end
+
+  def test_next
+    o = NavSample.new
+
+    r = with_pry_output_captured(
+      InputTester.new(
+        "next",
+        "next",
+        "next",
+        "continue"
+      )
+    ){ o.nested_bind_with_call }
+
+    assert(r.string.include?("def nested_bind_with_call"))
+    refute(r.string.include?("def nested_bind_call"))
+
+    assert(/nested_puts\n/ =~ r.string)
+    assert(/root_puts\n/ =~ r.string)
+  end
+
+  def test_continue
+    o = NavSample.new
+
+    r = with_pry_output_captured(
+      InputTester.new(
+        "continue",
+      )
+    ){ o.nested_bind_with_call }
+
+    assert(r.string.include?("def nested_bind_with_call"))
+    refute(r.string.include?("def nested_bind_call"))
+
+    assert(/nested_puts\n/ =~ r.string)
+    assert(/root_puts\n/ =~ r.string)
+  end
+
+  def test_file_context
+    assert(PryNav.check_file_context(binding))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'bundler/setup'
+require 'test/unit'
+
+# lets make sure it works will all of the pry extensions
+Bundler.require
+
+class NavSample
+  def nested_bind_with_call
+    Pry.start(binding)
+    nested_bind_call
+    puts "root_puts"
+  end
+
+  def nested_bind_call
+    puts "nested_puts"
+  end
+end
+
+# lifted from:
+# https://github.com/pry/pry-stack_explorer/blob/e3e6bd202e092712900f0d5f239ee21ab2f32b2b/test/support/input_tester.rb
+
+class InputTester
+  def initialize(*actions)
+    if actions.last.is_a?(Hash) && actions.last.keys == [:history]
+      @hist = actions.pop[:history]
+    end
+
+    @orig_actions = actions.dup
+    @actions = actions
+  end
+
+  def readline(*)
+    @actions.shift.tap{ |line| @hist << line if @hist }
+  end
+
+  def rewind
+    @actions = @orig_actions.dup
+  end
+end

metadata

@@ -1,38 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: pry-nav
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Gopal Patel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70284073919060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.15'
   type: :runtime
   prerelease: false
-  version_requirements: *70284073919060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: pry-remote
-  requirement: &70284073917940 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70284073917940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Turn Pry into a primitive debugger. Adds 'step' and 'next' commands to
   control execution.
 email: nixme@stillhope.com
@@ -40,7 +51,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -54,29 +67,31 @@ files:
 - lib/pry-nav/tracer.rb
 - lib/pry-nav/version.rb
 - pry-nav.gemspec
+- test/pry_nav_test.rb
+- test/test_helper.rb
 homepage: https://github.com/nixme/pry-nav
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
 summary: Simple execution navigation for Pry.
-test_files: []
+test_files:
+- test/pry_nav_test.rb
+- test/test_helper.rb