pry 0.8.4pre1-i386-mswin32 → 0.9.0-i386-mswin32

data/lib/pry/command_context.rb

@@ -4,25 +4,26 @@ class Pry
   class CommandContext
     attr_accessor :output
     attr_accessor :target
+    attr_accessor :captures
+    attr_accessor :eval_string
+    attr_accessor :arg_string
     attr_accessor :opts
     attr_accessor :command_set
     attr_accessor :command_processor
 
-    def run(name, *args)
-      if name.start_with? "."
-        cmd = name[1..-1]
-        command_processor.
-          execute_system_command([name, Shellwords.join(args)].join(' '),
-                                 target)
-      else
-        command_set.run_command(self, name, *args)
-      end
+    def run(command_string, *args)
+      complete_string = "#{command_string} #{args.join(" ")}"
+      command_processor.process_commands(complete_string, eval_string, target)
     end
 
     def commands
       command_set.commands
     end
 
+    def text
+      Pry::Helpers::Text
+    end
+
     include Pry::Helpers::BaseHelpers
     include Pry::Helpers::CommandHelpers
   end

data/lib/pry/command_processor.rb

@@ -2,9 +2,6 @@ require 'forwardable'
 
 class Pry
   class CommandProcessor
-    SYSTEM_COMMAND_DELIMITER = "."
-    SYSTEM_COMMAND_REGEX = /^#{Regexp.escape(SYSTEM_COMMAND_DELIMITER)}(.*)/
-
     extend Forwardable
 
     attr_accessor :pry_instance
@@ -15,32 +12,31 @@ class Pry
 
     def_delegators :@pry_instance, :commands, :nesting, :output
 
-    # Is the string a command valid?
+    # Is the string a valid command?
     # @param [String] val The string passed in from the Pry prompt.
+    # @param [Binding] target The context where the string should be
+    #   interpolated in.
     # @return [Boolean] Whether the string is a valid command.
-    def valid_command?(val)
-      system_command?(val) || pry_command?(val)
-    end
-
-    # Is the string a valid system command?
-    # @param [String] val The string passed in from the Pry prompt.
-    # @return [Boolean] Whether the string is a valid system command.
-    def system_command?(val)
-      !!(SYSTEM_COMMAND_REGEX =~ val)
+    def valid_command?(val, target=binding)
+      !!(command_matched(val, target)[0])
     end
 
-    # Is the string a valid pry command?
-    # A Pry command is a command that is not a system command.
-    # @param [String] val The string passed in from the Pry prompt.
-    # @return [Boolean] Whether the string is a valid Pry command.
-    def pry_command?(val)
-      !!command_matched(val).first
+    # Convert the object to a form that can be interpolated into a
+    # Regexp cleanly.
+    # @return [String] The string to interpolate into a Regexp
+    def convert_to_regex(obj)
+      case obj
+      when String
+        Regexp.escape(obj)
+      else
+        obj
+      end
     end
 
     # Revaluate the string (str) and perform interpolation.
     # @param [String] str The string to reevaluate with interpolation.
     # @param [Binding] target The context where the string should be
-    #   reevaluated in.
+    #   interpolated in.
     # @return [String] The reevaluated string with interpolations
     #   applied (if any).
     def interpolate_string(str, target)
@@ -49,52 +45,34 @@ class Pry
       target.eval(dumped_str)
     end
 
-    # Execute a given system command.
-    # The commands first have interpolation applied against the
-    # `target` context.
-    # All system command are forwarded to a shell. Note that the `cd`
-    # command is special-cased and is converted internallly to a `Dir.chdir`
-    # @param [String] val The system command to execute.
-    # @param [Binding] target The context in which to perform string interpolation.
-    def execute_system_command(val, target)
-      SYSTEM_COMMAND_REGEX  =~ val
-      cmd = interpolate_string($1, target)
-
-      if cmd =~ /^cd\s+(.+)/i
-        begin
-          @@cd_history ||= []
-          if $1 == "-"
-            dest = @@cd_history.pop || Dir.pwd
-          else
-            dest = File.expand_path($1)
-          end
-
-          @@cd_history << Dir.pwd
-          Dir.chdir(dest)
-        rescue Errno::ENOENT
-          output.puts "No such directory: #{dest}"
-        end
-      else
-        if !system(cmd)
-          output.puts "Error: there was a problem executing system command: #{cmd}"
-        end
-      end
-
-      # Tick, tock, im getting rid of this shit soon.
-      val.replace("")
-    end
-
     # Determine whether a Pry command was matched and return command data
     # and argument string.
     # This method should not need to be invoked directly.
     # @param [String] val The line of input.
+    # @param [Binding] target The binding to perform string
+    #   interpolation against.
     # @return [Array] The command data and arg string pair
-    def command_matched(val)
-      _, cmd_data = commands.commands.find do |name, cmd_data|
-        /^#{Regexp.escape(name)}(?!\S)(?:\s+(.+))?/ =~ val
+    def command_matched(val, target)
+      _, cmd_data = commands.commands.find do |name, data|
+
+        command_regex = /^#{convert_to_regex(name)}(?!\S)/
+
+        if data.options[:interpolate]
+          # If interpolation fails then the command cannot be matched,
+          # so early exit.
+          begin
+            interp_val = interpolate_string(val, target)
+          rescue NameError
+            next
+          end
+
+          val.replace interp_val if command_regex =~ interp_val
+        else
+          command_regex =~ val
+        end
       end
 
-      [cmd_data, $1]
+      [cmd_data, (Regexp.last_match ? Regexp.last_match.captures : nil), (Regexp.last_match ? Regexp.last_match.end(0) : nil)]
     end
 
     # Process Pry commands. Pry commands are not Ruby methods and are evaluated
@@ -107,30 +85,27 @@ class Pry
     #   multi-line input.
     # @param [Binding] target The receiver of the commands.
     def process_commands(val, eval_string, target)
-      def val.clear() replace("") end
-      def eval_string.clear() replace("") end
-
-      if system_command?(val)
-        execute_system_command(val, target)
-        return
-      end
 
       # no command was matched, so return to caller
-      return if !pry_command?(val)
+      command, captures, pos = command_matched(val, target)
+      return if !command
+      arg_string = val[pos..-1]
 
-      val.replace interpolate_string(val, target)
-      command, args_string = command_matched(val)
+      # remove the one leading space if it exists
+      arg_string.slice!(0) if arg_string.start_with?(" ")
 
-      args = args_string ? Shellwords.shellwords(args_string) : []
+      args = arg_string ? Shellwords.shellwords(arg_string) : []
 
       options = {
         :val => val,
+        :arg_string => arg_string,
         :eval_string => eval_string,
         :nesting => nesting,
-        :commands => commands.commands
+        :commands => commands.commands,
+        :captures => captures
       }
 
-      execute_command(target, command.name, options, *args)
+      execute_command(target, command.name, options, *(captures + args))
     end
 
     # Execute a Pry command.
@@ -146,6 +121,9 @@ class Pry
       context.opts        = options
       context.target      = target
       context.output      = output
+      context.captures    = options[:captures]
+      context.eval_string = options[:eval_string]
+      context.arg_string  = options[:arg_string]
       context.command_set = commands
 
       context.command_processor = self
@@ -153,7 +131,7 @@ class Pry
       ret = commands.run_command(context, command, *args)
 
       # Tick, tock, im getting rid of this shit soon.
-      options[:val].clear
+      options[:val].replace("")
 
       ret
     end

data/lib/pry/command_set.rb

@@ -5,7 +5,7 @@ class Pry
     end
   end
 
-  # This class used to create sets of commands. Commands can be impoted from
+  # This class is used to create sets of commands. Commands can be imported from
   # different sets, aliased, removed, etc.
   class CommandSet
     class Command < Struct.new(:name, :description, :options, :block)
@@ -26,23 +26,21 @@ class Pry
           args
         when 1, 0
           # Keep 1.8 happy
-          args.values_at *0..(arity - 1)
+          args.values_at 0..(arity - 1)
         end
       end
     end
 
+    include Enumerable
     include Pry::Helpers::BaseHelpers
 
     attr_reader :commands
-    attr_reader :name
     attr_reader :helper_module
 
-    # @param [Symbol] name Name of the command set
     # @param [Array<CommandSet>] imported_sets Sets which will be imported
     #   automatically
     # @yield Optional block run to define commands
-    def initialize(name, *imported_sets, &block)
-      @name          = name
+    def initialize(*imported_sets, &block)
       @commands      = {}
       @helper_module = Module.new
 
@@ -53,19 +51,29 @@ class Pry
     end
 
     # Defines a new Pry command.
-    # @param [String, Array] names The name of the command (or array of
-    #   command name aliases).
+    # @param [String, Regexp] name The name of the command. Can be
+    #   Regexp as well as String.
     # @param [String] description A description of the command.
     # @param [Hash] options The optional configuration parameters.
     # @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 regex based commands.
     # @yield The action to perform. The parameters in the block
     #   determines the parameters the command will receive. All
     #   parameters passed into the block will be strings. Successive
     #   command parameters are separated by whitespace at the Pry prompt.
     # @example
-    #   MyCommands = Pry::CommandSet.new :mine do
+    #   MyCommands = Pry::CommandSet.new do
     #     command "greet", "Greet somebody" do |name|
     #       puts "Good afternoon #{name.capitalize}!"
     #     end
@@ -77,25 +85,45 @@ class Pry
     #   # Good afternoon John!
     #   # pry(main)> help greet
     #   # Greet somebody
-    def command(names, description="No description.", options={}, &block)
-      first_name = Array(names).first
+    # @example Regexp command
+    #   MyCommands = Pry::CommandSet.new do
+    #     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)> number-10 john
+    #   # hello john, nice number: 10
+    #   # pry(main)> help number
+    #   # number-N regex command
+    def command(name, description="No description.", options={}, &block)
 
-      options = {:requires_gem => []}.merge(options)
+      options = {
+        :requires_gem => [],
+        :keep_retval => false,
+        :argument_required => false,
+        :interpolate => true,
+        :listing => name
+      }.merge!(options)
 
       unless command_dependencies_met? options
         gems_needed = Array(options[:requires_gem])
         gems_not_installed = gems_needed.select { |g| !gem_installed?(g) }
 
         options[:stub_info] = proc do
-          output.puts "\n#{first_name} requires the following gems to be installed: #{(gems_needed.join(", "))}"
-          output.puts "Command not available due to dependency on gems: `#{gems_not_installed.join(", ")}` not being met."
-          output.puts "Type `install #{first_name}` to install the required gems and activate this command."
+          output.puts "\nThe command '#{name}' is #{Helpers::Text.bold("unavailable")} because it requires the following gems to be installed: #{(gems_not_installed.join(", "))}"
+          output.puts "-"
+          output.puts "Type `install #{name}` to install the required gems and activate this command."
         end
       end
 
-      Array(names).each do |name|
-        commands[name] = Command.new(name, description, options, block)
-      end
+      commands[name] = Command.new(name, description, options, block)
+    end
+
+    def each &block
+      @commands.each(&block) 
     end
 
     # Removes some commands from the set
@@ -125,7 +153,7 @@ class Pry
     # Aliases a command
     # @param [String] new_name New name of the command.
     # @param [String] old_name Old name of the command.
-    # @pasam [String, nil] desc New description of the command.
+    # @param [String, nil] desc New description of the command.
     def alias_command(new_name, old_name, desc = nil)
       commands[new_name] = commands[old_name].dup
       commands[new_name].name = new_name
@@ -140,12 +168,17 @@ class Pry
     # @raise [NoCommandError] If the command is not defined in this set
     def run_command(context, name, *args)
       context.extend helper_module
+      command = commands[name]
 
-      if command = commands[name]
-        command.call(context, *args)
-      else
+      if command.nil?
         raise NoCommandError.new(name, self)
       end
+
+      if command.options[:argument_required] && args.empty?
+        puts "The command '#{command.name}' requires an argument."
+      else
+        command.call context, *args
+      end
     end
 
     # Sets the description for a command (replacing the old
@@ -153,7 +186,7 @@ class Pry
     # @param [String] name The command name.
     # @param [String] description The command description.
     # @example
-    #   MyCommands = Pry::CommandSet.new :test do
+    #   MyCommands = Pry::CommandSet.new do
     #     desc "help", "help description"
     #   end
     def desc(name, description)
@@ -176,8 +209,15 @@ class Pry
       helper_module.class_eval(&block)
     end
 
+
+    # @return [Array] The list of commands provided by the command set.
+    def list_commands
+      commands.keys
+    end
+
     private
     def define_default_commands
+
       command "help", "This menu." do |cmd|
         if !cmd
           output.puts
@@ -185,13 +225,13 @@ class Pry
 
           commands.each do |key, command|
             if command.description && !command.description.empty?
-              help_text << "#{key}".ljust(18) + command.description + "\n"
+              help_text << "#{command.options[:listing]}".ljust(18) + command.description + "\n"
             end
           end
 
           stagger_output(help_text)
         else
-          if command = commands[cmd]
+          if command = find_command(cmd)
             output.puts command.description
           else
             output.puts "No info for command: #{cmd}"
@@ -200,7 +240,8 @@ class Pry
       end
 
       command "install", "Install a disabled command." do |name|
-        stub_info = commands[name].options[:stub_info]
+        command = find_command(name)
+        stub_info = command.options[:stub_info]
 
         if !stub_info
           output.puts "Not a command stub. Nothing to do."
@@ -208,7 +249,7 @@ class Pry
         end
 
         output.puts "Attempting to install `#{name}` command..."
-        gems_to_install = Array(commands[name].options[:requires_gem])
+        gems_to_install = Array(command.options[:requires_gem])
 
         gem_install_failed = false
         gems_to_install.each do |g|
@@ -226,7 +267,17 @@ class Pry
         next if gem_install_failed
 
         Gem.refresh
-        commands[name].options.delete :stub_info
+        gems_to_install.each do |g|
+          begin
+            require g
+          rescue LoadError
+            output.puts "Required Gem: `#{g}` installed but not found?!. Aborting command installation."
+            gem_install_failed = true
+          end
+        end
+        next if gem_install_failed
+
+        command.options.delete :stub_info
         output.puts "Installation of `#{name}` successful! Type `help #{name}` for information"
       end
     end