pry 0.9.9.6 → 0.9.10pre1

data/CHANGELOG

@@ -1,3 +1,38 @@
+06/07/2012 version 0.10.pre.1
+dependency changes:
+* #561 upgrade the slop gem to version 3
+* #590 move to the jist gem from gist.
+* upgrade method_source to 0.8
+
+new features:
+* #572 add --hist, -o and -k flags to gist command
+* #584 support show-source/doc on methods defined in class-eval
+* #585 support show-source/doc on gem methods defined in C
+* #596 add --disable-plugin and --select-plugin options
+* #597 allow "cd -" to switch between bindings
+* #612 add Pry.config.should_load_local_rc to turn off ./.pryrc
+* allow running a file of pry input with pry <file>
+* support colours in "ri" command
+* add before_eval hook
+
+bug fixes &c.
+* #554 removed the "req" command
+* #567 fix rendering bugs when starting pry
+* #568 fix Array#pretty_print on Jruby
+* #575 fix "edit" on windows
+* #576 fix "find-method" in the presence of badly behaved objects
+* #580 fix "whereami" in erb files on rails
+* #632 raise fewer exceptions while tab completing
+* #605 dont immediately quite pry when an error happens in readline
+* #606 support for ansicon to give jruby windows users colour
+* #613 massive speed improvements to show-source for modules
+* #620 improve whereami command when not in a binding.pry
+* #622 support embedded documents (=begin ... =end)
+* #627 support editing files with spaces in the name
+* support for absolute paths in $EDITOR
+* fix "cat" command on files with unknown extensions
+* many many internal refactorings and tidyings
+
 09/05/2012 version 0.9.9.6 fixes #558
 * #558 has been a thorn in our side for long enough, hopefully this properly fixes it
 (though im not to confident :P)

data/CONTRIBUTORS

@@ -1,36 +1,37 @@
-   887	John Mair
-   232	Conrad Irwin
-   132	Ryan Fitzgerald
-    89	Rob Gleeson
-    51	Lee Jarvis
-    49	Mon ouïe
-    39	Jordon Bedwell
+   938	banisterfiend
+   290	cirwin
+   140	ryanf
+    93	robgleeson
+    51	injekt
+    49	Mon_Ouie
+    39	envygeeks
+    28	yorickpeterse
     18	David Palm
-    13	epitron
-    10	Matt Carey
-     9	Yorick Peterse
-     8	Eero Saynatkari
+    15	epitron
+    15	kyrylo
+    10	swarley
+     8	rue
      3	Darrick Wiebe
-     3	fowlmouth
+     3	fowl
      3	misfo
      2	Ben Langfeld
-     2	Bram Swenson
      2	Eric Christopherson
-     2	Erik Michaels-Ober
      2	Kelsey Judson
      2	Xavier Shay
-     2	robgleeson
-     1	Kirill Lashuk
-     1	Reginald Tan
-     1	Jordan Running
-     1	Robert Gleeson
-     1	Jonathan Soeder
-     1	Shawn Anderson
-     1	Sherin C
-     1	Tim Pope
+     2	sferic
+     2	shadowshell
      1	Gerbert Olivé
-     1	Jonathan Jackson
-     1	Joe Peduto
      1	Gosha Arinich
-     1	Lars Haugseth
+     1	Joe Peduto
+     1	Jonathan Jackson
+     1	Jonathan Soeder
+     1	Jordan Running
      1	Josh Cheek
+     1	KL-7
+     1	Lars Haugseth
+     1	Reginald Tan
+     1	Renato Mascarenhas
+     1	Shawn Anderson
+     1	Sherin C
+     1	sonnym
+     1	tpope

data/README.markdown

@@ -21,8 +21,8 @@
 </center>
 
 Pry is a powerful alternative to the standard IRB shell for Ruby. It is
-written from scratch to provide a number of advanced features, some of
-these include:
+written from scratch to provide a number of advanced features,
+including:
 
 * Source code browsing (including core C source with the pry-doc gem)
 * Documentation browsing
@@ -280,7 +280,7 @@ picked up by `rdoc`. Pry also has a basic understanding of both the
 rdoc and yard formats and will attempt to syntax highlight the
 documentation appropriately.
 
-Nonetheless The `ri` functionality is very good and
+Nonetheless, the `ri` functionality is very good and
 has an advantage over Pry's system in that it allows documentation
 lookup for classes as well as methods. Pry therefore has good
 integration with  `ri` through the `ri` command. The syntax
@@ -391,7 +391,7 @@ between commands and running commands in background
 
 ### Contact
 
-Problems or questions contact me at [github](http://github.com/banister)
+Problems or questions? file an issue at [github](https://github.com/pry/pry/issues)
 
 ### Contributors
 

data/Rakefile

@@ -20,8 +20,8 @@ def apply_spec_defaults(s)
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- test/*`.split("\n")
   s.add_dependency('coderay', '~> 1.0.5')
-  s.add_dependency('slop', ['>= 2.4.4', '< 3'])
-  s.add_dependency('method_source','~> 0.7.1')
+  s.add_dependency('slop', ['~> 3.3.1'])
+  s.add_dependency('method_source','~> 0.8')
   s.add_development_dependency('bacon', '~> 1.1')
   s.add_development_dependency('open4', '~> 1.3')
   s.add_development_dependency('rake', '~> 0.9')

data/lib/pry.rb

@@ -10,13 +10,7 @@ class Pry
   # The default hooks - display messages when beginning and ending Pry sessions.
   DEFAULT_HOOKS = Pry::Hooks.new.add_hook(:before_session, :default) do |out, target, _pry_|
     next if _pry_.quiet?
-    # ensure we're actually in a method
-    file = target.eval('__FILE__')
-
-    # /unknown/ for rbx
-    if file !~ /(\(.*\))|<.*>/ && file !~ /__unknown__/ && file != "" && file != "-e"  || file == Pry.eval_path
-      _pry_.run_command("whereami", "", target)
-    end
+    _pry_.run_command("whereami --quiet", "", target)
   end
 
   # The default print
@@ -89,13 +83,13 @@ class Pry
   # A prompt that includes the full object path as well as
   # input/output (_in_ and _out_) information. Good for navigation.
   NAV_PROMPT = [
-                proc do |_, level, pry|
-                  tree = pry.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
-                  "[#{pry.input_array.size}] (pry) #{tree}: #{level}> "
+                proc do |conf|
+                  tree = conf.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
+                  "[#{conf.expr_number}] (pry) #{tree}: #{conf.nesting_level}> "
                 end,
-                proc do |_, level, pry|
-                  tree = pry.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
-                  "[#{pry.input_array.size}] (pry) #{tree}: #{level}* "
+                proc do |conf|
+                  tree = conf.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
+                  "[#{conf.expr_number}] (pry) #{tree}: #{conf.nesting_level}* "
                 end,
                ]
 
@@ -106,14 +100,16 @@ class Pry
   # 3) In a nested session  - behave like `cd ..`       (pop a binding)
   DEFAULT_CONTROL_D_HANDLER = proc do |eval_string, _pry_|
     if !eval_string.empty?
-      # clear input buffer
+      # Clear input buffer.
       eval_string.replace("")
     elsif _pry_.binding_stack.one?
-      # ^D at top-level breaks out of loop
+      # ^D at top-level breaks out of a REPL loop.
       _pry_.binding_stack.clear
       throw(:breakout)
     else
-      # otherwise just pops a binding
+      # Otherwise, saves current binding stack as old stack and pops last
+      # binding out of binding stack (the old stack still has that binding).
+      _pry_.command_state["cd"].old_stack = _pry_.binding_stack.dup
       _pry_.binding_stack.pop
     end
   end
@@ -168,13 +164,20 @@ end
 
 require "method_source"
 require 'shellwords'
-require "readline"
 require "stringio"
 require "coderay"
 require "optparse"
 require "slop"
 require "rbconfig"
 
+begin
+  require 'readline'
+rescue LoadError
+  warn "You're running a version of ruby with no Readline support"
+  warn "Please `gem install rb-readline` or recompile ruby --with-readline."
+  exit!
+end
+
 if Pry::Helpers::BaseHelpers.jruby?
   begin
     require 'ffi'
@@ -183,11 +186,14 @@ if Pry::Helpers::BaseHelpers.jruby?
   end
 end
 
-if Pry::Helpers::BaseHelpers.windows?
+if Pry::Helpers::BaseHelpers.windows? && !Pry::Helpers::BaseHelpers.windows_ansi?
   begin
     require 'win32console'
+  # The mswin and mingw versions of pry require win32console, so this should
+  # only fail on jruby (where win32console doesn't work).
+  # Instead we'll recommend ansicon, which does.
   rescue LoadError
-    warn "You should: `gem install win32console` for better auto-indent and color support."
+    warn "For a better pry experience, please use ansicon: http://adoxa.3eeweb.com/ansicon/"
   end
 end
 

data/lib/pry/cli.rb

@@ -14,6 +14,10 @@ class Pry
       # @return [Array] The Procs that process the parsed options.
       attr_accessor :option_processors
 
+      # @return [Array<String>] The input array of strings to process
+      #   as CLI options.
+      attr_accessor :input_args
+
       # Add another set of CLI options (a Slop block)
       def add_options(&block)
         if options
@@ -55,7 +59,9 @@ class Pry
       def parse_options(args=ARGV.dup)
         raise NoOptionsError, "No command line options defined! Use Pry::CLI.add_options to add command line options." if !options
 
-        opts = Slop.parse(args, :help => true, :multiple_switches => false, &options)
+        self.input_args = args
+
+        opts = Slop.parse!(args, :help => true, :multiple_switches => false, &options)
         option_processors.each { |processor| processor.call(opts) } if option_processors # option processors are optional
 
         self
@@ -78,7 +84,7 @@ See: `https://github.com/pry` for more information.
 Copyright (c) 2011 John Mair (banisterfiend)
 --
 }
-  on :e, :exec, "A line of code to execute in context before the session starts", true
+  on :e, :exec, "A line of code to execute in context before the session starts", :argument => true
 
   on "no-pager", "Disable pager for long output" do
     Pry.config.pager = false
@@ -92,13 +98,21 @@ Copyright (c) 2011 John Mair (banisterfiend)
     Pry.color = false
   end
 
-  on :f, "Suppress loading of ~/.pryrc" do
-    # load ~/.pryrc, if not suppressed with -f option
+  on :f, "Suppress loading of ~/.pryrc and ./.pryrc" do
     Pry.config.should_load_rc = false
+    Pry.config.should_load_local_rc = false
+  end
+
+  on :s, "select-plugin", "Only load specified plugin (and no others).", :argument => true do |plugin_name|
+    Pry.config.should_load_plugins = false
+    Pry.plugins[plugin_name].activate!
+  end
+
+  on :d, "disable-plugin", "Disable a specific plugin.", :argument => true do |plugin_name|
+    Pry.plugins[plugin_name].disable!
   end
 
   on "no-plugins", "Suppress loading of plugins." do
-    # suppress plugins if given --no-plugins optino
     Pry.config.should_load_plugins = false
   end
 
@@ -115,11 +129,11 @@ Copyright (c) 2011 John Mair (banisterfiend)
     Pry.config.prompt = Pry::SIMPLE_PROMPT
   end
 
-  on :r, :require, "`require` a Ruby script at startup", true do |file|
+  on :r, :require, "`require` a Ruby script at startup", :argument => true do |file|
     Pry.config.requires << file
   end
 
-  on :I, "Add a path to the $LOAD_PATH", true do |path|
+  on :I, "Add a path to the $LOAD_PATH", :argument => true do |path|
     $LOAD_PATH << path
   end
 
@@ -130,17 +144,24 @@ Copyright (c) 2011 John Mair (banisterfiend)
 
   on(:c, :context,
      "Start the session in the specified context. Equivalent to `context.pry` in a session.",
-     true,
-     :default => "TOPLEVEL_BINDING"
+     :argument => true,
+     :default => "Pry.toplevel_binding"
      )
 end.process_options do |opts|
+
+  exit if opts.help?
+
   # invoked via cli
   Pry.cli = true
 
   # create the actual context
   context = Pry.binding_for(eval(opts[:context]))
 
-  if opts[:exec]
+  if Pry::CLI.input_args.any? && Pry::CLI.input_args != ["pry"]
+    full_name = File.expand_path(Pry::CLI.input_args.first)
+    Pry.load_file_through_repl(full_name)
+    exit
+  elsif opts[:exec]
     exec_string = opts[:exec] + "\n"
   else
     exec_string = ""

data/lib/pry/code.rb

@@ -27,79 +27,15 @@ class Pry
   # object.
   class Code
     class << self
-
-      # Determine if a string of code is a complete Ruby expression.
-      # @param [String] code The code to validate.
-      # @return [Boolean] Whether or not the code is a complete Ruby expression.
-      # @raise [SyntaxError] Any SyntaxError that does not represent incompleteness.
-      # @example
-      #   complete_expression?("class Hello") #=> false
-      #   complete_expression?("class Hello; end") #=> true
-      def complete_expression?(str)
-        if defined?(Rubinius::Melbourne19) && RUBY_VERSION =~ /^1\.9/
-          Rubinius::Melbourne19.parse_string(str, Pry.eval_path)
-        elsif defined?(Rubinius::Melbourne)
-          Rubinius::Melbourne.parse_string(str, Pry.eval_path)
-        else
-          catch(:valid) do
-            Helpers::BaseHelpers.silence_warnings do
-              eval("BEGIN{throw :valid}\n#{str}", binding, Pry.eval_path)
-            end
-          end
-        end
-
-        # Assert that a line which ends with a , or \ is incomplete.
-        str !~ /[,\\]\s*\z/
-      rescue SyntaxError => e
-        if incomplete_user_input_exception?(e)
-          false
-        else
-          raise e
-        end
-      end
-
-      # Check whether the exception indicates that the user should input more.
-      #
-      # @param [SyntaxError] the exception object that was raised.
-      # @param [Array<String>] The stack frame of the function that executed eval.
-      # @return [Boolean]
-      #
-      def incomplete_user_input_exception?(ex)
-        case ex.message
-        when /unexpected (\$end|end-of-file|END_OF_FILE)/, # mri, jruby, ironruby
-          /unterminated (quoted string|string|regexp) meets end of file/, # "quoted string" is ironruby
-          /missing 'end' for/, /: expecting '[})\]]'$/, /can't find string ".*" anywhere before EOF/, /: expecting keyword_end/, /expecting kWHEN/ # rbx
-          true
-        else
-          false
-        end
-      end
-      private :incomplete_user_input_exception?
-
-      # Retrieve the first complete expression from the passed string.
-      #
-      # @param [String, Array<String>] str The string (or array of lines) to extract the complete
-      #   expression from.
-      # @return [String, nil] The first complete expression, or `nil` if
-      #   none found.
-      def retrieve_complete_expression_from(str_or_lines)
-        lines = str_or_lines.is_a?(Array) ? str_or_lines : str_or_lines.each_line.to_a
-
-        code = ""
-        lines.each do |v|
-          code << v
-          return code if complete_expression?(code)
-        end
-        nil
-      end
+      include MethodSource::CodeHelpers
 
       # Instantiate a `Code` object containing code loaded from a file or
       # Pry's line buffer.
       #
       # @param [String] fn The name of a file, or "(pry)".
-      # @param [Symbol] code_type (:ruby) The type of code the file contains.
+      # @param [Symbol] code_type The type of code the file contains.
       # @return [Code]
-      def from_file(fn, code_type=nil)
+      def from_file(fn, code_type = nil)
         if fn == Pry.eval_path
           f = Pry.line_buffer.drop(1)
         else
@@ -107,7 +43,7 @@ class Pry
             f = File.open(fn, 'r')
             code_type = type_from_filename(fn)
           else
-            raise CommandError, "Cannot open #{fn.inspect} for reading."
+            raise MethodSource::SourceNotFoundError, "Cannot open #{fn.inspect} for reading."
           end
         end
         new(f, 1, code_type || :ruby)
@@ -120,8 +56,8 @@ class Pry
       #
       # @param [::Method, UnboundMethod, Proc, Pry::Method] meth The method
       #   object.
-      # @param [Fixnum, nil] The line number to start on, or nil to use the
-      #   method's original line numbers.
+      # @param [Fixnum, nil] start_line The line number to start on, or nil to
+      #   use the method's original line numbers.
       # @return [Code]
       def from_method(meth, start_line=nil)
         meth = Pry::Method(meth)
@@ -132,11 +68,16 @@ class Pry
       # Attempt to extract the source code for module (or class) `mod`.
       #
       # @param [Module, Class] mod The module (or class) of interest.
+      # @param [Fixnum, nil] start_line The line number to start on, or nil to use the
+      #   method's original line numbers.
+      # @param [Fixnum] candidate_rank The module candidate (by rank)
+      #   to use (see `Pry::WrappedModule::Candidate` for more information).
       # @return [Code]
-      def from_module(mod, start_line=nil)
-        mod = Pry::WrappedModule(mod)
-        start_line ||= mod.source_line || 1
-        new(mod.source, start_line, :ruby)
+      def from_module(mod, start_line=nil, candidate_rank=0)
+        candidate = Pry::WrappedModule(mod).candidate(candidate_rank)
+
+        start_line ||= candidate.line
+        new(candidate.source, start_line, :ruby)
       end
 
       protected
@@ -171,6 +112,7 @@ class Pry
         end
     end
 
+    # @return [Symbol] The type of code stored in this wrapper.
     attr_accessor :code_type
 
     # Instantiate a `Code` object containing code from the given `Array`,
@@ -179,8 +121,8 @@ class Pry
     # empty `Code` object and then use `#push` to insert the lines.
     #
     # @param [Array<String>, String, IO] lines
-    # @param [Fixnum?] (1) start_line
-    # @param [Symbol?] (:ruby) code_type
+    # @param [Fixnum?] start_line
+    # @param [Symbol?] code_type
     def initialize(lines=[], start_line=1, code_type=:ruby)
       if lines.is_a? String
         lines = lines.lines
@@ -269,7 +211,7 @@ class Pry
     # Remove all lines except for the `lines` up to and excluding `line_num`.
     #
     # @param [Fixnum] line_num
-    # @param [Fixnum] (1) lines
+    # @param [Fixnum] lines
     # @return [Code]
     def before(line_num, lines=1)
       return self unless line_num
@@ -283,7 +225,7 @@ class Pry
     # `line_num`.
     #
     # @param [Fixnum] line_num
-    # @param [Fixnum] (1) lines
+    # @param [Fixnum] lines
     # @return [Code]
     def around(line_num, lines=1)
       return self unless line_num
@@ -296,7 +238,7 @@ class Pry
     # Remove all lines except for the `lines` after and excluding `line_num`.
     #
     # @param [Fixnum] line_num
-    # @param [Fixnum] (1) lines
+    # @param [Fixnum] lines
     # @return [Code]
     def after(line_num, lines=1)
       return self unless line_num
@@ -321,7 +263,7 @@ class Pry
 
     # Format output with line numbers next to it, unless `y_n` is falsy.
     #
-    # @param [Boolean?] (true) y_n
+    # @param [Boolean?] y_n
     # @return [Code]
     def with_line_numbers(y_n=true)
       alter do
@@ -332,7 +274,7 @@ class Pry
     # Format output with a marker next to the given `line_num`, unless `line_num`
     # is falsy.
     #
-    # @param [Fixnum?] (1) line_num
+    # @param [Fixnum?] line_num
     # @return [Code]
     def with_marker(line_num=1)
       alter do
@@ -344,7 +286,7 @@ class Pry
     # Format output with the specified number of spaces in front of every line,
     # unless `spaces` is falsy.
     #
-    # @param [Fixnum?] (0) spaces
+    # @param [Fixnum?] spaces
     # @return [Code]
     def with_indentation(spaces=0)
       alter do
@@ -375,7 +317,7 @@ class Pry
         max_width = lines.last.last.to_s.length if lines.length > 0
         lines.each do |l|
           padded_line_num = l[1].to_s.rjust(max_width)
-          l[0] = "#{Pry::Helpers::Text.blue(padded_line_num)}: #{l[0]}"
+          l[0] = "#{Pry::Helpers::BaseHelpers.colorize_code(padded_line_num.to_s)}: #{l[0]}"
         end
       end
 
@@ -398,6 +340,22 @@ class Pry
       lines.map { |l| "#{l.first}\n" }.join
     end
 
+    # Get the comment that describes the expression on the given line number.
+    #
+    # @param [Fixnum]  line_number (1-based)
+    # @return [String]  the code.
+    def comment_describing(line_number)
+      self.class.comment_describing(raw, line_number)
+    end
+
+    # Get the multiline expression that starts on the given line number.
+    #
+    # @param [Fixnum]  line_number (1-based)
+    # @return [String]  the code.
+    def expression_at(line_number, consume=0)
+      self.class.expression_at(raw, line_number, :consume => consume)
+    end
+
     # Return an unformatted String of the code.
     #
     # @return [String]