pry 0.9.6.2 → 0.9.7

data/lib/pry/history.rb

@@ -34,7 +34,7 @@ class Pry
     # @param [String] line
     # @return [String] The same line that was passed in
     def push(line)
-      unless line.empty? || (@history.last && line.strip == @history.last.strip)
+      unless line.empty? || (@history.last && line == @history.last)
         Readline::HISTORY << line
         @history << line
       end

data/lib/pry/indent.rb

@@ -0,0 +1,205 @@
+require 'coderay'
+
+class Pry
+  ##
+  # Pry::Indent is a class that can be used to indent a number of lines
+  # containing Ruby code similar as to how IRB does it (but better). The class
+  # works by tokenizing a string using CodeRay and then looping over those
+  # tokens. Based on the tokens in a line of code that line (or the next one)
+  # will be indented or un-indented by correctly.
+  #
+  class Indent
+    # String containing the spaces to be inserted before the next line.
+    attr_reader :indent_level
+
+    # The amount of spaces to insert for each indent level.
+    SPACES = '  '
+
+    # Hash containing all the tokens that should increase the indentation
+    # level. The keys of this hash are open tokens, the values the matching
+    # tokens that should prevent a line from being indented if they appear on
+    # the same line.
+    OPEN_TOKENS = {
+      'def'    => 'end',
+      'class'  => 'end',
+      'module' => 'end',
+      'do'     => 'end',
+      'if'     => 'end',
+      'unless' => 'end',
+      'while'  => 'end',
+      'until'  => 'end',
+      'for'    => 'end',
+      'case'   => 'end',
+      'begin'  => 'end',
+      '['      => ']',
+      '{'      => '}',
+      '('      => ')'
+    }
+
+    # Which tokens can either be open tokens, or appear as modifiers on
+    # a single-line.
+    SINGLELINE_TOKENS = %w(if while until unless rescue)
+
+    # Collection of token types that should be ignored. Without this list
+    # keywords such as "class" inside strings would cause the code to be
+    # indented incorrectly.
+    IGNORE_TOKENS = [:space, :content, :string, :delimiter, :method, :ident]
+
+    # Tokens that indicate the end of a statement (i.e. that, if they appear
+    # directly before an "if" indicates that that if applies to the same line,
+    # not the next line)
+    STATEMENT_END_TOKENS = IGNORE_TOKENS + [:regexp, :integer, :float]
+
+    # Collection of tokens that should appear dedented even though they
+    # don't affect the surrounding code.
+    MIDWAY_TOKENS = %w(when else elsif rescue)
+
+    def initialize
+      reset
+    end
+
+    # reset internal state
+    def reset
+      @stack = []
+      @indent_level = ''
+      self
+    end
+
+    # Indents a string and returns it. This string can either be a single line
+    # or multiple ones.
+    #
+    # @example
+    #  str = <<TXT
+    #  class User
+    #  attr_accessor :name
+    #  end
+    #  TXT
+    #
+    #  # This would result in the following being displayed:
+    #  #
+    #  # class User
+    #  #   attr_accessor :name
+    #  # end
+    #  #
+    #  puts Pry::Indent.new.indent(str)
+    #
+    # @param  [String] input The input string to indent.
+    # @return [String] The indented version of +input+.
+    #
+    def indent(input)
+      output      = ''
+      open_tokens = OPEN_TOKENS.keys
+      prefix = indent_level
+
+      input.lines.each do |line|
+        tokens = CodeRay.scan(line, :ruby)
+        tokens = tokens.tokens.each_slice(2) if tokens.respond_to?(:tokens) # Coderay 1.0.0
+
+        before, after = indentation_delta(tokens)
+
+        before.times{ prefix.sub! SPACES, '' }
+        output += prefix + line.strip + "\n"
+        prefix += SPACES * after
+      end
+
+      @indent_level = prefix
+
+      return output.gsub(/\s+$/, '')
+    end
+
+    # Get the change in indentation indicated by the line.
+    #
+    # By convention, you remove indent from the line containing end tokens,
+    # but add indent to the line *after* that which contains the start tokens.
+    #
+    # This method returns a pair, where the first number is the number of closings
+    # on this line (i.e. the number of indents to remove before the line) and the
+    # second is the number of openings (i.e. the number of indents to add after
+    # this line)
+    #
+    # @param  [Array] tokens A list of tokens to scan.
+    # @return [Array[Integer]]
+    #
+    def indentation_delta(tokens)
+
+      # We need to keep track of whether we've seen a "for" on this line because
+      # if the line ends with "do" then that "do" should be discounted (i.e. we're
+      # only opening one level not two) To do this robustly we want to keep track
+      # of the indent level at which we saw the for, so we can differentiate
+      # between "for x in [1,2,3] do" and "for x in ([1,2,3].map do" properly
+      seen_for_at = []
+
+      # When deciding whether an "if" token is the start of a multiline statement,
+      # or just the middle of a single-line if statement, we just look at the
+      # preceding token, which is tracked here.
+      last_token, last_kind = [nil, nil]
+
+      # delta keeps track of the total difference from the start of each line after
+      # the given token, 0 is just the level at which the current line started for
+      # reference.
+      remove_before, add_after = [0, 0]
+
+      # If the list of tokens contains a matching closing token the line should
+      # not be indented (and thus we should return true).
+      tokens.each do |token, kind|
+        is_singleline_if  = (SINGLELINE_TOKENS.include?(token)) && end_of_statement?(last_token, last_kind)
+        is_optional_do = (token == "do" && seen_for_at.include?(add_after - 1))
+
+        last_token, last_kind = token, kind unless kind == :space
+        next if IGNORE_TOKENS.include?(kind)
+
+        seen_for_at << add_after if token == "for"
+
+        if OPEN_TOKENS.keys.include?(token) && !is_optional_do && !is_singleline_if
+          @stack << token
+          add_after += 1
+        elsif token == OPEN_TOKENS[@stack.last]
+          @stack.pop
+          if add_after == 0
+            remove_before += 1
+          else
+            add_after -= 1
+          end
+        elsif MIDWAY_TOKENS.include?(token)
+          if add_after == 0
+            remove_before += 1
+            add_after += 1
+          end
+        end
+      end
+
+      return [remove_before, add_after]
+    end
+
+    # If the code just before an "if" or "while" token on a line looks like the end of a statement,
+    # then we want to treat that "if" as a singleline, not multiline statement.
+    def end_of_statement?(last_token, last_kind)
+      (last_token =~ /^[)\]}\/]$/ || STATEMENT_END_TOKENS.include?(last_kind))
+    end
+
+    # Return a string which, when printed, will rewrite the previous line with
+    # the correct indentation. Mostly useful for fixing 'end'.
+    #
+    # @param [String] full_line The full line of input, including the prompt.
+    # @param [Fixnum] overhang (0) The number of chars to erase afterwards (i.e.,
+    #   the difference in length between the old line and the new one).
+    # @return [String]
+    def correct_indentation(full_line, overhang=0)
+      if Readline.respond_to?(:get_screen_size)
+        _, cols = Readline.get_screen_size
+        lines = full_line.length / cols + 1
+      elsif ENV['COLUMNS'] && ENV['COLUMNS'] != ''
+        cols = ENV['COLUMNS'].to_i
+        lines = full_line.length / cols + 1
+      else
+        lines = 1
+      end
+
+      move_up    = "\e[#{lines}F"
+      whitespace = ' ' * overhang
+      move_down  = "\e[#{lines}E"
+
+      "#{move_up}#{full_line}#{whitespace}#{move_down}"
+    end
+  end
+end

data/lib/pry/method.rb

@@ -0,0 +1,412 @@
+class Pry
+  class Method
+    include RbxMethod if Helpers::BaseHelpers.rbx?
+
+    class << self
+      # Given a string representing a method name and optionally a binding to
+      # search in, find and return the requested method wrapped in a `Pry::Method`
+      # instance.
+      #
+      # @param [String, nil] name The name of the method to retrieve, or `nil` to
+      #   delegate to `from_binding` instead.
+      # @param [Binding] target The context in which to search for the method.
+      # @param [Hash] options
+      # @option options [Boolean] :instance Look for an instance method if `name` doesn't
+      #   contain any context.
+      # @option options [Boolean] :methods Look for a bound/singleton method if `name` doesn't
+      #   contain any context.
+      # @return [Pry::Method, nil] A `Pry::Method` instance containing the requested
+      #   method, or `nil` if no method could be located matching the parameters.
+      def from_str(name, target=TOPLEVEL_BINDING, options={})
+        if name.nil?
+          from_binding(target)
+        elsif name.to_s =~ /(.+)\#(\S+)\Z/
+          context, meth_name = $1, $2
+          from_module(target.eval(context), meth_name)
+        elsif name.to_s =~ /(.+)\.(\S+)\Z/
+          context, meth_name = $1, $2
+          from_obj(target.eval(context), meth_name)
+        elsif options[:instance]
+          from_module(target.eval("self"), name)
+        elsif options[:methods]
+          from_obj(target.eval("self"), name)
+        else
+          from_str(name, target, :instance => true) or
+            from_str(name, target, :methods => true)
+        end
+      end
+
+      # Given a `Binding`, try to extract the `::Method` it originated from and
+      # use it to instantiate a `Pry::Method`. Return `nil` if this isn't
+      # possible.
+      #
+      # @param [Binding] b
+      # @return [Pry::Method, nil]
+      #
+      def from_binding(b)
+        meth_name = b.eval('__method__')
+        if [:__script__, nil, :__binding__, :__binding_impl__].include?(meth_name)
+          nil
+        else
+          new(b.eval("method(:#{meth_name})"))
+        end
+      end
+
+      # Given a `Class` or `Module` and the name of a method, try to
+      # instantiate a `Pry::Method` containing the instance method of
+      # that name. Return `nil` if no such method exists.
+      #
+      # @param [Class, Module] klass
+      # @param [String] name
+      # @return [Pry::Method, nil]
+      def from_class(klass, name)
+        new(klass.instance_method(name)) rescue nil
+      end
+      alias from_module from_class
+
+      # Given an object and the name of a method, try to instantiate
+      # a `Pry::Method` containing the method of that name bound to
+      # that object. Return `nil` if no such method exists.
+      #
+      # @param [Object] obj
+      # @param [String] name
+      # @return [Pry::Method, nil]
+      def from_obj(obj, name)
+        new(obj.method(name)) rescue nil
+      end
+
+      # Get all of the instance methods of a `Class` or `Module`
+      # @param [Class,Module] klass
+      # @return [Array[Pry::Method]]
+      def all_from_class(klass)
+        all_from_common(klass, :instance_method)
+      end
+
+      # Get all of the methods on an `Object`
+      # @param [Object] obj
+      # @return [Array[Pry::Method]]
+      def all_from_obj(obj)
+        all_from_common(obj, :method)
+      end
+
+      # Get every `Class` and `Module`, in order, that will be checked when looking
+      # for an instance method to call on this object.
+      # @param [Object] obj
+      # @return [Array[Class, Module]]
+      def resolution_order(obj)
+        if Class === obj
+          singleton_class_resolution_order(obj) + instance_resolution_order(Class)
+        else
+          klass = singleton_class(obj) rescue obj.class
+          instance_resolution_order(klass)
+        end
+      end
+
+      # Get every `Class` and `Module`, in order, that will be checked when looking
+      # for methods on instances of the given `Class` or `Module`.
+      # This does not treat singleton classes of classes specially.
+      # @param [Class, Module] klass
+      # @return [Array[Class, Module]]
+      def instance_resolution_order(klass)
+        # include klass in case it is a singleton class,
+        ([klass] + klass.ancestors).uniq
+      end
+
+      private
+
+      # See all_from_class and all_from_obj.
+      # If method_type is :instance_method, obj must be a `Class` or a `Module`
+      # If method_type is :method, obj can be any `Object`
+      #
+      # N.B. we pre-cache the visibility here to avoid O(N²) behaviour in "ls".
+      def all_from_common(obj, method_type)
+        %w(public protected private).map do |visibility|
+          safe_send(obj, :"#{visibility}_#{method_type}s").map do |method_name|
+            new(safe_send(obj, method_type, method_name), :visibility => visibility.to_sym)
+          end
+        end.flatten(1)
+      end
+
+      # Acts like send but ignores any methods defined below Object or Class in the
+      # inheritance heirarchy.
+      # This is required to introspect methods on objects like Net::HTTP::Get that
+      # have overridden the `method` method.
+      def safe_send(obj, method, *args, &block)
+        (Class === obj ? Class : Object).instance_method(method).bind(obj).call(*args, &block)
+      end
+
+      # Get the singleton classes of superclasses that could define methods on
+      # the given class object, and any modules they include.
+      # If a module is included at multiple points in the ancestry, only
+      # the lowest copy will be returned.
+      def singleton_class_resolution_order(klass)
+        resolution_order = klass.ancestors.map do |anc|
+          [singleton_class(anc)] + singleton_class(anc).included_modules if anc.is_a?(Class)
+        end.compact.flatten(1)
+
+        resolution_order.reverse.uniq.reverse - Class.included_modules
+      end
+
+      def singleton_class(obj); class << obj; self; end end
+    end
+
+    # A new instance of `Pry::Method` wrapping the given `::Method`, `UnboundMethod`, or `Proc`.
+    #
+    # @param [::Method, UnboundMethod, Proc] method
+    # @param [Hash] known_info, can be used to pre-cache expensive to compute stuff.
+    # @return [Pry::Method]
+    def initialize(method, known_info={})
+      @method = method
+      @visibility = known_info[:visibility]
+    end
+
+    # Get the name of the method as a String, regardless of the underlying Method#name type.
+    # @return [String]
+    def name
+      @method.name.to_s
+    end
+
+    # @return [String, nil] The source code of the method, or `nil` if it's unavailable.
+    def source
+      @source ||= case source_type
+        when :c
+          info = pry_doc_info
+          if info and info.source
+            code = strip_comments_from_c_code(info.source)
+          end
+        when :rbx
+          strip_leading_whitespace(core_code)
+        when :ruby
+          if pry_method?
+            code = Pry.new(:input => StringIO.new(Pry.line_buffer[source_line..-1].join), :prompt => proc {""}, :hooks => {}).r
+          else
+            code = @method.source
+          end
+          strip_leading_whitespace(code)
+        end
+    end
+
+    # @return [String, nil] The documentation for the method, or `nil` if it's
+    #   unavailable.
+    # @raise [CommandError] Raises when the method was defined in the REPL.
+    def doc
+      @doc ||= case source_type
+        when :c
+          info = pry_doc_info
+          info.docstring if info
+        when :rbx
+          strip_leading_hash_and_whitespace_from_ruby_comments(core_doc)
+        when :ruby
+          if pry_method?
+            raise CommandError, "Can't view doc for a REPL-defined method."
+          else
+            strip_leading_hash_and_whitespace_from_ruby_comments(@method.comment)
+          end
+        end
+    end
+
+    # @return [Symbol] The source type of the method. The options are
+    #   `:ruby` for ordinary Ruby methods, `:c` for methods written in
+    #   C, or `:rbx` for Rubinius core methods written in Ruby.
+    def source_type
+      if Helpers::BaseHelpers.rbx?
+        if core? then :rbx else :ruby end
+      else
+        if source_location.nil? then :c else :ruby end
+      end
+    end
+
+    # @return [String, nil] The name of the file the method is defined in, or
+    #   `nil` if the filename is unavailable.
+    def source_file
+      if source_location.nil?
+        if !Helpers::BaseHelpers.rbx? and source_type == :c
+          info = pry_doc_info
+          info.file if info
+        end
+      else
+        source_location.first
+      end
+    end
+
+    # @return [Fixnum, nil] The line of code in `source_file` which begins
+    #   the method's definition, or `nil` if that information is unavailable.
+    def source_line
+      source_location.nil? ? nil : source_location.last
+    end
+
+    # @return [Symbol] The visibility of the method. May be `:public`,
+    #   `:protected`, or `:private`.
+    def visibility
+     @visibility ||= if owner.public_instance_methods.any? { |m| m.to_s == name }
+                       :public
+                     elsif owner.protected_instance_methods.any? { |m| m.to_s == name }
+                       :protected
+                     elsif owner.private_instance_methods.any? { |m| m.to_s == name }
+                       :private
+                     else
+                       :none
+                     end
+    end
+
+    # @return [String] A representation of the method's signature, including its
+    #   name and parameters. Optional and "rest" parameters are marked with `*`
+    #   and block parameters with `&`. If the parameter names are unavailable,
+    #   they're given numbered names instead.
+    #   Paraphrased from `awesome_print` gem.
+    def signature
+      if respond_to?(:parameters)
+        args = parameters.inject([]) do |arr, (type, name)|
+          name ||= (type == :block ? 'block' : "arg#{arr.size + 1}")
+          arr << case type
+                 when :req        then name.to_s
+                 when :opt, :rest then "*#{name}"
+                 when :block      then "&#{name}"
+                 else '?'
+                 end
+        end
+      else
+        args = (1..arity.abs).map { |i| "arg#{i}" }
+        args[-1] = "*#{args[-1]}" if arity < 0
+      end
+
+      "#{name}(#{args.join(', ')})"
+    end
+
+    # @return [Pry::Method, nil] The wrapped method that is called when you
+    #   use "super" in the body of this method.
+    def super(times=1)
+      if respond_to?(:receiver)
+        sup = super_using_ancestors(Pry::Method.resolution_order(receiver), times)
+        sup &&= sup.bind(receiver)
+      else
+        sup = super_using_ancestors(Pry::Method.instance_resolution_order(owner), times)
+      end
+      Pry::Method.new(sup) if sup
+    end
+
+    # @return [Symbol, nil] The original name the method was defined under,
+    #   before any aliasing, or `nil` if it can't be determined.
+    def original_name
+      return nil if source_type != :ruby
+
+      first_line = source.lines.first
+      return nil if first_line.strip !~ /^def /
+
+      if RUBY_VERSION =~ /^1\.9/ && RUBY_ENGINE == "ruby"
+        require 'ripper'
+
+        # Ripper is ok with an extraneous end, so we don't need to worry about
+        # whether it's a one-liner.
+        tree = Ripper::SexpBuilder.new(first_line + ";end").parse
+
+        name = tree.flatten(2).each do |lst|
+          break lst[1] if lst[0] == :@ident
+        end
+
+        name.is_a?(String) ? name : nil
+      else
+        require 'ruby_parser'
+
+        # RubyParser breaks if there's an extra end, so we'll just rescue
+        # and try again.
+        tree = begin
+          RubyParser.new.parse(first_line + ";end")
+        rescue Racc::ParseError
+          RubyParser.new.parse(first_line)
+        end
+
+        name = tree.each_cons(2) do |a, b|
+          break a if b.is_a?(Array) && b.first == :args
+        end
+
+        name.is_a?(Symbol) ? name.to_s : nil
+      end
+    end
+
+    # @return [Boolean] Was the method defined outside a source file?
+    def dynamically_defined?
+      !!(source_file and source_file =~ /(\(.*\))|<.*>/)
+    end
+
+    # @return [Boolean] Was the method defined within the Pry REPL?
+    def pry_method?
+      source_file == Pry.eval_path
+    end
+
+    # @return [Boolean] Is the method definitely an alias?
+    def alias?
+      name != original_name
+    end
+
+    # @return [Boolean]
+    def ==(obj)
+      if obj.is_a? Pry::Method
+        super
+      else
+        @method == obj
+      end
+    end
+
+    # @param [Class] klass
+    # @return [Boolean]
+    def is_a?(klass)
+      klass == Pry::Method or @method.is_a?(klass)
+    end
+    alias kind_of? is_a?
+
+    # @param [String, Symbol] method_name
+    # @return [Boolean]
+    def respond_to?(method_name)
+      super or @method.respond_to?(method_name)
+    end
+
+    # Delegate any unknown calls to the wrapped method.
+    def method_missing(method_name, *args, &block)
+      @method.send(method_name, *args, &block)
+    end
+
+    private
+      # @return [YARD::CodeObjects::MethodObject]
+      # @raise [CommandError] Raises when the method can't be found or `pry-doc` isn't installed.
+      def pry_doc_info
+        if Pry.config.has_pry_doc
+          Pry::MethodInfo.info_for(@method) or raise CommandError, "Cannot locate this method: #{name}."
+        else
+          raise CommandError, "Cannot locate this method: #{name}. Try `gem install pry-doc` to get access to Ruby Core documentation."
+        end
+      end
+
+      # @param [String] code
+      # @return [String]
+      def strip_comments_from_c_code(code)
+        code.sub(/\A\s*\/\*.*?\*\/\s*/m, '')
+      end
+
+      # @param [String] comment
+      # @return [String]
+      def strip_leading_hash_and_whitespace_from_ruby_comments(comment)
+        comment = comment.dup
+        comment.gsub!(/\A\#+?$/, '')
+        comment.gsub!(/^\s*#/, '')
+        strip_leading_whitespace(comment)
+      end
+
+      # @param [String] text
+      # @return [String]
+      def strip_leading_whitespace(text)
+        Pry::Helpers::CommandHelpers.unindent(text)
+      end
+
+      # @param [Class,Module] the ancestors to investigate
+      # @return [Method] the unwrapped super-method
+      def super_using_ancestors(ancestors, times=1)
+        next_owner = self.owner
+        times.times do
+          next_owner = ancestors[ancestors.index(next_owner) + 1]
+          return nil unless next_owner
+        end
+        next_owner.instance_method(name) rescue nil
+      end
+  end
+end