pry 0.11.3 → 0.14.2

data/lib/pry/command.rb

@@ -1,20 +1,28 @@
+# frozen_string_literal: true
+
 require 'delegate'
-require 'pry/helpers/documentation_helpers'
+require 'shellwords'
 
 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.
+  # {Pry::CommandSet#command} which creates a BlockCommand or
+  # {Pry::CommandSet#create_command} which creates a ClassCommand. Please don't
+  # use this class directly.
   class Command
     extend Helpers::DocumentationHelpers
     extend CodeObject::Helpers
 
+    include Pry::Helpers::BaseHelpers
+    include Pry::Helpers::CommandHelpers
+    include Pry::Helpers::Text
+
     # represents a void return value for a command
     VOID_VALUE = Object.new
 
     # give it a nice inspect
-    def VOID_VALUE.inspect() "void" end
+    def VOID_VALUE.inspect
+      "void"
+    end
 
     # Properties of the command itself (as passed as arguments to
     # {CommandSet#command} or {CommandSet#create_command}).
@@ -24,7 +32,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,23 +42,23 @@ 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
       end
       # backward compatibility
-      alias_method :options, :command_options
-      alias_method :options=, :command_options=
+      alias options command_options
+      alias options= command_options=
 
       # Define or get the command's banner
-      def banner(arg=nil)
+      def banner(arg = nil)
         @banner = arg if arg
         @banner ||= description
       end
@@ -68,45 +76,28 @@ class Pry
         new.help
       end
 
-      def source_location
-        block.source_location
-      end
-
       def source_file
         Array(block.source_location).first
       end
-      alias_method :file, :source_file
+      alias file source_file
 
       def source_line
         Array(block.source_location).last
       end
-      alias_method :line, :source_line
+      alias line source_line
 
       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
+          keep_retval: false,
+          argument_required: false,
+          interpolate: true,
+          shellwords: true,
+          listing: (match.is_a?(String) ? 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
         super.to_s == "" ? "#<class(Pry::Command #{match.inspect})>" : super
       end
@@ -116,7 +107,7 @@ class Pry
       end
 
       def command_name
-        self.options[:listing]
+        options[:listing]
       end
 
       # Create a new command with the given properties.
@@ -161,26 +152,21 @@ class Pry
       # @return [Fixnum]
       def match_score(val)
         if command_regex =~ val
-          Regexp.last_match.size > 1 ? Regexp.last_match.begin(1) : Regexp.last_match.end(0)
+          if Regexp.last_match.size > 1
+            Regexp.last_match.begin(1)
+          else
+            Regexp.last_match.end(0)
+          end
         else
           -1
         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
-        Pry.hooks
-      end
-
       def command_regex
-        pr = Pry.respond_to?(:config) ? Pry.config.command_prefix : ""
-        prefix = convert_to_regex(pr)
+        prefix = convert_to_regex(Pry.config.command_prefix)
         prefix = "(?:#{prefix})?" unless options[:use_prefix]
 
-        /^#{prefix}#{convert_to_regex(match)}(?!\S)/
+        /\A#{prefix}#{convert_to_regex(match)}(?!\S)/
       end
 
       def convert_to_regex(obj)
@@ -196,22 +182,25 @@ 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)
-        @group ||= if name
-                     name
-                   else
-                     case Pry::Method(block).source_file
-                     when %r{/pry/.*_commands/(.*).rb}
-                       $1.capitalize.gsub(/_/, " ")
-                     when %r{(pry-\w+)-([\d\.]+([\w\.]+)?)}
-                       name, version = $1, $2
-                       "#{name.to_s} (v#{version.to_s})"
-                     when /pryrc/
-                       "~/.pryrc"
-                     else
-                       "(other)"
-                     end
-                   end
+      def group(name = nil)
+        @group ||= begin
+          name || case Pry::Method(block).source_file
+                  when %r{/pry/.*_commands/(.*).rb}
+                    Regexp.last_match(1).capitalize.tr('_', " ")
+                  when /(pry-\w+)-([\d\.]+([\w\.]+)?)/
+                    name = Regexp.last_match(1)
+                    version = Regexp.last_match(2)
+                    "#{name} (v#{version})"
+                  when /pryrc/
+                    "pryrc"
+                  else
+                    "(other)"
+                  end
+        end
+      end
+
+      def state
+        Pry::CommandState.default.state_for(match)
       end
     end
 
@@ -225,7 +214,8 @@ class Pry
     attr_accessor :context
     attr_accessor :command_set
     attr_accessor :hooks
-    attr_accessor :_pry_
+    attr_accessor :pry_instance
+    alias _pry_= pry_instance=
 
     # The block we pass *into* a command so long as `:takes_block` is
     # not equal to `false`
@@ -235,6 +225,47 @@ class Pry
     #   end
     attr_accessor :command_block
 
+    # Instantiate a command, in preparation for calling it.
+    # @param [Hash] context The runtime context to use with this command.
+    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_instance = context[:pry_instance]
+    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
+
     # Run a command from another command.
     # @param [String] command_string The string that invokes the command
     # @param [Array] args Further arguments to pass to the command
@@ -245,8 +276,8 @@ class Pry
     # @example
     #   run "amend-line",  "5", 'puts "hello world"'
     def run(command_string, *args)
-      command_string = _pry_.config.command_prefix.to_s + command_string
-      complete_string = "#{command_string} #{args.join(" ")}".rstrip
+      command_string = pry_instance.config.command_prefix.to_s + command_string
+      complete_string = "#{command_string} #{args.join(' ')}".rstrip
       command_set.process_line(complete_string, context)
     end
 
@@ -254,31 +285,19 @@ class Pry
       command_set.to_hash
     end
 
-    def text
-      Pry::Helpers::Text
-    end
-
     def void
       VOID_VALUE
     end
 
-    include Pry::Helpers::BaseHelpers
-    include Pry::Helpers::CommandHelpers
-
-    # Instantiate a command, in preparation for calling it.
-    # @param [Hash] context The runtime context to use with this command.
-    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]
+    def _pry_
+      Pry::Warning.warn('_pry_ is deprecated, use pry_instance instead')
+      pry_instance
     end
 
     # @return [Object] The value of `self` inside the `target` binding.
-    def target_self; target.eval('self'); end
+    def target_self
+      target.eval('self')
+    end
 
     # @return [Hash] Pry commands can store arbitrary state
     #   here. This state persists between subsequent command invocations.
@@ -288,7 +307,7 @@ class Pry
     #   state.my_state = "my state"  # this will not conflict with any
     #                                # `state.my_state` used in another command.
     def state
-      _pry_.command_state[match] ||= Pry::Config.from_hash({})
+      self.class.state
     end
 
     # Revaluate the string (str) and perform interpolation.
@@ -309,12 +328,15 @@ class Pry
     # the current scope.
     def check_for_command_collision(command_match, arg_string)
       collision_type = target.eval("defined?(#{command_match})")
-      collision_type ||= 'local-variable' if arg_string.match(%r{\A\s*[-+*/%&|^]*=})
+      collision_type ||= 'local-variable' if arg_string =~ %r{\A\s*[-+*/%&|^]*=}
 
       if collision_type
-        output.puts "#{text.bold('WARNING:')} Calling Pry command '#{command_match}', which conflicts with a #{collision_type}.\n\n"
+        output.puts(
+          "#{Helpers::Text.bold('WARNING:')} Calling Pry command '#{command_match}', " \
+          "which conflicts with a #{collision_type}.\n\n"
+        )
       end
-    rescue Pry::RescuableException
+    rescue Pry::RescuableException # rubocop:disable Lint/HandleExceptions
     end
 
     # Extract necessary information from a line that Command.matches? this
@@ -332,12 +354,15 @@ class Pry
     # @param [String] val The line of input
     # @return [Array]
     def tokenize(val)
-      val.replace(interpolate_string(val)) if command_options[:interpolate]
+      val = interpolate_string(val) if command_options[:interpolate]
 
       self.class.command_regex =~ val
 
       # please call Command.matches? before Command#call_safely
-      raise CommandError, "fatal: called a command which didn't match?!" unless Regexp.last_match
+      unless Regexp.last_match
+        raise CommandError, "fatal: called a command which didn't match?!"
+      end
+
       captures = Regexp.last_match.captures
       pos = Regexp.last_match.end(0)
 
@@ -349,11 +374,16 @@ class Pry
       # process and pass a block if one is found
       pass_block(arg_string) if command_options[:takes_block]
 
-      if arg_string
-        args = command_options[:shellwords] ? Shellwords.shellwords(arg_string) : arg_string.split(" ")
-      else
-        args = []
-      end
+      args =
+        if arg_string
+          if command_options[:shellwords]
+            Shellwords.shellwords(arg_string)
+          else
+            arg_string.split(" ")
+          end
+        else
+          []
+        end
 
       [val[0..pos].rstrip, arg_string, captures, args]
     end
@@ -364,7 +394,9 @@ class Pry
     def process_line(line)
       command_match, arg_string, captures, args = tokenize(line)
 
-      check_for_command_collision(command_match, arg_string) if Pry.config.collision_warning
+      if Pry.config.collision_warning
+        check_for_command_collision(command_match, arg_string)
+      end
 
       self.arg_string = arg_string
       self.captures = captures
@@ -372,38 +404,15 @@ class Pry
       call_safely(*(captures + args))
     end
 
-    # Pass a block argument to a command.
-    # @param [String] arg_string The arguments (as a string) passed to the command.
-    #   We inspect these for a '| do' or a '| {' and if we find it we use it
-    #   to start a block input sequence. Once we have a complete
-    #   block, we save it to an accessor that can be retrieved from the command context.
-    #   Note that if we find the '| do' or '| {' we delete this and the
-    #   elements following it from `arg_string`.
-    def pass_block(arg_string)
-      # Workaround for weird JRuby bug where rindex in this case can return nil
-      # even when there's a match.
-      arg_string.scan(/\| *(?:do|\{)/)
-      block_index = $~ && $~.offset(0)[0]
-
-      return if !block_index
-
-      block_init_string = arg_string.slice!(block_index..-1)[1..-1]
-      prime_string = "proc #{block_init_string}\n"
-
-      if !Pry::Code.complete_expression?(prime_string)
-        block_string = _pry_.r(target, prime_string)
-      else
-        block_string = prime_string
-      end
-
-      begin
-        self.command_block = target.eval(block_string)
-      rescue Pry::RescuableException
-        raise CommandError, "Incomplete block definition."
-      end
+    # Generate completions for this command
+    #
+    # @param [String] _search The line typed so far
+    # @return [Array<String>]  Completion words
+    def complete(_search)
+      []
     end
 
-    private :pass_block
+    private
 
     # Run the command with the given `args`.
     #
@@ -414,15 +423,6 @@ class Pry
     # @return [Object] The return value of the `#call` method, or
     #   {Command::VOID_VALUE}.
     def call_safely(*args)
-      unless dependencies_met?
-        gems_needed = Array(command_options[:requires_gem])
-        gems_not_installed = gems_needed.select { |g| !Rubygem.installed?(g) }
-        output.puts "\nThe command '#{command_name}' is #{text.bold("unavailable")} because it requires the following gems to be installed: #{(gems_not_installed.join(", "))}"
-        output.puts "-"
-        output.puts "Type `install-command #{command_name}` to install the required gems and activate this command."
-        return void
-      end
-
       if command_options[:argument_required] && args.empty?
         raise CommandError, "The command '#{command_name}' requires an argument."
       end
@@ -441,26 +441,41 @@ class Pry
       Symbol.instance_eval { define_method(:call, call_method) } if call_method
     end
 
-    # Are all the gems required to use this command installed?
-    #
-    # @return  Boolean
-    def dependencies_met?
-      @dependencies_met ||= command_dependencies_met?(command_options)
-    end
+    # Pass a block argument to a command.
+    # @param [String] arg_string The arguments (as a string) passed to the command.
+    #   We inspect these for a '| do' or a '| {' and if we find it we use it
+    #   to start a block input sequence. Once we have a complete
+    #   block, we save it to an accessor that can be retrieved from the command context.
+    #   Note that if we find the '| do' or '| {' we delete this and the
+    #   elements following it from `arg_string`.
+    def pass_block(arg_string)
+      # Workaround for weird JRuby bug where rindex in this case can return nil
+      # even when there's a match.
+      arg_string.scan(/\| *(?:do|\{)/)
+      block_index = $LAST_MATCH_INFO && $LAST_MATCH_INFO.offset(0)[0]
 
-    # Generate completions for this command
-    #
-    # @param [String] search  The line typed so far
-    # @return [Array<String>]  Completion words
-    def complete(search)
-      []
-    end
+      return unless block_index
 
-    private
+      block_init_string = arg_string.slice!(block_index..-1)[1..-1]
+      prime_string = "proc #{block_init_string}\n"
+
+      block_string =
+        if !Pry::Code.complete_expression?(prime_string)
+          pry_instance.r(target, prime_string)
+        else
+          prime_string
+        end
+
+      begin
+        self.command_block = target.eval(block_string)
+      rescue Pry::RescuableException
+        raise CommandError, "Incomplete block definition."
+      end
+    end
 
     def find_hooks(event)
       event_name = "#{event}_#{command_name}"
-      (self.hooks || self.class.hooks).get_hooks(event_name).values
+      (hooks || Pry.hooks || self.class.hooks).get_hooks(event_name).values
     end
 
     def before_hooks
@@ -486,231 +501,20 @@ class Pry
       ret
     end
 
-    # Fix the number of arguments we pass to a block to avoid arity warnings.
-    # @param [Fixnum] arity The arity of the block
-    # @param [Array] args The arguments to pass
-    # @return [Array] A (possibly shorter) array of the arguments to pass
-    def correct_arg_arity(arity, args)
-      case
-      when arity < 0
+    # Normalize method arguments according to its arity.
+    #
+    # @param [Integer] method
+    # @param [Array] args
+    # @return [Array] a (possibly shorter) array of the arguments to pass
+    def normalize_method_args(method, args)
+      case method.arity
+      when -1
         args
-      when arity == 0
+      when 0
         []
-      when arity > 0
-        args.values_at(*(0..(arity - 1)).to_a)
-      end
-    end
-  end
-
-  # A super-class for Commands that are created with a single block.
-  #
-  # This class ensures that the block is called with the correct number of arguments
-  # and the right context.
-  #
-  # Create subclasses using {Pry::CommandSet#command}.
-  class BlockCommand < Command
-    # backwards compatibility
-    alias_method :opts, :context
-
-    # Call the block that was registered with this command.
-    # @param [Array<String>] args The arguments passed
-    # @return [Object] The return value of the block
-    def call(*args)
-      instance_exec(*correct_arg_arity(block.arity, args), &block)
-    end
-
-    def help
-      "#{command_options[:listing].to_s.ljust(18)} #{description}"
-    end
-  end
-
-  # A super-class of Commands with structure.
-  #
-  # This class implements the bare-minimum functionality that a command should
-  # have, namely a --help switch, and then delegates actual processing to its
-  # subclasses.
-  #
-  # Create subclasses using {Pry::CommandSet#create_command}, and override the
-  # `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.command_options options
-      end
-
-      def source
-        source_object.source
-      end
-
-      def doc
-        new.help
-      end
-
-      def source_location
-        source_object.source_location
-      end
-
-      def source_file
-        source_object.source_file
-      end
-      alias_method :file, :source_file
-
-      def source_line
-        source_object.source_line
-      end
-      alias_method :line, :source_line
-
-      private
-
-      # The object used to extract the source for the command.
-      #
-      # This should be a `Pry::Method(block)` for a command made with `create_command`
-      # and a `Pry::WrappedModule(self)` for a command that's a standard class.
-      # @return [Pry::WrappedModule, Pry::Method]
-      def source_object
-        @source_object ||= if name =~ /^[A-Z]/
-                             Pry::WrappedModule(self)
-                           else
-                             Pry::Method(block)
-                           end
-      end
-    end
-
-    attr_accessor :opts
-    attr_accessor :args
-
-    # Set up `opts` and `args`, and then call `process`.
-    #
-    # This method will display help if necessary.
-    #
-    # @param [Array<String>] args The arguments passed
-    # @return [Object] The return value of `process` or VOID_VALUE
-    def call(*args)
-      setup
-
-      self.opts = slop
-      self.args = self.opts.parse!(args)
-
-      if opts.present?(:help)
-        output.puts slop.help
-        void
       else
-        process(*correct_arg_arity(method(:process).arity, args))
-      end
-    end
-
-    # Return the help generated by Pry::Slop for this command.
-    def help
-      slop.help
-    end
-
-    # Return an instance of Pry::Slop that can parse either subcommands or the
-    # options that this command accepts.
-    def slop
-      Pry::Slop.new do |opt|
-        opt.banner(unindent(self.class.banner))
-        subcommands(opt)
-        options(opt)
-        opt.on :h, :help, 'Show this message.'
+        args.values_at(*(0..(method.arity - 1)).to_a)
       end
     end
-
-    # Generate shell completions
-    # @param [String] search  The line typed so far
-    # @return [Array<String>]  the words to complete
-    def complete(search)
-      slop.flat_map do |opt|
-        [opt.long && "--#{opt.long} " || opt.short && "-#{opt.short}"]
-      end.compact + super
-    end
-
-    # A method called just before `options(opt)` as part of `call`.
-    #
-    # This method can be used to set up any context your command needs to run,
-    # for example requiring gems, or setting default values for options.
-    #
-    # @example
-    #   def setup
-    #     require 'gist'
-    #     @action = :method
-    #   end
-    def setup; end
-
-    # 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.
-    #
-    # @example A minimal example
-    #   def subcommands(cmd)
-    #     cmd.command :download do |opt|
-    #       description 'Downloads a content from a server'
-    #
-    #       opt.on :verbose, 'Use verbose output'
-    #
-    #       run do |options, arguments|
-    #         ContentDownloader.download(options, arguments)
-    #       end
-    #     end
-    #   end
-    #
-    # @example Define the invokation block anywhere you want
-    #   def subcommands(cmd)
-    #     cmd.command :download do |opt|
-    #       description 'Downloads a content from a server'
-    #
-    #       opt.on :verbose, 'Use verbose output'
-    #     end
-    #   end
-    #
-    #   def process
-    #     # Perform calculations...
-    #     opts.fetch_command(:download).run do |options, arguments|
-    #       ContentDownloader.download(options, arguments)
-    #     end
-    #     # More calculations...
-    #   end
-    def subcommands(cmd); end
-
-    # 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.
-    # If you need to set up default values, use `setup` instead.
-    #
-    # @example
-    #  def options(opt)
-    #    opt.banner "Gists methods or classes"
-    #    opt.on(:c, :class, "gist a class") do
-    #      @action = :class
-    #    end
-    #  end
-    def options(opt); end
-
-    # The actual body of your command should go here.
-    #
-    # 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
-    # created with `:keep_retval => true`, in which case it is returned to the
-    # repl.
-    #
-    # @example
-    #   def process
-    #     if opts.present?(:class)
-    #       gist_class
-    #     else
-    #       gist_method
-    #     end
-    #   end
-    def process; raise CommandError, "command '#{command_name}' not implemented" end
   end
 end