pry 0.9.4pre1-i386-mswin32 → 0.9.4pre2-i386-mswin32

data/CHANGELOG

@@ -8,6 +8,29 @@
 * show-doc and stat now display method visibility (update WIKI)
 * got rid of warnings caused by stricter ruby 1.9.3 rules
 * remove interpolation of command names and fix interpolation error messag (update WIKI) (thanks ryanf!)
+* 'nested sessions' now use binding stacks (so each instance manages its own collection of bindings without spawning other instances)
+* changed `exit` command so that it now called Kernel#exit (after saving history)
+* 'quit' now behaves like 'exit-all' (and aliased to exit-all) - it breaks out of the repl loop and sets empties the binding_stack
+* 'cd ..' just pops a binding off the binding_stack with special behaviour when only one binding in stack - it breaks out of the repl loop
+* added switch-to command (like jump-to but doesnt unwind the stack)
+* show-method and show-doc now accept multiple method names
+* control_d hook added (Pry.config.control_d_handler)
+* behaviour of ^d is now to break out of current expr if in multi-line expr, or break out of current context if nested, or break out of pry repl loop if at top-level
+* can no longer interpolate command name itself e.g #{x}-#{y} where x = "show" and y = "doc"
+* ^C no longer captured
+* got rid of Pry.active_instance, Pry.last_exception and friends.
+* also special locals now shared among bindings in a pry instance (i.e _ex_ (and friends) re-injected into new binding entered with 'cd')
+* renamed inp and out to _in_ and _out_ (to avoid collisions with actual locals in debugging scope)
+* added third parameter to prompts, the pry instance itself (_pry) see https://github.com/pry/pry/issues/233 for why it's important
+* cd behaviour when no args performs the same as `cd /`
+* commands with keep_retval can now return nil (to suppress output now return 'void' instead)
+* Pry::CommandProcessor::Result introduced
+* Pry.view_clip() modified to be more robust and properly display Class#name
+* edit command when invoked with no args now works like edit -t
+* when edit is invoked (with no args or with -t) inside a multi-line expression input buffer, it dumps that buffer into a temp file and takes you to it
+* got rid of Pry#null_input? since all that was needed was eval_string.empty?
+* cd command now supports complex syntax: cd ../@y/y/../z
+* JRuby is no longer a 2nd class citizen, almost full JRuby support, passing 100% tests
 
 */7/2011 version 0.9.3
 * cat --ex (cats 5 lines above and below line in file where exception was raised)

data/CONTRIBUTORS

@@ -1,11 +1,13 @@
-   547	John Mair <jrmair@gmail.com>
-    76	Rob Gleeson <rob@flowof.info>
-    46	Lee Jarvis <lee@jarvis.co>
-    46	Mon ouïe <mon.ouie@gmail.com>
-    18	David Palm <dpalm@elctech.com>
-    13	epitron <chris@ill-logic.com>
-     8	Conrad Irwin <conrad.irwin@gmail.com>
-     6	Ryan Fitzgerald <rwfitzge@gmail.com>
-     2	Eric Christopherson <echristopherson@gmail.com>
-     2	Xavier Shay <xavier@rhnh.net>
-     1	Josh Cheek <josh.cheek@gmail.com>
+   564	John Mair
+    76	Rob Gleeson
+    50	Lee Jarvis
+    46	Mon ouïe
+    18	David Palm
+    13	epitron
+     8	Conrad Irwin
+     6	Ryan Fitzgerald
+     2	Darrick Wiebe
+     2	Xavier Shay
+     2	Eric Christopherson
+     1	Josh Cheek
+     1	Tim Pope

data/README.markdown

@@ -6,6 +6,8 @@ _Get to the code_
 
 **Note that JRuby is not yet supported in this release, but will be
   soon.**
+  
+ **Please** [DONATE](http://www.pledgie.com/campaigns/15899) to the Pry project - Pry was a **huge** amount of work and every donation received is encouraging and supports Pry's continued development!
 
 [Skip to the website (recommended)](http://pry.github.com) <br />
 [Skip to the wiki](https://github.com/pry/pry/wiki)

data/Rakefile

@@ -22,8 +22,8 @@ def apply_spec_defaults(s)
   s.test_files = `git ls-files -- test/*`.split("\n")
   s.add_dependency("ruby_parser",">=2.0.5")
   s.add_dependency("coderay",">=0.9.8")
-  s.add_dependency("slop","~>1.9.0")
-  s.add_dependency("method_source",">=0.6.0")
+  s.add_dependency("slop","~>2.1.0")
+  s.add_dependency("method_source",">=0.6.5")
   s.add_development_dependency("bacon",">=1.1.0")
   s.add_development_dependency("open4", "~>1.0.1")
 end
@@ -62,6 +62,20 @@ namespace :ruby do
   end
 end
 
+namespace :jruby do
+  spec = Gem::Specification.new do |s|
+    apply_spec_defaults(s)
+    s.add_dependency("spoon", ">=0.0.1")
+    s.platform = "java"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+
 [:mingw32, :mswin32].each do |v|
   namespace v do
     spec = Gem::Specification.new do |s|

data/TODO

@@ -12,6 +12,14 @@
 * fix history saving (should not save all of Readline::HISTORY, but only what changed)
 * prevent blank lines going to Readline::HISTORY
 * ensure that cat --ex emulates the `whereami` format - includes line numbers and formatted the same, etc
+* rename inp and out to _inp_ and _out_ otherwise than can overwrite locals by those names when debugging (not good)
+* add source file to stat command
+* make plugins use hash instead of array
+* ensure edit -t has 'edit' alias (no parameters) and dumps eval_string into buffer
+* whitelist exceptions
+* hooks system
+* jruby shell command support
+*
 
 0.9.3
 * hist command now excludes last line of input (the command invocation itself)

data/lib/pry.rb

@@ -19,11 +19,20 @@ class Pry
 
   # The default prints
   DEFAULT_PRINT = proc do |output, value|
-    begin
-      Helpers::BaseHelpers.stagger_output("=> #{Helpers::BaseHelpers.colorize_code(value.pretty_inspect)}", output)
-    rescue NoMethodError
-      output.puts "=> unknown"
+    stringified = begin
+                    value.pretty_inspect
+                  rescue RescuableException => ex
+                    nil
+                  end
+
+    unless String === stringified
+      # Read the class name off of the singleton class to provide a default inspect.
+      klass = (class << value; self; end).ancestors.first
+      stringified = "#<#{klass}:0x#{value.__id__.to_s(16)}>"
+      Helpers::BaseHelpers.stagger_output("output error: #{ex.inspect}", output) if ex
     end
+
+    Helpers::BaseHelpers.stagger_output("=> #{Helpers::BaseHelpers.colorize_code(stringified)}", output)
   end
 
   # Will only show the first line of the backtrace
@@ -34,7 +43,7 @@ class Pry
 
   # The default prompt; includes the target and nesting level
   DEFAULT_PROMPT = [
-    proc { |target_self, nest_level|
+    proc { |target_self, nest_level, _|
       if nest_level == 0
         "pry(#{Pry.view_clip(target_self)})> "
       else
@@ -42,23 +51,62 @@ class Pry
       end
     },
 
-    proc { |target_self, nest_level|
+    proc { |target_self, nest_level, _|
       if nest_level == 0
         "pry(#{Pry.view_clip(target_self)})* "
       else
         "pry(#{Pry.view_clip(target_self)}):#{Pry.view_clip(nest_level)}* "
       end
     }
-  ]
+                   ]
+  # Deal with the ^D key being pressed, different behaviour in
+  # different cases:
+  # 1) In an expression     - behave like `!` command   (clear input buffer)
+  # 2) At top-level session - behave like `exit command (break out of repl loop)
+  # 3) In a nested session  - behave like `cd ..`       (pop a binding)
+  DEFAULT_CONTROL_D_HANDLER = proc do |eval_string, _pry_|
+    if !eval_string.empty?
+      # clear input buffer
+      eval_string.replace("")
+    elsif _pry_.binding_stack.one?
+      # ^D at top-level breaks out of loop
+      _pry_.binding_stack.clear
+      throw(:breakout)
+    else
+      # otherwise just pops a binding
+      _pry_.binding_stack.pop
+    end
+  end
 
   # A simple prompt - doesn't display target or nesting level
   SIMPLE_PROMPT = [proc { ">> " }, proc { " | " }]
 
   SHELL_PROMPT = [
-    proc { |target_self, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} $ " },
-    proc { |target_self, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} * " }
+    proc { |target_self, _, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} $ " },
+    proc { |target_self, _, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} * " }
   ]
 
+  # As a REPL, we often want to catch any unexpected exceptions that may have
+  # been raised; however we don't want to go overboard and prevent the user
+  # from exiting Pry when they want to.
+  module RescuableException
+    def self.===(exception)
+      case exception
+      # Catch when the user hits ^C (Interrupt < SignalException), and assume
+      # that they just wanted to stop the in-progress command (just like bash etc.)
+      when Interrupt
+        true
+      # Don't catch signals (particularly not SIGTERM) as these are unlikely to be
+      # intended for pry itself. We should also make sure that Kernel#exit works.
+      when SystemExit, SignalException
+        false
+      # All other exceptions will be caught.
+      else
+        true
+      end
+    end
+  end
+
 end
 
 require "method_source"
@@ -82,6 +130,7 @@ end
 require "pry/version"
 require "pry/history_array"
 require "pry/helpers"
+require "pry/history"
 require "pry/command_set"
 require "pry/commands"
 require "pry/command_context"

data/lib/pry/command_context.rb

@@ -2,6 +2,13 @@ class Pry
   # Command contexts are the objects runing each command.
   # Helper modules can be mixed into this class.
   class CommandContext
+
+    # represents a void return value for a command
+    VOID_VALUE = Object.new
+
+    # give it a nice inspect
+    def VOID_VALUE.inspect() "void" end
+
     attr_accessor :output
     attr_accessor :target
     attr_accessor :captures
@@ -34,6 +41,10 @@ class Pry
       Pry::Helpers::Text
     end
 
+    def void
+      VOID_VALUE
+    end
+
     include Pry::Helpers::BaseHelpers
     include Pry::Helpers::CommandHelpers
   end

data/lib/pry/command_processor.rb

@@ -2,6 +2,36 @@ require 'forwardable'
 
 class Pry
   class CommandProcessor
+
+    # Wraps the return result of process_commands, indicates if the
+    # result IS a command and what kind of command (e.g void)
+    class Result
+      attr_reader :retval
+
+      def initialize(is_command, keep_retval = false, retval = nil)
+        @is_command, @keep_retval, @retval = is_command, keep_retval, retval
+      end
+
+      # Is the result a command?
+      # @return [Boolean]
+      def command?
+        @is_command
+      end
+
+      # Is the result a command and if it is, is it a void command?
+      # (one that does not return a value)
+      # @return [Boolean]
+      def void_command?
+        (command? && !keep_retval?) || retval == CommandContext::VOID_VALUE
+      end
+
+      # Is the return value kept for this command? (i.e :keep_retval => true)
+      # @return [Boolean]
+      def keep_retval?
+        @keep_retval
+      end
+    end
+
     extend Forwardable
 
     attr_accessor :pry_instance
@@ -10,7 +40,7 @@ class Pry
       @pry_instance = pry_instance
     end
 
-    def_delegators :@pry_instance, :commands, :nesting, :output
+    def_delegators :@pry_instance, :commands, :output
 
     # Is the string a valid command?
     # @param [String] val The string passed in from the Pry prompt.
@@ -80,11 +110,17 @@ class Pry
     # @param [String] eval_string The cumulative lines of input for
     #   multi-line input.
     # @param [Binding] target The receiver of the commands.
+    # @return [Pry::CommandProcessor::Result] A wrapper object
+    #   containing info about the result of the command processing
+    #   (indicating whether it is a command and if it is what kind of
+    #   command it is.
     def process_commands(val, eval_string, target)
 
-      # no command was matched, so return to caller
       command, captures, pos = command_matched(val, target)
-      return if !command
+
+      # no command was matched, so return to caller
+      return Result.new(false) if !command
+
       arg_string = val[pos..-1]
 
       # remove the one leading space if it exists
@@ -96,12 +132,13 @@ class Pry
         :val => val,
         :arg_string => arg_string,
         :eval_string => eval_string,
-        :nesting => nesting,
         :commands => commands.commands,
         :captures => captures
       }
 
-      execute_command(target, command.name, options, *(captures + args))
+      ret = execute_command(target, command.name, options, *(captures + args))
+
+      Result.new(true, command.options[:keep_retval], ret)
     end
 
     # Execute a Pry command.
@@ -110,6 +147,7 @@ class Pry
     # @param [String] command The name of the command to be run.
     # @param [Hash] options The options to set on the Commands object.
     # @param [Array] args The command arguments.
+    # @return [Object] The value returned by the command
     def execute_command(target, command, options, *args)
       context = CommandContext.new
 
@@ -127,7 +165,6 @@ class Pry
 
       ret = commands.run_command(context, command, *args)
 
-      # Tick, tock, im getting rid of this shit soon.
       options[:val].replace("")
 
       ret

data/lib/pry/command_set.rb

@@ -15,7 +15,11 @@ class Pry
           context.instance_eval(&stub_block)
         else
           ret = context.instance_exec(*correct_arg_arity(block.arity, args), &block)
-          ret if options[:keep_retval]
+          if options[:keep_retval]
+            ret
+          else
+            Pry::CommandContext::VOID_VALUE
+          end
         end
       end
 
@@ -24,9 +28,15 @@ class Pry
         case arity <=> 0
         when -1
           args
-        when 1, 0
-          # Keep 1.8 happy
-          args.values_at 0..(arity - 1)
+        when 0
+          []
+        when 1
+          # another jruby hack
+          if Pry::Helpers::BaseHelpers.jruby?
+            args[0..(arity - 1)]
+          else
+            args.values_at 0..(arity - 1)
+          end
         end
       end
     end

data/lib/pry/completion.rb

@@ -94,7 +94,7 @@ class Pry
           begin
             candidates = eval("#{receiver}.constants.collect{|m| m.to_s}", bind)
             candidates |= eval("#{receiver}.methods.collect{|m| m.to_s}", bind)
-          rescue Exception
+          rescue RescuableException
             candidates = []
           end
           candidates.grep(/^#{message}/).collect{|e| receiver + "::" + e}
@@ -114,7 +114,7 @@ class Pry
 
           begin
             candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
-          rescue Exception
+          rescue RescuableException
             candidates = []
           end
           select_message(receiver, message, candidates)
@@ -126,7 +126,7 @@ class Pry
 
           begin
             candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
-          rescue Exception
+          rescue RescuableException
             candidates = []
           end
           select_message(receiver, message, candidates)
@@ -149,7 +149,7 @@ class Pry
             # Foo::Bar.func
             begin
               candidates = eval("#{receiver}.methods", bind).collect{|m| m.to_s}
-            rescue Exception
+            rescue RescuableException
               candidates = []
             end
           else
@@ -158,7 +158,7 @@ class Pry
             ObjectSpace.each_object(Module){|m|
               begin
                 name = m.name.to_s
-              rescue Exception
+              rescue RescuableException
                 name = ""
               end
               next if name != "IRB::Context" and

data/lib/pry/config.rb

@@ -51,9 +51,9 @@ class Pry
     # return value of that callable invocation is used as the exact
     # shell command to invoke the editor.
     # @example String
-    #   Pry.editor = "emacsclient"
+    #   Pry.config.editor = "emacsclient"
     # @example Callable
-    #   Pry.editor = proc { |file, line| "emacsclient #{file} +#{line}" }
+    #   Pry.config.editor = proc { |file, line| "emacsclient #{file} +#{line}" }
     # @return [String, #call]
     attr_accessor :editor
 
@@ -107,6 +107,10 @@ class Pry
 
     # @return [Integer] Amount of results that will be stored into out
     attr_accessor :memory_size
+
+    # @return [Proc] The proc that manages ^D presses in the REPL.
+    #   The proc is passed the current eval_string and the current pry instance.
+    attr_accessor :control_d_handler
   end
 end
 

data/lib/pry/default_commands/context.rb

@@ -6,75 +6,122 @@ class Pry
     Context = Pry::CommandSet.new do
       import Ls
 
-      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|
-        case obj
-        when nil
-          output.puts "Must provide an object."
-          next
-        when ".."
-          throw(:breakout, opts[:nesting].level)
-        when "/"
-          throw(:breakout, 1) if opts[:nesting].level > 0
-          next
-        when "::"
-          TOPLEVEL_BINDING.pry
-          next
+      command "cd", "Move into a new context (use `cd ..` to go back and `cd /` to return to Pry top-level). Complex syntax (e.g cd ../@x/y) also supported."  do |obj|
+        path   = arg_string.split(/\//)
+        stack  = _pry_.binding_stack.dup
+
+        # special case when we only get a single "/", return to root
+        stack  = [stack.first] if path.empty?
+
+        resolve_failure = false
+        path.each do |context|
+          begin
+            case context.chomp
+            when ""
+              stack = [stack.first]
+            when "::"
+              stack.push(TOPLEVEL_BINDING)
+            when "."
+              next
+            when ".."
+              if stack.one?
+                _pry_.binding_stack.clear
+                throw(:breakout)
+              else
+                stack.pop
+              end
+            else
+              stack.push(Pry.binding_for(stack.last.eval(context)))
+            end
+
+          rescue RescuableException
+            output.puts "Bad object path: #{arg_string}. Failed trying to resolve: #{context}"
+            resolve_failure = true
+          end
+        end
+
+        next if resolve_failure
+
+        _pry_.binding_stack = stack
+      end
+
+      command "switch-to", "Start a new sub-session on a binding in the current stack (numbered by nesting)." do |selection|
+        selection = selection.to_i
+
+        if selection < 0 || selection > _pry_.binding_stack.size - 1
+          output.puts "Invalid binding index #{selection} - use `nesting` command to view valid indices."
         else
-          Pry.start target.eval(arg_string)
+          Pry.start(_pry_.binding_stack[selection])
         end
       end
 
       command "nesting", "Show nesting information." do
-        nesting = opts[:nesting]
-
         output.puts "Nesting status:"
         output.puts "--"
-        nesting.each do |level, obj|
+        _pry_.binding_stack.each_with_index do |obj, level|
           if level == 0
-            output.puts "#{level}. #{Pry.view_clip(obj)} (Pry top level)"
+            output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))} (Pry top level)"
           else
-            output.puts "#{level}. #{Pry.view_clip(obj)}"
+            output.puts "#{level}. #{Pry.view_clip(obj.eval('self'))}"
           end
         end
       end
 
-      command "jump-to", "Jump to a Pry session further up the stack, exiting all sessions below." do |break_level|
+      command "jump-to", "Jump to a binding further up the stack, popping all bindings below." do |break_level|
         break_level = break_level.to_i
-        nesting = opts[:nesting]
+        nesting_level = _pry_.binding_stack.size - 1
 
         case break_level
-        when nesting.level
-          output.puts "Already at nesting level #{nesting.level}"
-        when (0...nesting.level)
-          throw(:breakout, break_level + 1)
+        when nesting_level
+          output.puts "Already at nesting level #{nesting_level}"
+        when (0...nesting_level)
+          _pry_.binding_stack.slice!(break_level + 1, _pry_.binding_stack.size)
+
         else
-          max_nest_level = nesting.level - 1
+          max_nest_level = nesting_level - 1
           output.puts "Invalid nest level. Must be between 0 and #{max_nest_level}. Got #{break_level}."
         end
       end
 
-      command "exit", "End the current Pry session. Accepts optional return value. Aliases: quit, back" do
-        throw(:breakout, [opts[:nesting].level, target.eval(arg_string)])
+      command "exit-all", "End the current Pry session (popping all bindings) and returning to caller. Accepts optional return value. Aliases: !!@" do
+        # clear the binding stack
+        _pry_.binding_stack.clear
+
+        # break out of the repl loop
+        throw(:breakout, target.eval(arg_string))
       end
 
-      alias_command "quit", "exit", ""
-      alias_command "back", "exit", ""
+      alias_command "!!@", "exit-all", ""
+
+      command "exit", "Pop the current binding and return to the one immediately prior. Note this does NOT exit the program. Aliases: quit", :keep_retval => true do
+        if _pry_.binding_stack.one?
+          # when breaking out of top-level then behave like `exit-all`
+          _pry_.binding_stack.clear
+          throw(:breakout, target.eval(arg_string))
+        else
+          # otherwise just pop a binding
+          popped_object = _pry_.binding_stack.pop.eval('self')
 
-      command "exit-all", "End all nested Pry sessions. Accepts optional return value. Aliases: !!@" do
-        throw(:breakout, [0, target.eval(arg_string)])
+          # return a user-specified value if given
+          if !arg_string.empty?
+            target.eval(arg_string)
+          else
+            popped_object
+          end
+        end
       end
 
-      alias_command "!!@", "exit-all", ""
+      alias_command "quit", "exit", ""
 
       command "exit-program", "End the current program. Aliases: quit-program, !!!" do
         Pry.save_history if Pry.config.history.should_save
-        exit
+        Kernel.exit target.eval(arg_string).to_i
       end
 
       alias_command "quit-program", "exit-program", ""
       alias_command "!!!", "exit-program", ""
 
-      command "!pry", "Start a Pry session on current self; this even works mid-expression." do
+      command "!pry", "Start a Pry session on current self; this even works mid multi-line expression." do
         target.pry
       end
 
@@ -100,6 +147,7 @@ class Pry
         set_file_and_dir_locals(file)
         output.puts "\n#{text.bold('From:')} #{file} @ line #{line_num} in #{klass}##{meth_name}:\n\n"
 
+
         # This method inspired by http://rubygems.org/gems/ir_b
         File.open(file).each_with_index do |line, index|
           line_n = index + 1