pry 0.2.5pre2 → 0.2.6

data/README.markdown

@@ -8,13 +8,14 @@ _attach an irb-like session to any object at runtime_
 Pry is a simple Ruby REPL (Read-Eval-Print-Loop) that specializes in the interactive
 manipulation of objects during the running of a program.
 
-It is not based on the IRB codebase and is small, at around 260 LOC.
+It is not based on the IRB codebase, and implements some unique REPL
+commands such as `show_method` and `jump_to`
 
 * Install the [gem](https://rubygems.org/gems/pry): `gem install pry`
 * Read the [documentation](http://rdoc.info/github/banister/pry/master/file/README.markdown)
 * See the [source code](http://github.com/banister/pry)
 
-example: Interacting with an object at runtime 
+Example: Interacting with an object at runtime 
 ---------------------------------------
 
 With the `Pry.start()` method we can pry (open an irb-like session) on
@@ -62,7 +63,7 @@ OR
     beginning Pry session for 6
     pry(6)>
     
-example: Pry sessions can nest arbitrarily deep so we can pry on objects inside objects:
+Example: Pry sessions can nest arbitrarily deep so we can pry on objects inside objects:
 ----------------------------------------------------------------------------------------
 
 Here we will begin Pry at top-level, then pry on a class and then on
@@ -137,7 +138,7 @@ uses (such as implementing a quake-like console for games, for example). Here is
 list of Pry's features along with some of its limitations given at the
 end.
 
-Features:
+####Features:
 
 * Pry can be invoked at any time and on any object in the running program.
 * Pry sessions can nest arbitrarily deeply -- to go back one level of nesting type 'exit' or 'quit' or 'back'
@@ -145,45 +146,40 @@ Features:
 * Pry has multi-line support built in.
 * Pry gives good control over nested sessions (important when exploring complicated runtime state)
 * Pry is not based on the IRB codebase.
-* Pry is small; around 260 LOC.
-* Pry implements all the methods in the REPL chain separately: `Pry.r`
-for reading; `Pry.re` for eval; `Pry.rep` for printing; and `Pry.repl`
-for the loop (`Pry.start` is simply an alias for `Pry.repl`). You can
+* Pry uses [RubyParser](https://github.com/seattlerb/ruby_parser) to
+validate expressions in 1.8, and [Ripper](http://rdoc.info/docs/ruby-core/1.9.2/Ripper) for 1.9.
+* Pry implements all the methods in the REPL chain separately: `Pry#r`
+for reading; `Pry#re` for eval; `Pry#rep` for printing; and `Pry#repl`
+for the loop (`Pry.start` simply wraps `Pry.new.repl`). You can
 invoke any of these methods directly depending on exactly what aspect of the functionality you need.
 
-Limitations:
+####Limitations:
 
 * Pry does not pretend to be a replacement for `irb`,
   and so does not have an executable. It is designed to be used by
   other programs, not on its own. For a full-featured `irb` replacement
   see [ripl](https://github.com/cldwalker/ripl)
-* Although Pry works fine in Ruby 1.9, only Ruby 1.8 syntax is
-  supported. This is because Pry uses the
-  [RubyParser](https://github.com/seattlerb/ruby_parser)
-  gem internally to  validate expressions, and RubyParser, as yet, only parses Ruby 1.8
-  code. In practice this usually just means you cannot use the new
-  hash literal syntax (this: syntax) or the 'stabby lambda' syntax
-  (->).
+* Pry's `show_method` and `show_instance_method` commands do not work
+  in Ruby 1.8.
  
 Commands
 -----------
 
 ### The Pry API:
 
-* `Pry.start()` and `Pry.into()` and `Pry.repl()` are all aliases of
-oneanother. They all start a Read-Eval-Print-Loop on the object they
-receive as a parameter. In the case of no parameter they operate on
-top-level (main). They can receive any object or a `Binding`
-object as parameter.
+* `Pry.start()` Starts a Read-Eval-Print-Loop on the object it
+receives as a parameter. In the case of no parameter it operates on
+top-level (main). It can receive any object or a `Binding`
+object as parameter. `Pry.start()` is implemented as `Pry.new.repl()`
 * `obj.pry` and `pry(obj)` may also be used as alternative syntax to `Pry.start(obj)`
-* If, for some reason you do not want to 'loop' then use `Pry.rep()`; it
+* If, for some reason you do not want to 'loop' then use `Pry.new.rep()`; it
 only performs the Read-Eval-Print section of the REPL - it ends the
 session after just one line of input. It takes the same parameters as
-`Pry.repl()`
-* Likewise `Pry.re()` only performs the Read-Eval section of the REPL,
+`Pry#repl()` 
+* Likewise `Pry#re()` only performs the Read-Eval section of the REPL,
 it returns the result of the evaluation or an Exception object in
-case of error. It also takes the same parameters as `Pry.repl()`
-* Similarly `Pry.r()` only performs the Read section of the REPL, only
+case of error. It also takes the same parameters as `Pry#repl()`
+* Similarly `Pry#r()` only performs the Read section of the REPL, only
 returning the Ruby expression (as a string). It takes the same parameters as all the others.
 
 ### Session commands
@@ -202,6 +198,13 @@ If you want to access a method of the same name, prefix the invocation by whites
 * `exit` or `quit` or `back` will end the current Pry session and go
   back to the calling process or back one level of nesting (if there
   are nested sessions).
+* `ls` returns a list of local variables and instance variables in the
+  current scope
+* `cd <var>` starts a `Pry` session on the variable <var>. E.g `cd @x`
+* `show_method <methname>` Displays the sourcecode for the method
+  <methname>. E.g `show_method hello`
+* `show_instance_method <methname>` Displays the sourcecode for the
+  instance method <methname>. E.g `show_instance_method goodbye`
 * `exit_program` or `quit_program` will end the currently running
   program.
 * `nesting` shows Pry nesting information.

data/Rakefile

@@ -7,7 +7,7 @@ require "#{direc}/lib/pry/version"
 
 CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
 CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
-              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj",
+              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
               "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
 
 def apply_spec_defaults(s)
@@ -20,6 +20,7 @@ def apply_spec_defaults(s)
   s.description = s.summary
   s.require_path = 'lib'
   s.add_dependency("ruby_parser",">=2.0.5")
+  s.add_dependency("method_source",">=0.1.4")
   s.homepage = "http://banisterfiend.wordpress.com"
   s.has_rdoc = 'yard'
   s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",

data/lib/pry.rb

@@ -4,6 +4,8 @@
 direc = File.dirname(__FILE__)
 
 require 'ruby_parser'
+require 'method_source'
+require 'stringio'
 require "#{direc}/pry/version"
 require "#{direc}/pry/input"
 require "#{direc}/pry/output"
@@ -15,7 +17,7 @@ class Pry
 
   def self.view(obj)
     case obj
-    when String, Symbol, nil
+    when String, Array, Hash, Symbol, nil
       obj.inspect
     else
       obj.to_s
@@ -65,7 +67,6 @@ class Pry
   def nesting=(v)
     self.class.nesting = v
   end
-
   
   # loop
   def repl(target=TOPLEVEL_BINDING)
@@ -107,6 +108,8 @@ class Pry
     target = binding_for(target)
     Pry.last_result = target.eval r(target)
     target.eval("_ = Pry.last_result")
+  rescue SystemExit => e
+    exit
   rescue Exception => e
     e
   end
@@ -145,22 +148,27 @@ class Pry
       eval_string.clear
     when "exit_all"
       throw(:breakout, 0)
-    when "exit", "quit", "back"
+    when "exit", "quit", "back", /^cd\s*\.\./
       output.exit
       throw(:breakout, nesting.level)
-    when /show_method\s*(\w*)/
+    when "ls"
+      output.ls(target)
+      eval_string.clear
+    when /^cd\s+(.+)/
+      obj = $~.captures.first
+      target.eval("#{obj}.pry")
+      eval_string.clear
+    when /^show_method\s*(.+)/
       meth_name = ($~.captures).first
-      file, line = target.eval("method(:#{meth_name}).source_location")
-      tp = Pry.new.tap { |v| v.input = SourceInput.new(file, line) }
-      tp.r.display
+      code = get_method_source(target, meth_name, :method)
+      output.show_method code
       eval_string.clear
-    when /show_instance_method\s*(\w*)/
+    when /^show_instance_method\s*(.+)/
       meth_name = ($~.captures).first
-      file, line = target.eval("instance_method(:#{meth_name}).source_location")
-      tp = Pry.new.tap { |v| v.input = SourceInput.new(file, line) }
-      tp.r.display
+      code = get_method_source(target, meth_name, :instance_method)
+      output.show_method code
       eval_string.clear
-    when /jump_to\s*(\d*)/
+    when /^jump_to\s*(\d*)/
       break_level = ($~.captures).first.to_i
       output.jump_to(break_level)
 
@@ -178,6 +186,10 @@ class Pry
     end
   end
 
+  def get_method_source(target, meth_name, kind)
+    target.eval("#{kind}(:#{meth_name}).source")
+  end
+
   def prompt(eval_string, target, nest)
     target_self = target.eval('self')
     
@@ -188,29 +200,23 @@ class Pry
     end
   end
 
-  def valid_expression?(code)
-    test_bed = Object.new.instance_eval { binding }
-
-    begin
-      test_bed.eval(code)
-    rescue Exception => e
-      case e
-      when SyntaxError 
-        case e.message
-        when /(parse|syntax) error.*?\$end/i, /unterminated/i 
-          return false
-        end
-      end
+  if RUBY_VERSION =~ /1.9/
+    require 'ripper'
+    
+    def valid_expression?(code)
+      !!Ripper::SexpBuilder.new(code).parse
     end
-    true
-  end
-
-  def old_valid_expression?(code)
-    RubyParser.new.parse(code)
-  rescue Racc::ParseError, SyntaxError
-    false
+    
   else
-    true
+    
+    def valid_expression?(code)
+      RubyParser.new.parse(code)
+    rescue Racc::ParseError, SyntaxError
+      false
+    else
+      true
+    end
+    
   end
 
   def binding_for(target)

data/lib/pry/input.rb

@@ -2,6 +2,8 @@ require 'readline'
 
 class Pry
   class Input
+    trap('INT') { exit }
+    
     def read(prompt)
       Readline.readline(prompt, true)
     end

data/lib/pry/output.rb

@@ -29,6 +29,10 @@ class Pry
       puts "status                           Show status information"
       puts "!                                Refresh the REPL"
       puts "nesting                          Show nesting information"
+      puts "ls                               Show the list of variables in the current scope"
+      puts "cd <var>                         Start a Pry session on <var> (use `cd ..` to go back)"
+      puts "show_method <methname>           Show the sourcecode for the method <method_name>"
+      puts "show_instance_method <methname>  Show the sourcecode for the instance method <method_name>"
       puts "exit/quit/back                   End the current Pry session"
       puts "exit_all                         End all nested Pry sessions"
       puts "exit_program/quit_program        End the current program"
@@ -52,10 +56,18 @@ class Pry
       puts "--"
       puts "Receiver: #{Pry.view(target.eval('self'))}"
       puts "Nesting level: #{nesting.level}"
-      puts "Local variables: #{Pry.view(target.eval("local_variables"))}"
+      puts "Local variables: #{target.eval('Pry.view(local_variables)')}"
       puts "Last result: #{Pry.view(Pry.last_result)}"
     end
 
+    def ls(target)
+      puts "#{target.eval('Pry.view(local_variables + instance_variables)')}"
+    end
+    
+    def show_method(code)
+      code.display
+    end
+
     def warn_already_at_level(nesting_level)
       puts "Already at nesting level #{nesting_level}"
     end

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.2.5pre2"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pry
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 2
-  - 5pre2
-  version: 0.2.5pre2
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-15 00:00:00 +13:00
+date: 2010-12-17 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,21 @@ dependencies:
         version: 2.0.5
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: method_source
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id002
 description: attach an irb-like session to any object at runtime
 email: jrmair@gmail.com
 executables: []
@@ -68,13 +83,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: