pry 0.6.0 → 0.6.1

data/CHANGELOG

@@ -1,17 +1,25 @@
-22/2/2010 version 0.5.8
+26/2/2011 version 0.6.1
+* !@ command alias for exit_all
+* `cd /` for breaking out to pry top level (jump-to 0)
+* made `-e` option work in a more effective way for `pry` command line invocation
+* exit and exit-all commands now accept a parameter, this parameter becomes the return value of repl()
+* `command` method from CommandBase now accepts a :keep_retval arg that determines if command value is returned to pry session or just `nil` (`nil` was old behaviour)
+* tests for new :keep_retval and exit-all/exit behaviour; :keep_retval will remain undocumented.
+
+22/2/2011 version 0.5.8
 * Added -c (context) option to show-doc, show-methods and eval-file
 * Fixed up ordering issue of -c and -r parameters to command line pry
 	
-21/2/2010 version 0.5.7
+21/2/2011 version 0.5.7
 * Added pry executable, auto-loads .pryrc in user's home directory, if it
 	exists.
 	
-19/2/2010 version 0.5.5
+19/2/2011 version 0.5.5
 * Added Pry.run_command
 * More useful error messages
 * Easter eggs (game and cohen-poem)
 
-17/2/2010 version 0.5.0
+17/2/2011 version 0.5.0
 * Use clipped version of Pry.view() for large objects
 * Exit Pry session on ^d
 * Use Shellwords for breaking up parameters to pry commands
@@ -27,16 +35,16 @@
 * Get rid of show_idoc and show_imethod
 * Add special eval-file command that evals target file in current context
 	
-27/1/2010 version 0.4.5
+27/1/2011 version 0.4.5
 * fixed show_method (though fragile as it references __binding_impl__
 	directly, making a name change to that method difficult
-27/1/2010 version 0.4.4
+27/1/2011 version 0.4.4
 * oops, added examples/ directory
-26/1/2010 version 0.4.3
+26/1/2011 version 0.4.3
 * added alias_command and desc methods to Pry::CommandBase
 * changed behaviour of ls_methods and ls_imethods to return sorted lists
 	of methods
-23/1/2010 version 0.4.1
+23/1/2011 version 0.4.1
 * made it so a 'def meth;end' in an object Pry session defines singleton
 	methods, not methods on the class (except in the case of
 	immediates)
@@ -44,7 +52,7 @@
 * storing wiki in a nested git repo, as github wiki pages have their own
 	repo
 * added more tests for new method definition behaviour
-x21/1/2010 version 0.4.0
+21/1/2011 version 0.4.0
 * added command API
 * added many new commands, i.e ls_methods and friends
 * modified other commands

data/README.markdown

@@ -13,7 +13,8 @@ session to your code (with Pry) instead of bringing your code to a
 REPL session (as with IRB).
 
 It is not based on the IRB codebase, and implements some unique REPL
-commands such as `show-method`, `show-doc`, `ls` and `cd`
+commands such as `show-method`, `show-doc`, `ls` and `cd` (type `help`
+to get a full list).
 
 Pry is also fairly flexible and allows significant user
 [customization](http://rdoc.info/github/banister/pry/master/file/wiki/Customizing-pry.md). It

data/bin/pry

@@ -61,10 +61,9 @@ load rcpath if File.exists?(rcpath) && options[:loadrc]
 # create the actual context
 context = Pry.binding_for(eval(options[:context_string]))
 
-# execute line of code, if provided with -e option
+# run code passed with `-e`, if there is any.
 if options[:code]
-  result = context.eval(options[:code])
-  puts "=> #{Pry.view(result)}"
+  Pry.new(:input => StringIO.new(options[:code]), :print => proc {}).rep(context)
 end
 
 # start the session

data/lib/pry/command_base.rb

@@ -33,11 +33,19 @@ class Pry
       #   # Good afternoon John!
       #   # pry(main)> help greet
       #   # Greet somebody
-      def command(names, description="No description.", &block)
+      def command(names, description="No description.", options={}, &block)
+        options = {
+          :keep_retval => false
+        }.merge!(options)
+        
         @commands ||= {}
 
         Array(names).each do |name|
-          commands[name] = { :description => description, :action => block }
+          commands[name] = {
+            :description => description,
+            :action => block,
+            :keep_retval => options[:keep_retval]
+          }
         end
       end
 

data/lib/pry/commands.rb

@@ -1,6 +1,9 @@
 direc = File.dirname(__FILE__)
-require "#{direc}/command_base"
+
 require "optparse"
+require "method_source"
+require "#{direc}/command_base"
+require "#{direc}/pry_instance"
 
 class Pry
 
@@ -72,10 +75,13 @@ class Pry
       output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
     end
     
-    command "exit-all", "End all nested Pry sessions." do
-      throw(:breakout, 0) 
+    command "exit-all", "End all nested Pry sessions. Accepts optional return value. Aliases: !@" do 
+      str = opts[:val].split.drop(1).join(' ')
+      throw(:breakout, [0, target.eval(str)])
     end
 
+    alias_command "!@", "exit-all", ""
+
     command "ls", "Show the list of vars in the current scope. Type `ls --help` for more info." do |*args|
       options = {}
       
@@ -210,7 +216,7 @@ Shows local and instance variables by default.
       if options[:v]
 
         # verbose
-        info.each.sort_by { |k, v| v.last }.each do |k, v|
+        info.sort_by { |k, v| v.last }.each do |k, v|
           if !v.first.empty?
             output.puts "#{k}:\n--"
             output.puts Pry.view(v.first)
@@ -218,7 +224,7 @@ Shows local and instance variables by default.
           end
         end
 
-        # plain
+      # plain
       else
         list = info.values.sort_by { |v| v.last }.map { |v| v.first }.inject(&:+)
         output.puts Pry.view(list)
@@ -232,7 +238,9 @@ Shows local and instance variables by default.
         next
       end
 
-      output.puts File.read(file_name)
+      contents = File.read(file_name)
+      output.puts contents
+      contents
     end
 
     command "eval-file", "Eval a Ruby script. Type `eval-file --help` for more info." do |*args|
@@ -290,13 +298,20 @@ e.g: eval-file -c self "hello.rb"
 
     alias_command "inspect", "cat", ""
     
-    command "cd", "Start a Pry session on VAR (use `cd ..` to go back)" do |obj|
+    command "cd", "Start a Pry session on VAR (use `cd ..` to go back and `cd /` to return to Pry top-level)",
+    :keep_retval => true do |obj|
       if !obj
         output.puts "Must provide an object."
         next
       end
       
       throw(:breakout, opts[:nesting].level) if obj == ".."
+
+      if obj == "/" 
+        throw(:breakout, 1) if opts[:nesting].level > 0
+        next
+      end
+
       target.eval("#{obj}.pry")
     end
 
@@ -452,8 +467,9 @@ e.g: show-method hello_method
       end
     end
 
-    command "exit", "End the current Pry session. Aliases: quit, back" do
-      throw(:breakout, opts[:nesting].level)
+    command "exit", "End the current Pry session. Accepts optional return value. Aliases: quit, back" do 
+      str = opts[:val].split.drop(1).join(' ')
+      throw(:breakout, [opts[:nesting].level, target.eval(str)])
     end
 
     alias_command "quit", "exit", ""
@@ -515,7 +531,7 @@ on these enormous landscapes,
 that if you turn your head
 they are lost for hours.
 -- Leonard Cohen                    
-              }
+                }
   output.puts text
   text
 end

data/lib/pry/pry_class.rb

@@ -1,5 +1,13 @@
+direc = File.dirname(__FILE__)
+
 require 'readline'
 require 'shellwords'
+require "#{direc}/prompts"
+require "#{direc}/hooks"
+require "#{direc}/print"
+require "#{direc}/commands"
+require "#{direc}/core_extensions"
+require "#{direc}/pry_instance"
 
 # @author John Mair (banisterfiend)
 class Pry
@@ -57,6 +65,8 @@ class Pry
     # @return [Array<Proc>] The array of Procs to be used for the
     #   prompts by default by all Pry instances.
     attr_accessor :prompt
+
+    attr_accessor :cmd_ret_value
   end
   
   # Start a Pry REPL.

data/lib/pry/pry_instance.rb

@@ -86,7 +86,7 @@ class Pry
     target.eval("_pry_ = Pry.active_instance")
     target.eval("_ = Pry.last_result")
 
-    break_level = catch(:breakout) do
+    break_data = catch(:breakout) do
       nesting.push [nesting.size, target_self, self]
       loop do
         rep(target)
@@ -97,11 +97,18 @@ class Pry
 
     exec_hook :after_session, output, target_self
 
+    # If break_data is an array, then the last element is the return value
+    break_level, return_value = Array(break_data)
+    
     # keep throwing until we reach the desired nesting level
     if nesting_level != break_level
-      throw :breakout, break_level
+      throw :breakout, break_data
     end
 
+    # if one was provided, return the return value
+    return return_value if return_value
+    
+    # otherwise return the target_self
     target_self
   end
 
@@ -170,8 +177,13 @@ class Pry
       
       val.chomp!
 
-      process_commands(val, eval_string, target)
-      eval_string << "#{val}\n"
+      Pry.cmd_ret_value = process_commands(val, eval_string, target)
+
+      if Pry.cmd_ret_value
+        eval_string << "Pry.cmd_ret_value\n"
+      else
+        eval_string << "#{val}\n"
+      end
 
       break eval_string if valid_expression?(eval_string)
     end
@@ -190,43 +202,49 @@ class Pry
     def val.clear() replace("") end
     def eval_string.clear() replace("") end
 
-    pattern, data = commands.commands.find do |name, data|
+    pattern, cmd_data = commands.commands.find do |name, cmd_data|
       /^#{name}(?!\S)(?:\s+(.+))?/ =~ val
     end
 
-    if pattern
-      args_string = $1
-      args = args_string ? Shellwords.shellwords(args_string) : []
-      action = data[:action]
-      
-      options = {
-        :val => val,
-        :eval_string => eval_string,
-        :nesting => nesting,
-        :commands => commands.commands
-      }
-
-      # set some useful methods to be used by the action blocks
-      commands.opts = options
-      commands.target = target
-      commands.output = output
-
-      case action.arity <=> 0
-      when -1
-
-        # Use instance_exec() to make the `opts` method, etc available
-        commands.instance_exec(*args, &action)
-      when 1, 0
-
-        # ensure that we get the right number of parameters
-        # since 1.8.7 complains about incorrect arity (1.9.2
-        # doesn't care)
-        args_with_corrected_arity = args.values_at *0..(action.arity - 1)
-        commands.instance_exec(*args_with_corrected_arity, &action)
-      end
-      
-      val.clear
+    # no command was matched, so return to caller
+    return if !pattern
+    
+    args_string = $1
+    args = args_string ? Shellwords.shellwords(args_string) : []
+    action = cmd_data[:action]
+    keep_retval = cmd_data[:keep_retval]
+    
+    options = {
+      :val => val,
+      :eval_string => eval_string,
+      :nesting => nesting,
+      :commands => commands.commands
+    }
+
+    # set some useful methods to be used by the action blocks
+    commands.opts = options
+    commands.target = target
+    commands.output = output
+
+    case action.arity <=> 0
+    when -1
+
+      # Use instance_exec() to make the `opts` method, etc available
+      ret_value = commands.instance_exec(*args, &action)
+    when 1, 0
+
+      # ensure that we get the right number of parameters
+      # since 1.8.7 complains about incorrect arity (1.9.2
+      # doesn't care)
+      args_with_corrected_arity = args.values_at *0..(action.arity - 1)
+      ret_value = commands.instance_exec(*args_with_corrected_arity, &action)
     end
+    
+    # a command was processed so we can now clear the input string
+    val.clear
+
+    # return value of block only if :keep_retval is true
+    ret_value if keep_retval
   end
 
   # Returns the next line of input to be used by the pry instance.

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/test/test.rb

@@ -335,6 +335,33 @@ describe Pry do
         end
 
         describe "commands" do
+          it 'should define a command that keeps its return value' do
+            class Command68 < Pry::CommandBase
+              command "hello", "", :keep_retval => true do
+                :kept_hello
+              end
+            end
+            str_output = StringIO.new
+            Pry.new(:input => StringIO.new("hello"), :output => str_output, :commands => Command68).rep
+            str_output.string.should =~ /:kept_hello/
+
+            Object.remove_const(:Command68)
+          end
+
+          it 'should define a command that does NOT keep its return value' do
+            class Command68 < Pry::CommandBase
+              command "hello", "", :keep_retval => false do
+                :kept_hello
+              end
+            end
+            str_output = StringIO.new
+            Pry.new(:input => StringIO.new("hello"), :output => str_output, :commands => Command68).rep
+            (str_output.string =~ /:kept_hello/).should == nil
+
+            Object.remove_const(:Command68)
+          end
+          
+          
           it 'should set the commands default, and the default should be overridable' do
             class Command0 < Pry::CommandBase
               command "hello" do
@@ -537,6 +564,28 @@ describe Pry do
           Pry.new(:input => InputTester.new("\"test\""), :output => str_output).rep
           str_output.string.should == "test\n"
         end
+
+        describe "pry return values" do
+          it 'should return the target object' do
+            Pry.start(self, :input => StringIO.new("exit"), :output => Pry::NullOutput).should == self
+          end
+
+          it 'should return the parameter given to exit' do
+            Pry.start(self, :input => StringIO.new("exit 10"), :output => Pry::NullOutput).should == 10
+          end
+
+          it 'should return the parameter (multi word string) given to exit' do
+            Pry.start(self, :input => StringIO.new("exit \"john mair\""), :output => Pry::NullOutput).should == "john mair"
+          end
+
+          it 'should return the parameter (function call) given to exit' do
+            Pry.start(self, :input => StringIO.new("exit 'abc'.reverse"), :output => Pry::NullOutput).should == 'cba'
+          end
+
+          it 'should return the parameter (self) given to exit' do
+            Pry.start("carl", :input => StringIO.new("exit self"), :output => Pry::NullOutput).should == "carl"
+          end
+        end
         
         describe "prompts" do
           it 'should set the prompt default, and the default should be overridable (single prompt)' do

metadata

@@ -1,80 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pry
-version: !ruby/object:Gem::Version 
-  hash: 7
+version: !ruby/object:Gem::Version
+  version: 0.6.1
   prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 0
-  version: 0.6.0
 platform: ruby
-authors: 
+authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-22 00:00:00 +13:00
+date: 2011-02-26 00:00:00.000000000 +13:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ruby_parser
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &17331060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 0
-        - 5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.5
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: method_source
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *17331060
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: &17330712 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 2
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bacon
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *17330712
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &17330376 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *17330376
 description: attach an irb-like session to any object at runtime
 email: jrmair@gmail.com
-executables: 
+executables:
 - pry
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/pry/commands.rb
 - lib/pry/command_base.rb
 - lib/pry/completion.rb
@@ -107,36 +84,26 @@ files:
 has_rdoc: true
 homepage: http://banisterfiend.wordpress.com
 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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: attach an irb-like session to any object at runtime
 test_files: []
-