pry 0.9.12.2 → 0.14.2

data/lib/pry/code/loc.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 class Pry
   class Code
-
-    # Represents a line of code. A line of code is a tuple, which consists of a
-    # line and a line number. A `LOC` object's state (namely, the line
-    # parameter) can be changed via instance methods. `Pry::Code` heavily uses
-    # this class.
+    # Represents a line of code (which may, in fact, contain multiple lines if
+    # the entirety was eval'd as a single unit following the `edit` command).
+    #
+    # A line of code is a tuple, which consists of a line and a line number. A
+    # `LOC` object's state (namely, the line parameter) can be changed via
+    # instance methods.  `Pry::Code` heavily uses this class.
     #
     # @api private
     # @example
@@ -18,7 +21,6 @@ class Pry
     #   loc.indent(3)
     #   loc.line #=> "   def example\n  :example\nend"
     class LOC
-
       # @return [Array<String, Integer>]
       attr_reader :tuple
 
@@ -52,17 +54,23 @@ class Pry
       # @param [Symbol] code_type
       # @return [void]
       def colorize(code_type)
-        tuple[0] = CodeRay.scan(line, code_type).term
+        tuple[0] = SyntaxHighlighter.highlight(line, code_type)
       end
 
       # Prepends the line number `lineno` to the `line`.
       #
       # @param [Integer] max_width
       # @return [void]
-      def add_line_number(max_width = 0)
+      def add_line_number(max_width = 0, color = false)
         padded = lineno.to_s.rjust(max_width)
-        colorized_lineno = Pry::Helpers::BaseHelpers.colorize_code(padded)
-        tuple[0] = "#{ colorized_lineno }: #{ line }"
+        colorized_lineno =
+          if color
+            Pry::Helpers::BaseHelpers.colorize_code(padded)
+          else
+            padded
+          end
+        properly_padded_line = handle_multiline_entries_from_edit_command(line, max_width)
+        tuple[0] = "#{colorized_lineno}: #{properly_padded_line}"
       end
 
       # Prepends a marker "=>" or an empty marker to the +line+.
@@ -73,9 +81,9 @@ class Pry
       def add_marker(marker_lineno)
         tuple[0] =
           if lineno == marker_lineno
-            " => #{ line }"
+            " => #{line}"
           else
-            "    #{ line }"
+            "    #{line}"
           end
       end
 
@@ -84,9 +92,14 @@ class Pry
       # @param [Integer] distance
       # @return [void]
       def indent(distance)
-        tuple[0] = "#{ ' ' * distance }#{ line }"
+        tuple[0] = "#{' ' * distance}#{line}"
       end
-    end
 
+      def handle_multiline_entries_from_edit_command(line, max_width)
+        line.split("\n").map.with_index do |inner_line, i|
+          i.zero? ? inner_line : "#{' ' * (max_width + 2)}#{inner_line}"
+        end.join("\n")
+      end
+    end
   end
 end

data/lib/pry/code.rb

@@ -1,5 +1,6 @@
-require 'pry/code/loc'
-require 'pry/code/code_range'
+# frozen_string_literal: true
+
+require 'method_source'
 
 class Pry
   class << self
@@ -29,26 +30,6 @@ class Pry
   # arbitrary chaining of formatting methods without mutating the original
   # object.
   class Code
-
-    # List of all supported languages.
-    # @return [Hash]
-    EXTENSIONS = {
-      %w(.py)        => :python,
-      %w(.js)        => :javascript,
-      %w(.css)       => :css,
-      %w(.xml)       => :xml,
-      %w(.php)       => :php,
-      %w(.html)      => :html,
-      %w(.diff)      => :diff,
-      %w(.java)      => :java,
-      %w(.json)      => :json,
-      %w(.c .h)      => :c,
-      %w(.rhtml)     => :rhtml,
-      %w(.yaml .yml) => :yaml,
-      %w(.cpp .hpp .cc .h cxx) => :cpp,
-      %w(.rb .ru .irbrc .gemspec .pryrc) => :ruby,
-    }
-
     class << self
       include MethodSource::CodeHelpers
 
@@ -58,13 +39,9 @@ class Pry
       # @param [String] filename The name of a file, or "(pry)".
       # @param [Symbol] code_type The type of code the file contains.
       # @return [Code]
-      def from_file(filename, code_type = type_from_filename(filename))
-        code = if filename == Pry.eval_path
-                 Pry.line_buffer.drop(1)
-               else
-                 File.read(abs_path(filename))
-               end
-        new(code, 1, code_type)
+      def from_file(filename, code_type = nil)
+        code_file = CodeFile.new(filename, code_type)
+        new(code_file.code, 1, code_file.code_type)
       end
 
       # Instantiate a `Code` object containing code extracted from a
@@ -89,40 +66,11 @@ class Pry
       # @param [Integer, nil] start_line The line number to start on, or nil to
       #   use the method's original line numbers.
       # @return [Code]
-      def from_module(mod, candidate_rank = 0, start_line=nil)
+      def from_module(mod, candidate_rank = 0, start_line = nil)
         candidate = Pry::WrappedModule(mod).candidate(candidate_rank)
         start_line ||= candidate.line
         new(candidate.source, start_line, :ruby)
       end
-
-      protected
-
-      # Guess the CodeRay type of a file from its extension, or nil if
-      # unknown.
-      #
-      # @param [String] filename
-      # @param [Symbol] default (:ruby) the file type to assume if none could be
-      #   detected.
-      # @return [Symbol, nil]
-      def type_from_filename(filename, default = :ruby)
-        _, type = Pry::Code::EXTENSIONS.find do |k, _|
-          k.any? { |ext| ext == File.extname(filename) }
-        end
-
-        type || default
-      end
-
-      # @param [String] filename
-      # @raise [MethodSource::SourceNotFoundError] if the +filename+ is not
-      #   readable for some reason.
-      # @return [String] absolute path for the given +filename+.
-      def abs_path(filename)
-        abs_path = [File.expand_path(filename, Dir.pwd),
-                    File.expand_path(filename, Pry::INITIAL_PWD)
-                   ].detect { |abs_path| File.readable?(abs_path) }
-        abs_path or raise MethodSource::SourceNotFoundError,
-                          "Cannot open #{filename.inspect} for reading."
-      end
     end
 
     # @return [Symbol] The type of code stored in this wrapper.
@@ -137,26 +85,23 @@ class Pry
     # @param [Integer?] start_line
     # @param [Symbol?] code_type
     def initialize(lines = [], start_line = 1, code_type = :ruby)
-      if lines.is_a? String
-        lines = lines.lines
+      lines = lines.lines if lines.is_a? String
+      @lines = lines.each_with_index.map do |line, lineno|
+        LOC.new(line, lineno + start_line.to_i)
       end
-      @lines = lines.each_with_index.map { |line, lineno|
-        LOC.new(line, lineno + start_line.to_i) }
       @code_type = code_type
+
+      @with_marker = @with_indentation = @with_line_numbers = nil
     end
 
     # Append the given line. +lineno+ is one more than the last existing
     # line, unless specified otherwise.
     #
     # @param [String] line
-    # @param [Integer?] lineno
-    # @return [String] The inserted line.
-    def push(line, lineno = nil)
-      if lineno.nil?
-        lineno = @lines.last.lineno + 1
-      end
-      @lines.push(LOC.new(line, lineno))
-      line
+    # @return [void]
+    def push(line)
+      line_number = @lines.any? ? @lines.last.lineno + 1 : 1
+      @lines.push(LOC.new(line, line_number))
     end
     alias << push
 
@@ -170,6 +115,16 @@ class Pry
       end
     end
 
+    # Filter the lines using the given block.
+    #
+    # @yield [LOC]
+    # @return [Code]
+    def reject(&block)
+      alter do
+        @lines = @lines.reject(&block)
+      end
+    end
+
     # Remove all lines that aren't in the given range, expressed either as a
     # `Range` object or a first and last line number (inclusive). Negative
     # indices count from the end of the array of lines.
@@ -197,7 +152,7 @@ class Pry
         if start_line >= 0
           @lines.index { |loc| loc.lineno >= start_line } || @lines.length
         else
-          @lines.length + start_line
+          [@lines.length + start_line, 0].max
         end
 
       alter do
@@ -251,6 +206,7 @@ class Pry
     # @return [Code]
     def grep(pattern)
       return self unless pattern
+
       pattern = Regexp.new(pattern)
 
       select do |loc|
@@ -292,27 +248,35 @@ class Pry
       end
     end
 
-    # @return [String]
-    def inspect
-      Object.instance_method(:to_s).bind(self).call
-    end
-
     # @return [Integer] the number of digits in the last line.
     def max_lineno_width
-      @lines.length > 0 ? @lines.last.lineno.to_s.length : 0
+      !@lines.empty? ? @lines.last.lineno.to_s.length : 0
     end
 
     # @return [String] a formatted representation (based on the configuration of
     #   the object).
     def to_s
-      @lines.map { |loc|
+      print_to_output(''.dup, false)
+    end
+
+    # @return [String] a (possibly highlighted) copy of the source code.
+    def highlighted
+      print_to_output(''.dup, true)
+    end
+
+    # Writes a formatted representation (based on the configuration of the
+    # object) to the given output, which must respond to `#<<`.
+    def print_to_output(output, color = false)
+      @lines.each do |loc|
         loc = loc.dup
-        loc.colorize(@code_type)              if Pry.color
-        loc.add_line_number(max_lineno_width) if @with_line_numbers
+        loc.colorize(@code_type)              if color
+        loc.add_line_number(max_lineno_width, color) if @with_line_numbers
         loc.add_marker(@marker_lineno)        if @with_marker
         loc.indent(@indentation_num)          if @with_indentation
-        loc.line
-      }.join("\n") + "\n"
+        output << loc.line
+        output << "\n"
+      end
+      output
     end
 
     # Get the comment that describes the expression on the given line number.
@@ -328,15 +292,14 @@ class Pry
     # @param [Integer] line_number (1-based)
     # @return [String] the code.
     def expression_at(line_number, consume = 0)
-      self.class.expression_at(raw, line_number, :consume => consume)
+      self.class.expression_at(raw, line_number, consume: consume)
     end
 
     # Get the (approximate) Module.nesting at the give line number.
     #
     # @param [Integer] line_number line number starting from 1
-    # @param [Module] top_module the module in which this code exists
     # @return [Array<Module>] a list of open modules.
-    def nesting_at(line_number, top_module = Object)
+    def nesting_at(line_number)
       Pry::Indent.nesting_at(raw, line_number)
     end
 
@@ -344,7 +307,7 @@ class Pry
     #
     # @return [String]
     def raw
-      @lines.map(&:line).join("\n") + "\n"
+      @lines.map(&:line).join("\n") << "\n"
     end
 
     # Return the number of lines stored.
@@ -369,10 +332,19 @@ class Pry
     end
 
     # Forward any missing methods to the output of `#to_s`.
-    def method_missing(name, *args, &block)
-      to_s.send(name, *args, &block)
+    def method_missing(method_name, *args, &block)
+      if (string = to_s).respond_to?(method_name)
+        string.__send__(method_name, *args, &block)
+      else
+        super
+      end
+    end
+    undef =~ if method_defined?(:=~)
+
+    # Check whether String responds to missing methods.
+    def respond_to_missing?(method_name, include_private = false)
+      ''.respond_to?(method_name, include_private) || super
     end
-    undef =~
 
     protected
 

data/lib/pry/code_object.rb

@@ -1,4 +1,24 @@
+# frozen_string_literal: true
+
 class Pry
+  # This class is responsible for taking a string (identifying a
+  # command/class/method/etc) and returning the relevant type of object.
+  # For example, if the user looks up "show-source" then  a
+  # `Pry::Command` will be returned. Alternatively, if the user passes in "Pry#repl" then
+  # a `Pry::Method` object will be returned.
+  #
+  # The `CodeObject.lookup` method is responsible for 1. figuring out what kind of
+  # object the user wants (applying precedence rules in doing so -- i.e methods
+  # get precedence over commands with the same name) and 2. Returning
+  # the appropriate object. If the user fails to provide a string
+  # identifer for the object (i.e they pass in `nil` or "") then the
+  # object looked up will be the 'current method' or 'current class'
+  # associated with the Binding.
+  #
+  # TODO: This class is a clusterfuck. We need a much more robust
+  # concept of what a "Code Object" really is. Currently
+  # commands/classes/candidates/methods and so on just share a very
+  # ill-defined interface.
   class CodeObject
     module Helpers
       # we need this helper as some Pry::Method objects can wrap Procs
@@ -18,13 +38,36 @@ class Pry
       def command?
         is_a?(Module) && self <= Pry::Command
       end
+
+      # @return [Boolean] `true` if this module was defined by means of the C API,
+      #   `false` if it's a Ruby module.
+      # @note If a module defined by C was extended with a lot of methods written
+      #   in Ruby, this method would fail.
+      def c_module?
+        return unless is_a?(WrappedModule)
+
+        method_locations = wrapped.methods(false).map do |m|
+          wrapped.method(m).source_location
+        end
+
+        method_locations.concat(
+          wrapped.instance_methods(false).map do |m|
+            wrapped.instance_method(m).source_location
+          end
+        )
+
+        c_methods = method_locations.grep(nil).count
+        ruby_methods = method_locations.count - c_methods
+
+        c_methods > ruby_methods
+      end
     end
 
     include Pry::Helpers::CommandHelpers
 
     class << self
-      def lookup(str, _pry_, options={})
-        co = new(str, _pry_, options)
+      def lookup(str, pry_instance, options = {})
+        co = new(str, pry_instance, options)
 
         co.default_lookup || co.method_or_class_lookup ||
           co.command_lookup || co.empty_lookup
@@ -33,41 +76,48 @@ class Pry
 
     attr_accessor :str
     attr_accessor :target
-    attr_accessor :pry
+    attr_accessor :pry_instance
     attr_accessor :super_level
 
-    def initialize(str, _pry_, options={})
+    def initialize(str, pry_instance, options = {})
       options = {
-        :super => 0,
+        super: 0
       }.merge!(options)
 
       @str = str
-      @pry = _pry_
-      @target = _pry_.current_context
+      @pry_instance = pry_instance
+      @target = pry_instance.current_context
       @super_level = options[:super]
     end
 
+    # TODO: just make it so find_command_by_match_or_listing doesn't raise?
     def command_lookup
-      # TODO: just make it so find_command_by_match_or_listing doesn't
-      # raise?
-      pry.commands.find_command_by_match_or_listing(str) rescue nil
+      pry_instance.commands.find_command_by_match_or_listing(str)
+    rescue StandardError
+      nil
     end
 
+    # when no paramter is given (i.e CodeObject.lookup(nil)), then we
+    # lookup the 'current object' from the binding.
     def empty_lookup
       return nil if str && !str.empty?
 
-      if internal_binding?(target)
-        mod = target_self.is_a?(Module) ? target_self : target_self.class
-        Pry::WrappedModule(mod)
-      else
-        Pry::Method.from_binding(target)
-      end
+      obj = if internal_binding?(target)
+              mod = target_self.is_a?(Module) ? target_self : target_self.class
+              Pry::WrappedModule(mod)
+            else
+              Pry::Method.from_binding(target)
+            end
+
+      # respect the super level (i.e user might have specified a
+      # --super flag to show-source)
+      lookup_super(obj, super_level)
     end
 
     # lookup variables and constants and `self` that are not modules
     def default_lookup
-
-      # we skip instance methods as we want those to fall through to method_or_class_lookup()
+      # we skip instance methods as we want those to fall through to
+      # method_or_class_lookup()
       if safe_to_evaluate?(str) && !looks_like_an_instance_method?(str)
         obj = target.eval(str)
 
@@ -77,27 +127,22 @@ class Pry
           Pry::Method(obj)
         elsif !obj.is_a?(Module)
           Pry::WrappedModule(obj.class)
-        else
-          nil
         end
       end
-
     rescue Pry::RescuableException
       nil
     end
 
     def method_or_class_lookup
-      # we need this here because stupid Pry::Method.from_str() does a
-      # Pry::Method.from_binding when str is nil.
-      # Once we refactor Pry::Method.from_str() so it doesnt lookup
-      # from bindings, we can get rid of this check
-      return nil if str.to_s.empty?
-
-      obj = if str =~ /::(?:\S+)\Z/
-        Pry::WrappedModule.from_str(str,target) || Pry::Method.from_str(str, target)
-      else
-        Pry::Method.from_str(str,target) || Pry::WrappedModule.from_str(str, target)
-      end
+      obj =
+        case str
+        when /\S+\(\)\z/
+          Pry::Method.from_str(str.sub(/\(\)\z/, ''), target) ||
+          Pry::WrappedModule.from_str(str, target)
+        else
+          Pry::WrappedModule.from_str(str, target) ||
+          Pry::Method.from_str(str, target)
+        end
 
       lookup_super(obj, super_level)
     end
@@ -108,7 +153,6 @@ class Pry
       [::Proc, ::Method, ::UnboundMethod].any? { |o| obj.is_a?(o) }
     end
 
-
     # Returns true if `str` looks like a method, i.e Klass#method
     # We need to consider this case because method lookups should fall
     # through to the `method_or_class_lookup()` method but a
@@ -128,6 +172,8 @@ class Pry
     # @return [Boolean]
     def safe_to_evaluate?(str)
       return true if str.strip == "self"
+      return false if str =~ /%/
+
       kind = target.eval("defined?(#{str})")
       kind =~ /variable|constant/
     end
@@ -140,14 +186,12 @@ class Pry
     # @param [Object] obj
     # @param [Fixnum] super_level How far up the super chain to ascend.
     def lookup_super(obj, super_level)
-      return nil if !obj
+      return unless obj
 
       sup = obj.super(super_level)
-      if !sup
-        raise Pry::CommandError, "No superclass found for #{obj.wrapped}"
-      else
-        sup
-      end
+      raise Pry::CommandError, "No superclass found for #{obj.wrapped}" unless sup
+
+      sup
     end
   end
 end

data/lib/pry/color_printer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'pp'
+require 'English'
+
+class Pry
+  # PP subclass for streaming inspect output in color.
+  class ColorPrinter < ::PP
+    Pry::SyntaxHighlighter.overwrite_coderay_comment_token!
+
+    def self.default(_output, value, pry_instance)
+      pry_instance.pager.open do |pager|
+        pager.print pry_instance.config.output_prefix
+        pp(value, pager, pry_instance.output.width - 1)
+      end
+    end
+
+    def self.pp(obj, output = $DEFAULT_OUTPUT, max_width = 79)
+      queue = ColorPrinter.new(output, max_width, "\n")
+      queue.guard_inspect_key { queue.pp(obj) }
+      queue.flush
+      output << "\n"
+    end
+
+    def pp(object)
+      return super unless object.is_a?(String)
+
+      # Avoid calling Ruby 2.4+ String#pretty_print that prints multiline
+      # Strings prettier
+      text(object.inspect)
+    rescue StandardError => exception
+      raise if exception.is_a?(Pry::Pager::StopPaging)
+
+      text(highlight_object_literal(inspect_object(object)))
+    end
+
+    def text(str, max_width = str.length)
+      if str.include?("\e[")
+        super("#{str}\e[0m", max_width)
+      elsif str.start_with?('#<') || %w[= >].include?(str)
+        super(highlight_object_literal(str), max_width)
+      else
+        super(SyntaxHighlighter.highlight(str), max_width)
+      end
+    end
+
+    private
+
+    def highlight_object_literal(object_literal)
+      code = Pry::SyntaxHighlighter.keyword_token_color
+      obj_color = code.start_with?("\e") ? code : "\e[0m\e[0;#{code}m"
+      "#{obj_color}#{object_literal}\e[0m"
+    end
+
+    def inspect_object(object)
+      object.inspect
+    rescue StandardError
+      # Read the class name off of the singleton class to provide a default
+      # inspect.
+      singleton = class << object; self; end
+      ancestors = Pry::Method.safe_send(singleton, :ancestors)
+      klass = ancestors.find { |k| k != singleton }
+      "#<#{klass}:0x#{object.__id__.to_s(16)}>"
+    end
+  end
+end