pryx 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c877bb193222c2d2540f95eea205253844c0e9c874d3f6a75235c42fcaef704
-  data.tar.gz: fec0feb940e81d862287bbd1a9e957fa2f6ae7247fe632da3c1eaf5354e96435
+  metadata.gz: e2f9082160dc0ffa9af96b30d01e26bca7d8602bd2effc786b7730d398d9fe7f
+  data.tar.gz: 848bfcea555d89bee6a2f0c9b3178e283d126c530a5320da93fd11625ee153b3
 SHA512:
-  metadata.gz: 2a1d57e969a8500268a5b13817de9fb90a0ab4a355f3a17af28fb83b1d1e0ad22369365b5d3377e77e14e931f96a2582fa4ff63bac5e77e581b1cab42f61eeb4
-  data.tar.gz: bb70d8c676aeb5ee72f449e63e598deeff24415ad08a677d1beb007bcce16a1059fa703e735fff9e89f253be672641b4e1b2a3b147c8e5c350ad2967b3b151d3
+  metadata.gz: a55dfb829c32795fb44f9266314fcc453c80fffd6793af00d9999aeb071a21de76ff7fb54205ef5e7fd4c84466522debfc0b4af10e9c6fdc0d6af6a6175c313d
+  data.tar.gz: 03e14482e878de5c7e8c32628a05362b2a21f069d8ea2ae66ca198ab6d2a3db528219b28377736b1848fe9645013811aa5ca2752ee054f48b5be1df8b893362e

data/lib/pry-nav/cli.rb

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

data/lib/pry-nav/commands.rb

@@ -0,0 +1,40 @@
+require 'pry' unless defined? Pry
+
+module PryNav
+  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_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.
+      def check_file_context
+        unless PryNav.check_file_context(target)
+          raise Pry::CommandError, 'Cannot find local context. Did you use `binding.pry`?'
+        end
+      end
+    end
+  end
+end
+
+Pry.commands.import PryNav::Commands

data/lib/pry-nav/pry_ext.rb

@@ -0,0 +1,22 @@
+require 'pry' unless defined? Pry
+require 'pry-nav/tracer'
+
+class << Pry
+  alias start_without_pry_nav start
+
+  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_without_pry_nav(target, old_options)
+      end
+    else
+      # No need for the tracer unless we have a file context to step through
+      start_without_pry_nav(target, old_options)
+    end
+  end
+
+  alias start start_with_pry_nav
+end

data/lib/pry-nav/pry_remote_ext.rb

@@ -0,0 +1,41 @@
+require 'pry' unless defined? Pry
+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-nav knows this is a remote session, and not kill
+    # the server right away
+    def run
+      if PryNav.current_remote_server
+        raise 'Already running a pry-remote session!'
+      else
+        PryNav.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 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
+
+# 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.
+at_exit do
+  set_trace_func nil
+  PryNav.current_remote_server.teardown if PryNav.current_remote_server
+end

data/lib/pry-nav/tracer.rb

@@ -0,0 +1,91 @@
+require 'pry' unless defined? Pry
+
+module PryNav
+  class Tracer
+    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
+      # For performance, disable any tracers while in the console.
+      stop
+
+      return_value = nil
+      command = catch(:breakout_nav) do      # Coordinates with PryNav::Commands
+        return_value = yield
+        {}    # Nothing thrown == no navigational command
+      end
+
+      # Adjust tracer based on command
+      if process_command(command)
+        start
+      else
+        if @pry_start_options[:pry_remote] && PryNav.current_remote_server
+          PryNav.current_remote_server.teardown
+        end
+      end
+
+      return_value
+    end
+
+    def start
+      set_trace_func method(:tracer).to_proc
+    end
+
+    def stop
+      set_trace_func nil
+    end
+
+    def process_command(command = {})
+      times = (command[:times] || 1).to_i
+      times = 1 if times <= 0
+
+      case command[:action]
+      when :step
+        @step_in_lines = times
+        @frames_when_stepping = nil
+        true
+      when :next
+        @step_in_lines = times
+        @frames_when_stepping = @frames
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    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))
+
+      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 == @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 < @frames_when_stepping
+          @step_in_lines = 0   # Break right away
+        end
+
+        # Break on this line?
+        Pry.start(binding, @pry_start_options) if @step_in_lines.zero?
+
+      when 'call', 'class'
+        @frames += 1         # Track entering a frame
+
+      when 'return', 'end'
+        @frames -= 1         # Track leaving a stack frame
+        @frames = 0 if @frames < 0
+      end
+    end
+  end
+end

data/lib/pry-nav/version.rb

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

data/lib/pry-nav.rb

@@ -0,0 +1,28 @@
+require 'pry-nav/version'
+require 'pry-nav/pry_ext'
+require 'pry-nav/commands'
+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')].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 = if target.respond_to?(:source_location)
+      target.source_location.first
+    else
+      target.eval('__FILE__')
+    end
+
+    file == Pry.eval_path || (file !~ /(\(.*\))|<.*>/ && file != '' && file != '-e')
+  end
+
+  # Reference to currently running pry-remote server. Used by the tracer.
+  attr_accessor :current_remote_server
+end

data/lib/pryx/pry_hack.rb

@@ -32,11 +32,9 @@ module Kernel
     # to customise the kind of variables shown.
     require_relative '../pry-state' if state
 
-    if Pryx::Background.foreground? and host.nil?
-      return unless ENV['Pry_was_started'].nil?
+    return unless ENV['Pry_was_started'].nil?
 
-      ENV['Pry_was_started'] = 'true'
-    end
+    ENV['Pry_was_started'] = 'true'
 
     pry3(2, host: host, port: port)
 

data/lib/pryx/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pryx
-  VERSION = [0, 10, 3]
+  VERSION = [0, 11, 0]
 
   class << VERSION
     include Comparable

data/lib/pryx.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-case RbConfig::CONFIG['ruby_version']
-when '3.3.0'...'3.4.0'
-  require "readline"
-end
-
 require 'pryx/version'
 require 'pryx/background'
 require 'pryx/trap_backtrace'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pryx
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -30,42 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: pry-nav
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: looksee
   requirement: !ruby/object:Gem::Requirement
@@ -229,6 +215,13 @@ files:
 - lib/pry-byebug/pry_ext.rb
 - lib/pry-disasm.rb
 - lib/pry-disasm/commands.rb
+- lib/pry-nav.rb
+- lib/pry-nav/cli.rb
+- lib/pry-nav/commands.rb
+- lib/pry-nav/pry_ext.rb
+- lib/pry-nav/pry_remote_ext.rb
+- lib/pry-nav/tracer.rb
+- lib/pry-nav/version.rb
 - lib/pry-remote.rb
 - lib/pry-state.rb
 - lib/pry-state/hook_action.rb
@@ -267,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: pry extension tools!