pry 0.8.4pre1 → 0.9.0pre1

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

data/lib/pry/commands.rb

@@ -1,3 +1,4 @@
+require "pry/default_commands/basic"
 require "pry/default_commands/documentation"
 require "pry/default_commands/gems"
 require "pry/default_commands/context"
@@ -6,135 +7,23 @@ require "pry/default_commands/shell"
 require "pry/default_commands/introspection"
 require "pry/default_commands/easter_eggs"
 
+require "pry/extended_commands/user_command_api"
+require "pry/extended_commands/experimental"
+
 class Pry
 
   # Default commands used by Pry.
-  Commands = Pry::CommandSet.new :default do
+  Commands = Pry::CommandSet.new do
+    import DefaultCommands::Basic
     import DefaultCommands::Documentation
     import DefaultCommands::Gems
     import DefaultCommands::Context
-    import DefaultCommands::Input, DefaultCommands::Shell
+    import DefaultCommands::Input
+    import DefaultCommands::Shell
     import DefaultCommands::Introspection
     import DefaultCommands::EasterEggs
 
-    Helpers::CommandHelpers.try_to_load_pry_doc
-
-    command "toggle-color", "Toggle syntax highlighting." do
-      Pry.color = !Pry.color
-      output.puts "Syntax highlighting #{Pry.color ? "on" : "off"}"
-    end
-
-    command "simple-prompt", "Toggle the simple prompt." do
-      case Pry.active_instance.prompt
-      when Pry::SIMPLE_PROMPT
-        Pry.active_instance.prompt = Pry::DEFAULT_PROMPT
-      else
-        Pry.active_instance.prompt = Pry::SIMPLE_PROMPT
-      end
-    end
-
-    command "status", "Show status information." do
-      nesting = opts[:nesting]
-
-      output.puts "Status:"
-      output.puts "--"
-      output.puts "Receiver: #{Pry.view_clip(target.eval('self'))}"
-      output.puts "Nesting level: #{nesting.level}"
-      output.puts "Pry version: #{Pry::VERSION}"
-      output.puts "Ruby version: #{RUBY_VERSION}"
-
-      mn = meth_name_from_binding(target)
-      output.puts "Current method: #{mn ? mn : "N/A"}"
-      output.puts "Pry instance: #{Pry.active_instance}"
-      output.puts "Last result: #{Pry.view(Pry.last_result)}"
-    end
-
-
-    command "req", "Requires gem(s). No need for quotes! (If the gem isn't installed, it will ask if you want to install it.)" do |*gems|
-      gems = gems.join(' ').gsub(',', '').split(/\s+/)
-      gems.each do |gem|
-        begin
-          if require gem
-            output.puts "#{bright_yellow(gem)} loaded"
-          else
-            output.puts "#{bright_white(gem)} already loaded"
-          end
-
-        rescue LoadError => e
-
-          if gem_installed? gem
-            output.puts e.inspect
-          else
-            output.puts "#{bright_red(gem)} not found"
-            if prompt("Install the gem?") == "y"
-              run "gem-install", gem
-            end
-          end
-
-        end # rescue
-      end # gems.each
-    end
-
-    command "version", "Show Pry version." do
-      output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
-    end
+#    Helpers::CommandHelpers.try_to_load_pry_doc
 
-
-    command "lls", "List local files using 'ls'" do |*args|
-      cmd = ".ls"
-      run cmd, *args
-    end
-
-    command "lcd", "Change the current (working) directory" do |*args|
-      run ".cd", *args
-    end
-
-
-    command "eval-file", "Eval a Ruby script. Type `eval-file --help` for more info." do |*args|
-      options = {}
-      target = target()
-      file_name = nil
-
-      OptionParser.new do |opts|
-        opts.banner = %{Usage: eval-file [OPTIONS] FILE
-Eval a Ruby script at top-level or in the specified context. Defaults to top-level.
-e.g: eval-file -c self "hello.rb"
---
-}
-        opts.on("-c", "--context CONTEXT", "Eval the script in the specified context.") do |context|
-          options[:c] = true
-          target = Pry.binding_for(target.eval(context))
-        end
-
-        opts.on_tail("-h", "--help", "This message.") do
-          output.puts opts
-          options[:h] = true
-        end
-      end.order(args) do |v|
-        file_name = v
-      end
-
-      next if options[:h]
-
-      if !file_name
-        output.puts "You need to specify a file name. Type `eval-file --help` for help"
-        next
-      end
-
-      old_constants = Object.constants
-      if options[:c]
-        target_self = target.eval('self')
-        target.eval(File.read(File.expand_path(file_name)))
-        output.puts "--\nEval'd '#{file_name}' in the `#{target_self}`  context."
-      else
-        TOPLEVEL_BINDING.eval(File.read(File.expand_path(file_name)))
-        output.puts "--\nEval'd '#{file_name}' at top-level."
-      end
-      set_file_and_dir_locals(file_name)
-
-      new_constants = Object.constants - old_constants
-      output.puts "Brought in the following top-level constants: #{new_constants.inspect}" if !new_constants.empty?
-    end
-
-end
+  end
 end

data/lib/pry/completion.rb

@@ -14,28 +14,29 @@ class Pry
     Readline.completion_append_character = nil
 
     ReservedWords = [
-                     "BEGIN", "END",
-                     "alias", "and",
-                     "begin", "break",
-                     "case", "class",
-                     "def", "defined", "do",
-                     "else", "elsif", "end", "ensure",
-                     "false", "for",
-                     "if", "in",
-                     "module",
-                     "next", "nil", "not",
-                     "or",
-                     "redo", "rescue", "retry", "return",
-                     "self", "super",
-                     "then", "true",
-                     "undef", "unless", "until",
-                     "when", "while",
-                     "yield",
-                    ]
-
-    Operators = ["%", "&", "*", "**", "+",  "-",  "/",
-                 "<", "<<", "<=", "<=>", "==", "===", "=~", ">", ">=", ">>",
-                 "[]", "[]=", "^", "!", "!=", "!~"]
+      "BEGIN", "END",
+      "alias", "and",
+      "begin", "break",
+      "case", "class",
+      "def", "defined", "do",
+      "else", "elsif", "end", "ensure",
+      "false", "for",
+      "if", "in",
+      "module",
+      "next", "nil", "not",
+      "or",
+      "redo", "rescue", "retry", "return",
+      "self", "super",
+      "then", "true",
+      "undef", "unless", "until",
+      "when", "while",
+      "yield" ]
+
+    Operators = [
+      "%", "&", "*", "**", "+",  "-",  "/",
+      "<", "<<", "<=", "<=>", "==", "===", "=~", ">", ">=", ">>",
+      "[]", "[]=", "^", "!", "!=", "!~"
+    ]
 
     # Return a new completion proc for use by Readline.
     # @param [Binding] target The current binding context.
@@ -188,13 +189,13 @@ class Pry
 
     def self.select_message(receiver, message, candidates)
       candidates.grep(/^#{message}/).collect do |e|
-	case e
-	when /^[a-zA-Z_]/
-	  receiver + "." + e
-	when /^[0-9]/
-	when *Operators
-	  #receiver + " " + e
-	end
+      	case e
+      	when /^[a-zA-Z_]/
+      	  receiver + "." + e
+      	when /^[0-9]/
+      	when *Operators
+      	  #receiver + " " + e
+      	end
       end
     end
   end

data/lib/pry/config.rb

@@ -0,0 +1,93 @@
+require 'ostruct'
+
+class Pry
+  class Config < OpenStruct
+
+    # Get/Set the object to use for input by default by all Pry instances.
+    # @return [#readline] The object to use for input by default by all
+    #   Pry instances.
+    attr_accessor :input
+
+    # Get/Set the object to use for output by default by all Pry instances.
+    # @return [#puts] The object to use for output by default by all
+    #   Pry instances.
+    attr_accessor :output
+
+    # Get/Set the object to use for commands by default by all Pry instances.
+    # @return [Pry::CommandBase] The object to use for commands by default by all
+    #   Pry instances.
+    attr_accessor :commands
+
+    # Get/Set the Proc to use for printing by default by all Pry
+    # instances.
+    # This is the 'print' component of the REPL.
+    # @return [Proc] The Proc to use for printing by default by all
+    #   Pry instances.
+    attr_accessor :print
+
+    # @return [Proc] The Proc to use for printing exceptions by default by all
+    #   Pry instances.
+    attr_accessor :exception_handler
+
+    # Get/Set the Hash that defines Pry hooks used by default by all Pry
+    # instances.
+    # @return [Hash] The hooks used by default by all Pry instances.
+    # @example
+    #   Pry.hooks :before_session => proc { puts "hello" },
+    #     :after_session => proc { puts "goodbye" }
+    attr_accessor :hooks
+
+    # Get the array of Procs to be used for the prompts by default by
+    # all Pry instances.
+    # @return [Array<Proc>] The array of Procs to be used for the
+    #   prompts by default by all Pry instances.
+    attr_accessor :prompt
+
+    # The default editor to use. Defaults to $EDITOR or nano if
+    # $EDITOR is not defined.
+    # If `editor` is a String then that string is used as the shell
+    # command to invoke the editor. If `editor` is callable (e.g a
+    # Proc) then `file` and `line` are passed in as parameters and the
+    # return value of that callable invocation is used as the exact
+    # shell command to invoke the editor.
+    # @example String
+    #   Pry.editor = "emacsclient"
+    # @example Callable
+    #   Pry.editor = proc { |file, line| "emacsclient #{file} +#{line}" }
+    # @return [String, #call]
+    attr_accessor :editor
+
+    # @return [Boolean] Toggle Pry color on and off.
+    attr_accessor :color
+
+    # @return [Boolean] Toggle paging on and off.
+    attr_accessor :pager
+
+    # Determines whether the rc file (~/.pryrc) should be loaded.
+    # @return [Boolean]
+    attr_accessor :should_load_rc
+
+    # Determines whether plugins should be loaded.
+    # @return [Boolean]
+    attr_accessor :should_load_plugins
+
+    # Config option for history.
+    # sub-options include hist.file, hist.load, and hist.save
+    # hist.file is the file to save/load history too, e.g
+    # Pry.config.history.file = "~/.pry_history".
+    # hist.load is a boolean that determines whether history will be
+    # loaded from hist.file at session start.
+    # hist.save is a boolean that determines whether history will be
+    # saved to hist.file at session end.
+    # @return [OpenStruct]
+    attr_accessor :history
+
+    # Config option for plugins:
+    # sub-options include:
+    # `plugins.enabled` (Boolean) to toggle the loading of plugins on and off wholesale. (defaults to true)
+    # `plugins.strict_loading` (Boolean) which toggles whether referring to a non-existent plugin should raise an exception (defaults to `false`)
+    # @return [OpenStruct]
+    attr_accessor :plugins
+  end
+end
+