pry 0.9.0pre3-java → 0.9.4pre2-java

data/TODO

@@ -1,10 +1,40 @@
+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
+*
 
-ROADMAP
-
-FUTURE
---------
-* Pry server and Pry client for SLIME style remote repl connectinos.
-* i18n support
+0.9.3
+* hist command now excludes last line of input (the command invocation itself)
+* hist now has `history` alias
+* `pry -r` requires now happen after plugin loading (so as not to interfere with
+* new Pry.config.disable_auto_reload option, for turning off auto reloading by edit-method and related
+* add better error messages for `cd` command
+* add command_prefix
+* change some command names to include hyphen, e.g version => pry-version, install => install-command
+* do cat --ex and edit --ex
+* add reload-method
+* fixed exotic object regression - BasicObject.new etc now return "=> unknown"
+* converted: import => import-set, version => pry-version, install => install-command
+* fix show-doc bug for ruby 1.8 and Kernel.fork
+* edit -t (opens a temporary file and evals it in current context when closed)
 
 0.9.0
 Major features

data/bin/pry

@@ -39,12 +39,14 @@ See: `https://github.com/banister` for more information.
     Pry.config.plugins.enabled = false
   end
 
+  on "installed-plugins", "List installed plugins."
+
   on "simple-prompt", "Enable simple prompt mode" do
     Pry.prompt = Pry::SIMPLE_PROMPT
   end
 
   on :r, :require, "`require` a Ruby script at startup", true do |file|
-    require file
+    Pry.config.requires << file
   end
 
   on :I, "Add a path to the $LOAD_PATH", true do |path|
@@ -63,6 +65,15 @@ See: `https://github.com/banister` for more information.
     )
 end
 
+if opts["installed-plugins"]
+  puts "Installed Plugins:"
+  puts "--"
+  Pry.locate_plugins.each do |plugin|
+    puts "#{plugin.name}".ljust(18) + plugin.spec.summary
+  end
+  exit
+end
+
 # invoked via cli
 Pry.cli = true
 

data/lib/pry.rb

@@ -2,13 +2,12 @@
 # MIT License
 
 require 'pp'
-
+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|
       # ensure we're actually in a method
-      meth_name = target.eval('__method__')
       file = target.eval('__FILE__')
 
       # /unknown/ for rbx
@@ -20,11 +19,20 @@ class Pry
 
   # The default prints
   DEFAULT_PRINT = proc do |output, value|
-    if Pry.color
-      output.puts "=> #{CodeRay.scan(value.pretty_inspect, :ruby).term}"
-    else
-      output.puts "=> #{Pry.view(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
 
   # Will only show the first line of the backtrace
@@ -35,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
@@ -43,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 { ">* " }]
+  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"
@@ -83,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
@@ -10,7 +17,17 @@ 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
+    # @param [Array] args Further arguments to pass to the command
+    # @example
+    #   run "show-input"
+    # @example
+    #   run ".ls"
+    # @example
+    #   run "amend-line",  "5", 'puts "hello world"'
     def run(command_string, *args)
       complete_string = "#{command_string} #{args.join(" ")}"
       command_processor.process_commands(complete_string, eval_string, target)
@@ -24,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,13 +40,15 @@ 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.
+    # @param [Binding] target The context where the string should be
+    #   interpolated in.
     # @return [Boolean] Whether the string is a valid command.
-    def valid_command?(val)
-      !!(command_matched(val, binding)[0])
+    def valid_command?(val, target=binding)
+      !!(command_matched(val, target)[0])
     end
 
     # Convert the object to a form that can be interpolated into a
@@ -34,7 +66,7 @@ class Pry
     # Revaluate the string (str) and perform interpolation.
     # @param [String] str The string to reevaluate with interpolation.
     # @param [Binding] target The context where the string should be
-    #   reevaluated in.
+    #   interpolated in.
     # @return [String] The reevaluated string with interpolations
     #   applied (if any).
     def interpolate_string(str, target)
@@ -52,14 +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 = convert_to_regex(Pry.config.command_prefix)
+        prefix = "(?:#{prefix})?" unless data.options[:use_prefix]
 
-        interp_val = interpolate_string(val, target)
-        command_regex = /^#{convert_to_regex(name)}(?!\S)/
+        command_regex = /^#{prefix}#{convert_to_regex(name)}(?!\S)/
 
-        if data.options[:interpolate] && (command_regex =~ interp_val)
-          val.replace interp_val
-        else
-          command_regex =~ val
+        if command_regex =~ val
+          if data.options[:interpolate]
+            val.replace(interpolate_string(val, target))
+            command_regex =~ val # re-match with the interpolated string
+          end
+          true
         end
       end
 
@@ -75,12 +110,21 @@ 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
-      arg_string = val[pos..-1].strip
+
+      # 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
+      arg_string.slice!(0) if arg_string.start_with?(" ")
 
       args = arg_string ? Shellwords.shellwords(arg_string) : []
 
@@ -88,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.
@@ -102,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
 
@@ -113,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

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
@@ -68,6 +78,9 @@ class Pry
     # @option options [String] :listing The listing name of the
     #   command. That is the name by which the command is looked up by
     #   help and by show-command. Necessary for regex based commands.
+    # @option options [Boolean] :use_prefix Whether the command uses
+    #   `Pry.config.command_prefix` prefix (if one is defined). Defaults
+    #   to true.
     # @yield The action to perform. The parameters in the block
     #   determines the parameters the command will receive. All
     #   parameters passed into the block will be strings. Successive
@@ -105,7 +118,8 @@ class Pry
         :keep_retval => false,
         :argument_required => false,
         :interpolate => true,
-        :listing => name
+        :listing => name,
+        :use_prefix => true
       }.merge!(options)
 
       unless command_dependencies_met? options
@@ -115,7 +129,7 @@ class Pry
         options[:stub_info] = proc do
           output.puts "\nThe command '#{name}' is #{Helpers::Text.bold("unavailable")} because it requires the following gems to be installed: #{(gems_not_installed.join(", "))}"
           output.puts "-"
-          output.puts "Type `install #{name}` to install the required gems and activate this command."
+          output.puts "Type `install-command #{name}` to install the required gems and activate this command."
         end
       end
 
@@ -123,7 +137,7 @@ class Pry
     end
 
     def each &block
-      @commands.each(&block) 
+      @commands.each(&block)
     end
 
     # Removes some commands from the set
@@ -223,11 +237,11 @@ class Pry
           output.puts
           help_text = heading("Command List: ") + "\n"
 
-          commands.each do |key, command|
+          help_text << commands.map do |key, command|
             if command.description && !command.description.empty?
-              help_text << "#{command.options[:listing]}".ljust(18) + command.description + "\n"
+              "#{command.options[:listing]}".ljust(18) + command.description
             end
-          end
+          end.compact.sort.join("\n")
 
           stagger_output(help_text)
         else
@@ -239,7 +253,7 @@ class Pry
         end
       end
 
-      command "install", "Install a disabled command." do |name|
+      command "install-command", "Install a disabled command." do |name|
         command = find_command(name)
         stub_info = command.options[:stub_info]