pry 0.9.6.2 → 0.9.7

data/lib/pry/default_commands/documentation.rb

@@ -7,103 +7,60 @@ class Pry
         run ".ri", *args
       end
 
-      command "show-doc", "Show the comments above METH. Type `show-doc --help` for more info. Aliases: \?" do |*args|
-        target = target()
-
-        opts = Slop.parse!(args) do |opt|
+      command "show-doc", "Show the comments above METH. Type `show-doc --help` for more info. Aliases: \?", :shellwords => false do |*args|
+        opts, meth = parse_options!(args, :method_object) do |opt|
           opt.banner unindent <<-USAGE
-            Usage: show-doc [OPTIONS] [METH 1] [METH 2] [METH N]
+            Usage: show-doc [OPTIONS] [METH]
             Show the comments above method METH. Tries instance methods first and then methods by default.
             e.g show-doc hello_method
           USAGE
 
-          opt.on :M, "instance-methods", "Operate on instance methods."
-          opt.on :m, :methods, "Operate on methods."
-          opt.on :c, :context, "Select object context to run under.", true do |context|
-            target = Pry.binding_for(target.eval(context))
-          end
           opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
-          opt.on :h, :help, "This message." do
-            output.puts opt
-          end
         end
 
-        next if opts.help?
+        raise Pry::CommandError, "No documentation found." if meth.doc.nil? || meth.doc.empty?
 
-        args = [nil] if args.empty?
-        args.each do |method_name|
-          meth_name = method_name
-          if (meth = get_method_object(meth_name, target, opts.to_hash(true))).nil?
-            output.puts "Invalid method name: #{meth_name}. Type `show-doc --help` for help"
-            next
-          end
-
-          doc, code_type = doc_and_code_type_for(meth)
-          next if !doc
-
-          next output.puts("No documentation found.") if doc.empty?
-          doc = process_comment_markup(doc, code_type)
-          output.puts make_header(meth, code_type, doc)
-          output.puts "#{text.bold("visibility: ")} #{method_visibility(meth).to_s}"
-          output.puts "#{text.bold("signature: ")} #{signature_for(meth)}"
-          output.puts
-          render_output(opts.flood?, false, doc)
-          doc
-        end
+        doc = process_comment_markup(meth.doc, meth.source_type)
+        output.puts make_header(meth, doc)
+        output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
+        output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
+        output.puts "#{text.bold("Signature:")} #{meth.signature}"
+        output.puts
+        render_output(opts.flood?, false, doc)
       end
 
       alias_command "?", "show-doc"
 
-      command "stat", "View method information and set _file_ and _dir_ locals. Type `stat --help` for more info." do |*args|
+      command "stat", "View method information and set _file_ and _dir_ locals. Type `stat --help` for more info.", :shellwords => false do |*args|
         target = target()
 
-        opts = Slop.parse!(args) do |opt|
+        opts, meth = parse_options!(args, :method_object) do |opt|
           opt.banner unindent <<-USAGE
             Usage: stat [OPTIONS] [METH]
             Show method information for method METH and set _file_ and _dir_ locals.
             e.g: stat hello_method
           USAGE
-
-          opt.on :M, "instance-methods", "Operate on instance methods."
-          opt.on :m, :methods, "Operate on methods."
-          opt.on :c, :context, "Select object context to run under.", true do |context|
-            target = Pry.binding_for(target.eval(context))
-          end
-          opt.on :h, :help, "This message" do
-            output.puts opt
-          end
-        end
-
-        next if opts.help?
-
-        meth_name = args.shift
-        if (meth = get_method_object(meth_name, target, opts.to_hash(true))).nil?
-          output.puts "Invalid method name: #{meth_name}. Type `stat --help` for help"
-          next
-        end
-
-        if !is_a_c_method?(meth) && !is_a_dynamically_defined_method?(meth)
-          set_file_and_dir_locals(path_line_for(meth).first)
         end
 
-        output.puts "Method Information:"
-        output.puts "--"
-        output.puts "Name: " + meth_name
-        output.puts "Owner: " + (meth.owner.to_s ? meth.owner.to_s : "Unknown")
-        output.puts "Visibility: " + method_visibility(meth).to_s
-        output.puts "Type: " + (meth.is_a?(Method) ? "Bound" : "Unbound")
-        output.puts "Arity: " + meth.arity.to_s
-        output.puts "Method Signature: " + signature_for(meth)
-
-        output.puts "Source location: " + (meth.source_location ? meth.source_location.join(":") : "Not found.")
+        output.puts unindent <<-EOS
+          Method Information:
+          --
+          Name: #{meth.name}
+          Owner: #{meth.owner ? meth.owner : "Unknown"}
+          Visibility: #{meth.visibility}
+          Type: #{meth.is_a?(::Method) ? "Bound" : "Unbound"}
+          Arity: #{meth.arity}
+          Method Signature: #{meth.signature}
+          Source Location: #{meth.source_location ? meth.source_location.join(":") : "Not found."}
+        EOS
       end
 
-      command "gist-method", "Gist a method to github. Type `gist-method --help` for more info.", :requires_gem => "gist" do |*args|
+      command "gist-method", "Gist a method to github. Type `gist-method --help` for more info.", :requires_gem => "gist", :shellwords => false do |*args|
         require 'gist'
 
         target = target()
 
-        opts = Slop.parse!(args) do |opt|
+        opts, meth = parse_options!(args, :method_object) do |opt|
           opt.banner unindent <<-USAGE
             Usage: gist-method [OPTIONS] [METH]
             Gist the method (doc or source) to github.
@@ -112,29 +69,18 @@ class Pry
             e.g: gist -d my_method
           USAGE
 
-          opt.on :m, :method, "Gist a method's source."
           opt.on :d, :doc, "Gist a method's documentation."
           opt.on :p, :private, "Create a private gist (default: true)", :default => true
-          opt.on :h, :help, "This message" do
-            output.puts opt
-          end
-        end
-
-        next if opts.help?
-
-        # This needs to be extracted into its own method as it's shared
-        # by show-method and show-doc and stat commands
-        meth_name = args.shift
-        if (meth = get_method_object(meth_name, target, opts.to_hash(true))).nil?
-          output.puts "Invalid method name: #{meth_name}. Type `gist-method --help` for help"
-          next
         end
 
         type_map = { :ruby => "rb", :c => "c", :plain => "plain" }
         if !opts.doc?
-          content, code_type = code_and_code_type_for(meth)
+          content = meth.source
+          code_type = meth.source_type
         else
-          content, code_type = doc_and_code_type_for(meth)
+          content = meth.doc
+          code_type = meth.source_type
+
           text.no_color do
             content = process_comment_markup(content, code_type)
           end
@@ -147,44 +93,6 @@ class Pry
 
         output.puts "Gist created at #{link}"
       end
-
-      helpers do
-
-        # paraphrased from awesome_print gem
-        def signature_for(method)
-          if method.respond_to?(:parameters)
-
-            args = method.parameters.inject([]) do |arr, (type, name)|
-              name ||= (type == :block ? 'block' : "arg#{arr.size + 1}")
-              arr << case type
-                     when :req        then name.to_s
-                     when :opt, :rest then "*#{name}"
-                     when :block      then "&#{name}"
-                     else '?'
-                     end
-            end
-          else 
-            args = (1..method.arity.abs).map { |i| "arg#{i}" }
-            args[-1] = "*#{args[-1]}" if method.arity < 0
-          end
-
-          "#{method.name}(#{args.join(', ')})"
-        end
-        
-        def method_visibility(meth)
-          if meth.owner.public_instance_methods.include? meth.name
-            :public
-          elsif meth.owner.protected_instance_methods.include? meth.name
-            :protected
-          elsif meth.owner.private_instance_methods.include? meth.name
-            :private
-          else
-            :none
-          end
-        end
-      end
-
     end
-
   end
 end

data/lib/pry/default_commands/gems.rb

@@ -4,14 +4,15 @@ class Pry
     Gems = Pry::CommandSet.new do
 
       command "gem-install", "Install a gem and refresh the gem cache.", :argument_required => true do |gem|
+        require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
         begin
           destination = File.writable?(Gem.dir) ? Gem.dir : Gem.user_dir
           installer = Gem::DependencyInstaller.new :install_dir => destination
           installer.install gem
         rescue Errno::EACCES
-          output.puts "Insufficient permissions to install `#{text.green gem}`"
+          raise CommandError, "Insufficient permissions to install `#{text.green gem}`."
         rescue Gem::GemNotFoundException
-          output.puts "Gem `#{text.green gem}` not found."
+          raise CommandError, "Gem `#{text.green gem}` not found."
         else
           Gem.refresh
           output.puts "Gem `#{text.green gem}` installed."
@@ -21,7 +22,11 @@ class Pry
       command "gem-cd", "Change working directory to specified gem's directory.", :argument_required => true do |gem|
         specs = Gem::Specification.respond_to?(:each) ? Gem::Specification.find_all_by_name(gem) : Gem.source_index.find_name(gem)
         spec  = specs.sort { |a,b| Gem::Version.new(b.version) <=> Gem::Version.new(a.version) }.first
-        spec ? Dir.chdir(spec.full_gem_path) : output.puts("Gem `#{gem}` not found.")
+        if spec
+          Dir.chdir(spec.full_gem_path)
+        else
+          raise CommandError, "Gem `#{gem}` not found."
+        end
       end
 
       command "gem-list", "List/search installed gems. (Optional parameter: a regexp to limit the search)" do |pattern|
@@ -41,7 +46,7 @@ class Pry
             index == 0 ? text.bright_green(spec.version.to_s) : text.green(spec.version.to_s)
           end
 
-          output.puts "#{text.white gem} (#{versions.join ', '})"
+          output.puts "#{text.default gem} (#{versions.join ', '})"
         end
       end
 

data/lib/pry/default_commands/input.rb

@@ -33,7 +33,10 @@ class Pry
         end
 
         next if opts.h?
-        next output.puts "No input to amend." if eval_string.empty?
+
+        if eval_string.empty?
+          raise CommandError, "No input to amend."
+        end
 
         replacement_line = "" if !replacement_line
         input_array = eval_string.each_line.to_a
@@ -77,20 +80,20 @@ class Pry
 
         if opts.m?
           meth_name = opts[:m]
-          if (meth = get_method_object(meth_name, target, {})).nil?
-            output.puts "Invalid method name: #{meth_name}."
-            next
-          end
-          code, _ = code_and_code_type_for(meth)
-          next if !code
+          meth = get_method_or_raise(meth_name, target, {}, :omit_help)
+          next unless meth.source
 
           range = opts.l? ? one_index_range_or_number(opts[:l]) : (0..-1)
           range = (0..-2) if opts.o?
 
-          eval_string << Array(code.each_line.to_a[range]).join
+          eval_string << Array(meth.source.each_line.to_a[range]).join
         elsif opts.f?
           file_name = File.expand_path(opts[:f])
-          next output.puts "No such file: #{opts[:f]}" if !File.exists?(file_name)
+
+          if !File.exists?(file_name)
+            raise CommandError, "No such file: #{opts[:f]}"
+          end
+
           text_array = File.readlines(file_name)
           range = opts.l? ? one_index_range_or_number(opts[:l]) : (0..-1)
           range = (0..-2) if opts.o?
@@ -98,7 +101,10 @@ class Pry
           _pry_.input_stack << _pry_.input
           _pry_.input = StringIO.new(Array(text_array[range]).join)
         else
-          next output.puts "Error: no input to play command" if !args.first
+          if !args.first
+            raise CommandError, "No input to play command."
+          end
+
           code = target.eval(args.first)
 
           range = opts.l? ? one_index_range_or_number(opts[:l]) : (0..-1)
@@ -242,7 +248,11 @@ class Pry
           case opts["save"]
           when Range
             hist_array = Array(history[opts["save"]])
-            next output.puts "Must provide a file name." if !args.first
+
+            if !args.first
+              raise CommandError, "Must provide a file name."
+            end
+
             file_name = File.expand_path(args.first)
           when String
             hist_array = history

data/lib/pry/default_commands/introspection.rb

@@ -5,59 +5,40 @@ class Pry
 
     Introspection = Pry::CommandSet.new do
 
-      command "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source" do |*args|
-        target = target()
-
-        opts = Slop.parse!(args) do |opt|
+      command "show-method", "Show the source for METH. Type `show-method --help` for more info. Aliases: $, show-source", :shellwords => false do |*args|
+        opts, meth = parse_options!(args, :method_object) do |opt|
           opt.banner unindent <<-USAGE
-            Usage: show-method [OPTIONS] [METH 1] [METH 2] [METH N]
+            Usage: show-method [OPTIONS] [METH]
             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)."
-
-          opt.on :M, "instance-methods", "Operate on instance methods."
-          opt.on :m, :methods, "Operate on methods."
           opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
-          opt.on :c, :context, "Select object context to run under.", true do |context|
-            target = Pry.binding_for(target.eval(context))
-          end
-          opt.on :h, :help, "This message." do
-            output.puts opt
-          end
         end
 
-        next if opts.help?
-
-        args = [nil] if args.empty?
-        args.each do |method_name|
-          meth_name = method_name
-          if (meth = get_method_object(meth_name, target, opts.to_hash(true))).nil?
-            output.puts "Invalid method name: #{meth_name}. Type `show-method --help` for help"
-            next
-          end
+        raise CommandError, "Could not find method source" unless meth.source
 
-          code, code_type = code_and_code_type_for(meth)
-          next if !code
-
-          output.puts make_header(meth, code_type, code)
-          if Pry.color
-            code = CodeRay.scan(code, code_type).term
-          end
-
-          start_line = false
-          if opts.l?
-            start_line = meth.source_location ? meth.source_location.last : 1
-          end
-
-          start_line = opts.b? ? 1 : start_line
+        output.puts make_header(meth)
+        output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
+        output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
+        output.puts
 
+        if Pry.color
+          code = CodeRay.scan(meth.source, meth.source_type).term
+        else
+          code = meth.source
+        end
 
-          render_output(opts.flood?, start_line, code)
-          code
+        start_line = false
+        if opts.b?
+          start_line = 1
+        elsif opts.l?
+          start_line = meth.source_line || 1
         end
+
+        render_output(opts.flood?, start_line, code)
       end
 
       alias_command "show-source", "show-method"
@@ -84,31 +65,33 @@ class Pry
 
         command_name = args.shift
         if !command_name
-          output.puts "You must provide a command name."
-          next
+          raise CommandError, "You must provide a command name."
         end
 
         if find_command(command_name)
-          block = find_command(command_name).block
+          block = Pry::Method.new(find_command(command_name).block)
 
-          code, _ = code_and_code_type_for(block)
-          next if !code
+          next unless block.source
+          set_file_and_dir_locals(block.source_file)
 
-          output.puts make_header(block, :ruby, code)
+          output.puts make_header(block)
+          output.puts
 
           if Pry.color
-            code = CodeRay.scan(code, :ruby).term
+            code = CodeRay.scan(block.source, :ruby).term
+          else
+            code = block.source
           end
 
           start_line = false
           if opts.l?
-            start_line = block.source_location ? block.source_location.last : 1
+            start_line = block.source_line || 1
           end
 
-          render_output(opts.flood?, opts.l? ? block.source_location.last : false, code)
+          render_output(opts.flood?, opts.l? ? block.source_line : false, code)
           code
         else
-          output.puts "No such command: #{command_name}."
+          raise CommandError, "No such command: #{command_name}."
         end
       end
 
@@ -133,8 +116,8 @@ class Pry
         end
         next if opts.h?
 
-        if [opts.ex?, opts.t?, opts.in?, !args.empty?].count(true) > 1
-          next output.puts "Only one of --ex, --temp, --in and FILE may be specified"
+        if [opts.ex?, opts.t?, opts.i?, !args.empty?].count(true) > 1
+          raise CommandError, "Only one of --ex, --temp, --in and FILE may be specified."
         end
 
         # edit of local code, eval'd within pry.
@@ -173,21 +156,29 @@ class Pry
         # edit of remote code, eval'd at top-level
         else
           if opts.ex?
-            next output.puts "No Exception found." if _pry_.last_exception.nil?
+            if _pry_.last_exception.nil?
+              raise CommandError, "No exception found."
+            end
+
             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)
+            if ex_file && RbxPath.is_core_path?(ex_file)
+              file_name = RbxPath.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
 
+            if file_name.nil?
+              raise CommandError, "Exception has no associated file."
+            end
+
+            if Pry.eval_path == file_name
+              raise CommandError, "Cannot edit exceptions raised in REPL."
+            end
           else
             # break up into file:line
             file_name = File.expand_path(args.first)
@@ -208,10 +199,10 @@ class Pry
         end
       end
 
-      command "edit-method", "Edit a method. Type `edit-method --help` for more info." do |*args|
+      command "edit-method", "Edit a method. Type `edit-method --help` for more info.", :shellwords => false do |*args|
         target = target()
 
-        opts = Slop.parse!(args) do |opt|
+        opts, meth = parse_options!(args, :method_object) do |opt|
           opt.banner unindent <<-USAGE
             Usage: edit-method [OPTIONS] [METH]
             Edit the method METH in an editor.
@@ -219,60 +210,49 @@ class Pry
             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
           opt.on :h, :help, "This message." do
             output.puts opt
           end
         end
 
-        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
+          raise CommandError, "No editor set!\nEnsure that #{text.bold("Pry.config.editor")} is set to your editor of choice."
         end
 
-        meth_name = args.shift
-        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 opts.p? || meth.dynamically_defined?
+          lines = meth.source.lines.to_a
 
-        if meth.nil?
-          output.puts "Invalid method name: #{meth_name}."
-          next
-        end
-
-        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}#{$'}"
+          if ((original_name = meth.original_name) &&
+              lines[0] =~ /^def (?:.*?\.)?#{original_name}(?=[\(\s;]|$)/)
+            lines[0] = "def #{original_name}#{$'}"
           else
-            next output.puts "Error: Pry can only patch methods created with the `def` keyword."
+            raise CommandError, "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)
+
+            if meth.alias?
+              with_method_transaction(original_name, meth.owner) do
+                Pry.new(:input => StringIO.new(File.read(f.path))).rep(meth.owner)
+                Pry.binding_for(meth.owner).eval("alias #{meth.name} #{original_name}")
+              end
+            else
+              Pry.new(:input => StringIO.new(File.read(f.path))).rep(meth.owner)
+            end
           end
           next
         end
 
-        if is_a_c_method?(meth)
-          output.puts "Error: Can't edit a C method."
+        if meth.source_type == :c
+          raise CommandError, "Can't edit a C method."
         else
-          file, line = path_line_for(meth)
-          set_file_and_dir_locals(file)
+          file, line = meth.source_file, meth.source_line
 
           invoke_editor(file, opts["no-jump"] ? 0 : line)
           silence_warnings do
@@ -281,6 +261,17 @@ class Pry
         end
       end
 
+      helpers do
+        def with_method_transaction(meth_name, target=TOPLEVEL_BINDING)
+          target = Pry.binding_for(target)
+          temp_name = "__pry_#{meth_name}__"
+
+          target.eval("alias #{temp_name} #{meth_name}")
+          yield
+          target.eval("alias #{meth_name} #{temp_name}")
+          target.eval("undef #{temp_name}")
+        end
+      end
     end
   end
 end