pry 0.9.3pre1-i386-mswin32 → 0.9.4-i386-mswin32

data/CHANGELOG

@@ -1,3 +1,56 @@
+8/9/2011 version 0.9.4
+
+MAJOR NEW FEATURES:
+- JRuby support, including show-method/edit-method and editor integration on both 1.8 and 1.9 versions
+- extended cd syntax: cd ../@x/y
+- play command now works much better with _in_ array (this is a very powerful feature, esp with Pry::NAV_PROMPT)
+- history saving/loading is now lightning fast
+- 'edit' (entered by itself) now opens current lines in input buffer in an editor, and evals on exit
+- 'edit' command is also, in general more intelligent
+- ls output no longer in array format, and colors can be configured, e.g: Pry.config.ls.ivar_color = :bright_blue
+- new switch-to command for moving around the binding stack without exiting out of sessions
+- more sophisticated prompts, Pry::NAV_PROMPT to ease deep spelunking of code
+- major bug fix for windows systems
+- much better support for huge objects, should no longer hang pry (see #245)
+- cat --ex and edit --ex now work better
+
+complete CHANGELOG:
+* tempfile should end in .rb (for edit -t)
+* ls output should not be in array format
+* fix history saving (should not save all of Readline::HISTORY, but only what changed)
+* prevent blank lines going to Readline::HISTORY (thanks cirwin!)
+* ensure that cat --ex emulates the `whereami` format - includes line numbers and formatted the same, etc
+* fixed bug #200 ( https://github.com/pry/pry/issues/200 )- string interpolation bug (thanks to ryanf)
+* 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)
+* '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
+* added Pry::NAV_PROMPT (great new navigation prompt, per robgleeson) and Pry::SIMPLE_PRINT for simple (IRB-style) print output (just using inspect)
+* _pry_ now passed as 3rd parameter to :before_session hook
+* ls colors now configurable via Pry.config.ls.local_var_color = :bright_red etc
+* ls separator configurable via, e.g Pry.config.ls.separator = "  "
+* Pry.view_clip() now only calls inspect on a few immediates, otherwise uses the #<> syntax, which has been truncated further to exclude teh mem address, again related to #245
+
 */7/2011 version 0.9.3
 * cat --ex (cats 5 lines above and below line in file where exception was raised)
 * edit --ex (edits line in file where exception was raised)

data/CONTRIBUTORS

@@ -0,0 +1,13 @@
+   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

@@ -1,4 +1,4 @@
-![Alt text](http://dl.dropbox.com/u/15761219/pry_horizontal_red.png)
+![Alt text](http://dl.dropbox.com/u/26521875/pry_logo_350.png)
 
 (C) John Mair (banisterfiend) 2011
 
@@ -6,8 +6,10 @@ _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](http://pry.github.com) <br />
+[Skip to the website (recommended)](http://pry.github.com) <br />
 [Skip to the wiki](https://github.com/pry/pry/wiki)
 
 Pry is a powerful alternative to the standard IRB shell for Ruby. It is

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|
@@ -78,7 +92,7 @@ end
 end
 
 desc "build all platform gems at once"
-task :gems => [:clean, :rmgems, "ruby:gem", "mswin32:gem", "mingw32:gem"]
+task :gems => [:clean, :rmgems, "ruby:gem", "mswin32:gem", "mingw32:gem", "jruby:gem"]
 
 desc "remove all platform gems"
 task :rmgems => ["ruby:clobber_package"]

data/TODO

@@ -1,3 +1,25 @@
+0.9.4
+* include method visiblity in show-doc and stat output
+* tempfile should end in .rb (for edit -t)
+* ls output should not be in array format
+* exceptions should allow access to previous items in the backtrace
+* input should allow multiple objects which are switched to automatically when EOF is reached on the preceding one
+* pry -r should happen in pry
+* more plugin-related commands in pry - see installed ones, see activated ones, see available on rubygems
+* should also allow plugins be explicitly activated as a command line option
+* should not raise if plugin activation fails (should show warning instead)
+* more documentation on CommandContext, etc and also command helpers
+* 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)
 * hist now has `history` alias

data/lib/pry.rb

@@ -6,27 +6,50 @@ require 'pry/helpers/base_helpers'
 class Pry
   # The default hooks - display messages when beginning and ending Pry sessions.
   DEFAULT_HOOKS = {
-    :before_session => proc do |out, target|
+    :before_session => proc do |out, target, _pry_|
       # ensure we're actually in a method
-      meth_name = target.eval('__method__')
       file = target.eval('__FILE__')
 
       # /unknown/ for rbx
       if file !~ /(\(.*\))|<.*>/ && file !~ /__unknown__/ && file != "" && file != "-e"
-        Pry.run_command "whereami 5", :output => out, :show_output => true, :context => target, :commands => Pry::Commands
+        _pry_.process_line("whereami 5", "", target)
       end
     end
   }
 
-  # The default prints
+  # The default print
   DEFAULT_PRINT = proc do |output, value|
+    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
+
+  # may be convenient when working with enormous objects and
+  # pretty_print is too slow
+  SIMPLE_PRINT = proc do |output, value|
     begin
-      Helpers::BaseHelpers.stagger_output("=> #{Helpers::BaseHelpers.colorize_code(value.pretty_inspect)}", output)
-    rescue NoMethodError
+      output.puts "=> #{value.inspect}"
+    rescue RescuableException
       output.puts "=> unknown"
     end
   end
 
+  # useful when playing with truly enormous objects
+  CLIPPED_PRINT = proc do |output, value|
+    output.puts "=> #{Pry.view_clip(value)}"
+  end
+
   # Will only show the first line of the backtrace
   DEFAULT_EXCEPTION_HANDLER = proc do |output, exception|
     output.puts "#{exception.class}: #{exception.message}"
@@ -35,30 +58,84 @@ class Pry
 
   # The default prompt; includes the target and nesting level
   DEFAULT_PROMPT = [
-    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
-    },
+                    proc { |target_self, nest_level, _|
+                      if nest_level == 0
+                        "pry(#{Pry.view_clip(target_self)})> "
+                      else
+                        "pry(#{Pry.view_clip(target_self)}):#{nest_level}> "
+                      end
+                    },
 
-    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
-    }
-  ]
+                    proc { |target_self, nest_level, _|
+                      if nest_level == 0
+                        "pry(#{Pry.view_clip(target_self)})* "
+                      else
+                        "pry(#{Pry.view_clip(target_self)}):#{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} * " }
+                 ]
+
+  # A prompt that includes the full object path as well as
+  # input/output (_in_ and _out_) information. Good for navigation.
+  NAV_PROMPT = [
+                proc do |_, level, pry|
+                  tree = pry.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
+                  "[#{pry.input_array.size}] (pry) #{tree}: #{level}> "
+                end,
+                proc do |_, level, pry|
+                  tree = pry.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
+                  "[#{pry.input_array.size}] (pry) #{tree}: #{level}* "
+                end,
+               ]
+
+
+  # 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
 
@@ -83,6 +160,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
@@ -10,6 +17,7 @@ class Pry
     attr_accessor :opts
     attr_accessor :command_set
     attr_accessor :command_processor
+    attr_accessor :_pry_
 
     # Run a command from another command.
     # @param [String] command_string The string that invokes the command
@@ -33,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.
@@ -54,24 +84,17 @@ class Pry
     # @return [Array] The command data and arg string pair
     def command_matched(val, target)
       _, cmd_data = commands.commands.find do |name, data|
-
-        prefix = Regexp.escape(Pry.config.command_prefix)
+        prefix = convert_to_regex(Pry.config.command_prefix)
         prefix = "(?:#{prefix})?" unless data.options[:use_prefix]
 
         command_regex = /^#{prefix}#{convert_to_regex(name)}(?!\S)/
 
-        if data.options[:interpolate]
-          # If interpolation fails then the command cannot be matched,
-          # so early exit.
-          begin
-            interp_val = interpolate_string(val, target)
-          rescue Exception
-            next
+        if command_regex =~ val
+          if data.options[:interpolate]
+            val.replace(interpolate_string(val, target))
+            command_regex =~ val # re-match with the interpolated string
           end
-
-          val.replace interp_val if command_regex =~ interp_val
-        else
-          command_regex =~ val
+          true
         end
       end
 
@@ -87,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
@@ -103,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.
@@ -117,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
 
@@ -128,12 +159,12 @@ class Pry
       context.eval_string = options[:eval_string]
       context.arg_string  = options[:arg_string]
       context.command_set = commands
+      context._pry_ = @pry_instance
 
       context.command_processor = self
 
       ret = commands.run_command(context, command, *args)
 
-      # Tick, tock, im getting rid of this shit soon.
       options[:val].replace("")
 
       ret