pry-stack_explorer 0.3.9 → 0.4.0

data/README.md

@@ -33,6 +33,7 @@ After installing `pry-stack_explorer`, just start Pry as normal (typically via a
 * Install the [gem](https://rubygems.org/gems/pry-stack_explorer): `gem install pry-stack_explorer`
 * Read the [documentation](http://rdoc.info/github/banister/pry-stack_explorer/master/file/README.md)
 * See the [source code](http://github.com/pry/pry-stack_explorer)
+* See the [wiki](https://github.com/pry/pry-stack_explorer/wiki) for in-depth usage information.
 
 Example: Moving around between frames
 --------

data/lib/pry-stack_explorer/commands.rb

@@ -85,50 +85,118 @@ module PryStackExplorer
         "#{meth_obj.name_with_owner}(UNKNOWN) (undefined method)"
       end
     end
+
+    #  Regexp.new(args[0])
+    def find_frame_by_regex(regex, up_or_down)
+      start_index = frame_manager.binding_index
+
+      if up_or_down == :down
+        enum = frame_manager.bindings[0..start_index - 1].reverse_each
+      else
+        enum = frame_manager.bindings[start_index + 1..-1]
+      end
+
+      new_frame = enum.find do |b|
+        b.eval("__method__").to_s =~ regex
+      end
+
+      frame_index = frame_manager.bindings.index(new_frame)
+
+      if frame_index
+        frame_index
+      else
+        raise Pry::CommandError, "No frame that matches #{regex.source} found!"
+      end
+    end
   end
 
   Commands = Pry::CommandSet.new do
-    create_command "up", "Go up to the caller's context. Accepts optional numeric parameter for how many frames to move up." do
+    create_command "up", "Go up to the caller's context." do
       include FrameHelpers
 
       banner <<-BANNER
         Usage: up [OPTIONS]
           Go up to the caller's context. Accepts optional numeric parameter for how many frames to move up.
-          e.g: up
-          e.g: up 3
+          Also accepts a string (regex) instead of numeric; for jumping to nearest parent method frame which matches the regex.
+          e.g: up      #=> Move up 1 stack frame.
+          e.g: up 3    #=> Move up 2 stack frames.
+          e.g: up meth #=> Jump to nearest parent stack frame whose method matches /meth/ regex, i.e `my_method`.
       BANNER
 
       def process
-        inc = args.first.nil? ? 1 : args.first.to_i
+        inc = args.first.nil? ? "1" : args.first
 
         if !frame_manager
           raise Pry::CommandError, "Nowhere to go!"
         else
-          frame_manager.change_frame_to frame_manager.binding_index + inc
+          if inc =~ /\d+/
+            frame_manager.change_frame_to frame_manager.binding_index + inc.to_i
+          elsif inc =~ /^[^-].*$/
+            new_frame_index = find_frame_by_regex(Regexp.new(inc), :up)
+            frame_manager.change_frame_to new_frame_index
+          end
         end
       end
     end
 
-    create_command "down", "Go down to the callee's context. Accepts optional numeric parameter for how many frames to move down." do
+    create_command "down", "Go down to the callee's context." do
       include FrameHelpers
 
       banner <<-BANNER
         Usage: down [OPTIONS]
           Go down to the callee's context. Accepts optional numeric parameter for how many frames to move down.
-          e.g: down
-          e.g: down 3
+          Also accepts a string (regex) instead of numeric; for jumping to nearest child method frame which matches the regex.
+          e.g: down      #=> Move down 1 stack frame.
+          e.g: down 3    #=> Move down 2 stack frames.
+          e.g: down meth #=> ump to nearest child stack frame whose method matches /meth/ regex, i.e `my_method`.
       BANNER
 
       def process
-        inc = args.first.nil? ? 1 : args.first.to_i
+        inc = args.first.nil? ? "1" : args.first
 
         if !frame_manager
           raise Pry::CommandError, "Nowhere to go!"
         else
-          if frame_manager.binding_index - inc < 0
-            raise Pry::CommandError, "At bottom of stack, cannot go further!"
+          if inc =~ /\d+/
+            if frame_manager.binding_index - inc.to_i < 0
+              raise Pry::CommandError, "At bottom of stack, cannot go further!"
+            else
+              frame_manager.change_frame_to frame_manager.binding_index - inc.to_i
+            end
+          elsif inc =~ /^[^-].*$/
+            new_frame_index = find_frame_by_regex(Regexp.new(inc), :down)
+            frame_manager.change_frame_to new_frame_index
+          end
+        end
+      end
+    end
+
+    create_command "frame", "Switch to a particular frame." do
+      include FrameHelpers
+
+      banner <<-BANNER
+        Usage: frame [OPTIONS]
+          Switch to a particular frame. Accepts numeric parameter (or regex for method name) for the target frame to switch to (use with show-stack).
+          Negative frame numbers allowed. When given no parameter show information about the current frame.
+
+          e.g: frame 4         #=> jump to the 4th frame
+          e.g: frame meth      #=> jump to nearest parent stack frame whose method matches /meth/ regex, i.e `my_method`
+          e.g: frame -2        #=> jump to the second-to-last frame
+          e.g: frame           #=> show information info about current frame
+      BANNER
+
+      def process
+        if !frame_manager
+          raise Pry::CommandError, "nowhere to go!"
+        else
+
+          if args[0] =~ /\d+/
+            frame_manager.change_frame_to args[0].to_i
+          elsif args[0] =~ /^[^-].*$/
+            new_frame_index = find_frame_by_regex(Regexp.new(args[0]), :up)
+            frame_manager.change_frame_to new_frame_index
           else
-            frame_manager.change_frame_to frame_manager.binding_index - inc
+            output.puts "##{frame_manager.binding_index} #{frame_info(target, true)}"
           end
         end
       end
@@ -212,44 +280,5 @@ module PryStackExplorer
 
       end
     end
-
-    create_command "frame", "Switch to a particular frame. Accepts numeric parameter for the target frame to switch to (use with show-stack). Negative frame numbers allowed." do
-      include FrameHelpers
-
-      banner <<-BANNER
-        Usage: frame [OPTIONS]
-          Switch to a particular frame. Accepts numeric parameter (or regex for method name) for the target frame to switch to (use with show-stack).
-          Negative frame numbers allowed. When given no parameter show information about the current frame.
-
-          e.g: frame 4         #=> jump to the 4th frame
-          e.g: frame meth      #=> jump to nearest parent stack frame whose method matches /meth/ regex, i.e `my_method`
-          e.g: frame -2        #=> jump to the second-to-last frame
-          e.g: frame           #=> show information info about current frame
-      BANNER
-
-      def process
-        if !frame_manager
-          raise Pry::CommandError, "nowhere to go!"
-        else
-
-          if args[0] =~ /\d+/
-            frame_manager.change_frame_to args[0].to_i
-          elsif args[0] =~ /^[^-].*$/
-            new_frame_index = frame_manager.each_with_index.find_index do |b, i|
-              b.eval("__method__").to_s =~ Regexp.new(args[0]) && i > frame_manager.binding_index
-            end
-
-            if new_frame_index
-              frame_manager.change_frame_to new_frame_index
-            else
-              raise Pry::CommandError, "No parent frame that matches #{args[0]} found!"
-            end
-
-          else
-            output.puts "##{frame_manager.binding_index} #{frame_info(target, true)}"
-          end
-        end
-      end
-    end
   end
 end

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = "0.3.9"
+  VERSION = "0.4.0"
 end

data/pry-stack_explorer.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pry-stack_explorer"
-  s.version = "0.3.9"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mair (banisterfiend)"]
-  s.date = "2012-02-09"
+  s.date = "2012-02-17"
   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"]

data/test/test_commands.rb

@@ -45,6 +45,44 @@ describe PryStackExplorer::Commands do
       @o.first_method.should  == :bang
       @o.second_method.should == :bing
     end
+
+    describe "by method name regex" do
+      it 'should move to the method name that matches the regex' do
+        redirect_pry_io(InputTester.new("@first_method = __method__",
+                                        "up bi",
+                                        "@second_method = __method__",
+                                        "exit-all"), out=StringIO.new) do
+          @o.bing
+        end
+
+        @o.first_method.should  == :bang
+        @o.second_method.should == :bing
+      end
+
+      it 'should move through all methods that match regex in order' do
+        redirect_pry_io(InputTester.new("@first_method = __method__",
+                                        "up b",
+                                        "@second_method = __method__",
+                                        "up b",
+                                        "@third_method = __method__",
+                                        "exit-all"), out=StringIO.new) do
+          @o.bing
+        end
+
+        @o.first_method.should  == :bang
+        @o.second_method.should == :bong
+        @o.third_method.should  == :bing
+      end
+
+      it 'should error if it cant find frame to match regex' do
+        redirect_pry_io(InputTester.new("up conrad_irwin",
+                                        "exit-all"), out=StringIO.new) do
+          @o.bing
+        end
+
+        out.string.should =~ /Error: No frame that matches/
+      end
+    end
   end
 
   describe "down" do
@@ -75,6 +113,46 @@ describe PryStackExplorer::Commands do
       @o.first_method.should  == :bing
       @o.second_method.should == :bang
     end
+
+    describe "by method name regex" do
+      it 'should move to the method name that matches the regex' do
+        redirect_pry_io(InputTester.new("frame -1",
+                                        "down bo",
+                                        "@first_method = __method__",
+                                        "exit-all"), out=StringIO.new) do
+          @o.bing
+        end
+
+        @o.first_method.should == :bong
+      end
+
+      it 'should move through all methods that match regex in order' do
+        redirect_pry_io(InputTester.new("frame bing",
+                                        "@first_method = __method__",
+                                        "down b",
+                                        "@second_method = __method__",
+                                        "down b",
+                                        "@third_method = __method__",
+                                        "exit-all"), out=StringIO.new) do
+          @o.bing
+        end
+
+        @o.first_method.should  == :bing
+        @o.second_method.should == :bong
+        @o.third_method.should  == :bang
+      end
+
+      it 'should error if it cant find frame to match regex' do
+        redirect_pry_io(InputTester.new("frame -1",
+                                        "down conrad_irwin",
+                                        "exit-all"), out=StringIO.new) do
+          @o.bing
+        end
+
+        out.string.should =~ /Error: No frame that matches/
+      end
+    end
+
   end
 
   describe "frame" do
@@ -96,7 +174,7 @@ describe PryStackExplorer::Commands do
           @o.bing
         end
 
-        out.string.should =~ /Error: No parent frame that matches/
+        out.string.should =~ /Error: No frame that matches/
       end
 
     end

metadata

@@ -2,7 +2,7 @@
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-09 00:00:00 Z
+date: 2012-02-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: binding_of_caller