pry-stack 0.5.0

data/test/test_frame_manager.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+Pry.config.output = StringIO.new
+
+describe PryStack::FrameManager do
+
+  before do
+    @pry_instance = Pry.new
+    @bindings = [binding, binding, binding, binding]
+    @bindings.each_with_index { |v, i| v.eval("x = #{i}") }
+    @pry_instance.binding_stack.push @bindings.last
+    @frame_manager = PE::FrameManager.new(@bindings, @pry_instance)
+  end
+
+  describe "creation" do
+    it "should make bindings accessible via 'bindings' method" do
+      @frame_manager.bindings.should == @bindings
+    end
+
+    it "should set binding_index to 0" do
+      @frame_manager.binding_index.should == 0
+    end
+
+    it "should set current_frame to first frame" do
+      @frame_manager.current_frame.should == @bindings.first
+    end
+  end
+
+  describe "FrameManager#change_frame_to" do
+    it 'should change the frame to the given one' do
+      @frame_manager.change_frame_to(1)
+
+      @frame_manager.binding_index.should == 1
+      @frame_manager.current_frame.should == @bindings[1]
+      @pry_instance.binding_stack.last.should == @frame_manager.current_frame
+    end
+
+    it 'should accept negative indices when specifying frame' do
+      @frame_manager.change_frame_to(-1)
+
+      # negative index is converted to a positive one inside change_frame_to
+      @frame_manager.binding_index.should == @bindings.size - 1
+
+      @frame_manager.current_frame.should == @bindings[-1]
+      @pry_instance.binding_stack.last.should == @frame_manager.current_frame
+    end
+  end
+
+  describe "FrameManager#refresh_frame" do
+    it 'should change the Pry frame to the active one in the FrameManager' do
+      @frame_manager.binding_index = 2
+      @frame_manager.refresh_frame
+
+      @pry_instance.binding_stack.last.should == @frame_manager.current_frame
+    end
+  end
+
+  describe "FrameManager is Enumerable" do
+    it 'should perform an Enumerable#map on the frames' do
+      @frame_manager.map { |v| v.eval("x") }.should == (0..(@bindings.size - 1)).to_a
+    end
+  end
+
+end
+

data/test/test_stack.rb

@@ -0,0 +1,393 @@
+require 'helper'
+
+describe PryStack do
+
+  describe "Pry.start" do
+    before do
+      Pry.config.hooks.add_hook(:when_started, :save_caller_bindings, WhenStartedHook)
+      Pry.config.hooks.add_hook(:after_session, :delete_frame_manager, AfterSessionHook)
+
+      @o = Object.new
+      class << @o; attr_reader :frame; end
+      def @o.bing() bong end
+      def @o.bong() bang end
+      def @o.bang() Pry.start(binding) end
+    end
+
+    after do
+      Pry.config.hooks.delete_hook(:when_started, :save_caller_bindings)
+      Pry.config.hooks.delete_hook(:after_session, :delete_frame_manager)
+    end
+
+    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
+          @o.bing
+        end
+
+        @o.frame.should == :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 = Object.new
+        class << o; attr_reader :frames; end
+        def o.bing() bong end
+        def o.bong() bang end
+        def o.bang() Pry.start(binding) end
+
+        redirect_pry_io(InputTester.new(
+                                        "@frames = SE.frame_manager(_pry_).bindings.take(3)",
+                                        "exit-all")) do
+          o.bing
+        end
+
+        o.frames.map { |f| f.eval("__method__") }.should == [:bang, :bong, :bing]
+
+        class << Pry
+          alias_method :start, :old_start
+        end
+      end
+
+      it 'should begin session at specified frame' do
+        o = Object.new
+        class << o; attr_reader :frame; end
+        def o.bing() bong end
+        def o.bong() bang end
+        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
+
+        o.frame.should == :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
+
+        o.frame.should == :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
+
+        out.string.should =~ /hello/
+      end
+    end
+
+    describe ":call_stack option" do
+      it 'should invoke a session with the call stack set' do
+        redirect_pry_io(StringIO.new("show-stack\nexit\n"), out=StringIO.new) do
+          @o.bing
+        end
+
+        out.string.should =~ /bang.*?bong.*?bing/m
+      end
+
+      it 'should set no call stack when :call_stack => false' do
+        o = Object.new
+        def o.bing() bong end
+        def o.bong() bang end
+        def o.bang() Pry.start(binding, :call_stack => false) end
+
+        redirect_pry_io(StringIO.new("show-stack\nexit\n"), out=StringIO.new) do
+          o.bing
+        end
+
+        out.string.should =~ /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("show-stack\nexit\n"), out=StringIO.new) do
+          Pry.start(binding, :call_stack => [o.beta, o.gamma, o.alpha])
+        end
+
+        out.string.should =~ /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_.hooks.errors\nexit\n")) do
+          Pry.start(o, :call_stack => [1, 2, 3])
+        end
+        o.errors.first.is_a?(ArgumentError).should == true
+      end
+
+      it 'should raise if custom call stack is empty' do
+        o = OpenStruct.new
+        redirect_pry_io(StringIO.new("self.errors = _pry_.hooks.errors\nexit\n")) do
+          Pry.start o, :call_stack => []
+        end
+        o.errors.first.is_a?(ArgumentError).should == true
+      end
+    end
+  end
+
+  describe "unit tests for PryStack class methods" do
+    before do
+      @pry_instance = Pry.new
+      @bindings = [binding, binding]
+    end
+
+    after do
+      PE.clear_frame_managers(@pry_instance)
+    end
+
+    describe "PryStack.create_and_push_frame_manager" do
+
+      it  "should create and push one new FrameManager" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.frame_manager(@pry_instance).is_a?(PE::FrameManager).should == true
+        PE.frame_managers(@pry_instance).count.should == 1
+      end
+
+      it "should refresh Pry instance to use FrameManager's active binding" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        @pry_instance.binding_stack.size.should  == 1
+        @pry_instance.binding_stack.first.should == @bindings.first
+      end
+
+      it 'should save prior binding in FrameManager instance' do
+        _pry_ = Pry.new
+        _pry_.binding_stack.push(b=binding)
+        PryStack.create_and_push_frame_manager(@bindings, _pry_)
+        PryStack.frame_manager(_pry_).prior_binding.should == 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)
+          @pry_instance.binding_stack.size.should  == 1
+          @pry_instance.binding_stack.first.should == @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)
+            @pry_instance.binding_stack.size.should  == 1
+            @pry_instance.binding_stack.first.should == @bindings.last
+          end
+
+          it 'should work with negative frame number (-2)' do
+            PE.create_and_push_frame_manager(@bindings, @pry_instance, :initial_frame => -2)
+            @pry_instance.binding_stack.size.should  == 1
+            @pry_instance.binding_stack.first.should == @bindings.first
+          end
+        end
+      end
+
+      it 'should save prior backtrace in FrameManager instance' do
+        _pry_ = Pry.new
+        _pry_.backtrace = ["my backtrace"]
+        PryStack.create_and_push_frame_manager(@bindings, _pry_)
+        PryStack.frame_manager(_pry_).prior_backtrace.should == _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)
+        PE.frame_managers(@pry_instance).count.should == 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)
+        PE.frame_managers(@pry_instance).count.should == 1
+        PE.frame_managers(p2).count.should == 1
+      end
+    end
+
+    describe "PryStack.frame_manager" do
+      it  "should have the correct bindings" do
+        PE.create_and_push_frame_manager(@bindings, @pry_instance)
+        PE.frame_manager(@pry_instance).bindings.should == @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)
+        PE.frame_manager(@pry_instance).bindings.should == 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)
+        PE.frame_manager(@pry_instance).bindings.should == @bindings
+        PE.frame_manager(p2).bindings.should == bindings
+      end
+    end
+
+    describe "PryStack.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)
+        PE.frame_managers(@pry_instance).count.should == 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)
+        PE.pop_frame_manager(@pry_instance).bindings.should == 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)
+        PE.frame_managers(@pry_instance).count.should == 0
+        PE.frame_managers(p2).count.should == 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)
+        PE.frame_hash.has_key?(@pry_instance).should == 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)
+        @pry_instance.binding_stack.size.should == 1
+      end
+
+      it 'should return nil when popping non-existent frame manager' do
+        PE.pop_frame_manager(@pry_instance).should == 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)
+          @pry_instance.binding_stack.first.should == 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)
+          @pry_instance.binding_stack.first.should == 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)
+          @pry_instance.binding_stack.first.should == 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)
+          @pry_instance.binding_stack.first.should == 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)
+          p1.backtrace.should == "my backtrace2"
+          PE.pop_frame_manager(p1)
+          p1.backtrace.should == "my backtrace1"
+        end
+      end
+    end
+
+    describe "PryStack.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)
+        PE.frame_hash.has_key?(@pry_instance).should == 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)
+        PE.frame_managers(p2).count.should == 1
+        PE.frame_hash.has_key?(@pry_instance).should == 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)
+        PE.frame_hash.has_key?(@pry_instance).should == 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)
+          p1.backtrace.should == "my backtrace1"
+        end
+      end
+    end
+  end
+end