pry 0.9.7.4 → 0.9.8pre2

data/lib/pry/command_processor.rb

@@ -101,6 +101,17 @@ class Pry
       [cmd_data, (Regexp.last_match ? Regexp.last_match.captures : nil), (Regexp.last_match ? Regexp.last_match.end(0) : nil)]
     end
 
+    # Display a warning if a command collides with a local/method in
+    # the current scope.
+    # @param [String] command_name_match The name of the colliding command.
+    # @param [Binding] target The current binding context.
+    def check_for_command_name_collision(command_name_match, target)
+      if collision_type = target.eval("defined?(#{command_name_match})")
+        pry_instance.output.puts "#{Pry::Helpers::Text.bold('WARNING:')} Command name collision with a #{collision_type}: '#{command_name_match}'\n\n"
+      end
+    rescue Pry::RescuableException
+    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`
@@ -123,6 +134,8 @@ class Pry
 
       arg_string = val[pos..-1]
 
+      check_for_command_name_collision(val[0..pos].rstrip, target) if Pry.config.collision_warning
+
       # remove the one leading space if it exists
       arg_string.slice!(0) if arg_string.start_with?(" ")
 

data/lib/pry/command_set.rb

@@ -142,6 +142,46 @@ class Pry
       commands[name] = Command.new(name, description, options, block)
     end
 
+    # Execute a block of code before a command is invoked. The block also
+    # gets access to parameters that will be passed to the command and
+    # is evaluated in the same context.
+    # @param [String, Regexp] name The name of the command.
+    # @yield The block to be run before the command.
+    # @example Display parameter before invoking command
+    #   Pry.commands.before_command("whereami") do |n|
+    #     output.puts "parameter passed was #{n}"
+    #   end
+    def before_command(name, &block)
+      cmd = find_command_by_name_or_listing(name)
+      prev_block = cmd.block
+
+      wrapper_block = proc do |*args|
+        instance_exec(*args, &block)
+        instance_exec(*args, &prev_block)
+      end
+      cmd.block = wrapper_block
+    end
+
+    # Execute a block of code after a command is invoked. The block also
+    # gets access to parameters that will be passed to the command and
+    # is evaluated in the same context.
+    # @param [String, Regexp] name The name of the command.
+    # @yield The block to be run after the command.
+    # @example Display text 'command complete' after invoking command
+    #   Pry.commands.after_command("whereami") do |n|
+    #     output.puts "command complete!"
+    #   end
+    def after_command(name, &block)
+      cmd = find_command_by_name_or_listing(name)
+      prev_block = cmd.block
+
+      wrapper_block = proc do |*args|
+        instance_exec(*args, &prev_block)
+        instance_exec(*args, &block)
+      end
+      cmd.block = wrapper_block
+    end
+
     def each &block
       @commands.each(&block)
     end
@@ -149,7 +189,10 @@ class Pry
     # Removes some commands from the set
     # @param [Array<String>] names name of the commands to remove
     def delete(*names)
-      names.each { |name| commands.delete name }
+      names.each do |name|
+        cmd = find_command_by_name_or_listing(name)
+        commands.delete cmd.name
+      end
     end
 
     # Imports all the commands from one or more sets.
@@ -167,19 +210,63 @@ class Pry
     # @param [Array<String>] names Commands to import
     def import_from(set, *names)
       helper_module.send :include, set.helper_module
-      names.each { |name| commands[name] = set.commands[name] }
+      names.each do |name|
+        cmd = set.find_command_by_name_or_listing(name)
+        commands[cmd.name] = cmd
+      end
+    end
+
+    # @param [String, Regexp] name_or_listing The name or listing name
+    #   of the command to retrieve.
+    # @return [Command] The command object matched.
+    def find_command_by_name_or_listing(name_or_listing)
+      if commands[name_or_listing]
+        cmd = commands[name_or_listing]
+      else
+        _, cmd = commands.find { |name, command| command.options[:listing] == name_or_listing }
+      end
+
+      raise ArgumentError, "Cannot find a command with name: '#{name_or_listing}'!" if !cmd
+      cmd
     end
+    protected :find_command_by_name_or_listing
 
     # Aliases a command
     # @param [String] new_name New name of the command.
     # @param [String] old_name Old name of the command.
     # @param [String, nil] desc New description of the command.
     def alias_command(new_name, old_name, desc="")
-      commands[new_name] = commands[old_name].dup
+      orig_command = find_command_by_name_or_listing(old_name)
+      commands[new_name] = orig_command.dup
       commands[new_name].name = new_name
       commands[new_name].description = desc
     end
 
+    # Rename a command. Accepts either actual name or listing name for
+    # the `old_name`.
+    # `new_name` must be the actual name of the new command.
+    # @param [String, Regexp] new_name The new name for the command.
+    # @param [String, Regexp] old_name The command's current name.
+    # @param [Hash] options The optional configuration parameters,
+    #   accepts the same as the `command` method, but also allows the
+    #   command description to be passed this way too.
+    # @example Renaming the `ls` command and changing its description.
+    #   Pry.config.commands.rename "dir", "ls", :description => "DOS friendly ls"
+    def rename_command(new_name, old_name, options={})
+      cmd = find_command_by_name_or_listing(old_name)
+
+      options = {
+        :listing     => new_name,
+        :description => cmd.description
+      }.merge!(options)
+
+      commands[new_name] = cmd.dup
+      commands[new_name].name = new_name
+      commands[new_name].description = options.delete(:description)
+      commands[new_name].options.merge!(options)
+      commands.delete(cmd.name)
+    end
+
     # Runs a command.
     # @param [Object] context Object which will be used as self during the
     #   command.
@@ -201,16 +288,22 @@ class Pry
       end
     end
 
-    # Sets the description for a command (replacing the old
-    # description.)
-    # @param [String] name The command name.
+    # Sets or gets the description for a command (replacing the old
+    # description). Returns current description if no description
+    # parameter provided.
+    # @param [String, Regexp] name The command name.
     # @param [String] description The command description.
-    # @example
+    # @example Setting
     #   MyCommands = Pry::CommandSet.new do
     #     desc "help", "help description"
     #   end
-    def desc(name, description)
-      commands[name].description = description
+    # @example Getting
+    #   Pry.config.commands.desc "amend-line"
+    def desc(name, description=nil)
+      cmd = find_command_by_name_or_listing(name)
+      return cmd.description if !description
+
+      cmd.description = description
     end
 
     # Defines helpers methods for this command sets.

data/lib/pry/config.rb

@@ -98,14 +98,20 @@ class Pry
     # @return [Boolean]
     attr_accessor :disable_auto_reload
 
+    # Determines whether Pry should trap SIGINT and cause it to raise an
+    # Interrupt exception. This is only useful on jruby, MRI does this
+    # for us.
+    # @return [Boolean]
+    attr_accessor :should_trap_interrupts
+
     # Config option for history.
-    # sub-options include hist.file, hist.load, and hist.save
-    # hist.file is the file to save/load history too, e.g
+    # sub-options include history.file, history.load, and history.save
+    # history.file is the file to save/load history to, e.g
     # Pry.config.history.file = "~/.pry_history".
-    # hist.should_load is a boolean that determines whether history will be
-    # loaded from hist.file at session start.
-    # hist.should_save is a boolean that determines whether history will be
-    # saved to hist.file at session end.
+    # history.should_load is a boolean that determines whether history will be
+    # loaded from history.file at session start.
+    # history.should_save is a boolean that determines whether history will be
+    # saved to history.file at session end.
     # @return [OpenStruct]
     attr_accessor :history
 
@@ -138,6 +144,22 @@ class Pry
     # @return [Boolean] Whether or not indentation should be corrected
     #   after hitting enter. This feature is not supported by all terminals.
     attr_accessor :correct_indent
+
+    # @return [Boolean] Whether or not a warning will be displayed when
+    #   a command name collides with a method/local in the current context.
+    attr_accessor :collision_warning
+
+
+    # Config option for gist.
+    # sub-options include `gist.inspecter`,
+    # `gist.inspecter` is a callable that defines how the expression output
+    # will be displayed when using the `gist -i` command.
+    # @example Pretty inspect output
+    #   Pry.config.gist.inspecter = proc { |v| v.pretty_inspect }
+    # @example Regular inspect
+    #   Pry.config.gist.inspecter = proc &:inspect
+    # @return [OpenStruct]
+    attr_accessor :gist
   end
 end
 

data/lib/pry/default_commands/context.rb

@@ -127,10 +127,14 @@ class Pry
         target.pry
       end
 
+      command "pry-backtrace", "Show the backtrace for the Pry session" do
+        output.puts "\n#{text.bold('Backtrace:')}\n--\n"
+        output.puts _pry_.backtrace
+      end
+
       command "whereami", "Show the code context for the session. (whereami <n> shows <n> extra lines of code around the invocation line. Default: 5)" do |num|
         file = target.eval('__FILE__')
         line_num = target.eval('__LINE__')
-        klass = target.eval('self.class')
 
         if num
           i_num = num.to_i
@@ -138,18 +142,15 @@ class Pry
           i_num = 5
         end
 
-        if (meth = Pry::Method.from_binding(target))
-          meth_name = meth.name
-        else
-          meth_name = "N/A"
-        end
-
         if file != Pry.eval_path && (file =~ /(\(.*\))|<.*>/ || file == "" || file == "-e")
           raise CommandError, "Cannot find local context. Did you use `binding.pry`?"
         end
 
         set_file_and_dir_locals(file)
-        output.puts "\n#{text.bold('From:')} #{file} @ line #{line_num} in #{klass}##{meth_name}:\n\n"
+
+        method = Pry::Method.from_binding(target)
+        method_description = method ? " in #{method.name_with_owner}" : ""
+        output.puts "\n#{text.bold('From:')} #{file} @ line #{line_num}#{method_description}:\n\n"
 
         if file == Pry.eval_path
           f = Pry.line_buffer[1..-1]

data/lib/pry/default_commands/documentation.rb

@@ -26,7 +26,7 @@ class Pry
         output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
         output.puts "#{text.bold("Signature:")} #{meth.signature}"
         output.puts
-        render_output(opts.flood?, false, doc)
+        render_output(opts.present?(:flood), false, doc)
       end
 
       alias_command "?", "show-doc"
@@ -55,29 +55,43 @@ class Pry
         EOS
       end
 
-      command "gist-method", "Gist a method to github. Type `gist-method --help` for more info.", :requires_gem => "gist", :shellwords => false do |*args|
+      command "gist", "Gist a method or expression history to github. Type `gist --help` for more info.", :requires_gem => "gist", :shellwords => false do |*args|
         require 'gist'
 
         target = target()
 
-        opts, meth = parse_options!(args, :method_object) do |opt|
+        opts = parse_options!(args) do |opt|
           opt.banner unindent <<-USAGE
-            Usage: gist-method [OPTIONS] [METH]
-            Gist the method (doc or source) to github.
+            Usage: gist [OPTIONS] [METH]
+            Gist method (doc or source) or input expression to github.
             Ensure the `gist` gem is properly working before use. http://github.com/defunkt/gist for instructions.
             e.g: gist -m my_method
             e.g: gist -d my_method
+            e.g: gist -i 1..10
           USAGE
 
-          opt.on :d, :doc, "Gist a method's documentation."
-          opt.on :p, :private, "Create a private gist (default: true)", :default => true
+          opt.on :d, :doc, "Gist a method's documentation.", true
+          opt.on :m, :method, "Gist a method's source.", true
+          opt.on :p, :public, "Create a public gist (default: false)", :default => false
+          opt.on :i, :in, "Gist entries from Pry's input expression history. Takes an index or range.", :optional => true, :as => Range, :default => -5..-1
         end
 
         type_map = { :ruby => "rb", :c => "c", :plain => "plain" }
-        if !opts.doc?
-          content = meth.source
-          code_type = meth.source_type
-        else
+        if opts.present?(:in)
+          code_type = :ruby
+          content = ""
+          normalized_range = absolute_index_range(opts[:i], _pry_.input_array.length)
+          input_items = _pry_.input_array[normalized_range] || []
+
+          input_items.each_with_index.map do |code, index|
+            corrected_index = index + normalized_range.first
+            if code && code != ""
+              content << code
+              content << "#{comment_expression_result_for_gist(Pry.config.gist.inspecter.call(_pry_.output_array[corrected_index]))}" if code !~ /;\Z/
+            end
+          end
+        elsif opts.present?(:doc)
+          meth = get_method_or_raise(opts[:d], target, {})
           content = meth.doc
           code_type = meth.source_type
 
@@ -85,14 +99,42 @@ class Pry
             content = process_comment_markup(content, code_type)
           end
           code_type = :plain
+        elsif opts.present?(:method)
+          meth = get_method_or_raise(opts[:m], target, {})
+          content = meth.source
+          code_type = meth.source_type
         end
 
+        # prevent Gist from exiting the session on error
+        begin
         link = Gist.write([:extension => ".#{type_map[code_type]}",
                            :input => content],
-                          opts.p?)
+                          !opts[:p])
+        rescue SystemExit
+        end
 
-        output.puts "Gist created at #{link}"
+        if link
+          Gist.copy(link)
+          output.puts "Gist created at #{link} and added to clipboard."
+        end
       end
+
+
+      helpers do
+        def comment_expression_result_for_gist(result)
+          content = ""
+          result.lines.each_with_index do |line, index|
+            if index == 0
+              content << "# => #{line}"
+            else
+              content << "#    #{line}"
+            end
+          end
+          content
+        end
+      end
+
+
     end
   end
 end

data/lib/pry/default_commands/easter_eggs.rb

@@ -8,7 +8,7 @@ class Pry
         run "show-input"
       end
 
-      command "get-naked" "" do
+      command "get-naked", "" do
         text = %{
 --
 We dont have to take our clothes off to have a good time.

data/lib/pry/default_commands/input.rb

@@ -32,7 +32,7 @@ class Pry
           end
         end
 
-        next if opts.h?
+        next if opts.present?(:help)
 
         if eval_string.empty?
           raise CommandError, "No input to amend."
@@ -57,7 +57,7 @@ class Pry
         run "show-input"
       end
 
-      alias_command(/%.?(-?\d+)?(?:\.\.(-?\d+))?/, /amend-line(?: (-?\d+)(?:\.\.(-?\d+))?)?/)
+      alias_command(/%.?(-?\d+)?(?:\.\.(-?\d+))?/, "amend-line")
 
       command "play", "Play back a string variable or a method or a file as input. Type `play --help` for more information." do |*args|
         opts = Slop.parse!(args) do |opt|
@@ -78,16 +78,16 @@ class Pry
           end
         end
 
-        if opts.m?
+        if opts.present?(:method)
           meth_name = opts[:m]
           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?
+          range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
+          range = (0..-2) if opts.present?(:open)
 
           eval_string << Array(meth.source.each_line.to_a[range]).join
-        elsif opts.f?
+        elsif opts.present?(:file)
           file_name = File.expand_path(opts[:f])
 
           if !File.exists?(file_name)
@@ -95,8 +95,8 @@ class Pry
           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?
+          range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
+          range = (0..-2) if opts.present?(:open)
 
           _pry_.input_stack << _pry_.input
           _pry_.input = StringIO.new(Array(text_array[range]).join)
@@ -107,13 +107,13 @@ class Pry
 
           code = target.eval(args.first)
 
-          range = opts.l? ? one_index_range_or_number(opts[:l]) : (0..-1)
-          range = (0..-2) if opts.o?
+          range = opts.present?(:lines) ? one_index_range_or_number(opts[:l]) : (0..-1)
+          range = (0..-2) if opts.present?(:open)
 
           eval_string << Array(code.each_line.to_a[range]).join
         end
 
-        run "show-input" if !_pry_.valid_expression?(eval_string)
+        run "show-input" if !_pry_.complete_expression?(eval_string)
       end
 
       command "hist", "Show and replay Readline history. Type `hist --help` for more info. Aliases: history" do |*args|
@@ -153,15 +153,15 @@ class Pry
             output.puts opt.help
           end
         end
-        next if opts.help?
+        next if opts.present?(:help)
 
-        if opts.grep?
+        if opts.present?(:grep)
           pattern = Regexp.new(arg_string.strip.split(/ /, 2).last.strip)
           history.pop
 
           history.map!.with_index do |element, index|
             if element =~ pattern
-              if opts.n?
+              if opts.present?(:"no-numbers")
                 element
               else
                 "#{text.blue index}: #{element}"
@@ -173,11 +173,11 @@ class Pry
           next
         end
 
-        if opts.head?
+        if opts.present?(:head)
           limit = opts['head'] || 10
           list  = history.first limit
           lines = list.join("\n")
-          if opts.n?
+          if opts.present?(:"no-numbers")
             stagger_output lines
           else
             stagger_output text.with_line_numbers(lines, 0)
@@ -185,14 +185,14 @@ class Pry
           next
         end
 
-        if opts.tail?
+        if opts.present?(:tail)
           limit = opts['tail'] || 10
           offset = history.size - limit
           offset = offset < 0 ? 0 : offset
 
           list  = history.last limit
           lines = list.join("\n")
-          if opts.n?
+          if opts.present?(:'no-numbers')
             stagger_output lines
           else
             stagger_output text.with_line_numbers(lines, offset)
@@ -200,11 +200,11 @@ class Pry
           next
         end
 
-        if opts.show?
+        if opts.present?(:show)
           range = opts['show']
           start_line = range.is_a?(Range) ? range.first : range
           lines = Array(history[range]).join("\n")
-          if opts.n?
+          if opts.present?(:'no-numbers')
             stagger_output lines
           else
             stagger_output text.with_line_numbers(lines, start_line)
@@ -212,10 +212,10 @@ class Pry
           next
         end
 
-        if opts.exclude?
+        if opts.present?(:exclude)
           history.map!.with_index do |element, index|
             unless command_processor.valid_command? element
-              if opts.n?
+              if opts.present?(:'no-numbers')
                 element
               else
                 "#{text.blue index}: #{element}"
@@ -226,7 +226,7 @@ class Pry
           next
         end
 
-        if opts.replay?
+        if opts.present?(:replay)
           range = opts['replay']
           actions = Array(history[range]).join("\n") + "\n"
           _pry_.input_stack << _pry_.input
@@ -234,7 +234,7 @@ class Pry
           next
         end
 
-        if opts.clear?
+        if opts.present?(:clear)
           Pry.history.clear
           output.puts 'History cleared.'
           next
@@ -274,7 +274,7 @@ class Pry
         end
 
         lines = history.join("\n")
-        if opts.n?
+        if opts.present?(:'no-numbers')
           stagger_output lines
         else
           stagger_output text.with_line_numbers(lines, 0)