pry-stack_explorer 0.2.8pre6 → 0.2.8pre7

data/README.md

@@ -1,27 +1,128 @@
-pry-stack_explore
+pry-stack_explorer
 ===========
 
 (C) John Mair (banisterfiend) 2011
 
-FIXME: _tagline_
+_Walk the stack in a Pry session_
 
-FIXME: _description goes here_
+pry-stack_explorer is a plugin for the [Pry](http://pry.github.com)
+REPL that enables the user to navigate the call-stack.
 
-* Install the [gem](https://rubygems.org/gems/pry-stack_explore): `gem install pry-stack_explore`
-* Read the [documentation](http://rdoc.info/github/banister/pry-stack_explore/master/file/README.md)
-* See the [source code](http://github.com/banister/pry-stack_explore)
+From the point a Pry session is started, the user can move up the stack
+through parent frames, examine state, and even evaluate code.
 
-Example: Example description
---------
+Unlike `ruby-debug`, pry-stack_explorer incurs no runtime cost and
+enables navigation right up the call-stack to the birth of the
+program.
+
+pry-stack_explorer is currently designed to work on MRI and
+Ruby 1.9.2+ (including 1.9.3). Support for other Ruby versions and
+implementations is planned for the future.
+
+The `up`, `down`, `frame` and `show-stack` commands are provided.
+
+Please note that this is a first release and may have some teething problems, feel free to file an [issue](https://github.com/banister/pry-stack_explorer) if you encounter any problems.
 
-Example preamble
+* 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/banister/pry-stack_explorer)
 
-    puts "example code"
+Example: Moving around between frames
+--------
+
+```
+[8] pry(J)> show-stack
+
+Showing all accessible frames in stack:
+--
+=> #0 [method]  c <Object#c()>
+   #1 [block]   block in b <Object#b()>
+   #2 [method]  b <Object#b()>
+   #3 [method]  alphabet <Object#alphabet(y)>
+   #4 [class]   <class:J> 
+   #5 [block]   block in <main> 
+   #6 [eval]    <main> 
+   #7 [top]     <main> 
+[9] pry(J)> frame 3
+
+Frame number: 3/7
+Frame type: method
+
+From: /Users/john/ruby/projects/pry-stack_explorer/examples/example.rb @ line 10 in Object#alphabet:
+
+     5: 
+     6: require 'pry-stack_explorer'
+     7: 
+     8: def alphabet(y)
+     9:   x = 20
+ => 10:   b
+    11: end
+    12: 
+    13: def b
+    14:   x = 30
+    15:   proc {
+[10] pry(J)> x
+=> 20
+```
+
+Example: Modifying state in a caller
+-------
 
-Features and limitations
+```
+Frame number: 0/3
+Frame type: method
+
+From: /Users/john/ruby/projects/pry-stack_explorer/examples/example2.rb @ line 15 in Object#beta:
+
+    10:   beta
+    11:   puts x
+    12: end
+    13: 
+    14: def beta
+ => 15:   binding.pry
+    16: end
+    17: 
+    18: alpha
+[1] pry(main)> show-stack
+
+Showing all accessible frames in stack:
+--
+=> #0 [method]  beta <Object#beta()>
+   #1 [method]  alpha <Object#alpha()>
+   #2 [eval]    <main> 
+   #3 [top]     <main> 
+[2] pry(main)> up
+
+Frame number: 1/3
+Frame type: method
+
+From: /Users/john/ruby/projects/pry-stack_explorer/examples/example2.rb @ line 10 in Object#alpha:
+
+     5: 
+     6: 
+     7: 
+     8: def alpha
+     9:   x = "hello"
+ => 10:   beta
+    11:   puts x
+    12: end
+    13: 
+    14: def beta
+    15:   binding.pry
+[3] pry(main)> x = "goodbye"
+=> "goodbye"
+[4] pry(main)> ^D
+
+OUTPUT: goodbye
+```
+
+Output from above is `goodbye` as we changed the `x` local inside the `alpha` (caller) stack frame.
+
+Limitations
 -------------------------
 
-Feature List Preamble
+* First release, so may have teething problems.
+* Limited to MRI 1.9.2+ at this stage.
 
 Contact
 -------
@@ -32,7 +133,7 @@ Problems or questions contact me at [github](http://github.com/banister)
 License
 -------
 
-(The MIT License) 
+(The MIT License)
 
 Copyright (c) 2011 John Mair (banisterfiend)
 

data/Rakefile

@@ -26,6 +26,7 @@ def apply_spec_defaults(s)
   s.add_dependency("pry","0.9.8pre2")
   s.add_development_dependency("bacon","~>1.1.0")
   s.add_development_dependency('rake', '~> 0.9')
+  s.required_ruby_version = '>= 1.9.2'
   s.homepage = "https://github.com/banister"
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- test/*`.split("\n")
@@ -41,6 +42,11 @@ task :example do
   sh "ruby -I#{direc}/lib/ #{direc}/examples/example.rb "
 end
 
+desc "Run example2"
+task :example2 do
+  sh "ruby -I#{direc}/lib/ #{direc}/examples/example2.rb "
+end
+
 desc "Show version"
 task :version do
   puts "PryStackExplorer version: #{PryStackExplorer::VERSION}"

data/examples/example.rb

@@ -19,7 +19,7 @@ end
 
 def c
   u = 50
-  J.pry
+  binding.pry
 end
 
 # hello

data/examples/example2.rb

@@ -0,0 +1,18 @@
+unless Object.const_defined? :PryStackExplorer
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'pry'
+end
+
+require 'pry-stack_explorer'
+
+def alpha
+  x = "hello"
+  beta
+  puts x
+end
+
+def beta
+  binding.pry
+end
+
+alpha

data/lib/pry-stack_explorer/commands.rb

@@ -64,32 +64,28 @@ module PryStackExplorer
         if frame_num
           PryStackExplorer.frame_manager(_pry_).change_frame_to frame_num.to_i
         else
-          output.puts "##{PryStackExplorer.frame_manager(_pry_).binding_index} #{frame_info(target)}"
+          output.puts "##{PryStackExplorer.frame_manager(_pry_).binding_index} #{frame_info(target, true)}"
         end
       end
     end
 
-    command "frame-type", "Display current frame type." do
-      output.puts _pry_.binding_stack.last.frame_type
-    end
-
     helpers do
       def frame_info(b, verbose = false)
         meth = b.eval('__method__')
         b_self = b.eval('self')
         meth_obj = Pry::Method.from_binding(b) if meth
 
-        type = b.frame_type ? "[#{b.frame_type}]" : ""
+        type = b.frame_type ? "[#{b.frame_type}]".ljust(9) : ""
         desc = b.frame_description ? "#{b.frame_description}" : "#{PryStackExplorer.frame_manager(_pry_).frame_info_for(b)}"
-        sig = meth ? "#{se_signature_with_owner(meth_obj)}" : ""
+        sig = meth_obj ? "<#{se_signature_with_owner(meth_obj)}>" : ""
 
-        slf_class = "#{Pry.view_clip(b_self)}"
+        self_clipped = "#{Pry.view_clip(b_self)}"
         path = "@ #{b.eval('__FILE__')}:#{b.eval('__LINE__')}"
 
         if !verbose
-          "#{desc} #{sig} #{type}"
+          "#{type} #{desc} #{sig}"
         else
-          "#{desc} #{sig} #{type}\n      in #{slf_class} #{path}"
+          "#{type} #{desc} #{sig}\n      in #{self_clipped} #{path}"
         end
       end
 

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = "0.2.8pre6"
+  VERSION = "0.2.8pre7"
 end

data/pry-stack_explorer.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pry-stack_explorer}
-  s.version = "0.2.8pre5"
+  s.version = "0.2.8pre6"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Mair (banisterfiend)"]
+  s.authors = [%q{John Mair (banisterfiend)}]
   s.date = %q{2011-12-21}
   s.description = %q{Walk the stack in a Pry session}
   s.email = %q{jrmair@gmail.com}
-  s.files = [".gemtest", ".gitignore", ".travis.yml", ".yardopts", "CHANGELOG", "Gemfile", "LICENSE", "README.md", "Rakefile", "examples/example.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", "pry-stack_explorer.gemspec", "test/helper.rb", "test/test_frame_manager.rb", "test/test_stack_explorer.rb", "tester.rb"]
+  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{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{pry-stack_explorer.gemspec}, %q{test/helper.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 = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Walk the stack in a Pry session}
-  s.test_files = ["test/helper.rb", "test/test_frame_manager.rb", "test/test_stack_explorer.rb"]
+  s.test_files = [%q{test/helper.rb}, %q{test/test_frame_manager.rb}, %q{test/test_stack_explorer.rb}]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version
-  version: 0.2.8pre6
+  version: 0.2.8pre7
   prerelease: 5
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-21 00:00:00.000000000 Z
+date: 2011-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
-  requirement: &70304748409420 !ruby/object:Gem::Requirement
+  requirement: &70297085157800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70304748409420
+  version_requirements: *70297085157800
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70304748402320 !ruby/object:Gem::Requirement
+  requirement: &70297085156300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.8pre2
   type: :runtime
   prerelease: false
-  version_requirements: *70304748402320
+  version_requirements: *70297085156300
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &70304748401240 !ruby/object:Gem::Requirement
+  requirement: &70297088892900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70304748401240
+  version_requirements: *70297088892900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70304748399760 !ruby/object:Gem::Requirement
+  requirement: &70297088891420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70304748399760
+  version_requirements: *70297088891420
 description: Walk the stack in a Pry session
 email: jrmair@gmail.com
 executables: []
@@ -71,6 +71,7 @@ files:
 - 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
@@ -91,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: