pry-stack_explorer 0.2.9pre4 → 0.2.9pre5

data/Rakefile

@@ -23,7 +23,7 @@ def apply_spec_defaults(s)
   s.description = s.summary
   s.require_path = 'lib'
   s.add_dependency("binding_of_caller","~>0.6.1")
-  s.add_dependency("pry","0.9.8pre4")
+  s.add_dependency("pry","0.9.8pre6")
   s.add_development_dependency("bacon","~>1.1.0")
   s.add_development_dependency('rake', '~> 0.9')
   s.required_ruby_version = '>= 1.9.2'

data/lib/pry-stack_explorer.rb

@@ -10,68 +10,105 @@ require "binding_of_caller"
 
 module PryStackExplorer
 
-  # @return [Hash] The hash storing all frames for all Pry instances for
-  #   the current thread
-  def self.frame_hash
-    Thread.current[:__pry_frame_managers__]
-  end
-
-  def self.init_frame_hash
-    Thread.current[:__pry_frame_managers__] ||= Hash.new { |h, k| h[k] = [] }
-  end
-
-  # Create a `Pry::FrameManager` object and push it onto the frame
-  # manager stack for the relevant `_pry_` instance.
-  # @param [Array] bindings The array of bindings (frames)
-  # @param [Pry] _pry_ The Pry instance associated with the frame manager
-  def self.create_and_push_frame_manager(bindings, _pry_)
-    init_frame_hash
-    frame_hash[_pry_].push FrameManager.new(bindings, _pry_)
-  end
-
-  # Return the complete frame manager stack for the Pry instance
-  # @param [Pry] _pry_ The Pry instance associated with the frame
-  #   managers
-  # @return [Array] The stack of Pry::FrameManager objections
-  def self.frame_managers(_pry_)
-    init_frame_hash
-    frame_hash[_pry_]
-  end
-
-  # Delete the currently active frame manager
-  # @param [Pry] _pry_ The Pry instance associated with the frame managers
-  def self.pop_frame_manager(_pry_)
-    init_frame_hash
-    popped = frame_managers(_pry_).pop
-    frame_hash.delete(_pry_) if frame_managers(_pry_).empty?
-    _pry_.backtrace = popped.prior_backtrace
-    popped
-  end
-
-  # Clear the stack of frame managers for the Pry instance
-  # @param [Pry] _pry_ The Pry instance associated with the frame managers
-  def self.clear_frame_managers(_pry_)
-    init_frame_hash
-    pop_frame_manager(_pry_) until frame_managers(_pry_).empty?
-    frame_hash.delete(_pry_) # this line should be unnecessary!
-  end
-
-  class << self; alias_method :delete_frame_managers, :clear_frame_managers; end
-
-  # @return [PryStackExplorer::FrameManager] The currently active frame manager
-  def self.frame_manager(_pry_)
-    init_frame_hash
-    frame_hash[_pry_].last
-  end
-
-  # Simple test to check whether two `Binding` objects are equal.
-  # @param [Binding] b1 First binding.
-  # @param [Binding] b2 Second binding.
-  def self.bindings_equal?(b1, b2)
-    (b1.eval('self') == b2.eval('self')) &&
-      (b1.eval('__method__') == b2.eval('__method__')) &&
-      (b1.eval('local_variables').map { |v| b1.eval("#{v}") } ==
-       b2.eval('local_variables').map { |v| b2.eval("#{v}") })
+  class << self
+    # @return [Hash] The hash storing all frames for all Pry instances for
+    #   the current thread.
+    def frame_hash
+      Thread.current[:__pry_frame_managers__] ||= Hash.new { |h, k| h[k] = [] }
+    end
+
+    # Return the complete frame manager stack for the Pry instance
+    # @param [Pry] _pry_ The Pry instance associated with the frame
+    #   managers
+    # @return [Array] The stack of Pry::FrameManager objections
+    def frame_managers(_pry_)
+      frame_hash[_pry_]
+    end
+
+    # Create a `Pry::FrameManager` object and push it onto the frame
+    # manager stack for the relevant `_pry_` instance.
+    # @param [Array] bindings The array of bindings (frames)
+    # @param [Pry] _pry_ The Pry instance associated with the frame manager
+    def create_and_push_frame_manager(bindings, _pry_, options={})
+      fm = FrameManager.new(bindings, _pry_)
+      frame_hash[_pry_].push fm
+      push_helper(fm, options)
+      fm
+    end
+
+    # Update the Pry instance to operate on the specified frame for the
+    # current frame manager.
+    # @param [PryStackExplorer::FrameManager] fm The active frame manager.
+    # @param [Hash] options The options hash.
+    def push_helper(fm, options={})
+      options = {
+        :initial_frame => 0
+      }.merge!(options)
+
+      fm.change_frame_to(options[:initial_frame], false)
+    end
+
+    private :push_helper
+
+    # Delete the currently active frame manager
+    # @param [Pry] _pry_ The Pry instance associated with the frame
+    #   managers.
+    # @return [Pry::FrameManager] The popped frame manager.
+    def pop_frame_manager(_pry_)
+      return if frame_managers(_pry_).empty?
+
+      popped_fm = frame_managers(_pry_).pop
+      pop_helper(popped_fm, _pry_)
+      popped_fm
+    end
+
+    # Restore the Pry instance to operate on the previous
+    # binding. Also responsible for restoring Pry instance's backtrace.
+    # @param [Pry::FrameManager] popped_fm The recently popped frame manager.
+    # @param [Pry] _pry_ The Pry instance associated with the frame managers.
+    def pop_helper(popped_fm, _pry_)
+      if frame_managers(_pry_).empty?
+        if _pry_.binding_stack.empty?
+          _pry_.binding_stack.push popped_fm.prior_binding
+        else
+          _pry_.binding_stack[-1] = popped_fm.prior_binding
+        end
+
+        frame_hash.delete(_pry_)
+      else
+        frame_manager(_pry_).refresh_frame(false)
+      end
+
+      # restore backtrace
+      _pry_.backtrace = popped_fm.prior_backtrace
+    end
+
+    private :pop_helper
+
+    # Clear the stack of frame managers for the Pry instance
+    # @param [Pry] _pry_ The Pry instance associated with the frame managers
+    def clear_frame_managers(_pry_)
+      pop_frame_manager(_pry_) until frame_managers(_pry_).empty?
+      frame_hash.delete(_pry_) # this line should be unnecessary!
+    end
+
+    alias_method :delete_frame_managers, :clear_frame_managers
+
+    # @return [PryStackExplorer::FrameManager] The currently active frame manager
+    def frame_manager(_pry_)
+      frame_hash[_pry_].last
+    end
+
+    # Simple test to check whether two `Binding` objects are equal.
+    # @param [Binding] b1 First binding.
+    # @param [Binding] b2 Second binding.
+    # @return [Boolean] Whether the `Binding`s are equal.
+    def bindings_equal?(b1, b2)
+      (b1.eval('self') == b2.eval('self')) &&
+        (b1.eval('__method__') == b2.eval('__method__')) &&
+        (b1.eval('local_variables').map { |v| b1.eval("#{v}") } ==
+         b2.eval('local_variables').map { |v| b2.eval("#{v}") })
+    end
   end
 end
 

data/lib/pry-stack_explorer/frame_manager.rb

@@ -3,9 +3,13 @@ module PryStackExplorer
   class FrameManager
     include Enumerable
 
-    attr_accessor :binding_index
+    # @return [Array<Binding>] The array of bindings that constitute
+    #   the call-stack.
     attr_accessor :bindings
 
+    # @return [Fixnum] The index of the active frame (binding) in the call-stack.
+    attr_accessor :binding_index
+
     # @return [Hash] A hash for user defined data
     attr_reader :user
 

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = "0.2.9pre4"
+  VERSION = "0.2.9pre5"
 end

data/lib/pry-stack_explorer/when_started_hook.rb

@@ -4,10 +4,10 @@ module PryStackExplorer
     def caller_bindings(binding_stack)
       target = binding_stack.last
 
-      if binding.of_caller(6).eval('__method__') == :pry
-        drop_number = 8
+      if binding.of_caller(7).eval('__method__') == :pry
+        drop_number = 9
       else
-        drop_number = 7
+        drop_number = 8
       end
 
       bindings = binding.callers.drop(drop_number)
@@ -24,22 +24,24 @@ module PryStackExplorer
     end
 
     def call(binding_stack, options, _pry_)
-      options[:call_stack]    = true unless options.has_key?(:call_stack)
-      options[:initial_frame] = 0 unless options.has_key?(:initial_frame)
-      initial_frame = options[:initial_frame]
+      options = {
+        :call_stack    => true,
+        :initial_frame => 0
+      }.merge!(options)
 
       return if !options[:call_stack]
 
       if options[:call_stack].is_a?(Array)
         bindings = options[:call_stack]
-        raise ArgumentError, ":call_stack must be an array of bindings" if bindings.empty? || !bindings.all? { |v| v.is_a?(Binding) }
+
+        if bindings.empty? || !bindings.all? { |v| v.is_a?(Binding) }
+          raise ArgumentError, ":call_stack must be an array of bindings"
+        end
       else
-       bindings = caller_bindings(binding_stack)
+        bindings = caller_bindings(binding_stack)
       end
 
-      binding_stack.replace [bindings[initial_frame]]
-      PryStackExplorer.create_and_push_frame_manager(bindings, _pry_)
-      PryStackExplorer.frame_manager(_pry_).set_binding_index_safely(initial_frame)
+      PryStackExplorer.create_and_push_frame_manager bindings, _pry_, :initial_frame => options[:initial_frame]
     end
   end
 end

data/pry-stack_explorer.gemspec

@@ -1,39 +1,39 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "pry-stack_explorer"
-  s.version = "0.2.9pre4"
+  s.name = %q{pry-stack_explorer}
+  s.version = "0.2.9pre5"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2012-01-16"
-  s.description = "Walk the stack in a Pry session"
-  s.email = "jrmair@gmail.com"
-  s.files = [".gemtest", ".gitignore", ".travis.yml", ".yardopts", "CHANGELOG", "Gemfile", "LICENSE", "README.md", "Rakefile", "examples/example.rb", "examples/example2.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/helper.rb", "test/test_commands.rb", "test/test_frame_manager.rb", "test/test_stack_explorer.rb", "tester.rb"]
-  s.homepage = "https://github.com/banister"
-  s.require_paths = ["lib"]
+  s.authors = [%q{John Mair (banisterfiend)}]
+  s.date = %q{2012-01-20}
+  s.description = %q{Walk the stack in a Pry session}
+  s.email = %q{jrmair@gmail.com}
+  s.files = [%q{.gemtest}, %q{.gitignore}, %q{.travis.yml}, %q{.yardopts}, %q{CHANGELOG}, %q{Gemfile}, %q{LICENSE}, %q{README.md}, %q{Rakefile}, %q{examples/example.rb}, %q{examples/example2.rb}, %q{lib/pry-stack_explorer.rb}, %q{lib/pry-stack_explorer/commands.rb}, %q{lib/pry-stack_explorer/frame_manager.rb}, %q{lib/pry-stack_explorer/version.rb}, %q{lib/pry-stack_explorer/when_started_hook.rb}, %q{pry-stack_explorer.gemspec}, %q{test/helper.rb}, %q{test/test_commands.rb}, %q{test/test_frame_manager.rb}, %q{test/test_stack_explorer.rb}, %q{tester.rb}]
+  s.homepage = %q{https://github.com/banister}
+  s.require_paths = [%q{lib}]
   s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
-  s.rubygems_version = "1.8.11"
-  s.summary = "Walk the stack in a Pry session"
-  s.test_files = ["test/helper.rb", "test/test_commands.rb", "test/test_frame_manager.rb", "test/test_stack_explorer.rb"]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Walk the stack in a Pry session}
+  s.test_files = [%q{test/helper.rb}, %q{test/test_commands.rb}, %q{test/test_frame_manager.rb}, %q{test/test_stack_explorer.rb}]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<binding_of_caller>, ["~> 0.6.1"])
-      s.add_runtime_dependency(%q<pry>, ["= 0.9.8pre4"])
+      s.add_runtime_dependency(%q<pry>, ["= 0.9.8pre6"])
       s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_development_dependency(%q<rake>, ["~> 0.9"])
     else
       s.add_dependency(%q<binding_of_caller>, ["~> 0.6.1"])
-      s.add_dependency(%q<pry>, ["= 0.9.8pre4"])
+      s.add_dependency(%q<pry>, ["= 0.9.8pre6"])
       s.add_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_dependency(%q<rake>, ["~> 0.9"])
     end
   else
     s.add_dependency(%q<binding_of_caller>, ["~> 0.6.1"])
-    s.add_dependency(%q<pry>, ["= 0.9.8pre4"])
+    s.add_dependency(%q<pry>, ["= 0.9.8pre6"])
     s.add_dependency(%q<bacon>, ["~> 1.1.0"])
     s.add_dependency(%q<rake>, ["~> 0.9"])
   end

data/test/helper.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'ostruct'
 
 unless Object.const_defined? 'PryStackExplorer'
   $:.unshift File.expand_path '../../lib', __FILE__

data/test/test_stack_explorer.rb

@@ -33,9 +33,9 @@ describe PryStackExplorer do
         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
+        def o.bang() Pry.start(binding, :initial_frame => 1) end #*
 
-        redirect_pry_io(StringIO.new("@frame = __method__\nexit\n"), out=StringIO.new) do
+        redirect_pry_io(StringIO.new("@frame = __method__\nexit-all\n"), out=StringIO.new) do
           o.bing
         end
 
@@ -93,14 +93,20 @@ describe PryStackExplorer do
         out.string.should =~ /beta.*?gamma.*?alpha/m
       end
 
-      it 'should raise if custom call stack does not contain bindings or is empty' do
-        redirect_pry_io(StringIO.new("show-stack\nexit\n"), out=StringIO.new) do
-          lambda { Pry.start(binding, :call_stack => [1, 2, 3]) }.should.raise ArgumentError
+      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
 
-        redirect_pry_io(StringIO.new("show-stack\nexit\n"), out=StringIO.new) do
-          lambda { Pry.start(binding, :call_stack => []) }.should.raise ArgumentError
+      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
@@ -123,6 +129,12 @@ describe PryStackExplorer do
         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)
@@ -130,6 +142,28 @@ describe PryStackExplorer do
         PryStackExplorer.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"]
@@ -209,6 +243,53 @@ describe PryStackExplorer do
         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

metadata

@@ -1,70 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pry-stack_explorer
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.9pre5
   prerelease: 5
-  version: 0.2.9pre4
 platform: ruby
-authors: 
+authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: binding_of_caller
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70127592869260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.6.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70127592869260
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70127592897240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.9.8pre4
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.8pre6
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bacon
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70127592897240
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &70127592900320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70127592900320
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70127592903060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *70127592903060
 description: Walk the stack in a Pry session
 email: jrmair@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gemtest
 - .gitignore
 - .travis.yml
@@ -89,32 +85,29 @@ files:
 - tester.rb
 homepage: https://github.com/banister
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Walk the stack in a Pry session
-test_files: 
+test_files:
 - test/helper.rb
 - test/test_commands.rb
 - test/test_frame_manager.rb