pry-stack_explorer 0.2.5pre1 → 0.2.6pre1

data/Rakefile

@@ -61,6 +61,12 @@ task :gems => [:clean, :rmgems, "ruby:gem"]
 desc "remove all platform gems"
 task :rmgems => ["ruby:clobber_package"]
 
+desc "reinstall gem"
+task :reinstall => :gems do
+  sh "gem uninstall pry-exception_explorer" rescue nil
+  sh "gem install #{direc}/pkg/#{PROJECT_NAME}-#{PryStackExplorer::VERSION}.gem"
+end
+
 desc "build and push latest gems"
 task :pushgems => :gems do
   chdir("#{File.dirname(__FILE__)}/pkg") do

data/lib/pry-stack_explorer.rb

@@ -2,169 +2,52 @@
 # (C) John Mair (banisterfiend); MIT license
 
 require "pry-stack_explorer/version"
+require "pry-stack_explorer/commands"
+require "pry-stack_explorer/frame_manager"
 require "pry"
 require "binding_of_caller"
 
 module PryStackExplorer
+  Thread.current[:__pry_frame_managers__] ||= Hash.new { |h, k| h[k] = [] }
+  
+  # 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.push_and_create_frame_manager(bindings, _pry_)
+    Thread.current[:__pry_frame_managers__][_pry_].push FrameManager.new(bindings, _pry_)
+  end
 
-  def self.add_frame_manager(bindings, _pry_)
-    Thread.current[:__pry_frame_managers__] ||= {}
-    Thread.current[:__pry_frame_managers__][_pry_] = FrameManager.new(bindings, _pry_)
+  # Delete the currently active frame manager
+  # @param [Pry] _pry_ The Pry instance associated with the frame managers
+  def self.pop_frame_manager(_pry_)
+    Thread.current[:__pry_frame_managers__][_pry_].pop 
   end
 
-  def self.delete_frame_manager(_pry_)
-    Thread.current[:__pry_frame_managers__].delete(_pry_)
+  # 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_)
+    Thread.current[:__pry_frame_managers__][_pry_].clear    
   end
 
+  # @return [PryStackExplorer::FrameManager] The currently active frame manager
   def self.frame_manager(_pry_)
-    Thread.current[:__pry_frame_managers__][_pry_]
+    Thread.current[:__pry_frame_managers__][_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}") })
   end
-
-  class FrameManager
-    attr_reader   :binding_index
-    attr_accessor :bindings
-
-    def initialize(bindings, _pry_)
-      @bindings      = bindings
-      @binding_index = 0
-      @pry           = _pry_
-    end
-
-    def convert_from_one_index(n)
-      if n >= 0
-        n - 1
-      else
-        n
-      end
-    end
-    private :convert_from_one_index
-
-    def signature(b)
-      if b.eval('__method__')
-        "#{closure_type} in #{b.eval('self').class}##{b.eval('__method__')}"
-      else
-        if b.eval('self').is_a?(Module)
-          "#{closure_type} in <class:#{b.eval('self')}>"
-        end
-      end
-    end
-
-    def binding_info_for(b)
-      b_self = b.eval('self')
-      b_method = b.eval('__method__')
-
-      if b_method && b_method != :__binding__ && b_method != :__binding_impl__
-        b_method.to_s
-      elsif b_self.instance_of?(Module)
-        "<module:#{b_self}>"
-      elsif b_self.instance_of?(Class)
-        "<class:#{b_self}>"
-      else
-        "<main>"
-      end
-    end
-
-    def change_binding_to(index)
-      index = convert_from_one_index(index)
-
-      if index > bindings.size - 1
-        @pry.output.puts "Warning: At top of stack, cannot go further!"
-      elsif index < 0
-        @pry.output.puts "Warning: At bottom of stack, cannot go further!"
-      else
-        @binding_index = index
-        @pry.binding_stack[-1] = bindings[binding_index]
-
-        @pry.run_command "whereami"
-      end
-    end
-  end
-
-  StackCommands = Pry::CommandSet.new do
-    command "up", "Go up to the caller's context" do |inc_str|
-      inc = inc_str.nil? ? 1 : inc_str.to_i
-
-      if !PryStackExplorer.frame_manager(_pry_)
-        output.puts "Nowhere to go!"
-      else
-        binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
-        PryStackExplorer.frame_manager(_pry_).change_binding_to binding_index + inc + 1
-      end
-    end
-
-    command "down", "Go down to the callee's context." do |inc_str|
-      inc = inc_str.nil? ? 1 : inc_str.to_i
-
-      if !PryStackExplorer.frame_manager(_pry_)
-        output.puts "Nowhere to go!"
-      else
-        binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
-        PryStackExplorer.frame_manager(_pry_).change_binding_to binding_index - inc + 1
-      end
-    end
-
-    command "show-stack", "Show all frames" do |*args|
-      opts = parse_options!(args) do |opt|
-        opt.banner unindent <<-USAGE
-            Usage: show-stack [OPTIONS]
-            Show all accessible stack frames.
-            e.g: show-stack -v
-          USAGE
-
-        opt.on :v, :verbose, "Include extra information."
-      end
-
-      if !PryStackExplorer.frame_manager(_pry_)
-        output.puts "No caller stack available!"
-      else
-        output.puts "\n#{text.bold('Showing all accessible frames in stack:')}\n--\n"
-
-        PryStackExplorer.frame_manager(_pry_).bindings.each_with_index do |b, i|
-          meth = b.eval('__method__')
-          b_self = b.eval('self')
-
-          desc = b.frame_description ? "#{text.bold('Description:')} #{b.frame_description}".ljust(40) :
-            "#{text.bold('Description:')} #{PryStackExplorer.frame_manager(_pry_).binding_info_for(b)}".ljust(40)
-          sig = meth ? "#{text.bold('Signature:')} #{Pry::Method.new(b_self.method(meth)).signature}".ljust(40) : "".ljust(32)
-          type = b.frame_type ? "#{text.bold('Type:')} #{b.frame_type}".ljust(20) : "".ljust(20)
-          slf = "#{text.bold('Self:')} #{b_self}".ljust(20)
-          path = "#{text.bold("@ File:")} #{b.eval('__FILE__')}:#{b.eval('__LINE__')}"
-
-          info = "##{i + 1} #{desc} #{sig} #{slf if opts[:v]} #{type \
-                  if opts[:v]} #{path if opts[:v]}"
-          if i == PryStackExplorer.frame_manager(_pry_).binding_index
-
-            output.puts "=> #{info}"
-          else
-            output.puts "   #{info}"
-          end
-        end
-      end
-    end
-
-    command "frame", "Switch to a particular frame." do |frame_num|
-      if !PryStackExplorer.frame_manager(_pry_)
-        output.puts "nowhere to go!"
-      else
-        PryStackExplorer.frame_manager(_pry_).change_binding_to frame_num.to_i
-      end
-    end
-
-    command "frame-type", "Display current frame type." do
-      output.puts _pry_.binding_stack.last.frame_type
-    end
-  end
 end
 
 Pry.config.hooks.add_hook(:after_session, :delete_frame_manager) do |_, _, _pry_|
-  PryStackExplorer.delete_frame_manager(_pry_)
+  PryStackExplorer.clear_frame_managers(_pry_)
 end
 
 Pry.config.hooks.add_hook(:when_started, :save_caller_bindings) do |binding_stack, _pry_|
@@ -187,9 +70,10 @@ Pry.config.hooks.add_hook(:when_started, :save_caller_bindings) do |binding_stac
   end
 
   binding_stack.replace([bindings.first])
-  PryStackExplorer.add_frame_manager(bindings, _pry_)
+  PryStackExplorer.push_and_create_frame_manager(bindings, _pry_)
 end
 
+# Import the StackExplorer commands
 Pry.config.commands.import PryStackExplorer::StackCommands
 
 # monkey-patch the whereami command to show some frame information,
@@ -200,7 +84,7 @@ Pry.config.commands.before_command("whereami") do |num|
     binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
 
     output.puts "\n"
-    output.puts "#{Pry::Helpers::Text.bold('Frame number:')} #{binding_index + 1}/#{bindings.size}"
+    output.puts "#{Pry::Helpers::Text.bold('Frame number:')} #{binding_index}/#{bindings.size - 1}"
     output.puts "#{Pry::Helpers::Text.bold('Frame type:')} #{bindings[binding_index].frame_type}" if bindings[binding_index].frame_type
   end
 end

data/lib/pry-stack_explorer/commands.rb

@@ -0,0 +1,75 @@
+module PryStackExplorer
+  StackCommands = Pry::CommandSet.new do
+    command "up", "Go up to the caller's context" do |inc_str|
+      inc = inc_str.nil? ? 1 : inc_str.to_i
+
+      if !PryStackExplorer.frame_manager(_pry_)
+        output.puts "Nowhere to go!"
+      else
+        binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
+        PryStackExplorer.frame_manager(_pry_).change_frame_to binding_index + inc 
+      end
+    end
+
+    command "down", "Go down to the callee's context." do |inc_str|
+      inc = inc_str.nil? ? 1 : inc_str.to_i
+
+      if !PryStackExplorer.frame_manager(_pry_) 
+        output.puts "Nowhere to go!"
+      else
+        binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
+        PryStackExplorer.frame_manager(_pry_).change_frame_to binding_index - inc 
+      end
+    end
+
+    command "show-stack", "Show all frames" do |*args|
+      opts = parse_options!(args) do |opt|
+        opt.banner unindent <<-USAGE
+            Usage: show-stack [OPTIONS]
+            Show all accessible stack frames.
+            e.g: show-stack -v
+          USAGE
+
+        opt.on :v, :verbose, "Include extra information."
+      end
+
+      if !PryStackExplorer.frame_manager(_pry_)
+        output.puts "No caller stack available!"
+      else
+        output.puts "\n#{text.bold('Showing all accessible frames in stack:')}\n--\n"
+
+        PryStackExplorer.frame_manager(_pry_).each_with_index do |b, i|
+          meth = b.eval('__method__')
+          b_self = b.eval('self')
+
+          desc = b.frame_description ? "#{text.bold('Description:')} #{b.frame_description}".ljust(40) :
+            "#{text.bold('Description:')} #{PryStackExplorer.frame_manager(_pry_).frame_info_for(b)}".ljust(40)
+          sig = meth ? "#{text.bold('Signature:')} #{Pry::Method.new(b_self.method(meth)).signature}".ljust(40) : "".ljust(32)
+          type = b.frame_type ? "#{text.bold('Type:')} #{b.frame_type}".ljust(20) : "".ljust(20)
+          slf_class = "#{text.bold('Self.class:')} #{b_self.class}".ljust(20)
+          path = "#{text.bold("@ File:")} #{b.eval('__FILE__')}:#{b.eval('__LINE__')}"
+
+          info = "##{i} #{desc} #{slf_class} #{sig} #{type \
+                  if opts[:v]} #{path if opts[:v]}"
+          if i == PryStackExplorer.frame_manager(_pry_).binding_index
+            output.puts "=> #{info}"
+          else
+            output.puts "   #{info}"
+          end
+        end
+      end
+    end
+
+    command "frame", "Switch to a particular frame." do |frame_num|
+      if !PryStackExplorer.frame_manager(_pry_)
+        output.puts "nowhere to go!"
+      else
+        PryStackExplorer.frame_manager(_pry_).change_frame_to frame_num.to_i
+      end
+    end
+
+    command "frame-type", "Display current frame type." do
+      output.puts _pry_.binding_stack.last.frame_type
+    end
+  end
+end

data/lib/pry-stack_explorer/frame_manager.rb

@@ -0,0 +1,80 @@
+module PryStackExplorer
+  
+  class FrameManager
+    include Enumerable
+    
+    attr_accessor :binding_index
+    attr_accessor :bindings
+
+    # @return [Hash] A hash for user defined data
+    attr_reader :user
+
+    def initialize(bindings, _pry_)
+      self.bindings      = bindings
+      self.binding_index = 0
+      @pry               = _pry_
+      @user              = {}
+    end
+
+    # Replace the current set of bindings (call stack) and binding
+    # index (current frame)
+    # @param [Array] bindings The new call stack (array of bindings)
+    # @param [Fixnum] binding_index The currently 'active' frame (binding).
+    def replace_call_stack(bindings, binding_index = 0)
+      self.bindings      = bindings
+      self.binding_index = binding_index
+    end
+
+    # Iterate over all frames
+    def each(&block)
+      bindings.each(&block)
+    end
+
+    # Return a description of the frame (binding)
+    # @param [Binding] b The binding.
+    # @return [String] A description of the frame (binding).
+    def frame_info_for(b)
+      b_self = b.eval('self')
+      b_method = b.eval('__method__')
+
+      if b_method && b_method != :__binding__ && b_method != :__binding_impl__
+        b_method.to_s
+      elsif b_self.instance_of?(Module)
+        "<module:#{b_self}>"
+      elsif b_self.instance_of?(Class)
+        "<class:#{b_self}>"
+      else
+        "<main>"
+      end
+    end
+
+    # Ensure the Pry instance's active binding is the frame manager's
+    # active binding.
+    def refresh_frame
+      change_frame_to binding_index 
+    end
+
+    # @return [Binding] The currently active frame
+    def current_frame
+      bindings[binding_index]
+    end
+
+    # Change active frame to the one indexed by `index`.
+    # Note that indexing base is `0`
+    # @param [Fixnum] index The index of the frame.
+    def change_frame_to(index)
+
+      if index > bindings.size - 1
+        @pry.output.puts "Warning: At top of stack, cannot go further!"
+      elsif index < 0
+        @pry.output.puts "Warning: At bottom of stack, cannot go further!"
+      else
+        self.binding_index = index
+        @pry.binding_stack[-1] = bindings[binding_index]
+
+        @pry.run_command "whereami"
+      end
+    end
+    
+  end
+end

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = "0.2.5pre1"
+  VERSION = "0.2.6pre1"
 end

metadata

@@ -2,7 +2,7 @@
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version 
   prerelease: 5
-  version: 0.2.5pre1
+  version: 0.2.6pre1
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-06 00:00:00 Z
+date: 2011-12-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: binding_of_caller
@@ -43,6 +43,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/pry-stack_explorer/commands.rb
+- lib/pry-stack_explorer/frame_manager.rb
 - lib/pry-stack_explorer/version.rb
 - lib/pry-stack_explorer.rb
 - test/test.rb