pry 0.7.3 → 0.8.0

data/lib/pry/completion.rb

@@ -6,7 +6,7 @@ class Pry
 
   # Implements tab completion for Readline in Pry
   module InputCompleter
-    
+
     if Readline.respond_to?("basic_word_break_characters=")
       Readline.basic_word_break_characters= " \t\n\"\\'`><=;|&{("
     end

data/lib/pry/custom_completions.rb

@@ -0,0 +1,6 @@
+class Pry
+
+  # This proc will be instance_eval's against the active Pry instance
+  DEFAULT_CUSTOM_COMPLETIONS = proc { commands.commands.keys }
+  FILE_COMPLETIONS = proc { commands.commands.keys + Dir.entries('.') }
+end

data/lib/pry/hooks.rb

@@ -2,18 +2,16 @@ class Pry
 
   # The default hooks - display messages when beginning and ending Pry sessions.
   DEFAULT_HOOKS = {
-    
-    :before_session => proc do |out, target|
-      out.puts "Beginning Pry session for #{Pry.view_clip(target.eval('self'))}"
 
+    :before_session => proc do |out, target|
       # ensure we're actually in a method
       meth_name = target.eval('__method__')
       file = target.eval('__FILE__')
-      if ![:__script__, nil, :__binding__, :__binding_impl__].include?(meth_name) && file !~ /(\(.*\))|<.*>/
-        Pry.run_command "whereami", :output => out, :show_output => true, :context => target, :commands => Pry::Commands
+
+      # /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
       end
     end,
-    
-    :after_session => proc { |out, target| out.puts "Ending Pry session for #{Pry.view_clip(target.eval('self'))}" }
   }
 end

data/lib/pry/print.rb

@@ -1,19 +1,16 @@
 class Pry
-
-  # The default print object - only show first line of backtrace and
-  # prepend output with `=>`
   DEFAULT_PRINT = proc do |output, value|
-    case value
-    when Exception
-      output.puts "#{value.class}: #{value.message}"
-      output.puts "from #{value.backtrace.first}"
+    if Pry.color
+      output.puts "=> #{CodeRay.scan(Pry.view(value), :ruby).term}"
     else
-      if Pry.color
-        output.puts "=> #{CodeRay.scan(Pry.view(value), :ruby).term}"
-      else
-        output.puts "=> #{Pry.view(value)}"
-      end
+      output.puts "=> #{Pry.view(value)}"
     end
   end
+
+  # Will only show the first line of the backtrace
+  DEFAULT_EXCEPTION_HANDLER = proc do |output, exception|
+    output.puts "#{exception.class}: #{exception.message}"
+    output.puts "from #{exception.backtrace.first}"
+  end
 end
-  
+

data/lib/pry/prompts.rb

@@ -1,6 +1,6 @@
 class Pry
 
-  
+
   # The default prompt; includes the target and nesting level
   DEFAULT_PROMPT = [
                     proc do |target_self, nest_level|
@@ -11,7 +11,7 @@ class Pry
                         "pry(#{Pry.view_clip(target_self)}):#{Pry.view_clip(nest_level)}> "
                       end
                     end,
-                    
+
                     proc do |target_self, nest_level|
                       if nest_level == 0
                         "pry(#{Pry.view_clip(target_self)})* "
@@ -23,4 +23,9 @@ class Pry
 
   # 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} * " }
+                ]
 end

data/lib/pry/pry_class.rb

@@ -1,9 +1,9 @@
 # @author John Mair (banisterfiend)
 class Pry
 
-  # The RC Files to load. 
+  # The RC Files to load.
   RC_FILES = ["~/.pryrc"]
-  
+
   # class accessors
   class << self
 
@@ -49,6 +49,10 @@ class Pry
     #   Pry instances.
     attr_accessor :print
 
+    # @return [Proc] The Proc to use for printing exceptions by default by all
+    #   Pry instances.
+    attr_accessor :exception_handler
+
     # Get/Set the Hash that defines Pry hooks used by default by all Pry
     # instances.
     # @return [Hash] The hooks used by default by all Pry instances.
@@ -57,6 +61,14 @@ class Pry
     #     :after_session => proc { puts "goodbye" }
     attr_accessor :hooks
 
+
+    # Get/Set the Proc that defines extra Readline completions (on top
+    # of the ones defined for IRB).
+    # @return [Proc] The Proc that defines extra Readline completions (on top
+    # @example Add file names to completion list
+    #   Pry.custom_completions = proc { Dir.entries('.') }
+    attr_accessor :custom_completions
+
     # Get the array of Procs to be used for the prompts by default by
     # all Pry instances.
     # @return [Array<Proc>] The array of Procs to be used for the
@@ -68,11 +80,15 @@ class Pry
     attr_accessor :cmd_ret_value
 
     # Determines whether colored output is enabled.
-    # @return [Boolean] 
+    # @return [Boolean]
     attr_accessor :color
 
+    # Determines whether paging (of long blocks of text) is enabled.
+    # @return [Boolean]
+    attr_accessor :pager
+
     # Determines whether the rc file (~/.pryrc) should be loaded.
-    # @return [Boolean] 
+    # @return [Boolean]
     attr_accessor :should_load_rc
 
     # Set to true if Pry is invoked from command line using `pry` executable
@@ -93,7 +109,7 @@ class Pry
       load(file_name) if File.exists?(file_name)
     end
   end
-  
+
   # Start a Pry REPL.
   # This method also loads the files specified in `Pry::RC_FILES` the
   # first time it is invoked.
@@ -107,7 +123,7 @@ class Pry
       load_rc
       @rc_loaded = true
     end
-    
+
     new(options).repl(target)
   end
 
@@ -117,11 +133,14 @@ class Pry
   # @return [String] The string representation of `obj`.
   def self.view(obj)
     case obj
-    when String, Hash, Array, Symbol, nil
+    when String, Hash, Array, Symbol, Exception, nil
       obj.inspect
     else
       obj.to_s
     end
+
+  rescue NoMethodError
+    "unknown"
   end
 
   # A version of `Pry.view` that clips the output to `max_size` chars.
@@ -158,17 +177,18 @@ class Pry
   def self.run_command(arg_string, options={})
     name, arg_string = arg_string.split(/\s+/, 2)
     arg_string = "" if !arg_string
-    
+
     options = {
       :context => TOPLEVEL_BINDING,
       :show_output => false,
       :output => Pry.output,
       :commands => Pry.commands
     }.merge!(options)
-    
+
     null_output = Object.new.tap { |v| v.instance_eval { def puts(*) end } }
-    
-    commands = options[:commands].clone
+
+    commands = options[:commands]
+
     commands.output = options[:show_output] ? options[:output] : null_output
     commands.target = Pry.binding_for(options[:context])
 
@@ -188,8 +208,11 @@ class Pry
     @commands = Pry::Commands
     @prompt = DEFAULT_PROMPT
     @print = DEFAULT_PRINT
+    @exception_handler = DEFAULT_EXCEPTION_HANDLER
     @hooks = DEFAULT_HOOKS
+    @custom_completions = DEFAULT_CUSTOM_COMPLETIONS
     @color = true
+    @pager = true
     @should_load_rc = true
     @rc_loaded = false
     @cli = false

data/lib/pry/pry_instance.rb

@@ -1,8 +1,13 @@
+direc = File.dirname(__FILE__)
+
+require "#{direc}/command_processor.rb"
+
 class Pry
 
   # The list of configuration options.
   CONFIG_OPTIONS = [:input, :output, :commands, :print,
-                   :prompt, :hooks]
+                    :exception_handler, :prompt, :hooks,
+                    :custom_completions]
 
   attr_accessor *CONFIG_OPTIONS
 
@@ -13,13 +18,11 @@ class Pry
 
   # Create a new `Pry` object.
   # @param [Hash] options The optional configuration parameters.
-  # @option options [#readline] :input The object to use for input. 
-  # @option options [#puts] :output The object to use for output. 
-  # @option options [Pry::CommandBase] :commands The object to use for
-  #   commands. (see commands.rb)
+  # @option options [#readline] :input The object to use for input.
+  # @option options [#puts] :output The object to use for output.
+  # @option options [Pry::CommandBase] :commands The object to use for commands. (see commands.rb)
   # @option options [Hash] :hooks The defined hook Procs (see hooks.rb)
-  # @option options [Array<Proc>] :default_prompt The array of Procs
-  #   to use for the prompts. (see prompts.rb)
+  # @option options [Array<Proc>] :default_prompt The array of Procs to use for the prompts. (see prompts.rb)
   # @option options [Proc] :print The Proc to use for the 'print'
   #   component of the REPL. (see print.rb)
   def initialize(options={})
@@ -31,6 +34,8 @@ class Pry
     CONFIG_OPTIONS.each do |key|
       instance_variable_set("@#{key}", default_options[key])
     end
+
+    @command_processor = CommandProcessor.new(self)
   end
 
   # Get nesting data.
@@ -73,8 +78,8 @@ class Pry
     Pry.active_instance = self
 
     # Make sure special locals exist
-    target.eval("_pry_ = Pry.active_instance")
-    target.eval("_ = Pry.last_result")
+    target.eval("_pry_ = ::Pry.active_instance")
+    target.eval("_ = ::Pry.last_result")
     self.session_target = target
   end
 
@@ -87,7 +92,7 @@ class Pry
 
     # 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_data
@@ -95,7 +100,7 @@ class Pry
 
     return_value
   end
-  
+
   # Start a read-eval-print-loop.
   # If no parameter is given, default to top-level (main).
   # @param [Object, Binding] target The receiver of the Pry session
@@ -109,7 +114,7 @@ class Pry
     target_self = target.eval('self')
 
     repl_prologue(target)
-    
+
     # cannot rely on nesting.level as
     # nesting.level changes with new sessions
     nesting_level = nesting.size
@@ -125,7 +130,7 @@ class Pry
 
     # if one was provided, return the return value
     return return_value if return_value
-    
+
     # otherwise return the target_self
     target_self
   end
@@ -137,13 +142,17 @@ class Pry
   #   Pry.new.rep(Object.new)
   def rep(target=TOPLEVEL_BINDING)
     target = Pry.binding_for(target)
-    print.call output, re(target)
+    result = re(target)
+
+    show_result(result) if should_print?
   end
 
   # Perform a read-eval
   # If no parameter is given, default to top-level (main).
   # @param [Object, Binding] target The receiver of the read-eval-print
-  # @return [Object] The result of the eval or an `Exception` object in case of error.
+  # @return [Object] The result of the eval or an `Exception` object in case of
+  #   error. In the latter case, you can check whether the exception was raised
+  #   or is just the result of the expression using #last_result_is_exception?
   # @example
   #   Pry.new.re(Object.new)
   def re(target=TOPLEVEL_BINDING)
@@ -151,13 +160,14 @@ class Pry
 
     if input == Readline
       # Readline tab completion
-      Readline.completion_proc = Pry::InputCompleter.build_completion_proc(target, commands.commands.keys)
+      Readline.completion_proc = Pry::InputCompleter.build_completion_proc target, instance_eval(&custom_completions)
     end
 
-
     # save the pry instance to active_instance
     Pry.active_instance = self
-    target.eval("_pry_ = Pry.active_instance")
+    target.eval("_pry_ = ::Pry.active_instance")
+
+    @last_result_is_exception = false
 
     # eval the expression and save to last_result
     # Do not want __FILE__, __LINE__ here because we need to distinguish
@@ -167,6 +177,7 @@ class Pry
   rescue SystemExit => e
     exit
   rescue Exception => e
+    @last_result_is_exception = true
     set_last_exception(e, target)
   end
 
@@ -181,105 +192,95 @@ class Pry
   #   Pry.new.r(Object.new)
   def r(target=TOPLEVEL_BINDING)
     target = Pry.binding_for(target)
+    @suppress_output = false
     eval_string = ""
 
+    val = ""
     loop do
-      current_prompt = select_prompt(eval_string.empty?, target.eval('self'))
+      val = retrieve_line(eval_string, target)
+      process_line(val, eval_string, target)
+      break if valid_expression?(eval_string)
+    end
 
-      val = readline(current_prompt)
+    @suppress_output = true if eval_string =~ /;\Z/ || null_input?(val)
 
-      # exit pry if we receive EOF character
-      if !val
-        output.puts
-        throw(:breakout, nesting.level) 
-      end
-      
-      val.chomp!
+    eval_string
+  end
 
-      Pry.cmd_ret_value = process_commands(val, eval_string, target)
+  # FIXME should delete this method? it's exposing an implementation detail!
+  def show_result(result)
+    if last_result_is_exception?
+      exception_handler.call output, result
+    else
+      print.call output, result
+    end
+  end
 
-      if Pry.cmd_ret_value
-        eval_string << "Pry.cmd_ret_value\n"
-      else
-        eval_string << "#{val}\n"
-      end
+  # Returns true if input is "" and a command is not returning a
+  # value.
+  # @param [String] val The input string.
+  # @return [Boolean] Whether the input is null.
+  def null_input?(val)
+    val.empty? && !Pry.cmd_ret_value
+  end
+
+  # Read a line of input and check for ^d, also determine prompt to use.
+  # This method should not need to be invoked directly.
+  # @param [String] eval_string The cumulative lines of input.
+  # @param [Binding] target The target of the session.
+  # @return [String] The line received.
+  def retrieve_line(eval_string, target)
+    current_prompt = select_prompt(eval_string.empty?, target.eval('self'))
+    val = readline(current_prompt)
+
+    # exit session if we receive EOF character
+    if !val
+      output.puts
+      throw(:breakout, nesting.level)
+    end
 
-      break eval_string if valid_expression?(eval_string)
+    val
+  end
+
+  # Process the line received.
+  # This method should not need to be invoked directly.
+  # @param [String] val The line to process.
+  # @param [String] eval_string The cumulative lines of input.
+  # @target [Binding] target The target of the Pry session.
+  def process_line(val, eval_string, target)
+    val.rstrip!
+    Pry.cmd_ret_value = @command_processor.process_commands(val, eval_string, target)
+
+    if Pry.cmd_ret_value
+      eval_string << "Pry.cmd_ret_value\n"
+    else
+      eval_string << "#{val}\n" if !val.empty?
     end
   end
 
   # Set the last result of an eval.
+  # This method should not need to be invoked directly.
   # @param [Object] result The result.
   # @param [Binding] target The binding to set `_` on.
   def set_last_result(result, target)
     Pry.last_result = result
-    target.eval("_ = Pry.last_result")
+    target.eval("_ = ::Pry.last_result")
   end
 
   # Set the last exception for a session.
+  # This method should not need to be invoked directly.
   # @param [Exception] ex The exception.
   # @param [Binding] target The binding to set `_ex_` on.
   def set_last_exception(ex, target)
     Pry.last_exception = ex
-    target.eval("_ex_ = Pry.last_exception")
+    target.eval("_ex_ = ::Pry.last_exception")
   end
 
-  # Process Pry commands. Pry commands are not Ruby methods and are evaluated
-  # prior to Ruby expressions.
-  # Commands can be modified/configured by the user: see `Pry::Commands`
-  # This method should not need to be invoked directly - it is called
-  # by `Pry#r`.
-  # @param [String] val The current line of input.
-  # @param [String] eval_string The cumulative lines of input for
-  #   multi-line input.
-  # @param [Binding] target The receiver of the commands.
-  def process_commands(val, eval_string, target)
-    def val.clear() replace("") end
-    def eval_string.clear() replace("") end
-
-    pattern, cmd_data = commands.commands.find do |name, cmd_data|
-      /^#{name}(?!\S)(?:\s+(.+))?/ =~ val
-    end
-
-    # 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
+  # @return [Boolean] True if the last result is an exception that was raised,
+  #   as opposed to simply an instance of Exception (like the result of
+  #   Exception.new)
+  def last_result_is_exception?
+    @last_result_is_exception
   end
 
   # Returns the next line of input to be used by the pry instance.
@@ -294,14 +295,28 @@ class Pry
       # as it has a second parameter.
       input.readline(current_prompt, true)
     else
-      if input.method(:readline).arity == 1
-        input.readline(current_prompt)
-      else
-        input.readline
+      begin
+        if input.method(:readline).arity == 1
+          input.readline(current_prompt)
+        else
+          input.readline
+        end
+
+      rescue EOFError
+        self.input = Readline
+        ""
       end
     end
   end
 
+  # Whether the print proc should be invoked.
+  # Currently only invoked if the output is not suppressed OR the last result
+  # is an exception regardless of suppression.
+  # @return [Boolean] Whether the print proc should be invoked.
+  def should_print?
+    !@suppress_output || last_result_is_exception?
+  end
+
   # Returns the appropriate prompt to use.
   # This method should not need to be invoked directly.
   # @param [Boolean] first_line Whether this is the first line of input
@@ -317,7 +332,7 @@ class Pry
     end
   end
 
-  if RUBY_VERSION =~ /1.9/
+  if RUBY_VERSION =~ /1.9/ && RUBY_ENGINE == "ruby"
     require 'ripper'
 
     # Determine if a string of code is a valid Ruby expression.

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.7.3"
+  VERSION = "0.8.0"
 end

data/lib/pry.rb

@@ -4,7 +4,6 @@
 direc = File.dirname(__FILE__)
 
 $LOAD_PATH << File.expand_path(direc)
-$LOAD_PATH << "."
 
 require "method_source"
 require 'shellwords'
@@ -16,18 +15,25 @@ if RUBY_PLATFORM =~ /mswin/ || RUBY_PLATFORM =~ /mingw/
   begin
     require 'win32console'
   rescue LoadError
-    $stderr.puts "Need to `gem install win32console`" 
+    $stderr.puts "Need to `gem install win32console`"
     exit 1
   end
 end
 
-require "pry/version"
-require "pry/hooks"
-require "pry/print"
-require "pry/command_base"
-require "pry/commands"
-require "pry/prompts"
-require "pry/completion"
-require "pry/core_extensions"
-require "pry/pry_class"
-require "pry/pry_instance"
+require "#{direc}/pry/version"
+require "#{direc}/pry/hooks"
+require "#{direc}/pry/print"
+require "#{direc}/pry/command_base"
+require "#{direc}/pry/commands"
+require "#{direc}/pry/prompts"
+require "#{direc}/pry/custom_completions"
+require "#{direc}/pry/completion"
+require "#{direc}/pry/core_extensions"
+require "#{direc}/pry/pry_class"
+require "#{direc}/pry/pry_instance"
+
+
+# TEMPORARY HACK FOR BUG IN JRUBY 1.9 REGEX (which kills CodeRay)
+if RUBY_VERSION =~ /1.9/ && RUBY_ENGINE =~ /jruby/
+  Pry.color = false
+end