pry 0.12.0 → 0.14.0

data/lib/pry/command_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Pry
   class NoCommandError < StandardError
     def initialize(match, owner)
@@ -29,16 +31,12 @@ class Pry
     # @option options [Boolean] :keep_retval Whether or not to use return value
     #   of the block for return of `command` or just to return `nil`
     #   (the default).
-    # @option options [Array<String>] :requires_gem Whether the command has
-    #   any gem dependencies, if it does and dependencies not met then
-    #   command is disabled and a stub proc giving instructions to
-    #   install command is provided.
     # @option options [Boolean] :interpolate Whether string #{} based
     #   interpolation is applied to the command arguments before
     #   executing the command. Defaults to true.
     # @option options [String] :listing The listing name of the
     #   command. That is the name by which the command is looked up by
-    #   help and by show-command. Necessary for commands with regex matches.
+    #   help and by show-source. Necessary for commands with regex matches.
     # @option options [Boolean] :use_prefix Whether the command uses
     #   `Pry.config.command_prefix` prefix (if one is defined). Defaults
     #   to true.
@@ -57,31 +55,38 @@ class Pry
     #   end
     #
     #   # From pry:
-    #   # pry(main)> _pry_.commands = MyCommands
+    #   # pry(main)> pry_instance.commands = MyCommands
     #   # pry(main)> greet john
     #   # Good afternoon John!
     #   # pry(main)> help greet
     #   # Greet somebody
     # @example Regexp command
     #   MyCommands = Pry::CommandSet.new do
-    #     command /number-(\d+)/, "number-N regex command", :listing => "number" do |num, name|
+    #     command(
+    #       /number-(\d+)/, "number-N regex command", :listing => "number"
+    #     ) do |num, name|
     #       puts "hello #{name}, nice number: #{num}"
     #     end
     #   end
     #
     #   # From pry:
-    #   # pry(main)> _pry_.commands = MyCommands
+    #   # pry(main)> pry_instance.commands = MyCommands
     #   # pry(main)> number-10 john
     #   # hello john, nice number: 10
     #   # pry(main)> help number
     #   # number-N regex command
     def block_command(match, description = "No description.", options = {}, &block)
-      description, options = ["No description.", description] if description.is_a?(Hash)
+      if description.is_a?(Hash)
+        options = description
+        description = "No description."
+      end
       options = Pry::Command.default_options(match).merge!(options)
 
-      @commands[match] = Pry::BlockCommand.subclass(match, description, options, helper_module, &block)
+      @commands[match] = Pry::BlockCommand.subclass(
+        match, description, options, helper_module, &block
+      )
     end
-    alias_method :command, :block_command
+    alias command block_command
 
     # Defines a new Pry command class.
     #
@@ -99,7 +104,9 @@ class Pry
     #     end
     #
     #     def process
-    #       raise Pry::CommandError, "-u and -d makes no sense" if opts.present?(:u) && opts.present?(:d)
+    #       if opts.present?(:u) && opts.present?(:d)
+    #         raise Pry::CommandError, "-u and -d makes no sense"
+    #       end
     #       result = args.join(" ")
     #       result.downcase! if opts.present?(:downcase)
     #       result.upcase! if opts.present?(:upcase)
@@ -108,10 +115,15 @@ class Pry
     #   end
     #
     def create_command(match, description = "No description.", options = {}, &block)
-      description, options = ["No description.", description] if description.is_a?(Hash)
+      if description.is_a?(Hash)
+        options = description
+        description = "No description."
+      end
       options = Pry::Command.default_options(match).merge!(options)
 
-      @commands[match] = Pry::ClassCommand.subclass(match, description, options, helper_module, &block)
+      @commands[match] = Pry::ClassCommand.subclass(
+        match, description, options, helper_module, &block
+      )
       @commands[match].class_eval(&block)
       @commands[match]
     end
@@ -121,7 +133,8 @@ class Pry
     end
 
     # Removes some commands from the set
-    # @param [Array<String>] searches the matches or listings of the commands to remove
+    # @param [Array<String>] searches the matches or listings of the commands
+    #   to remove
     def delete(*searches)
       searches.each do |search|
         cmd = find_command_by_match_or_listing(search)
@@ -160,7 +173,7 @@ class Pry
     def find_command_by_match_or_listing(match_or_listing)
       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}'!"
+      cmd || raise(ArgumentError, "cannot find a command: '#{match_or_listing}'")
     end
 
     # Aliases a command
@@ -175,13 +188,13 @@ class Pry
     # @example Pass explicit description (overriding default).
     #   Pry.config.commands.alias_command "lM", "ls -M", :desc => "cutiepie"
     def alias_command(match, action, options = {})
-      cmd = find_command(action) or fail "Command: `#{action}` not found"
+      (cmd = find_command(action)) || raise("command: '#{action}' not found")
       original_options = cmd.options.dup
 
-      options = original_options.merge!({
-                                          desc: "Alias for `#{action}`",
-                                          listing: match
-                                        }).merge!(options)
+      options = original_options.merge!(
+        desc: "Alias for `#{action}`",
+        listing: match.is_a?(String) ? match : match.inspect
+      ).merge!(options)
 
       # ensure default description is used if desc is nil
       desc = options.delete(:desc).to_s
@@ -190,6 +203,7 @@ class Pry
         run action, *args
       end
 
+      # TODO: untested. What's this about?
       c.class_eval do
         define_method(:complete) do |input|
           cmd.new(context).complete(input)
@@ -225,17 +239,6 @@ class Pry
       @commands.delete(cmd.match)
     end
 
-    def disabled_command(name_of_disabled_command, message, matcher = name_of_disabled_command)
-      create_command name_of_disabled_command do
-        match matcher
-        description ""
-
-        define_method(:process) do
-          output.puts "DISABLED: #{message}"
-        end
-      end
-    end
-
     # Sets or gets the description for a command (replacing the old
     # description). Returns current description if no description
     # parameter provided.
@@ -249,50 +252,33 @@ class Pry
     #   Pry.config.commands.desc "amend-line"
     def desc(search, description = nil)
       cmd = find_command_by_match_or_listing(search)
-      return cmd.description if !description
+      return cmd.description unless description
 
       cmd.description = description
     end
 
-    # Defines helpers methods for this command sets.
-    # Those helpers are only defined in this command set.
-    #
-    # @yield A block defining helper methods
-    # @example
-    #   helpers do
-    #     def hello
-    #       puts "Hello!"
-    #     end
-    #
-    #     include OtherModule
-    #   end
-    def helpers(&block)
-      helper_module.class_eval(&block)
-    end
-
     # @return [Array]
     #   The list of commands provided by the command set.
     def list_commands
       @commands.keys
     end
-    alias_method :keys, :list_commands
+    alias keys list_commands
 
     def to_hash
       @commands.dup
     end
-    alias_method :to_h, :to_hash
+    alias to_h to_hash
 
     # Find a command that matches the given line
     # @param [String] pattern The line that might be a command invocation
     # @return [Pry::Command, nil]
     def [](pattern)
-      @commands.values.select do |command|
+      commands = @commands.values.select do |command|
         command.matches?(pattern)
-      end.sort_by do |command|
-        command.match_score(pattern)
-      end.last
+      end
+      commands.max_by { |command| command.match_score(pattern) }
     end
-    alias_method :find_command, :[]
+    alias find_command []
 
     #
     # Re-assign the command found at _pattern_ with _command_.
@@ -311,9 +297,11 @@ class Pry
     #
     def []=(pattern, command)
       if command.equal?(nil)
-        return @commands.delete(pattern)
+        @commands.delete(pattern)
+        return
       end
-      unless Class === command && command < Pry::Command
+
+      unless command.is_a?(Class) && command < Pry::Command
         raise TypeError, "command is not a subclass of Pry::Command"
       end
 
@@ -341,11 +329,12 @@ class Pry
     # @param [String] search The user's search.
     # @return [Pry::Command?]
     def find_command_for_help(search)
-      find_command(search) || (begin
-        find_command_by_match_or_listing(search)
-      rescue ArgumentError
-        nil
-      end)
+      find_command(search) ||
+        (begin
+           find_command_by_match_or_listing(search)
+         rescue ArgumentError
+           nil
+         end)
     end
 
     # Is the given line a command invocation?
@@ -369,12 +358,6 @@ class Pry
       end
     end
 
-    # @private (used for testing)
-    def run_command(context, match, *args)
-      command = @commands[match] or raise NoCommandError.new(match, self)
-      command.new(context).call_safely(*args)
-    end
-
     # 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
@@ -383,11 +366,30 @@ class Pry
       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 + " " }
+        keys = @commands.keys.select do |key|
+          key.is_a?(String) && key.start_with?(search)
+        end
+        keys.map { |key| key + " " }
       end
     end
+
+    private
+
+    # Defines helpers methods for this command sets.
+    # Those helpers are only defined in this command set.
+    #
+    # @yield A block defining helper methods
+    # @example
+    #   helpers do
+    #     def hello
+    #       puts "Hello!"
+    #     end
+    #
+    #     include OtherModule
+    #   end
+    def helpers(&block)
+      helper_module.class_eval(&block)
+    end
   end
 
   # Wraps the return result of process_commands, indicates if the
@@ -396,7 +398,8 @@ class Pry
     attr_reader :retval
 
     def initialize(is_command, retval = nil)
-      @is_command, @retval = is_command, retval
+      @is_command = is_command
+      @retval = retval
     end
 
     # Is the result a command?

data/lib/pry/command_state.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+class Pry
+  # CommandState is a data structure to hold per-command state.
+  #
+  # Pry commands can store arbitrary state here. This state persists between
+  # subsequent command invocations. All state saved here is unique to the
+  # command.
+  #
+  # @since v0.13.0
+  # @api private
+  class CommandState
+    def self.default
+      @default ||= new
+    end
+
+    def initialize
+      @command_state = {}
+    end
+
+    def state_for(command_name)
+      @command_state[command_name] ||= OpenStruct.new
+    end
+
+    def reset(command_name)
+      @command_state[command_name] = OpenStruct.new
+    end
+  end
+end

data/lib/pry/commands/amend_line.rb

@@ -1,98 +1,103 @@
+# frozen_string_literal: true
+
 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(amend_input)
-      run "fix-indent"
-      run "show-input"
-    end
+  class Command
+    class 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(amend_input)
+        run "fix-indent"
+        run "show-input"
+      end
 
-    private
+      private
 
-    # @return [String] A new string with the amendments applied to it.
-    def amend_input
-      input_array = eval_string.each_line.to_a
+      # @return [String] A new string with the amendments applied to it.
+      def amend_input
+        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
+        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
+        input_array.join
+      end
 
-    def delete_from_array(array, range)
-      array.slice!(range)
-    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 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
+      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
+      # @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
+      # 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
+        [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
+      # 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
+      # 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
-  end
 
-  Pry::Commands.add_command(Pry::Command::AmendLine)
+    Pry::Commands.add_command(Pry::Command::AmendLine)
+  end
 end