pry 0.9.10 → 0.9.11

data/lib/pry/command_set.rb

@@ -81,7 +81,7 @@ class Pry
     #   # number-N regex command
     def block_command(match, description="No description.", options={}, &block)
       description, options = ["No description.", description] if description.is_a?(Hash)
-      options = default_options(match).merge!(options)
+      options = Pry::Command.default_options(match).merge!(options)
 
       commands[match] = Pry::BlockCommand.subclass(match, description, options, helper_module, &block)
     end
@@ -113,7 +113,7 @@ class Pry
     #
     def create_command(match, description="No description.", options={}, &block)
       description, options = ["No description.", description] if description.is_a?(Hash)
-      options = default_options(match).merge!(options)
+      options = Pry::Command.default_options(match).merge!(options)
 
       commands[match] = Pry::ClassCommand.subclass(match, description, options, helper_module, &block)
       commands[match].class_eval(&block)
@@ -148,7 +148,7 @@ class Pry
       cmd.hooks[:after] << block
     end
 
-    def each &block
+    def each(&block)
       @commands.each(&block)
     end
 
@@ -196,16 +196,10 @@ class Pry
     #   of the command to retrieve.
     # @return [Command] The command object matched.
     def find_command_by_match_or_listing(match_or_listing)
-      if commands[match_or_listing]
-        cmd = commands[match_or_listing]
-      else
-        _, cmd = commands.find { |match, command| command.options[:listing] == match_or_listing }
-      end
-
-      raise ArgumentError, "Cannot find a command: '#{match_or_listing}'!" if !cmd
-      cmd
+      cmd = (commands[match_or_listing] ||
+        Pry::Helpers::BaseHelpers.find_command(match_or_listing, commands))
+      cmd or raise ArgumentError, "Cannot find a command: '#{match_or_listing}'!"
     end
-    protected :find_command_by_match_or_listing
 
     # Aliases a command
     # @param [String, Regex] match The match of the alias (can be a regex).
@@ -219,7 +213,8 @@ class Pry
     # @example Pass explicit description (overriding default).
     #   Pry.config.commands.alias_command "lM", "ls -M", :desc => "cutiepie"
     def alias_command(match, action,  options={})
-      original_options = find_command(action).options.dup
+      cmd = find_command(action) or fail "Command: `#{action}` not found"
+      original_options = cmd.options.dup
 
       options = original_options.merge!({
                                           :desc => "Alias for `#{action}`",
@@ -233,6 +228,12 @@ class Pry
         run action, *args
       end
 
+      c.class_eval do
+        define_method(:complete) do |input|
+          cmd.new(context).complete(input)
+        end
+      end
+
       c.group "Aliases"
 
       c
@@ -262,6 +263,17 @@ class Pry
       commands.delete(cmd.match)
     end
 
+    def deprecated_command(name_of_deprecated_command, deprecation_message, matcher=name_of_deprecated_command)
+      create_command name_of_deprecated_command do
+        match matcher
+        description ""
+
+        define_method(:process) do
+          output.puts "DEPRECATED: #{deprecation_message}"
+        end
+      end
+    end
+
     # Sets or gets the description for a command (replacing the old
     # description). Returns current description if no description
     # parameter provided.
@@ -348,19 +360,18 @@ class Pry
       command.new(context).call_safely(*args)
     end
 
-    private
-
-    def default_options(match)
-      {
-        :requires_gem => [],
-        :keep_retval => false,
-        :argument_required => false,
-        :interpolate => true,
-        :shellwords => true,
-        :listing => (String === match ? match : match.inspect),
-        :use_prefix => true,
-        :takes_block => false
-      }
+    # Generate completions for the user's search.
+    # @param [String] search The line to search for
+    # @param [Hash] context  The context to create the command with
+    # @return [Array<String>]
+    def complete(search, context={})
+      if command = find_command(search)
+        command.new(context).complete(search)
+      else
+        commands.keys.select do |x|
+          String === x && x.start_with?(search)
+        end.map{ |command| command + " " } + Bond::DefaultMission.completions
+      end
     end
   end
 

data/lib/pry/commands.rb

@@ -1,29 +1,6 @@
-require "pry/default_commands/misc"
-require "pry/default_commands/help"
-require "pry/default_commands/gems"
-require "pry/default_commands/context"
-require "pry/default_commands/commands"
-require "pry/default_commands/input_and_output"
-require "pry/default_commands/introspection"
-require "pry/default_commands/editing"
-require "pry/default_commands/navigating_pry"
-require "pry/default_commands/easter_eggs"
+# Default commands used by Pry.
+Pry::Commands = Pry::CommandSet.new
 
-require "pry/extended_commands/experimental"
-
-class Pry
-
-  # Default commands used by Pry.
-  Commands = Pry::CommandSet.new do
-    import DefaultCommands::Misc
-    import DefaultCommands::Help
-    import DefaultCommands::Gems
-    import DefaultCommands::Context
-    import DefaultCommands::NavigatingPry
-    import DefaultCommands::Editing
-    import DefaultCommands::InputAndOutput
-    import DefaultCommands::Introspection
-    import DefaultCommands::EasterEggs
-    import DefaultCommands::Commands
-  end
+Dir[File.expand_path('../commands/*.rb', __FILE__)].each do |file|
+  require file
 end

data/lib/pry/commands/amend_line.rb

@@ -0,0 +1,99 @@
+class Pry
+  class Command::AmendLine < Pry::ClassCommand
+    match /amend-line(?: (-?\d+)(?:\.\.(-?\d+))?)?/
+    group 'Editing'
+    description 'Amend a line of input in multi-line mode.'
+    command_options :interpolate => false, :listing => 'amend-line'
+
+    banner <<-'BANNER'
+      Amend a line of input in multi-line mode. `amend-line N`, where the N represents
+      line to replace. Can also specify a range of lines using `amend-line N..M`
+      syntax. Passing "!" as replacement content deletes the line(s) instead.
+
+      amend-line 1 puts 'new'    # replace line 1
+      amend-line 1..4 !          # delete lines 1..4
+      amend-line 3 >puts 'bye'   # insert before line 3
+      amend-line puts 'appended' # no line number modifies immediately preceding line
+    BANNER
+
+    def process
+      raise CommandError, "No input to amend." if eval_string.empty?
+
+      eval_string.replace amended_input(eval_string)
+      run "fix-indent"
+      run "show-input"
+    end
+
+    private
+
+    # @param [String] string The string to amend.
+    # @return [String] A new string with the amendments applied to it.
+    def amended_input(string)
+      input_array = eval_string.each_line.to_a
+
+      if arg_string == "!"
+        delete_from_array(input_array, line_range)
+      elsif arg_string.start_with?(">")
+        insert_into_array(input_array, line_range)
+      else
+        replace_in_array(input_array, line_range)
+      end
+
+      input_array.join
+    end
+
+    def delete_from_array(array, range)
+      array.slice!(range)
+    end
+
+    def insert_into_array(array, range)
+      insert_slot = Array(range).first
+      array.insert(insert_slot, arg_string[1..-1] + "\n")
+    end
+
+    def replace_in_array(array, range)
+      array[range] = arg_string + "\n"
+    end
+
+    # @return [Fixnum] The number of lines currently in `eval_string` (the input buffer).
+    def line_count
+      eval_string.lines.count
+    end
+
+    # Returns the (one-indexed) start and end lines given by the user.
+    # The lines in this range will be affected by the `amend-line`.
+    # Returns `nil` if no lines were specified by the user.
+    # @return [Array<Fixnum>, nil]
+    def start_and_end_line_number
+      start_line_number, end_line_number = args
+      end_line_number ||= start_line_number.to_i
+
+      [start_line_number.to_i, end_line_number.to_i] if start_line_number
+    end
+
+    # Takes two numbers that are 1-indexed, and returns a range (or
+    # number) that is 0-indexed. 1-indexed means the first element is
+    # indentified by 1 rather than by 0 (as is the case for Ruby arrays).
+    # @param [Fixnum] start_line_number One-indexed number.
+    # @param [Fixnum] end_line_number One-indexed number.
+    # @return [Range] The zero-indexed range.
+    def zero_indexed_range_from_one_indexed_numbers(start_line_number, end_line_number)
+      # FIXME: one_index_number is a horrible name for this method
+      one_index_number(start_line_number)..one_index_number(end_line_number)
+    end
+
+    # The lines (or line) that will be modified by the `amend-line`.
+    # @return [Range, Fixnum] The lines or line.
+    def line_range
+      start_line_number, end_line_number = start_and_end_line_number
+      if start_line_number
+        zero_indexed_range_from_one_indexed_numbers(start_line_number,
+                                                    end_line_number)
+      else
+        line_count - 1
+      end
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::AmendLine)
+end

data/lib/pry/commands/bang.rb

@@ -0,0 +1,20 @@
+class Pry
+  class Command::Bang < Pry::ClassCommand
+    match '!'
+    group 'Editing'
+    description 'Clear the input buffer.'
+    command_options :use_prefix => false
+
+    banner <<-'BANNER'
+      Clear the input buffer. Useful if the parsing process goes wrong and you get
+      stuck in the read loop.
+    BANNER
+
+    def process
+      output.puts 'Input buffer cleared!'
+      eval_string.replace('')
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Bang)
+end

data/lib/pry/commands/bang_pry.rb

@@ -0,0 +1,17 @@
+class Pry
+  class Command::BangPry < Pry::ClassCommand
+    match '!pry'
+    group 'Navigating Pry'
+    description 'Start a Pry session on current self.'
+
+    banner <<-'BANNER'
+      Start a Pry session on current self. Also works mid multi-line expression.
+    BANNER
+
+    def process
+      target.pry
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::BangPry)
+end

data/lib/pry/commands/cat.rb

@@ -0,0 +1,53 @@
+class Pry
+  class Command::Cat < Pry::ClassCommand
+    require 'pry/commands/cat/abstract_formatter.rb'
+    require 'pry/commands/cat/input_expression_formatter.rb'
+    require 'pry/commands/cat/exception_formatter.rb'
+    require 'pry/commands/cat/file_formatter.rb'
+
+    match 'cat'
+    group 'Input and Output'
+    description "Show code from a file, Pry's input buffer, or the last exception."
+
+    banner <<-'BANNER'
+      Usage: cat FILE
+             cat --ex [STACK_INDEX]
+             cat --in [INPUT_INDEX_OR_RANGE]
+
+      `cat` is capable of showing part or all of a source file, the context of the
+      last exception, or an expression from Pry's input history.
+
+      `cat --ex` defaults to showing the lines surrounding the location of the last
+      exception. Invoking it more than once travels up the exception's backtrace, and
+      providing a number shows the context of the given index of the backtrace.
+    BANNER
+
+    def options(opt)
+      opt.on :ex,        "Show the context of the last exception", :optional_argument => true, :as => Integer
+      opt.on :i, :in,    "Show one or more entries from Pry's expression history", :optional_argument => true, :as => Range, :default => -5..-1
+      opt.on :s, :start, "Starting line (defaults to the first line)", :optional_argument => true, :as => Integer
+      opt.on :e, :end,   "Ending line (defaults to the last line)", :optional_argument => true, :as => Integer
+      opt.on :l, :'line-numbers', "Show line numbers"
+      opt.on :t, :type,  "The file type for syntax highlighting (e.g., 'ruby' or 'python')", :argument => true, :as => Symbol
+    end
+
+    def process
+      output = case
+               when opts.present?(:ex)
+                 ExceptionFormatter.new(_pry_.last_exception, _pry_, opts).format
+               when opts.present?(:in)
+                 InputExpressionFormatter.new(_pry_.input_array, opts).format
+               else
+                 FileFormatter.new(args.first, _pry_, opts).format
+               end
+
+      stagger_output(output)
+    end
+
+    def complete(search)
+      super + Bond::Rc.files(search.split(" ").last || '')
+    end
+  end
+
+  Pry::Commands.add_command(Pry::Command::Cat)
+end

data/lib/pry/commands/cat/abstract_formatter.rb

@@ -0,0 +1,27 @@
+class Pry
+  class Command::Cat
+    class AbstractFormatter
+      include Pry::Helpers::CommandHelpers
+      include Pry::Helpers::BaseHelpers
+
+      private
+      def decorate(content)
+        content.code_type = code_type
+        content.between(*between_lines).
+          with_line_numbers(use_line_numbers?)
+      end
+
+      def code_type
+        opts[:type] || :ruby
+      end
+
+      def use_line_numbers?
+        opts.present?(:'line-numbers') || opts.present?(:ex)
+      end
+
+      def between_lines
+        [opts[:start] || 1, opts[:end] || -1]
+      end
+    end
+  end
+end

data/lib/pry/commands/cat/exception_formatter.rb

@@ -0,0 +1,78 @@
+class Pry
+  class Command::Cat
+    class ExceptionFormatter < AbstractFormatter
+      attr_accessor :ex
+      attr_accessor :opts
+      attr_accessor :_pry_
+
+      def initialize(exception, _pry_, opts)
+        @ex = exception
+        @opts = opts
+        @_pry_ = _pry_
+      end
+
+      def format
+        check_for_errors
+        set_file_and_dir_locals(backtrace_file, _pry_, _pry_.current_context)
+        code = decorate(Pry::Code.from_file(backtrace_file).
+                                    between(*start_and_end_line_for_code_window).
+                                    with_marker(backtrace_line)).to_s
+        "#{header}#{code}"
+      end
+
+      private
+
+      def code_window_size
+        Pry.config.default_window_size || 5
+      end
+
+      def backtrace_level
+        return @backtrace_level if @backtrace_level
+
+        bl =  if opts[:ex].nil?
+                ex.bt_index
+              else
+                ex.bt_index = absolute_index_number(opts[:ex], ex.backtrace.size)
+              end
+
+        increment_backtrace_level
+        @backtrace_level = bl
+      end
+
+      def increment_backtrace_level
+        ex.inc_bt_index
+      end
+
+      def backtrace_file
+        file = Array(ex.bt_source_location_for(backtrace_level)).first
+        (file && RbxPath.is_core_path?(file)) ? RbxPath.convert_path_to_full(file) : file
+      end
+
+      def backtrace_line
+        Array(ex.bt_source_location_for(backtrace_level)).last
+      end
+
+      def check_for_errors
+        raise CommandError, "No exception found." unless ex
+        raise CommandError, "The given backtrace level is out of bounds." unless backtrace_file
+      end
+
+      def start_and_end_line_for_code_window
+        start_line = backtrace_line - code_window_size
+        start_line = 1 if start_line < 1
+
+        [start_line, backtrace_line + code_window_size]
+      end
+
+      def header
+        unindent %{
+        #{Helpers::Text.bold 'Exception:'} #{ex.class}: #{ex.message}
+        --
+        #{Helpers::Text.bold('From:')} #{backtrace_file} @ line #{backtrace_line} @ #{Helpers::Text.bold("level: #{backtrace_level}")} of backtrace (of #{ex.backtrace.size - 1}).
+
+      }
+      end
+
+    end
+  end
+end