pry 0.9.5 → 0.9.6

data/lib/pry/default_commands/introspection.rb

@@ -9,9 +9,11 @@ class Pry
         target = target()
 
         opts = Slop.parse!(args) do |opt|
-          opt.banner "Usage: show-method [OPTIONS] [METH 1] [METH 2] [METH N]\n" \
-                     "Show the source for method METH. Tries instance methods first and then methods by default.\n" \
-                     "e.g: show-method hello_method"
+          opt.banner unindent <<-USAGE
+            Usage: show-method [OPTIONS] [METH 1] [METH 2] [METH N]
+            Show the source for method METH. Tries instance methods first and then methods by default.
+            e.g: show-method hello_method
+          USAGE
 
           opt.on :l, "line-numbers", "Show line numbers."
           opt.on :b, "base-one", "Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands)."
@@ -58,16 +60,18 @@ class Pry
         end
       end
 
-      alias_command "show-source", "show-method", ""
-      alias_command "$", "show-method", ""
+      alias_command "show-source", "show-method"
+      alias_command "$", "show-method"
 
       command "show-command", "Show the source for CMD. Type `show-command --help` for more info." do |*args|
         target = target()
 
         opts = Slop.parse!(args) do |opt|
-          opt.banner = "Usage: show-command [OPTIONS] [CMD]\n" \
-                       "Show the source for command CMD.\n" \
-                       "e.g: show-command show-method"
+          opt.banner unindent <<-USAGE
+            Usage: show-command [OPTIONS] [CMD]
+            Show the source for command CMD.
+            e.g: show-command show-method
+          USAGE
 
           opt.on :l, "line-numbers", "Show line numbers."
           opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
@@ -110,70 +114,86 @@ class Pry
 
       command "edit", "Invoke the default editor on a file. Type `edit --help` for more info" do |*args|
         opts = Slop.parse!(args) do |opt|
-          opt.banner "Usage: edit [OPTIONS] [FILE]\n" \
-                      "Edit the method FILE in an editor.\nWhen no file given, opens editor with contents of input buffer and evals after closing." \
-                      "\nEnsure #{text.bold("Pry.config.editor")} is set to your editor of choice.\n" \
-                      "e.g: edit sample.rb"
-
-          opt.on :r, "reload", "Eval file content after editing (evals at top level)"
-          opt.on :n, "no-reload", "Do not automatically reload the file after editing (only applies to --ex and -t)."
-          opt.on :ex, "Open an editor at the line and file that generated the most recent Exception, reloads file after editing."
-          opt.on :t, "temp", "Open a temporary file in an editor with contents of input buffer and eval it in current context after closing (same as `edit` with no args)"
-          opt.on :p, "play", "Use the pry `play` command to eval the file content after editing."
-          opt.on :l, "line", "Specify line number to jump to in file", true, :as => Integer
+          opt.banner unindent <<-USAGE
+            Usage: edit [--no-reload|--reload] [--line LINE] [--temp|--ex|FILE[:LINE]]
+            Open a text editor. When no FILE is given, edits the pry input buffer.
+            Ensure #{text.bold("Pry.config.editor")} is set to your editor of choice.
+            e.g: edit sample.rb
+          USAGE
+
+          opt.on :e, :ex, "Open the file that raised the most recent exception (_ex_.file)", :optional => true, :as => Integer
+          opt.on :t, :temp, "Open an empty temporary file"
+          opt.on :l, :line, "Jump to this line in the opened file", true, :as => Integer
+          opt.on :n, :"no-reload", "Don't automatically reload the edited code"
+          opt.on :r, :reload, "Reload the edited code immediately (default for ruby files)"
           opt.on :h, :help, "This message." do
             output.puts opt
           end
         end
         next if opts.h?
 
-        should_reload_at_top_level = opts[:r]
-        should_reload_locally      = false
-
-        if opts.ex?
-          next output.puts "No Exception found." if _pry_.last_exception.nil?
+        if [opts.ex? || nil, opts.t? || nil, !args.empty? || nil].compact.size > 1
+          next output.puts "Only one of --ex, --temp, and FILE may be specified"
+        end
 
-          if is_core_rbx_path?(_pry_.last_exception.file)
-            file_name = rbx_convert_path_to_full(_pry_.last_exception.file)
-          else
-            file_name = _pry_.last_exception.file
+        # edit of local code, eval'd within pry.
+        if !opts.ex? && args.empty?
+
+          content = if opts.t?
+                      ""
+                    elsif eval_string.strip != ""
+                      eval_string
+                    else
+                      _pry_.input_array.reverse_each.find{ |x| x && x.strip != "" } || ""
+                    end
+
+          line = content.lines.count
+
+          temp_file do |f|
+            f.puts(content)
+            f.flush
+            invoke_editor(f.path, line)
+            if !opts.n?
+              silence_warnings do
+                eval_string.replace(File.read(f.path))
+              end
+            end
           end
 
-          line = _pry_.last_exception.line
-          next output.puts "Exception has no associated file." if file_name.nil?
-          next output.puts "Cannot edit exceptions raised in REPL." if Pry.eval_path == file_name
+        # edit of remote code, eval'd at top-level
+        else
+          if opts.ex?
+            next output.puts "No Exception found." if _pry_.last_exception.nil?
+            ex = _pry_.last_exception
+            bt_index = opts[:ex].to_i
+
+            ex_file, ex_line = ex.bt_source_location_for(bt_index)
+            if ex_file && is_core_rbx_path?(ex_file)
+              file_name = rbx_convert_path_to_full(ex_file)
+            else
+              file_name = ex_file
+            end
+
+            line = ex_line
+            next output.puts "Exception has no associated file." if file_name.nil?
+            next output.puts "Cannot edit exceptions raised in REPL." if Pry.eval_path == file_name
 
-          should_reload_at_top_level = opts[:n] ? false : true
+          else
+            # break up into file:line
+            file_name = File.expand_path(args.first)
 
-        elsif opts.t? || args.first.nil?
-          file_name = temp_file do |f|
-            f.puts eval_string  if !eval_string.empty?
+            line = file_name.sub!(/:(\d+)$/, "") ? $1.to_i : 1
           end
-          line = eval_string.lines.count + 1
-          should_reload_locally = opts[:n] ? false : true
-        else
-          # break up into file:line
-          /(:(\d+))?$/ =~ File.expand_path(args.first)
 
-          # $` is pre-match
-          file_name, line = [$`, $2]
-          line = line ? line.to_i : opts[:l].to_i
-        end
+          line = opts[:l].to_i if opts.l?
 
-        invoke_editor(file_name, line)
-        set_file_and_dir_locals(file_name)
+          invoke_editor(file_name, line)
+          set_file_and_dir_locals(file_name)
 
-        if opts[:p]
-          silence_warnings do
-            _pry_.input = StringIO.new(File.readlines(file_name).join)
-          end
-        elsif should_reload_locally
-          silence_warnings do
-            eval_string.replace(File.read(file_name))
-          end
-        elsif should_reload_at_top_level
-          silence_warnings do
-            TOPLEVEL_BINDING.eval(File.read(file_name), file_name)
+          if opts.r? || ((opts.ex? || file_name.end_with?(".rb")) && !opts.n?)
+            silence_warnings do
+              TOPLEVEL_BINDING.eval(File.read(file_name), file_name)
+            end
           end
         end
       end
@@ -182,15 +202,18 @@ class Pry
         target = target()
 
         opts = Slop.parse!(args) do |opt|
-          opt.banner "Usage: edit-method [OPTIONS] [METH]\n" \
-                      "Edit the method METH in an editor.\n" \
-                      "Ensure #{text.bold("Pry.config.editor")} is set to your editor of choice.\n" \
-                      "e.g: edit-method hello_method"
+          opt.banner unindent <<-USAGE
+            Usage: edit-method [OPTIONS] [METH]
+            Edit the method METH in an editor.
+            Ensure #{text.bold("Pry.config.editor")} is set to your editor of choice.
+            e.g: edit-method hello_method
+          USAGE
 
           opt.on :M, "instance-methods", "Operate on instance methods."
           opt.on :m, :methods, "Operate on methods."
           opt.on :n, "no-reload", "Do not automatically reload the method's file after editing."
           opt.on "no-jump", "Do not fast forward editor to first line of method."
+          opt.on :p, :patch, "Instead of editing the method's file, try to edit in a tempfile and apply as a monkey patch."
           opt.on :c, :context, "Select object context to run under.", true do |context|
             target = Pry.binding_for(target.eval(context))
           end
@@ -201,20 +224,42 @@ class Pry
 
         next if opts.help?
 
+        if !Pry.config.editor
+          output.puts "Error: No editor set!"
+          output.puts "Ensure that #{text.bold("Pry.config.editor")} is set to your editor of choice."
+          next
+        end
+
         meth_name = args.shift
-        if (meth = get_method_object(meth_name, target, opts.to_hash(true))).nil?
+        meth_name, target, type = get_method_attributes(meth_name, target, opts.to_hash(true))
+        meth = get_method_object_from_target(meth_name, target, type)
+
+        if meth.nil?
           output.puts "Invalid method name: #{meth_name}."
           next
         end
 
-        next output.puts "Error: No editor set!\nEnsure that #{text.bold("Pry.config.editor")} is set to your editor of choice." if !Pry.config.editor
+        if opts.p? || is_a_dynamically_defined_method?(meth)
+          code, _ = code_and_code_type_for(meth)
+
+          lines = code.lines.to_a
+          if lines[0] =~ /^def [^( \n]+/
+            lines[0] = "def #{meth_name}#{$'}"
+          else
+            next output.puts "Error: Pry can only patch methods created with the `def` keyword."
+          end
+
+          temp_file do |f|
+            f.puts lines.join
+            f.flush
+            invoke_editor(f.path, 0)
+            Pry.new(:input => StringIO.new(File.read(f.path))).rep(meth.owner)
+          end
+          next
+        end
 
         if is_a_c_method?(meth)
           output.puts "Error: Can't edit a C method."
-        elsif is_a_dynamically_defined_method?(meth)
-          output.puts "Error: Can't edit an eval method."
-
-          # editor is invoked here
         else
           file, line = path_line_for(meth)
           set_file_and_dir_locals(file)

data/lib/pry/default_commands/shell.rb

@@ -11,11 +11,8 @@ class Pry
           rescue Errno::ENOENT
             output.puts "No such directory: #{dest}"
           end
-
         else
-          if !system(cmd)
-            output.puts "Error: there was a problem executing system command: #{cmd}"
-          end
+          Pry.config.system.call(output, cmd, _pry_)
         end
       end
 
@@ -32,12 +29,13 @@ class Pry
         end
       end
 
-      alias_command "file-mode", "shell-mode", ""
+      alias_command "file-mode", "shell-mode"
 
       command "cat", "Show output of file FILE. Type `cat --help` for more information." do |*args|
         start_line = 0
         end_line = -1
         file_name = nil
+        bt_index = 0
 
         opts = Slop.parse!(args) do |opt|
           opt.on :s, :start, "Start line (defaults to start of file)Line 1 is the first line.", true, :as => Integer do |line|
@@ -48,17 +46,25 @@ class Pry
             end_line = line - 1
           end
 
-          opt.on :ex, "Show a window of N lines either side of the last exception (defaults to 5).", :optional => true, :as => Integer do |window_size|
-            window_size ||= 5
+          opt.on :ex, "Show a window of N lines either side of the last exception (defaults to 5).", :optional => true, :as => Integer do |bt_index_arg|
+            window_size = Pry.config.exception_window_size || 5
             ex = _pry_.last_exception
             next if !ex
-            start_line = (ex.line - 1) - window_size
+            if bt_index_arg
+              bt_index = bt_index_arg
+            else
+              bt_index = ex.bt_index
+            end
+            ex.bt_index = (bt_index + 1) % ex.backtrace.size
+
+            ex_file, ex_line = ex.bt_source_location_for(bt_index)
+            start_line = (ex_line - 1) - window_size
             start_line = start_line < 0 ? 0 : start_line
-            end_line = (ex.line - 1) + window_size
-            if is_core_rbx_path?(ex.file)
-              file_name = rbx_convert_path_to_full(ex.file)
+            end_line = (ex_line - 1) + window_size
+            if ex_file && is_core_rbx_path?(ex_file)
+              file_name = rbx_convert_path_to_full(ex_file)
             else
-              file_name = ex.file
+              file_name = ex_file
             end
           end
 
@@ -74,7 +80,6 @@ class Pry
 
         if opts.ex?
           next output.puts "No Exception or Exception has no associated file." if file_name.nil?
-          next output.puts "Cannot cat exceptions raised in REPL." if Pry.eval_path == file_name
         else
           file_name = args.shift
         end
@@ -84,8 +89,13 @@ class Pry
           next
         end
 
-        contents, _, _ = read_between_the_lines(file_name, start_line, end_line)
-        contents = syntax_highlight_by_file_type_or_specified(contents, file_name, opts[:type])
+        begin
+          contents, _, _ = read_between_the_lines(file_name, start_line, end_line)
+          contents = syntax_highlight_by_file_type_or_specified(contents, file_name, opts[:type])
+        rescue Errno::ENOENT
+          output.puts "Could not find file: #{file_name}"
+          next
+        end
 
         if opts.l?
           contents = text.with_line_numbers contents, start_line + 1
@@ -93,11 +103,12 @@ class Pry
 
         # add the arrow pointing to line that caused the exception
         if opts.ex?
+          ex_file, ex_line = _pry_.last_exception.bt_source_location_for(bt_index)
           contents = text.with_line_numbers contents, start_line + 1, :bright_red
 
           contents = contents.lines.each_with_index.map do |line, idx|
             l = idx + start_line
-            if l == (_pry_.last_exception.line - 1)
+            if l == (ex_line - 1)
               " =>#{line}"
             else
               "   #{line}"
@@ -106,7 +117,7 @@ class Pry
 
           # header for exceptions
           output.puts "\n#{Pry::Helpers::Text.bold('Exception:')} #{_pry_.last_exception.class}: #{_pry_.last_exception.message}\n--"
-          output.puts "#{Pry::Helpers::Text.bold('From:')} #{file_name} @ line #{_pry_.last_exception.line}\n\n"
+          output.puts "#{Pry::Helpers::Text.bold('From:')} #{ex_file} @ line #{ex_line} @ #{text.bold('level: ')} #{bt_index} of backtrace (of #{_pry_.last_exception.backtrace.size - 1}).\n\n"
         end
 
         set_file_and_dir_locals(file_name)

data/lib/pry/helpers/command_helpers.rb

@@ -44,7 +44,6 @@ class Pry
       def temp_file
         file = Tempfile.new(["tmp", ".rb"])
         yield file
-        file.path
       ensure
         file.close
       end
@@ -178,37 +177,43 @@ class Pry
         [doc, code_type]
       end
 
-      def get_method_object(meth_name, target, options)
+      def get_method_object(meth_name, target=nil, options={})
+        get_method_object_from_target(*get_method_attributes(meth_name, target, options)) rescue nil
+      end
+
+      def get_method_attributes(meth_name, target=nil, options={})
         if meth_name
           if meth_name =~ /(\S+)\#(\S+)\Z/
             context, meth_name = $1, $2
             target = Pry.binding_for(target.eval(context))
-            options["instance-methods"] = true
-            options[:methods] = false
+            type = :instance
           elsif meth_name =~ /(\S+)\.(\S+)\Z/
             context, meth_name = $1, $2
             target = Pry.binding_for(target.eval(context))
-            options["instance-methods"] = false
-            options[:methods] = true
+            type = :singleton
+          elsif options["instance_methods"]
+            type = :instance
+          elsif options[:methods]
+            type = :singleton
+          else
+            type = nil
           end
         else
           meth_name = meth_name_from_binding(target)
+          type = nil
         end
+        [meth_name, target, type]
+      end
 
-        if !meth_name
-          return nil
-        end
-
-        if options["instance-methods"]
+      def get_method_object_from_target(meth_name, target, type=nil)
+        case type
+        when :instance
           target.eval("instance_method(:#{meth_name})") rescue nil
-        elsif options[:methods]
+        when :singleton
           target.eval("method(:#{meth_name})") rescue nil
         else
-          begin
-            target.eval("instance_method(:#{meth_name})")
-          rescue
-            target.eval("method(:#{meth_name})") rescue nil
-          end
+          get_method_object_from_target(meth_name, target, :instance) ||
+            get_method_object_from_target(meth_name, target, :singleton)
         end
       end
 
@@ -305,7 +310,11 @@ class Pry
       # returns the file content between the lines and the normalized
       # start and end line numbers.
       def read_between_the_lines(file_name, start_line, end_line)
-        content = File.read(File.expand_path(file_name))
+        if file_name == Pry.eval_path
+          content = Pry.line_buffer.drop(1).join
+        else
+          content = File.read(File.expand_path(file_name))
+        end
         lines_array = content.each_line.to_a
 
         [lines_array[start_line..end_line].join, normalized_line_number(start_line, lines_array.size),
@@ -372,6 +381,7 @@ class Pry
         else
           editor_invocation = "#{Pry.config.editor} #{start_line_syntax_for_editor(file, line)}"
         end
+        return nil unless editor_invocation
 
         if jruby?
           begin
@@ -379,18 +389,23 @@ class Pry
             pid = Spoon.spawnp(*editor_invocation.split)
             Process.waitpid(pid)
           rescue FFI::NotFoundError
-            run ".#{editor_invocation}"
+            system(editor_invocation)
           end
         else
-          run ".#{editor_invocation}"
+          # Note we dont want to use Pry.config.system here as that
+          # may be invoked non-interactively (i.e via Open4), whereas we want to
+          # ensure the editor is always interactive
+          system(editor_invocation)
         end
       end
 
+      # Return the syntax for a given editor for starting the editor
+      # and moving to a particular line within that file
       def start_line_syntax_for_editor(file_name, line_number)
         file_name = file_name.gsub(/\//, '\\') if RUBY_PLATFORM =~ /mswin|mingw/
 
-        # special case 0th line
-        return file_name if line_number <= 0
+        # special case for 1st line
+        return file_name if line_number <= 1
 
         case Pry.config.editor
         when /^[gm]?vi/, /^emacs/, /^nano/, /^pico/, /^gedit/, /^kate/
@@ -410,27 +425,45 @@ class Pry
         end
       end
 
-      def prompt(message, options="Yn")
-        opts      = options.scan(/./)
-        optstring = opts.join("/") # case maintained
-        defaults  = opts.select{|o| o.upcase == o }
-        opts      = opts.map{|o| o.downcase}
-
-        raise "Error: Too many default values for the prompt: #{default.inspect}" if defaults.size > 1
-
-        default = defaults.first
-
-        loop do
-          response = Pry.input.readline("#{message} (#{optstring}) ").downcase
-          case response
-          when *opts
-            return response
-          when ""
-            return default.downcase
+      # Remove any common leading whitespace from every line in `text`.
+      #
+      # This can be used to make a HEREDOC line up with the left margin, without
+      # sacrificing the indentation level of the source code.
+      #
+      # e.g.
+      #   opt.banner unindent <<-USAGE
+      #     Lorem ipsum dolor sit amet, consectetur adipisicing elit,
+      #     sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+      #       "Ut enim ad minim veniam."
+      #   USAGE
+      #
+      # @param  [String] The text from which to remove indentation
+      # @return [String], The text with indentation stripped.
+      #
+      # @copyright Heavily based on textwrap.dedent from Python, which is:
+      #   Copyright (C) 1999-2001 Gregory P. Ward.
+      #   Copyright (C) 2002, 2003 Python Software Foundation.
+      #   Written by Greg Ward <gward@python.net>
+      #
+      #   Licensed under <http://docs.python.org/license.html>
+      #   From <http://hg.python.org/cpython/file/6b9f0a6efaeb/Lib/textwrap.py>
+      #
+      def unindent(text)
+        # Empty blank lines
+        text = text.sub(/^[ \t]+$/, '')
+
+        # Find the longest common whitespace to all indented lines
+        margin = text.scan(/^[ \t]*(?=[^ \t\n])/).inject do |current_margin, next_indent|
+          if next_indent.start_with?(current_margin)
+            current_margin
+          elsif current_margin.start_with?(next_indent)
+            next_indent
           else
-            output.puts "  |_ Invalid option: #{response.inspect}. Try again."
+            ""
           end
         end
+
+        text.gsub(/^#{margin}/, '')
       end
 
     end