pry 0.10.3 → 0.12.2

data/lib/pry/command.rb

@@ -2,7 +2,6 @@ require 'delegate'
 require 'pry/helpers/documentation_helpers'
 
 class Pry
-
   # The super-class of all commands, new commands should be created by calling
   # {Pry::CommandSet#command} which creates a BlockCommand or {Pry::CommandSet#create_command}
   # which creates a ClassCommand. Please don't use this class directly.
@@ -24,7 +23,7 @@ class Pry
       attr_writer :command_options
       attr_writer :match
 
-      def match(arg=nil)
+      def match(arg = nil)
         if arg
           @command_options ||= default_options(arg)
           @command_options[:listing] = arg.is_a?(String) ? arg : arg.inspect
@@ -34,13 +33,13 @@ class Pry
       end
 
       # Define or get the command's description
-      def description(arg=nil)
+      def description(arg = nil)
         @description = arg if arg
         @description ||= nil
       end
 
       # Define or get the command's options
-      def command_options(arg=nil)
+      def command_options(arg = nil)
         @command_options ||= default_options(match)
         @command_options.merge!(arg) if arg
         @command_options
@@ -50,9 +49,9 @@ class Pry
       alias_method :options=, :command_options=
 
       # Define or get the command's banner
-      def banner(arg=nil)
+      def banner(arg = nil)
         @banner = arg if arg
-        @banner || description
+        @banner ||= description
       end
 
       def block
@@ -68,10 +67,6 @@ class Pry
         new.help
       end
 
-      def source_location
-        block.source_location
-      end
-
       def source_file
         Array(block.source_location).first
       end
@@ -84,27 +79,32 @@ class Pry
 
       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
+          requires_gem: [],
+          keep_retval: false,
+          argument_required: false,
+          interpolate: true,
+          shellwords: true,
+          listing: (String === match ? match : match.inspect),
+          use_prefix: true,
+          takes_block: false
         }
       end
     end
 
     # Make those properties accessible to instances
     def name; self.class.name; end
+
     def match; self.class.match; end
+
     def description; self.class.description; end
+
     def block; self.class.block; end
+
     def command_options; self.class.options; end
+
     def command_name; self.class.command_name; end
+
     def source; self.class.source; end
-    def source_location; self.class.source_location; end
 
     class << self
       def name
@@ -167,11 +167,10 @@ class Pry
         end
       end
 
+      # @deprecated Replaced with {Pry::Hooks#add_hook}. Left for compatibility.
       # Store hooks to be run before or after the command body.
-      # @see {Pry::CommandSet#before_command}
-      # @see {Pry::CommandSet#after_command}
       def hooks
-        @hooks ||= {:before => [], :after => []}
+        Pry.hooks
       end
 
       def command_regex
@@ -195,7 +194,7 @@ class Pry
       # This is usually auto-generated from directory naming, but it can be
       # manually overridden if necessary.
       # Group should not be changed once it is initialized.
-      def group(name=nil)
+      def group(name = nil)
         @group ||= if name
                      name
                    else
@@ -204,9 +203,9 @@ class Pry
                        $1.capitalize.gsub(/_/, " ")
                      when %r{(pry-\w+)-([\d\.]+([\w\.]+)?)}
                        name, version = $1, $2
-                       "#{name.to_s} (v#{version.to_s})"
+                       "#{name} (v#{version})"
                      when /pryrc/
-                       "~/.pryrc"
+                       "pryrc"
                      else
                        "(other)"
                      end
@@ -223,6 +222,7 @@ class Pry
     attr_accessor :arg_string
     attr_accessor :context
     attr_accessor :command_set
+    attr_accessor :hooks
     attr_accessor :_pry_
 
     # The block we pass *into* a command so long as `:takes_block` is
@@ -252,6 +252,14 @@ class Pry
       command_set.to_hash
     end
 
+    #
+    # @deprecated
+    #   Please use black(), white(), etc directly instead (as you would with helper
+    #   functions from BaseHelpers and CommandHelpers)
+    #
+    # @return [Module]
+    #   Returns Pry::Helpers::Text
+    #
     def text
       Pry::Helpers::Text
     end
@@ -262,15 +270,17 @@ class Pry
 
     include Pry::Helpers::BaseHelpers
     include Pry::Helpers::CommandHelpers
+    include Pry::Helpers::Text
 
     # Instantiate a command, in preparation for calling it.
     # @param [Hash] context The runtime context to use with this command.
-    def initialize(context={})
+    def initialize(context = {})
       self.context      = context
       self.target       = context[:target]
       self.output       = context[:output]
       self.eval_string  = context[:eval_string]
       self.command_set  = context[:command_set]
+      self.hooks        = context[:hooks]
       self._pry_        = context[:pry_instance]
     end
 
@@ -335,6 +345,7 @@ class Pry
 
       # please call Command.matches? before Command#call_safely
       raise CommandError, "fatal: called a command which didn't match?!" unless Regexp.last_match
+
       captures = Regexp.last_match.captures
       pos = Regexp.last_match.end(0)
 
@@ -424,10 +435,20 @@ class Pry
         raise CommandError, "The command '#{command_name}' requires an argument."
       end
 
-      ret = call_with_hooks(*args)
+      ret = use_unpatched_symbol do
+        call_with_hooks(*args)
+      end
       command_options[:keep_retval] ? ret : void
     end
 
+    def use_unpatched_symbol
+      call_method = Symbol.method_defined?(:call) && Symbol.instance_method(:call)
+      Symbol.class_eval { undef :call } if call_method
+      yield
+    ensure
+      Symbol.instance_eval { define_method(:call, call_method) } if call_method
+    end
+
     # Are all the gems required to use this command installed?
     #
     # @return  Boolean
@@ -437,25 +458,36 @@ class Pry
 
     # Generate completions for this command
     #
-    # @param [String] search  The line typed so far
+    # @param [String] _search The line typed so far
     # @return [Array<String>]  Completion words
-    def complete(search)
+    def complete(_search)
       []
     end
 
     private
 
+    def find_hooks(event)
+      event_name = "#{event}_#{command_name}"
+      (self.hooks || self.class.hooks).get_hooks(event_name).values
+    end
+
+    def before_hooks
+      find_hooks('before')
+    end
+
+    def after_hooks
+      find_hooks('after')
+    end
+
     # Run the `#call` method and all the registered hooks.
     # @param [Array<String>] args The arguments to `#call`
     # @return [Object] The return value from `#call`
     def call_with_hooks(*args)
-      self.class.hooks[:before].each do |block|
-        instance_exec(*args, &block)
-      end
+      before_hooks.each { |block| instance_exec(*args, &block) }
 
       ret = call(*args)
 
-      self.class.hooks[:after].each do |block|
+      after_hooks.each do |block|
         ret = instance_exec(*args, &block)
       end
 
@@ -507,18 +539,17 @@ class Pry
   # subclasses.
   #
   # Create subclasses using {Pry::CommandSet#create_command}, and override the
-  # `options(opt)` method to set up an instance of Slop, and the `process`
+  # `options(opt)` method to set up an instance of Pry::Slop, and the `process`
   # method to actually run the command. If necessary, you can also override
   # `setup` which will be called before `options`, for example to require any
   # gems your command needs to run, or to set up state.
   class ClassCommand < Command
     class << self
-
       # Ensure that subclasses inherit the options, description and
       # match from a ClassCommand super class.
       def inherited(klass)
-        klass.match  match
-        klass.description  description
+        klass.match match
+        klass.description description
         klass.command_options options
       end
 
@@ -583,15 +614,15 @@ class Pry
       end
     end
 
-    # Return the help generated by Slop for this command.
+    # Return the help generated by Pry::Slop for this command.
     def help
       slop.help
     end
 
-    # Return an instance of Slop that can parse either subcommands or the
+    # Return an instance of Pry::Slop that can parse either subcommands or the
     # options that this command accepts.
     def slop
-      Slop.new do |opt|
+      Pry::Slop.new do |opt|
         opt.banner(unindent(self.class.banner))
         subcommands(opt)
         options(opt)
@@ -603,9 +634,9 @@ class Pry
     # @param [String] search  The line typed so far
     # @return [Array<String>]  the words to complete
     def complete(search)
-      slop.map do |opt|
+      slop.flat_map do |opt|
         [opt.long && "--#{opt.long} " || opt.short && "-#{opt.short}"]
-      end.flatten(1).compact + super
+      end.compact + super
     end
 
     # A method called just before `options(opt)` as part of `call`.
@@ -620,7 +651,7 @@ class Pry
     #   end
     def setup; end
 
-    # A method to setup Slop commands so it can parse the subcommands your
+    # A method to setup Pry::Slop commands so it can parse the subcommands your
     # command expects. If you need to set up default values, use `setup`
     # instead.
     #
@@ -655,7 +686,7 @@ class Pry
     #   end
     def subcommands(cmd); end
 
-    # A method to setup Slop so it can parse the options your command expects.
+    # A method to setup Pry::Slop so it can parse the options your command expects.
     #
     # @note Please don't do anything side-effecty in the main part of this
     # method, as it may be called by Pry at any time for introspection reasons.
@@ -672,7 +703,7 @@ class Pry
 
     # The actual body of your command should go here.
     #
-    # The `opts` mehod can be called to get the options that Slop has passed,
+    # The `opts` mehod can be called to get the options that Pry::Slop has passed,
     # and `args` gives the remaining, unparsed arguments.
     #
     # The return value of this method is discarded unless the command was

data/lib/pry/command_set.rb

@@ -75,7 +75,7 @@ class Pry
     #   # hello john, nice number: 10
     #   # pry(main)> help number
     #   # number-N regex command
-    def block_command(match, description="No description.", options={}, &block)
+    def block_command(match, description = "No description.", options = {}, &block)
       description, options = ["No description.", description] if description.is_a?(Hash)
       options = Pry::Command.default_options(match).merge!(options)
 
@@ -107,7 +107,7 @@ class Pry
     #     end
     #   end
     #
-    def create_command(match, description="No description.", options={}, &block)
+    def create_command(match, description = "No description.", options = {}, &block)
       description, options = ["No description.", description] if description.is_a?(Hash)
       options = Pry::Command.default_options(match).merge!(options)
 
@@ -116,34 +116,6 @@ class Pry
       @commands[match]
     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] search The match or listing of the command.
-    # @yield The block to be run before the command.
-    # @example Display parameter before invoking command
-    #   Pry.config.commands.before_command("whereami") do |n|
-    #     output.puts "parameter passed was #{n}"
-    #   end
-    def before_command(search, &block)
-      cmd = find_command_by_match_or_listing(search)
-      cmd.hooks[:before].unshift 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] search The match or listing of the command.
-    # @yield The block to be run after the command.
-    # @example Display text 'command complete' after invoking command
-    #   Pry.config.commands.after_command("whereami") do |n|
-    #     output.puts "command complete!"
-    #   end
-    def after_command(search, &block)
-      cmd = find_command_by_match_or_listing(search)
-      cmd.hooks[:after] << block
-    end
-
     def each(&block)
       @commands.each(&block)
     end
@@ -202,13 +174,13 @@ class Pry
     #   Pry.config.commands.alias_command "lM", "ls -M"
     # @example Pass explicit description (overriding default).
     #   Pry.config.commands.alias_command "lM", "ls -M", :desc => "cutiepie"
-    def alias_command(match, action,  options={})
+    def alias_command(match, action, options = {})
       cmd = find_command(action) or fail "Command: `#{action}` not found"
       original_options = cmd.options.dup
 
       options = original_options.merge!({
-                                          :desc => "Alias for `#{action}`",
-                                          :listing => match
+                                          desc: "Alias for `#{action}`",
+                                          listing: match
                                         }).merge!(options)
 
       # ensure default description is used if desc is nil
@@ -238,12 +210,12 @@ class Pry
     #   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_match, search, options={})
+    def rename_command(new_match, search, options = {})
       cmd = find_command_by_match_or_listing(search)
 
       options = {
-        :listing     => new_match,
-        :description => cmd.description
+        listing: new_match,
+        description: cmd.description
       }.merge!(options)
 
       @commands[new_match] = cmd.dup
@@ -253,7 +225,7 @@ class Pry
       @commands.delete(cmd.match)
     end
 
-    def disabled_command(name_of_disabled_command, message, matcher=name_of_disabled_command)
+    def disabled_command(name_of_disabled_command, message, matcher = name_of_disabled_command)
       create_command name_of_disabled_command do
         match matcher
         description ""
@@ -275,7 +247,7 @@ class Pry
     #   end
     # @example Getting
     #   Pry.config.commands.desc "amend-line"
-    def desc(search, description=nil)
+    def desc(search, description = nil)
       cmd = find_command_by_match_or_listing(search)
       return cmd.description if !description
 
@@ -298,7 +270,6 @@ class Pry
       helper_module.class_eval(&block)
     end
 
-
     # @return [Array]
     #   The list of commands provided by the command set.
     def list_commands
@@ -345,6 +316,7 @@ class Pry
       unless Class === command && command < Pry::Command
         raise TypeError, "command is not a subclass of Pry::Command"
       end
+
       bind_command_to_pattern = pattern != command.match
       if bind_command_to_pattern
         command_copy = command.dup
@@ -387,9 +359,9 @@ class Pry
     # @param [String] val The line to execute
     # @param [Hash] context The context to execute the commands with
     # @return [CommandSet::Result]
-    def process_line(val, context={})
-      if command = find_command(val)
-        context = context.merge(:command_set => self)
+    def process_line(val, context = {})
+      if (command = find_command(val))
+        context = context.merge(command_set: self)
         retval = command.new(context).process_line(val)
         Result.new(true, retval)
       else
@@ -407,13 +379,13 @@ class Pry
     # @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)
+    def complete(search, context = {})
+      if (command = find_command(search))
         command.new(context).complete(search)
       else
         @commands.keys.select do |key|
           String === key && key.start_with?(search)
-        end.map{ |key| key + " " }
+        end.map { |key| key + " " }
       end
     end
   end

data/lib/pry/commands/amend_line.rb

@@ -3,7 +3,7 @@ class Pry
     match(/amend-line(?: (-?\d+)(?:\.\.(-?\d+))?)?/)
     group 'Editing'
     description 'Amend a line of input in multi-line mode.'
-    command_options :interpolate => false, :listing => 'amend-line'
+    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
@@ -19,16 +19,15 @@ class Pry
     def process
       raise CommandError, "No input to amend." if eval_string.empty?
 
-      eval_string.replace amended_input(eval_string)
+      eval_string.replace(amend_input)
       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)
+    def amend_input
       input_array = eval_string.each_line.to_a
 
       if arg_string == "!"

data/lib/pry/commands/bang.rb

@@ -3,7 +3,7 @@ class Pry
     match(/^\s*!\s*$/)
     group 'Editing'
     description 'Clear the input buffer.'
-    command_options :use_prefix => false
+    command_options use_prefix: false
 
     banner <<-'BANNER'
       Clear the input buffer. Useful if the parsing process goes wrong and you get

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

@@ -4,6 +4,7 @@ class Pry
       attr_reader :ex
       attr_reader :opts
       attr_reader :_pry_
+      include Pry::Helpers::Text
 
       def initialize(exception, _pry_, opts)
         @ex = exception
@@ -27,16 +28,18 @@ class Pry
       end
 
       def backtrace_level
-        return @backtrace_level if @backtrace_level
-
-        bl =  if opts[:ex].nil?
+        @backtrace_level ||=
+          begin
+            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
+            increment_backtrace_level
+            bl
+          end
       end
 
       def increment_backtrace_level
@@ -65,13 +68,12 @@ class Pry
 
       def header
         unindent %{
-        #{Helpers::Text.bold 'Exception:'} #{ex.class}: #{ex.message}
+        #{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}).
+        #{bold('From:')} #{backtrace_file} @ line #{backtrace_line} @ #{bold("level: #{backtrace_level}")} of backtrace (of #{ex.backtrace.size - 1}).
 
       }
       end
-
     end
   end
 end

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

@@ -6,6 +6,8 @@ class Pry
       attr_reader :_pry_
 
       def initialize(file_with_embedded_line, _pry_, opts)
+        raise CommandError, "Must provide a filename, --in, or --ex." if !file_with_embedded_line
+
         @file_with_embedded_line = file_with_embedded_line
         @opts = opts
         @_pry_ = _pry_
@@ -13,8 +15,6 @@ class Pry
       end
 
       def format
-        raise CommandError, "Must provide a filename, --in, or --ex." if !file_with_embedded_line
-
         set_file_and_dir_locals(file_name, _pry_, _pry_.current_context)
         decorate(@code_from_file)
       end
@@ -40,7 +40,11 @@ class Pry
       end
 
       def decorate(content)
-        line_number ? super.around(line_number, code_window_size) : super
+        if line_number
+          super(content.around(line_number, code_window_size))
+        else
+          super
+        end
       end
 
       def code_type

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

@@ -36,7 +36,7 @@ class Pry
       end
 
       def normalized_expression_range
-        absolute_index_range(opts[:i], input_expressions.length)
+        absolute_index_range(opts[:i], input_expressions.count)
       end
     end
   end

data/lib/pry/commands/cat.rb

@@ -23,12 +23,12 @@ class Pry
     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 :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
+      opt.on :t, :type, "The file type for syntax highlighting (e.g., 'ruby' or 'python')", argument: true, as: Symbol
     end
 
     def process
@@ -36,7 +36,7 @@ class Pry
                when opts.present?(:ex)
                  ExceptionFormatter.new(_pry_.last_exception, _pry_, opts).format
                when opts.present?(:in)
-                 InputExpressionFormatter.new(_pry_.input_array, opts).format
+                 InputExpressionFormatter.new(_pry_.input_ring, opts).format
                else
                  FileFormatter.new(args.first, _pry_, opts).format
                end
@@ -52,6 +52,7 @@ class Pry
       $LOAD_PATH.flat_map do |path|
         Dir[path + '/**/*'].map { |f|
           next if File.directory?(f)
+
           f.sub!(path + '/', '')
         }
       end

data/lib/pry/commands/change_prompt.rb

@@ -4,23 +4,43 @@ class Pry::Command::ChangePrompt < Pry::ClassCommand
   description 'Change the current prompt.'
   command_options argument_required: true
   banner <<-BANNER
-    Usage: change-prompt NAME
+    Usage: change-prompt [OPTIONS] [NAME]
 
-    Change the current prompt. See list-prompts for a list of available
-    prompts.
+    Change the current prompt.
   BANNER
 
+  def options(opt)
+    opt.on(:l, :list, 'List the available prompts')
+  end
+
   def process(prompt)
-    if prompt_map.key?(prompt)
-      _pry_.prompt = prompt_map[prompt][:value]
+    if opts.present?(:l)
+      list_prompts
     else
-      raise Pry::CommandError, "'#{prompt}' isn't a known prompt!"
+      change_prompt(prompt)
     end
   end
 
-private
-  def prompt_map
-    Pry::Prompt::MAP
+  private
+
+  def list_prompts
+    prompts = Pry::Prompt.all.map do |name, prompt|
+      "#{bold(name)}#{red(' (selected)') if _pry_.prompt == prompt[:value]}\n" +
+        prompt[:description]
+    end
+    output.puts(prompts.join("\n"))
   end
+
+  def change_prompt(prompt)
+    if Pry::Prompt.all.key?(prompt)
+      _pry_.prompt = Pry::Prompt.all[prompt][:value]
+    else
+      raise(Pry::CommandError, <<MSG)
+'#{prompt}' isn't a known prompt. Run `change-prompt --list` to see
+the list of known prompts.
+MSG
+    end
+  end
+
   Pry::Commands.add_command(self)
 end