pry 0.9.9.6pre2-i386-mswin32 → 0.9.10-i386-mswin32

data/lib/pry/default_commands/introspection.rb

@@ -20,29 +20,53 @@ class Pry
       def process(name)
         if module?(name)
           code_or_doc = process_module
-        else method?
+        elsif method?
           code_or_doc = process_method
+        else
+          code_or_doc = process_alternatives
         end
 
         render_output(code_or_doc, opts)
       end
 
-      def module_start_line(mod, candidate=0)
+      def process_alternatives
+        if args.empty? && internal_binding?(target)
+          mod = target_self.is_a?(Module) ? target_self : target_self.class
+          self.module_object = Pry::WrappedModule(mod)
+
+          process_module
+        else
+          process_method
+        end
+      end
+
+      def module_start_line(mod, candidate_rank=0)
         if opts.present?(:'base-one')
           1
         else
-          mod.source_line_for_candidate(candidate)
+          mod.candidate(candidate_rank).line
         end
       end
 
       def use_line_numbers?
         opts.present?(:b) || opts.present?(:l)
       end
+
+      def attempt
+        rank = 0
+        begin
+          yield(rank)
+        rescue Pry::CommandError
+          raise if rank > (module_object.number_of_candidates - 1)
+          rank += 1
+          retry
+        end
+      end
     end
 
     Introspection = Pry::CommandSet.new do
 
-      create_command "show-doc", "Show the comments above METH. Aliases: \?", :shellwords => false do
+      create_command "show-doc", "Show the documentation for a method or class. Aliases: \?", :shellwords => false do
         include ModuleIntrospectionHelpers
         include Helpers::DocumentationHelpers
         extend Helpers::BaseHelpers
@@ -51,7 +75,7 @@ class Pry
           Usage: show-doc [OPTIONS] [METH]
           Aliases: ?
 
-          Show the comments above method METH. Tries instance methods first and then methods by default.
+          Show the documentation for a method or class. Tries instance methods first and then methods by default.
           e.g show-doc hello_method    # docs for hello_method
           e.g show-doc Pry             # docs for Pry class
           e.g show-doc Pry -a          # docs for all definitions of Pry class (all monkey patches)
@@ -80,43 +104,36 @@ class Pry
         end
 
         def normal_module
-          mod = module_object
-
-          # source_file reveals the underlying .c file in case of core
-          # classes on MRI. This is different to source_location, which
-          # will return nil.
-          if mod.yard_docs?
-            file_name, line = mod.source_file, nil
+          doc = ""
+          if module_object.yard_docs?
+            file_name, line = module_object.yard_file, module_object.yard_line
+            doc << module_object.yard_doc
+            start_line = 1
           else
-            file_name, line = mod.source_location
+            attempt do |rank|
+              file_name, line = module_object.candidate(rank).source_location
+              set_file_and_dir_locals(file_name)
+              doc << module_object.candidate(rank).doc
+              start_line = module_start_line(module_object, rank)
+            end
           end
 
-          if mod.doc.empty?
-            output.puts "No documentation found."
-            ""
-          else
-            set_file_and_dir_locals(file_name) if !mod.yard_docs?
-            doc = ""
-            doc << mod.doc
+          doc = Code.new(doc, start_line, :text).
+            with_line_numbers(use_line_numbers?).to_s
 
-            doc = Code.new(doc, module_start_line(mod), :text).
-              with_line_numbers(use_line_numbers?).to_s
-
-            doc.insert(0, "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} @ line #{line ? line : "N/A"}:\n\n")
-          end
+          doc.insert(0, "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} @ line #{line ? line : "N/A"}:\n\n")
         end
 
         def all_modules
-          mod = module_object
-
           doc = ""
-          doc << "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
-          mod.number_of_candidates.times do |v|
+          doc << "Found #{module_object.number_of_candidates} candidates for `#{module_object.name}` definition:\n"
+          module_object.number_of_candidates.times do |v|
+            candidate = module_object.candidate(v)
             begin
-              doc << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{mod.source_file_for_candidate(v)} @ #{mod.source_line_for_candidate(v)}:\n\n"
-              dc = mod.doc_for_candidate(v)
-              doc << (dc.empty? ? "No documentation found.\n" : dc)
+              doc << "\nCandidate #{v+1}/#{module_object.number_of_candidates}: #{candidate.file} @ #{candidate.line}:\n\n"
+              doc << candidate.doc
             rescue Pry::RescuableException
+              doc << "No documentation found.\n"
               next
             end
           end
@@ -124,14 +141,13 @@ class Pry
         end
 
         def process_method
-          meth = method_object
-          raise Pry::CommandError, "No documentation found." if meth.doc.nil? || meth.doc.empty?
+          raise Pry::CommandError, "No documentation found." if method_object.doc.nil? || method_object.doc.empty?
 
-          doc = process_comment_markup(meth.doc, meth.source_type)
-          output.puts make_header(meth, doc)
-          output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
-          output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
-          output.puts "#{text.bold("Signature:")} #{meth.signature}"
+          doc = process_comment_markup(method_object.doc)
+          output.puts make_header(method_object, doc)
+          output.puts "#{text.bold("Owner:")} #{method_object.owner || "N/A"}"
+          output.puts "#{text.bold("Visibility:")} #{method_object.visibility}"
+          output.puts "#{text.bold("Signature:")} #{method_object.signature}"
           output.puts
 
           if use_line_numbers?
@@ -146,8 +162,8 @@ class Pry
           if opts.present?(:'base-one')
             1
           else
-            if mod.source_line_for_candidate(candidate)
-              mod.source_line_for_candidate(candidate) - mod.doc_for_candidate(candidate).lines.count
+            if mod.candidate(candidate).line
+              mod.candidate(candidate).line - mod.candidate(candidate).doc.lines.count
             else
               1
             end
@@ -196,13 +212,13 @@ class Pry
         include ModuleIntrospectionHelpers
         extend Helpers::BaseHelpers
 
-        description "Show the source for METH or CLASS. Aliases: $, show-method"
+        description "Show the source for a method or class. Aliases: $, show-method"
 
         banner <<-BANNER
           Usage: show-source [OPTIONS] [METH|CLASS]
           Aliases: $, show-method
 
-          Show the source for method METH or CLASS. Tries instance methods first and then methods by default.
+          Show the source for a method or class. Tries instance methods first and then methods by default.
 
           e.g: `show-source hello_method`
           e.g: `show-source -m hello_method`
@@ -250,11 +266,14 @@ class Pry
         end
 
         def normal_module
-          mod = module_object
+          file_name = line = code = nil
+          attempt do |rank|
+            file_name, line = module_object.candidate(rank).source_location
+            set_file_and_dir_locals(file_name)
+            code = Code.from_module(module_object, module_start_line(module_object, rank), rank).
+              with_line_numbers(use_line_numbers?).to_s
+          end
 
-          file_name, line = mod.source_location
-          set_file_and_dir_locals(file_name)
-          code = Code.from_module(mod, module_start_line(mod)).with_line_numbers(use_line_numbers?).to_s
           result = ""
           result << "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} @ line #{line}:\n"
           result << "#{Pry::Helpers::Text.bold('Number of lines:')} #{code.lines.count}\n\n"
@@ -267,12 +286,15 @@ class Pry
           result = ""
           result << "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
           mod.number_of_candidates.times do |v|
+            candidate = mod.candidate(v)
             begin
-              code = Code.new(mod.source_for_candidate(v), module_start_line(mod, v)).with_line_numbers(use_line_numbers?).to_s
-              result << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{mod.source_file_for_candidate(v)} @ line #{mod.source_line_for_candidate(v)}:\n"
+              result << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{candidate.file} @ line #{candidate.line}:\n"
+              code = Code.from_module(mod, module_start_line(mod, v), v).
+                with_line_numbers(use_line_numbers?).to_s
               result << "Number of lines: #{code.lines.count}\n\n"
               result << code
             rescue Pry::RescuableException
+              result << "\nNo code found.\n"
               next
             end
           end
@@ -341,12 +363,45 @@ class Pry
           Usage: ri [spec]
           e.g. ri Array#each
 
-          Relies on the ri executable being available. See also: show-doc.
+          Relies on the rdoc gem being installed. See also: show-doc.
         BANNER
 
-        def process
-          run ".ri", *args
+        def process(spec)
+          # Lazily load RI
+          require 'rdoc/ri/driver'
+
+          unless defined? RDoc::RI::PryDriver
+
+            # Subclass RI so that it formats its output nicely, and uses `lesspipe`.
+            subclass = Class.new(RDoc::RI::Driver) # the hard way.
+
+            subclass.class_eval do
+              def page
+                Pry::Helpers::BaseHelpers.lesspipe {|less| yield less}
+              end
+
+              def formatter(io)
+                if @formatter_klass then
+                  @formatter_klass.new
+                else
+                  RDoc::Markup::ToAnsi.new
+                end
+              end
+            end
+
+            RDoc::RI.const_set :PryDriver, subclass   # hook it up!
+          end
+
+          # Spin-up an RI insance.
+          ri = RDoc::RI::PryDriver.new :use_stdout => true, :interactive => false
+
+          begin
+            ri.display_names [spec]  # Get the documentation (finally!)
+          rescue RDoc::RI::Driver::NotFoundError => e
+            output.puts "error: '#{e.name}' not found"
+          end
         end
+
       end
 
     end

data/lib/pry/default_commands/ls.rb

@@ -35,7 +35,7 @@ class Pry
 
           opt.on :i, "ivars", "Show instance variables (in blue) and class variables (in bright blue)"
 
-          opt.on :G, "grep", "Filter output by regular expression", :optional => false
+          opt.on :G, "grep", "Filter output by regular expression", :argument => true
           if jruby?
             opt.on :J, "all-java", "Show all the aliases for methods from java (default is to show only prettiest)"
           end

data/lib/pry/default_commands/misc.rb

@@ -33,11 +33,6 @@ class Pry
           output.puts "Reloaded #{file_name}."
         end
       end
-
-      command "req", "Require file(s) and expand their paths." do |*args|
-        args.each { |file_name| load File.expand_path(file_name) }
-      end
-
     end
   end
 end

data/lib/pry/default_commands/whereami.rb

@@ -0,0 +1,92 @@
+
+class Pry
+  module DefaultCommands
+    Whereami = Pry::CommandSet.new do
+      create_command "whereami" do
+        description "Show code surrounding the current context."
+        group 'Context'
+        banner <<-BANNER
+          Usage: whereami [-q] [N]
+
+          Describe the current location. If you use `binding.pry` inside a
+          method then whereami will print out the source for that method.
+
+          If a number is passed, then N lines before and after the current line
+          will be shown instead of the method itself.
+
+          The `-q` flag can be used to suppress error messages in the case that
+          there's no code to show. This is used by pry in the default
+          before_session hook to show you when you arrive at a `binding.pry`.
+
+          When pry was started on an Object and there is no associated method,
+          whereami will instead output a brief description of the current
+          object.
+        BANNER
+
+        def setup
+          @method = Pry::Method.from_binding(target)
+          @file = target.eval('__FILE__')
+          @line = target.eval('__LINE__')
+        end
+
+        def options(opt)
+          opt.on :q, :quiet, "Don't display anything in case of an error"
+        end
+
+        def code
+          @code ||= if show_method?
+                      Pry::Code.from_method(@method)
+                    else
+                      Pry::Code.from_file(@file).around(@line, window_size)
+                    end
+        end
+
+        def location
+          "#{@file} @ line #{show_method? ? @method.source_line : @line} #{@method && @method.name_with_owner}"
+        end
+
+        def process
+          if opts.quiet? && (internal_binding?(target) || !code?)
+            return
+          elsif internal_binding?(target)
+            if target_self == TOPLEVEL_BINDING.eval("self")
+              output.puts "At the top level."
+            else
+              output.puts "Inside #{Pry.view_clip(target_self)}."
+            end
+            return
+          end
+
+          set_file_and_dir_locals(@file)
+
+          output.puts "\n#{text.bold('From:')} #{location}:\n\n"
+          output.puts code.with_line_numbers.with_marker(@line)
+          output.puts
+        end
+
+        private
+
+        def show_method?
+          args.empty? && @method && @method.source? && @method.source_range.count < 20 &&
+          # These checks are needed in case of an eval with a binding and file/line
+          # numbers set to outside the function. As in rails' use of ERB.
+          @method.source_file == @file && @method.source_range.include?(@line)
+        end
+
+        def code?
+          !!code
+        rescue MethodSource::SourceNotFoundError
+          false
+        end
+
+        def window_size
+          if args.empty?
+            Pry.config.default_window_size
+          else
+            args.first.to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pry/helpers/base_helpers.rb

@@ -70,7 +70,7 @@ class Pry
       end
 
       def use_ansi_codes?
-        defined?(Win32::Console) || ENV['TERM'] && ENV['TERM'] != "dumb"
+         windows_ansi? || ENV['TERM'] && ENV['TERM'] != "dumb"
       end
 
       def colorize_code(code)
@@ -100,6 +100,11 @@ class Pry
         RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
       end
 
+      # are we able to use ansi on windows?
+      def windows_ansi?
+        defined?(Win32::Console) || ENV['ANSICON']
+      end
+
       # are we on Jruby platform?
       def jruby?
         RbConfig::CONFIG['ruby_install_name'] == 'jruby'

data/lib/pry/helpers/command_helpers.rb

@@ -39,13 +39,17 @@ class Pry
         [file, line_num]
       end
 
+      def internal_binding?(target)
+        m = target.eval("__method__").to_s
+        # class_eval is here because of http://jira.codehaus.org/browse/JRUBY-6753
+        ["__binding__", "__pry__", "class_eval"].include?(m)
+      end
+
       def get_method_or_raise(name, target, opts={}, omit_help=false)
         meth = Pry::Method.from_str(name, target, opts)
 
         if name && !meth
           command_error("The method '#{name}' could not be found.", omit_help)
-        elsif !meth
-          command_error("No method name given, and context is not a method.", omit_help, NonMethodContextError)
         end
 
         (opts[:super] || 0).times do
@@ -56,6 +60,10 @@ class Pry
           end
         end
 
+        if !meth || (!name && internal_binding?(target))
+          command_error("No method name given, and context is not a method.", omit_help, NonMethodContextError)
+        end
+
         set_file_and_dir_locals(meth.source_file)
         meth
       end
@@ -69,7 +77,7 @@ class Pry
         header = "\n#{Pry::Helpers::Text.bold('From:')} #{meth.source_file} "
 
         if meth.source_type == :c
-          header << "in Ruby Core (C Method):\n"
+          header << "(C Method):\n"
         else
           header << "@ line #{meth.source_line}:\n"
         end
@@ -107,7 +115,7 @@ class Pry
       # not to block the process from which they were launched (in this case, Pry).
       # For those editors, return the flag that produces the desired behavior.
       def blocking_flag_for_editor(block)
-        case Pry.config.editor
+        case editor_name
         when /^emacsclient/
           '--no-wait' unless block
         when /^[gm]vim/
@@ -129,7 +137,7 @@ class Pry
         # special case for 1st line
         return file_name if line_number <= 1
 
-        case Pry.config.editor
+        case editor_name
         when /^[gm]?vi/, /^emacs/, /^nano/, /^pico/, /^gedit/, /^kate/
           "+#{line_number} #{file_name}"
         when /^mate/, /^geany/
@@ -149,6 +157,20 @@ class Pry
         end
       end
 
+      # Get the name of the binary that Pry.config.editor points to.
+      #
+      # This is useful for deciding which flags we pass to the editor as
+      # we can just use the program's name and ignore any absolute paths.
+      #
+      # @example
+      #   Pry.config.editor="/home/conrad/bin/textmate -w"
+      #   editor_name
+      #   # => textmate
+      #
+      def editor_name
+        File.basename(Pry.config.editor).split(" ").first
+      end
+
       # Remove any common leading whitespace from every line in `text`.
       #
       # This can be used to make a HEREDOC line up with the left margin, without
@@ -161,10 +183,7 @@ class Pry
       #       "Ut enim ad minim veniam."
       #   USAGE
       #
-      # @param  [String] The text from which to remove indentation
-      # @return [String], The text with indentation stripped.
-      #
-      # @copyright Heavily based on textwrap.dedent from Python, which is:
+      # Heavily based on textwrap.dedent from Python, which is:
       #   Copyright (C) 1999-2001 Gregory P. Ward.
       #   Copyright (C) 2002, 2003 Python Software Foundation.
       #   Written by Greg Ward <gward@python.net>
@@ -172,6 +191,8 @@ class Pry
       #   Licensed under <http://docs.python.org/license.html>
       #   From <http://hg.python.org/cpython/file/6b9f0a6efaeb/Lib/textwrap.py>
       #
+      # @param [String] text The text from which to remove indentation
+      # @return [String] The text with indentation stripped.
       def unindent(text)
         # Empty blank lines
         text = text.sub(/^[ \t]+$/, '')