pry-stack_explorer 0.6.1 → 0.6.2

data/test/stack_explorer_test.rb

@@ -0,0 +1,374 @@
+require_relative 'test_helper'
+
+describe PryStackExplorer do
+
+  describe "Pry.start" do
+    include ResetHelper
+
+    let(:bingbong){ BingBong.new }
+
+    describe ":initial_frame option" do
+      it 'should default to first frame when no option provided' do
+        redirect_pry_io(StringIO.new("@frame = __method__\nexit\n"), out=StringIO.new) do
+          bingbong.bing
+        end
+
+        expect(bingbong.frame).to eq(:bang)
+      end
+
+      it 'should begin at correct frame even if Pry.start is monkey-patched (only works with one monkey-patch currently)' do
+        class << Pry
+          alias_method :old_start, :start
+
+          def start(*args, &block)
+            old_start(*args, &block)
+          end
+        end
+
+        o = BingBong.new
+
+        redirect_pry_io(
+          InputTester.new(
+            "@frames = SE.frame_manager(pry_instance).bindings.take(3)",
+            "exit-all"
+          )
+        ){ o.bing }
+
+        expect(
+          o.frames.map { |f| f.eval("__method__") }
+        ).to eq([:bang, :bong, :bing])
+
+        class << Pry
+          alias_method :start, :old_start
+        end
+      end
+
+      it 'should begin session at specified frame' do
+        o = bingbong
+        def o.bang; Pry.start(binding, :initial_frame => 1); end
+
+        redirect_pry_io(StringIO.new("@frame = __method__\nexit-all\n"), out=StringIO.new) do
+          o.bing
+        end
+
+        expect(o.frame).to eq(:bong)
+      end
+
+      it 'should begin session at specified frame when using :call_stack' do
+        o = Object.new
+        class << o; attr_accessor :frame; end
+        def o.alpha() binding end
+        def o.beta() binding end
+        def o.gamma() binding end
+
+        redirect_pry_io(StringIO.new("@frame = __method__\nexit\n"), out=StringIO.new) do
+          Pry.start(binding, :call_stack => [o.gamma, o.beta, o.alpha], :initial_frame => 1)
+        end
+
+        expect(o.frame).to eq(:beta)
+      end
+
+      # regression test for #12
+      it 'does not infinite loop when pry is started in MyObject#==' do
+        o = Object.new
+        def o.==(other)
+          binding.pry
+        end
+
+        redirect_pry_io(InputTester.new(":hello", "exit-all"), out=StringIO.new) do
+          o.==(1)
+        end
+
+        expect(out.string).to match(/hello/)
+      end
+    end
+
+    describe ":call_stack option" do
+      it 'should invoke a session with the call stack set' do
+        redirect_pry_io(StringIO.new("stack\nexit\n"), out=StringIO.new) do
+          bingbong.bing
+        end
+
+        expect(out.string).to match(/bang.*?bong.*?bing/m)
+      end
+
+      it 'should set no call stack when :call_stack => false' do
+        def bingbong.bang; Pry.start(binding, :call_stack => false); end
+
+        redirect_pry_io(StringIO.new("stack\nexit\n"), out=StringIO.new) do
+          bingbong.bing
+        end
+
+        expect(out.string).to match(/No caller stack/)
+      end
+
+      it 'should set custom call stack when :call_stack => [b1, b2]' do
+        o = Object.new
+        def o.alpha() binding end
+        def o.beta() binding end
+        def o.gamma() binding end
+
+        redirect_pry_io(StringIO.new("stack\nexit\n"), out=StringIO.new) do
+          Pry.start(binding, :call_stack => [o.beta, o.gamma, o.alpha])
+        end
+
+        expect(out.string).to match(/beta.*?gamma.*?alpha/m)
+      end
+
+      it 'should raise if custom call stack does not contain bindings' do
+        o = OpenStruct.new
+        redirect_pry_io(StringIO.new("self.errors = pry_instance.hooks.errors\nexit\n")) do
+          Pry.start(o, :call_stack => [1, 2, 3])
+        end
+        expect(o.errors.first.is_a?(ArgumentError)).to eq(true)
+      end
+
+      it 'should raise if custom call stack is empty' do
+        o = OpenStruct.new
+        redirect_pry_io(StringIO.new("self.errors = pry_instance.hooks.errors\nexit\n")) do
+          Pry.start o, :call_stack => []
+        end
+        expect(o.errors.first.is_a?(ArgumentError)).to eq(true)
+      end
+    end
+  end
+
+  describe "class methods" do
+    before do
+      @pry_instance = Pry.new
+      @bindings = [binding, binding]
+    end
+
+    after do
+      PE.clear_frame_managers(@pry_instance)
+    end
+
+    describe "PryStackExplorer.create_and_push_frame_manager" do
+
+      it  "should create and push one new FrameManager" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        expect(PE.frame_manager(@pry_instance).is_a?(PE::FrameManager)).to eq(true)
+        expect(PE.frame_managers(@pry_instance).count).to eq(1)
+      end
+
+      it "should refresh Pry instance to use FrameManager's active binding" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        expect(@pry_instance.binding_stack.size).to eq(1)
+        expect(@pry_instance.binding_stack.first).to eq(@bindings.first)
+      end
+
+      it 'should save prior binding in FrameManager instance' do
+        _pry_ = Pry.new
+        _pry_.binding_stack.push(b=binding)
+        PryStackExplorer.create_and_push_frame_manager(@bindings, _pry_)
+        expect(PryStackExplorer.frame_manager(_pry_).prior_binding).to eq(b)
+      end
+
+      describe ":initial_frame option" do
+        it 'should start on specified frame' do
+          PE.create_and_push_frame_manager(@bindings, @pry_instance, :initial_frame => 1)
+          expect(@pry_instance.binding_stack.size).to eq(1)
+          expect(@pry_instance.binding_stack.first).to eq(@bindings.last)
+        end
+
+        describe "negative numbers" do
+          it 'should work with negative frame number (-1)' do
+            PE.create_and_push_frame_manager(@bindings, @pry_instance, :initial_frame => -1)
+            expect(@pry_instance.binding_stack.size).to eq(1)
+            expect(@pry_instance.binding_stack.first).to eq(@bindings.last)
+          end
+
+          it 'should work with negative frame number (-2)' do
+            PE.create_and_push_frame_manager(@bindings, @pry_instance, :initial_frame => -2)
+            expect(@pry_instance.binding_stack.size).to eq(1)
+            expect(@pry_instance.binding_stack.first).to eq(@bindings.first)
+          end
+        end
+      end
+
+      it 'should save prior backtrace in FrameManager instance' do
+        _pry_ = Pry.new
+        _pry_.backtrace = ["my backtrace"]
+        PryStackExplorer.create_and_push_frame_manager(@bindings, _pry_)
+        expect(PryStackExplorer.frame_manager(_pry_).prior_backtrace).to eq(_pry_.backtrace)
+      end
+
+      it  "should create and push multiple FrameManagers" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        expect(PE.frame_managers(@pry_instance).count).to eq(2)
+      end
+
+      it 'should push FrameManagers to stacks based on Pry instance' do
+        p2 = Pry.new
+        bindings = [binding, binding]
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(bindings, p2)
+        expect(PE.frame_managers(@pry_instance).count).to eq(1)
+        expect(PE.frame_managers(p2).count).to eq(1)
+      end
+    end
+
+    describe "PryStackExplorer.frame_manager" do
+      it  "should have the correct bindings" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        expect(PE.frame_manager(@pry_instance).bindings).to eq(@bindings)
+      end
+
+      it "should return the last pushed FrameManager" do
+        bindings = [binding, binding]
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(bindings, @pry_instance)
+        expect(PE.frame_manager(@pry_instance).bindings).to eq(bindings)
+      end
+
+      it "should return the correct FrameManager for the given Pry instance" do
+        bindings = [binding, binding]
+        p2 = Pry.new
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(bindings, p2)
+        expect(PE.frame_manager(@pry_instance).bindings).to eq(@bindings)
+        expect(PE.frame_manager(p2).bindings).to eq(bindings)
+      end
+    end
+
+    describe "PryStackExplorer.pop_frame_manager" do
+      it "should remove FrameManager from stack" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.pop_frame_manager(@pry_instance)
+        expect(PE.frame_managers(@pry_instance).count).to eq(1)
+      end
+
+      it "should return the most recently added FrameManager" do
+        bindings = [binding, binding]
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(bindings, @pry_instance)
+        expect(PE.pop_frame_manager(@pry_instance).bindings).to eq(bindings)
+      end
+
+      it "should remove FrameManager from the appropriate stack based on Pry instance" do
+        p2 = Pry.new
+        bindings = [binding, binding]
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(bindings, p2)
+        PE.pop_frame_manager(@pry_instance)
+        expect(PE.frame_managers(@pry_instance).count).to eq(0)
+        expect(PE.frame_managers(p2).count).to eq(1)
+      end
+
+      it "should remove key when no frames remaining for Pry instance" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.pop_frame_manager(@pry_instance)
+        PE.pop_frame_manager(@pry_instance)
+        expect(PE.frame_hash.has_key?(@pry_instance)).to eq(false)
+      end
+
+      it 'should not change size of binding_stack when popping' do
+        bindings = [bindings, bindings]
+        PE.create_and_push_frame_manager(bindings, @pry_instance)
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.pop_frame_manager(@pry_instance)
+        expect(@pry_instance.binding_stack.size).to eq(1)
+      end
+
+      it 'should return nil when popping non-existent frame manager' do
+        expect(PE.pop_frame_manager(@pry_instance)).to eq(nil)
+      end
+
+      describe "restoring previous binding" do
+        it 'should restore previous binding for Pry instance on pop, where previous binding is not first frame' do
+          bindings = [binding, binding]
+          PE.create_and_push_frame_manager(bindings, @pry_instance).binding_index = 1
+          PE.create_and_push_frame_manager(@bindings, @pry_instance)
+          PE.pop_frame_manager(@pry_instance)
+          expect(@pry_instance.binding_stack.first).to eq(bindings[1])
+        end
+
+        it 'should restore previous binding for Pry instance on pop (previous frame frame manager)' do
+          bindings = [binding, binding]
+          PE.create_and_push_frame_manager(bindings, @pry_instance)
+          PE.create_and_push_frame_manager(@bindings, @pry_instance)
+          PE.pop_frame_manager(@pry_instance)
+          expect(@pry_instance.binding_stack.first).to eq(bindings.first)
+        end
+
+        it 'should restore previous binding for Pry instance on pop (no previous frame manager)' do
+          b = binding
+          @pry_instance.binding_stack = [b]
+          PE.create_and_push_frame_manager(@bindings, @pry_instance)
+          PE.pop_frame_manager(@pry_instance)
+          expect(@pry_instance.binding_stack.first).to eq(b)
+        end
+
+        it 'should restore previous binding for Pry instance on pop (no previous frame manager AND no empty binding_stack)' do
+          b = binding
+          @pry_instance.binding_stack = [b]
+          PE.create_and_push_frame_manager(@bindings, @pry_instance)
+          @pry_instance.binding_stack.clear
+          PE.pop_frame_manager(@pry_instance)
+          expect(@pry_instance.binding_stack.first).to eq(b)
+        end
+      end
+
+      describe "_pry_.backtrace" do
+        it "should restore backtrace when frame is popped" do
+          p1 = Pry.new
+          bindings = [binding, binding]
+          p1.backtrace = "my backtrace1"
+          PE.create_and_push_frame_manager(bindings, p1)
+          p1.backtrace = "my backtrace2"
+          PE.create_and_push_frame_manager(bindings, p1)
+          p1.backtrace = "my backtrace3"
+
+          PE.pop_frame_manager(p1)
+          expect(p1.backtrace).to eq("my backtrace2")
+          PE.pop_frame_manager(p1)
+          expect(p1.backtrace).to eq("my backtrace1")
+        end
+      end
+    end
+
+    describe "PryStackExplorer.clear_frame_managers" do
+      it "should clear all FrameManagers for a Pry instance" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.clear_frame_managers(@pry_instance)
+        expect(PE.frame_hash.has_key?(@pry_instance)).to eq(false)
+      end
+
+      it "should clear all FrameManagers for a Pry instance but leave others untouched" do
+        p2 = Pry.new
+        bindings = [binding, binding]
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(bindings, p2)
+        PE.clear_frame_managers(@pry_instance)
+        expect(PE.frame_managers(p2).count).to eq(1)
+        expect(PE.frame_hash.has_key?(@pry_instance)).to eq(false)
+      end
+
+      it "should remove key" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.clear_frame_managers(@pry_instance)
+        expect(PE.frame_hash.has_key?(@pry_instance)).to eq(false)
+      end
+
+      describe "_pry_.backtrace" do
+        it "should restore backtrace to initial one when frame managers are cleared" do
+          p1 = Pry.new
+          bindings = [binding, binding]
+          p1.backtrace = "my backtrace1"
+          PE.create_and_push_frame_manager(bindings, p1)
+          p1.backtrace = "my backtrace2"
+          PE.create_and_push_frame_manager(bindings, p1)
+          p1.backtrace = "my backtrace3"
+
+          PE.clear_frame_managers(p1)
+          expect(p1.backtrace).to eq("my backtrace1")
+        end
+      end
+    end
+  end
+end

data/test/support/bingbong.rb

@@ -0,0 +1,11 @@
+class BingBong
+  attr_reader :frames, :frame, :methods
+
+  def initialize
+    @methods = []
+  end
+
+  def bing; bong; end
+  def bong; bang; end
+  def bang; Pry.start(binding); end
+end

data/test/support/input_tester.rb

@@ -0,0 +1,17 @@
+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

data/test/support/io_utils.rb

@@ -0,0 +1,49 @@
+module IOUtils
+  def redirect_pry_output!
+    @pry_output = StringIO.new
+    Pry.config.output = @pry_output
+  end
+
+  attr_accessor :pry_output
+
+  # Set I/O streams.
+  #
+  # Out defaults to an anonymous StringIO.
+  def with_pry_output_captured(new_in, new_out = StringIO.new)
+    old_in = Pry.input
+    old_out = Pry.output
+
+    Pry.input = new_in
+    Pry.output = new_out
+
+    begin
+      yield
+    ensure
+      Pry.input = old_in
+      Pry.output = old_out
+    end
+
+    new_out
+  end
+
+  alias :redirect_pry_io :with_pry_output_captured
+
+
+  def mock_pry(*args)
+    binding = args.first.is_a?(Binding) ? args.shift : binding()
+
+    input = InputTester.new(*args)
+    output = StringIO.new
+
+    redirect_pry_io(input, output) do
+      binding.pry
+    end
+
+    output.string
+  end
+
+  def issue_pry_commands(*commands, &block)
+    input_tester = InputTester.new(*commands)
+    redirect_pry_io(input_tester, &block).string
+  end
+end

data/test/support/reset_helper.rb

@@ -0,0 +1,57 @@
+module ResetHelper
+
+  def self.reset_pry_defaults!
+    # Pry.reset_defaults
+
+    # Pry.color = false
+    Pry.pager = false
+    Pry.config.hooks               = Pry::Hooks.new
+    # Pry.config.should_load_rc      = false
+    # Pry.config.should_load_plugins = false
+    # Pry.config.auto_indent         = false
+    # Pry.config.collision_warning   = false
+  end
+
+  def hooks
+    Hooks
+  end
+
+  def self.included(base)
+    base.class_exec do
+      before :all do
+        ResetHelper.reset_pry_defaults!
+      end
+
+      around do |example|
+        hooks.with_setup{ example.run }
+      end
+    end
+  end
+
+  module Hooks; end
+
+  class << Hooks
+    def memoize!
+      @@hooks = {
+        when_started: Pry.config.hooks.get_hook(:when_started, :save_caller_bindings),
+        after_session: Pry.config.hooks.get_hook(:after_session, :delete_frame_manager)
+      }
+    end
+
+    def setup!
+      Pry.config.hooks.add_hook(:when_started, :save_caller_bindings, @@hooks[:when_started])
+      Pry.config.hooks.add_hook(:after_session, :delete_frame_manager, @@hooks[:after_session])
+    end
+
+    def teardown!
+      Pry.config.hooks.delete_hook(:when_started, :save_caller_bindings)
+      Pry.config.hooks.delete_hook(:after_session, :delete_frame_manager)
+    end
+
+    def with_setup(&block)
+      setup!
+      yield
+      teardown!
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'ostruct'
+require 'pry'
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each do |file|
+  require file
+end
+
+if RUBY_VERSION >= '2.7.2'
+  # NOTE: https://bugs.ruby-lang.org/issues/17000
+  Warning[:deprecated] = true
+end
+
+# unless Object.const_defined? 'PryStackExplorer'
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'pry-stack_explorer'
+# end
+
+puts "Testing pry-stack_explorer version #{PryStackExplorer::VERSION}..."
+puts "Ruby version: #{RUBY_VERSION}"
+
+PE = PryStackExplorer
+
+ResetHelper::Hooks.memoize!
+
+RSpec.configure do |config|
+  config.include IOUtils
+end

metadata

@@ -1,27 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - John Mair (banisterfiend)
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2026-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -66,28 +65,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description:
-email:
-- jrmair@gmail.com
+description: Walk the stack in a Pry session
+email: jrmair@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gemtest"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
+- bin/rspec
+- examples/example.rb
+- examples/example2.rb
+- examples/example3.rb
 - lib/pry-stack_explorer.rb
 - lib/pry-stack_explorer/commands.rb
 - lib/pry-stack_explorer/frame_manager.rb
 - lib/pry-stack_explorer/version.rb
 - lib/pry-stack_explorer/when_started_hook.rb
+- pry-stack_explorer.gemspec
+- test/commands_test.rb
+- test/frame_manager_test.rb
+- test/stack_explorer_test.rb
+- test/support/bingbong.rb
+- test/support/input_tester.rb
+- test/support/io_utils.rb
+- test/support/reset_helper.rb
+- test/test_helper.rb
 homepage: https://github.com/pry/pry-stack_explorer
-licenses:
-- MIT
-metadata:
-  bug_tracker_uri: https://github.com/pry/pry-stack_explorer/issues
-  source_code_uri: https://github.com/pry/pry-stack_explorer
-  changelog_uri: https://github.com/pry/pry-stack_explorer/blob/master/CHANGELOG
-post_install_message:
+licenses: []
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
@@ -95,15 +109,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Walk the stack in a Pry session
-test_files: []
+test_files:
+- test/commands_test.rb
+- test/frame_manager_test.rb
+- test/stack_explorer_test.rb
+- test/support/bingbong.rb
+- test/support/input_tester.rb
+- test/support/io_utils.rb
+- test/support/reset_helper.rb
+- test/test_helper.rb