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

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,20 @@ 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
-
-
-    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,100 @@
+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.should_load is a boolean that determines whether history will be
+    # loaded from hist.file at session start.
+    # hist.should_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
+
+    # @return [Integer] Amount of results that will be stored into out
+    attr_accessor :memory_size
+
+    # @return [Boolean] Whether or not evalation results (`=>`) are sent
+    # through a pager.
+    attr_accessor :result_pager
+  end
+end
+

data/lib/pry/default_commands/basic.rb

@@ -0,0 +1,37 @@
+class Pry
+  module DefaultCommands
+
+    Basic = Pry::CommandSet.new do
+      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.pop_prompt
+        else
+          Pry.active_instance.push_prompt Pry::SIMPLE_PROMPT
+        end
+      end
+
+      command "version", "Show Pry version." do
+        output.puts "Pry version: #{Pry::VERSION} on Ruby #{RUBY_VERSION}."
+      end
+
+      command "import", "Import a command set" do |command_set_name|
+        next output.puts "Provide a command set name" if command_set.nil?
+
+        set = target.eval(arg_string)
+        Pry.active_instance.commands.import set
+      end
+
+      command "reset", "Reset the REPL to a clean state." do
+        output.puts "Pry reset."
+        exec "pry"
+      end
+    end
+
+  end
+end

data/lib/pry/default_commands/context.rb

@@ -3,23 +3,25 @@ require "pry/default_commands/ls"
 class Pry
   module DefaultCommands
 
-    Context = Pry::CommandSet.new :context do
+    Context = Pry::CommandSet.new do
       import Ls
 
       command "cd", "Start a Pry session on VAR (use `cd ..` to go back and `cd /` to return to Pry top-level)",  :keep_retval => true do |obj|
-        if !obj
+        case obj
+        when nil
           output.puts "Must provide an object."
           next
-        end
-
-        throw(:breakout, opts[:nesting].level) if obj == ".."
-
-        if obj == "/"
+        when ".."
+          throw(:breakout, opts[:nesting].level)
+        when "/"
           throw(:breakout, 1) if opts[:nesting].level > 0
           next
+        when "::"
+          TOPLEVEL_BINDING.pry
+          next
+        else
+          Pry.start target.eval(arg_string)
         end
-
-        Pry.start target.eval("#{obj}")
       end
 
       command "nesting", "Show nesting information." do
@@ -52,21 +54,20 @@ class Pry
       end
 
       command "exit", "End the current Pry session. Accepts optional return value. Aliases: quit, back" do
-        str = remove_first_word(opts[:val])
-        throw(:breakout, [opts[:nesting].level, target.eval(str)])
+        throw(:breakout, [opts[:nesting].level, target.eval(arg_string)])
       end
 
       alias_command "quit", "exit", ""
       alias_command "back", "exit", ""
 
       command "exit-all", "End all nested Pry sessions. Accepts optional return value. Aliases: !!@" do
-        str = remove_first_word(opts[:val])
-        throw(:breakout, [0, target.eval(str)])
+        throw(:breakout, [0, target.eval(arg_string)])
       end
 
       alias_command "!!@", "exit-all", ""
 
       command "exit-program", "End the current program. Aliases: quit-program, !!!" do
+        Pry.active_instance.save_history if Pry.config.history.should_save
         exit
       end
 
@@ -74,7 +75,7 @@ class Pry
       alias_command "!!!", "exit-program", ""
 
       command "!pry", "Start a Pry session on current self; this even works mid-expression." do
-        Pry.start(target)
+        target.pry
       end
 
       command "whereami", "Show the code context for the session. (whereami <n> shows <n> extra lines of code around the invocation line. Default: 5)" do |num|
@@ -97,7 +98,7 @@ class Pry
         end
 
         set_file_and_dir_locals(file)
-        output.puts "\n#{bold('From:')} #{file} @ line #{line_num} in #{klass}##{meth_name}:\n\n"
+        output.puts "\n#{text.bold('From:')} #{file} @ line #{line_num} in #{klass}##{meth_name}:\n\n"
 
         # This method inspired by http://rubygems.org/gems/ir_b
         File.open(file).each_with_index do |line, index|

data/lib/pry/default_commands/documentation.rb

@@ -1,7 +1,7 @@
 class Pry
   module DefaultCommands
 
-    Documentation = Pry::CommandSet.new :gems do
+    Documentation = Pry::CommandSet.new do
 
       command "ri", "View ri documentation. e.g `ri Array#each`" do |*args|
         run ".ri", *args
@@ -10,20 +10,19 @@ class Pry
       command "show-doc", "Show the comments above METH. Type `show-doc --help` for more info. Aliases: \?" do |*args|
         target = target()
 
-        opts = Slop.parse!(args) do |opts|
-          opts.banner %{Usage: show-doc [OPTIONS] [METH]
-Show the comments above method METH. Tries instance methods first and then methods by default.
-e.g show-doc hello_method
---
-}
-          opts.on :M, "instance-methods", "Operate on instance methods."
-          opts.on :m, :methods, "Operate on methods."
-          opts.on :c, :context, "Select object context to run under.", true do |context|
+        opts = Slop.parse!(args) do |opt|
+          opt.banner = "Usage: show-doc [OPTIONS] [METH]\n" \
+                       "Show the comments above method METH. Tries instance methods first and then methods by default.\n" \
+                       "e.g show-doc hello_method"
+
+          opt.on :M, "instance-methods", "Operate on instance methods."
+          opt.on :m, :methods, "Operate on methods."
+          opt.on :c, :context, "Select object context to run under.", true do |context|
             target = Pry.binding_for(target.eval(context))
           end
-          opts.on :f, :flood, "Do not use a pager to view text longer than one screen."
-          opts.on :h, :help, "This message." do
-            output.puts opts
+          opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
+          opt.on :h, :help, "This message." do
+            output.puts opt
           end
         end
 
@@ -41,29 +40,31 @@ e.g show-doc hello_method
         next output.puts("No documentation found.") if doc.empty?
         doc = process_comment_markup(doc, code_type)
         output.puts make_header(meth, code_type, doc)
+        if meth.respond_to?(:parameters)
+          output.puts "#{text.bold("signature")}: #{signature_for(meth)}"
+          output.puts
+        end
         render_output(opts.flood?, false, doc)
         doc
       end
 
       alias_command "?", "show-doc", ""
 
-
       command "stat", "View method information and set _file_ and _dir_ locals. Type `stat --help` for more info." do |*args|
         target = target()
 
-        opts = Slop.parse!(args) do |opts|
-          opts.banner %{Usage: stat [OPTIONS] [METH]
-Show method information for method METH and set _file_ and _dir_ locals.
-e.g: stat hello_method
---
-}
-          opts.on :M, "instance-methods", "Operate on instance methods."
-          opts.on :m, :methods, "Operate on methods."
-          opts.on :c, :context, "Select object context to run under.", true do |context|
+        opts = Slop.parse!(args) do |opt|
+          opt.banner "Usage: stat [OPTIONS] [METH]\n" \
+                     "Show method information for method METH and set _file_ and _dir_ locals." \
+                     "e.g: stat hello_method"
+
+          opt.on :M, "instance-methods", "Operate on instance methods."
+          opt.on :m, :methods, "Operate on methods."
+          opt.on :c, :context, "Select object context to run under.", true do |context|
             target = Pry.binding_for(target.eval(context))
           end
-          opts.on :h, :help, "This message" do
-            output.puts opts
+          opt.on :h, :help, "This message" do
+            output.puts opt
           end
         end
 
@@ -75,41 +76,40 @@ e.g: stat hello_method
           next
         end
 
-        code, code_type = code_and_code_type_for(meth)
-        next if !code
-        doc, code_type = doc_and_code_type_for(meth)
+        if !is_a_c_method?(meth) && !is_a_dynamically_defined_method?(meth)
+          set_file_and_dir_locals(path_line_for(meth).first)
+        end
 
-        output.puts make_header(meth, code_type, code)
-        output.puts bold("Method Name: ") + meth_name
-        output.puts bold("Method Owner: ") + (meth.owner.to_s ? meth.owner.to_s : "Unknown")
-        output.puts bold("Method Language: ") + code_type.to_s.capitalize
-        output.puts bold("Method Type: ") + (meth.is_a?(Method) ? "Bound" : "Unbound")
-        output.puts bold("Method Arity: ") + meth.arity.to_s
+        output.puts "Method Information:"
+        output.puts "--"
+        output.puts "Name: " + meth_name
+        output.puts "Owner: " + (meth.owner.to_s ? meth.owner.to_s : "Unknown")
+        output.puts "Type: " + (meth.is_a?(Method) ? "Bound" : "Unbound")
+        output.puts "Arity: " + meth.arity.to_s
 
-        name_map = { :req => "Required:", :opt => "Optional:", :rest => "Rest:" }
         if meth.respond_to?(:parameters)
-          output.puts bold("Method Parameters: ") + meth.parameters.group_by(&:first).
-            map { |k, v| "#{name_map[k]} #{v.map { |kk, vv| vv ? vv.to_s : "noname" }.join(", ")}" }.join(". ")
+          output.puts "Method Signature: " + signature_for(meth)
         end
-        output.puts bold("Comment length: ") + (doc.empty? ? 'No comment.' : (doc.lines.count.to_s + ' lines.'))
+
       end
 
       command "gist-method", "Gist a method to github. Type `gist-method --help` for more info.", :requires_gem => "gist" do |*args|
+        require 'gist'
+
         target = target()
 
-        opts = Slop.parse!(args) do |opts|
-          opts.banner = %{Usage: gist-method [OPTIONS] [METH]
-Gist the method (doc or source) to github.
-Ensure the `gist` gem is properly working before use. http://github.com/defunkt/gist for instructions.
-e.g: gist -m my_method
-e.g: gist -d my_method
---
-}
-          opts.on :m, :method, "Gist a method's source."
-          opts.on :d, :doc, "Gist a method's documentation."
-          opts.on :p, :private, "Create a private gist (default: true)", :default => true
-          opts.on :h, :help, "This message" do
-            output.puts opts
+        opts = Slop.parse!(args) do |opt|
+          opt.banner "Usage: gist-method [OPTIONS] [METH]\n" \
+                     "Gist the method (doc or source) to github.\n" \
+                     "Ensure the `gist` gem is properly working before use. http://github.com/defunkt/gist for instructions.\n" \
+                     "e.g: gist -m my_method\n" \
+                     "e.g: gist -d my_method\n"
+
+          opt.on :m, :method, "Gist a method's source."
+          opt.on :d, :doc, "Gist a method's documentation."
+          opt.on :p, :private, "Create a private gist (default: true)", :default => true
+          opt.on :h, :help, "This message" do
+            output.puts opt
           end
         end
 
@@ -128,14 +128,33 @@ e.g: gist -d my_method
           content, code_type = code_and_code_type_for(meth)
         else
           content, code_type = doc_and_code_type_for(meth)
-          no_color do
+          text.no_color do
             content = process_comment_markup(content, code_type)
           end
           code_type = :plain
         end
 
-        IO.popen("gist#{' -p' if opts.p?} -t #{type_map[code_type]} -", "w") do |gist|
-          gist.puts content
+        link = Gist.write([:extension => ".#{type_map[code_type]}",
+                           :input => content],
+                          opts.p?)
+
+        output.puts "Gist created at #{link}"
+      end
+
+      helpers do
+        def signature_for(meth)
+          param_strings = []
+          meth.parameters.each do |kind, name|
+            case kind
+            when :req
+              param_strings << name
+            when :opt
+              param_strings << "#{name}=?"
+            when :rest
+              param_strings << "*#{name}"
+            end
+          end
+          "#{meth.name}(#{param_strings.join(", ")})"
         end
       end