pry 0.10.1 → 0.13.1

data/lib/pry/commands/whereami.rb

@@ -1,190 +1,205 @@
-class Pry
-  class Command::Whereami < Pry::ClassCommand
+# frozen_string_literal: true
 
-    class << self
-      attr_accessor :method_size_cutoff
-    end
+require 'method_source'
 
-    @method_size_cutoff = 30
+class Pry
+  class Command
+    class Whereami < Pry::ClassCommand
+      def initialize(*)
+        super
 
-    match 'whereami'
-    description 'Show code surrounding the current context.'
-    group 'Context'
+        @method_code = nil
+      end
 
-    banner <<-'BANNER'
-      Usage: whereami [-qn] [LINES]
+      class << self
+        attr_accessor :method_size_cutoff
+      end
 
-      Describe the current location. If you use `binding.pry` inside a method then
-      whereami will print out the source for that method.
+      @method_size_cutoff = 30
 
-      If a number is passed, then LINES lines before and after the current line will be
-      shown instead of the method itself.
+      match 'whereami'
+      description 'Show code surrounding the current context.'
+      group 'Context'
 
-      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`.
+      banner <<-'BANNER'
+        Usage: whereami [-qn] [LINES]
 
-      The `-n` flag can be used to hide line numbers so that code can be copy/pasted
-      effectively.
+        Describe the current location. If you use `binding.pry` inside a method then
+        whereami will print out the source for that method.
 
-      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
+        If a number is passed, then LINES lines before and after the current line will be
+        shown instead of the method itself.
 
-    def setup
-      @file = expand_path(target.eval('__FILE__'))
-      @line = target.eval('__LINE__')
-      @method = Pry::Method.from_binding(target)
-    end
+        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`.
 
-    def options(opt)
-      opt.on :q, :quiet,             "Don't display anything in case of an error"
-      opt.on :n, :"no-line-numbers", "Do not display line numbers"
-      opt.on :m, :"method", "Show the complete source for the current method."
-      opt.on :c, :"class", "Show the complete source for the current class or module."
-      opt.on :f, :"file", "Show the complete source for the current file."
-    end
+        The `-n` flag can be used to hide line numbers so that code can be copy/pasted
+        effectively.
 
-    def code
-      @code ||= if opts.present?(:m)
-                  method_code or raise CommandError, "Cannot find method code."
-                elsif opts.present?(:c)
-                  class_code or raise CommandError, "Cannot find class code."
-                elsif opts.present?(:f)
-                  Pry::Code.from_file(@file)
-                elsif args.any?
-                  code_window
-                else
-                  default_code
-                end
-    end
+        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 code?
-      !!code
-    rescue MethodSource::SourceNotFoundError
-      false
-    end
+      def setup
+        if target.respond_to?(:source_location)
+          file, @line = target.source_location
+          @file = expand_path(file)
+        else
+          @file = expand_path(target.eval('__FILE__'))
+          @line = target.eval('__LINE__')
+        end
+        @method = Pry::Method.from_binding(target)
+      end
 
-    def bad_option_combination?
-      [opts.present?(:m), opts.present?(:f),
-       opts.present?(:c), args.any?].count(true) > 1
-    end
+      def options(opt)
+        opt.on :q, :quiet, "Don't display anything in case of an error"
+        opt.on :n, :"no-line-numbers", "Do not display line numbers"
+        opt.on :m, :method, "Show the complete source for the current method."
+        opt.on :c, :class, "Show the complete source for the current class or module."
+        opt.on :f, :file, "Show the complete source for the current file."
+      end
 
-    def location
-      "#{@file} @ line #{@line} #{@method && @method.name_with_owner}"
-    end
+      def code
+        @code ||= if opts.present?(:m)
+                    method_code || raise(CommandError, "Cannot find method code.")
+                  elsif opts.present?(:c)
+                    class_code || raise(CommandError, "Cannot find class code.")
+                  elsif opts.present?(:f)
+                    Pry::Code.from_file(@file)
+                  elsif args.any?
+                    code_window
+                  else
+                    default_code
+                  end
+      end
 
-    def process
-      if bad_option_combination?
-        raise CommandError, "Only one of -m, -c, -f, and  LINES may be specified."
+      def code?
+        !!code
+      rescue MethodSource::SourceNotFoundError
+        false
       end
 
-      if nothing_to_do?
-        return
-      elsif internal_binding?(target)
-        handle_internal_binding
-        return
+      def bad_option_combination?
+        [opts.present?(:m), opts.present?(:f),
+         opts.present?(:c), args.any?].count(true) > 1
       end
 
-      set_file_and_dir_locals(@file)
+      def location
+        "#{@file}:#{@line} #{@method && @method.name_with_owner}"
+      end
 
-      out = "\n#{text.bold('From:')} #{location}:\n\n" <<
-        code.with_line_numbers(use_line_numbers?).with_marker(marker).highlighted << "\n"
+      def process
+        if bad_option_combination?
+          raise CommandError, "Only one of -m, -c, -f, and  LINES may be specified."
+        end
 
-      _pry_.pager.page out
-    end
+        return if nothing_to_do?
 
-    private
+        if internal_binding?(target)
+          handle_internal_binding
+          return
+        end
 
-    def nothing_to_do?
-      opts.quiet? && (internal_binding?(target) || !code?)
-    end
+        set_file_and_dir_locals(@file)
 
-    def use_line_numbers?
-      !opts.present?(:n)
-    end
+        pretty_code = code.with_line_numbers(use_line_numbers?)
+          .with_marker(marker)
+          .highlighted
+        pry_instance.pager.page(
+          "\n#{bold('From:')} #{location}:\n\n" + pretty_code + "\n"
+        )
+      end
 
-    def marker
-      !opts.present?(:n) && @line
-    end
+      private
 
-    def top_level?
-      target_self == Pry.main
-    end
+      def nothing_to_do?
+        opts.quiet? && (internal_binding?(target) || !code?)
+      end
 
-    def handle_internal_binding
-      if top_level?
-        output.puts "At the top level."
-      else
-        output.puts "Inside #{Pry.view_clip(target_self)}."
+      def use_line_numbers?
+        !opts.present?(:n)
       end
-    end
 
-    def small_method?
-      @method.source_range.count < self.class.method_size_cutoff
-    end
+      def marker
+        !opts.present?(:n) && @line
+      end
 
-    def default_code
-      if method_code && small_method?
-        method_code
-      else
-        code_window
+      def top_level?
+        target_self == Pry.main
       end
-    end
 
-    def code_window
-      Pry::Code.from_file(@file).around(@line, window_size)
-    end
+      def handle_internal_binding
+        if top_level?
+          output.puts "At the top level."
+        else
+          output.puts "Inside #{Pry.view_clip(target_self)}."
+        end
+      end
 
-    def method_code
-      return @method_code if @method_code
+      def small_method?
+        @method.source_range.count < self.class.method_size_cutoff
+      end
 
-      if valid_method?
-        @method_code = Pry::Code.from_method(@method)
+      def default_code
+        if method_code && small_method?
+          method_code
+        else
+          code_window
+        end
       end
-    end
 
-    # This either returns the `target_self`
-    # or it returns the class of `target_self` if `target_self` is not a class.
-    # @return [Pry::WrappedModule]
-    def target_class
-      target_self.is_a?(Module) ? Pry::WrappedModule(target_self) :
-        Pry::WrappedModule(target_self.class)
-    end
+      def code_window
+        Pry::Code.from_file(@file).around(@line, window_size)
+      end
+
+      def method_code
+        return @method_code if @method_code
 
-    def class_code
-      return @class_code if @class_code
+        @method_code = Pry::Code.from_method(@method) if valid_method?
+      end
 
-      mod = @method ? Pry::WrappedModule(@method.owner) : target_class
+      # This either returns the `target_self`
+      # or it returns the class of `target_self` if `target_self` is not a class.
+      # @return [Pry::WrappedModule]
+      def target_class
+        return Pry::WrappedModule(target_self) if target_self.is_a?(Module)
 
-      idx = mod.candidates.find_index { |v| expand_path(v.source_file) == @file }
-      @class_code = idx && Pry::Code.from_module(mod, idx)
-    end
+        Pry::WrappedModule(target_self.class)
+      end
 
-    def valid_method?
-      @method && @method.source? && expand_path(@method.source_file) == @file &&
-        @method.source_range.include?(@line)
-    end
+      def class_code
+        @class_code ||=
+          begin
+            mod = @method ? Pry::WrappedModule(@method.owner) : target_class
+            idx = mod.candidates.find_index { |v| expand_path(v.source_file) == @file }
+            idx && Pry::Code.from_module(mod, idx)
+          end
+      end
 
-    def expand_path(f)
-      return if !f
+      def valid_method?
+        @method && @method.source? && expand_path(@method.source_file) == @file &&
+          @method.source_range.include?(@line)
+      end
+
+      def expand_path(filename)
+        return unless filename
+        return filename if Pry.eval_path == filename
 
-      if Pry.eval_path == f
-        f
-      else
-        File.expand_path(f)
+        File.expand_path(filename)
       end
-    end
 
-    def window_size
-      if args.empty?
-        _pry_.config.default_window_size
-      else
-        args.first.to_i
+      def window_size
+        if args.empty?
+          pry_instance.config.default_window_size
+        else
+          args.first.to_i
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Whereami)
-  Pry::Commands.alias_command '@', 'whereami'
+    Pry::Commands.add_command(Pry::Command::Whereami)
+    Pry::Commands.alias_command '@', 'whereami'
+    Pry::Commands.alias_command(/whereami[!?]+/, 'whereami')
+  end
 end

data/lib/pry/commands/wtf.rb

@@ -1,57 +1,95 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::Wtf < Pry::ClassCommand
-    match(/wtf([?!]*)/)
-    group 'Context'
-    description 'Show the backtrace of the most recent exception.'
-    options :listing => 'wtf?'
+  class Command
+    class Wtf < Pry::ClassCommand
+      match(/wtf([?!]*)/)
+      group 'Context'
+      description 'Show the backtrace of the most recent exception.'
+      options listing: 'wtf?'
 
-    banner <<-'BANNER'
-      Usage: wtf[?|!]
+      banner <<-'BANNER'
+        Usage: wtf[?|!]
 
-      Show's a few lines of the backtrace of the most recent exception (also available
-      as `_ex_.backtrace`). If you want to see more lines, add more question marks or
-      exclamation marks.
+        Shows a few lines of the backtrace of the most recent exception (also available
+        as `_ex_.backtrace`). If you want to see more lines, add more question marks or
+        exclamation marks.
 
-      wtf?
-      wtf?!???!?!?
+        wtf?
+        wtf?!???!?!?
 
-      # To see the entire backtrace, pass the `-v` or `--verbose` flag.
-      wtf -v
-    BANNER
+        # To see the entire backtrace, pass the `-v` or `--verbose` flag.
+        wtf -v
+      BANNER
 
-    def options(opt)
-      opt.on :v, :verbose, "Show the full backtrace"
-    end
+      RUBY_FRAME_PATTERN = /\A(?<file>(.+)):(?<line>(\d+))/.freeze
+
+      def options(opt)
+        opt.on :v, :verbose, "Show the full backtrace"
+        opt.on :c, :code, "Show code corresponding to the backtrace frame"
+      end
 
-    def process
-      raise Pry::CommandError, "No most-recent exception" unless exception
+      def process
+        unless pry_instance.last_exception
+          raise Pry::CommandError, "No most-recent exception"
+        end
 
-      output.puts "#{text.bold('Exception:')} #{exception.class}: #{exception}\n--"
-      if opts.verbose?
-        output.puts with_line_numbers(backtrace)
-      else
-        output.puts with_line_numbers(backtrace.first(size_of_backtrace))
+        text = ''.dup
+        unwind_exceptions.each_with_index do |exception, i|
+          title = (i == 0 ? 'Exception' : 'Caused by')
+          text << format_header(title, exception)
+          text << format_backtrace(exception.backtrace)
+        end
+        output.puts(text)
       end
-    end
 
-    private
+      private
 
-    def exception
-      _pry_.last_exception
-    end
+      def unwind_exceptions
+        exception_list = []
+        exception = pry_instance.last_exception
 
-    def with_line_numbers(bt)
-      Pry::Code.new(bt, 0, :text).with_line_numbers.to_s
-    end
+        while exception
+          exception_list << exception
+          exception = (exception.cause if exception.respond_to?(:cause))
+        end
 
-    def backtrace
-      exception.backtrace
-    end
+        exception_list
+      end
+
+      def format_header(title, exception)
+        "#{bold(title + ':')} #{exception.class}: #{exception}\n--\n"
+      end
 
-    def size_of_backtrace
-      [captures[0].size, 0.5].max * 10
+      def format_backtrace(backtrace)
+        lines = trim_backtrace(backtrace).map do |frame|
+          next frame unless opts.code?
+
+          match = frame.match(RUBY_FRAME_PATTERN)
+          code = read_line(match[:file], match[:line].to_i)
+          [bold(frame), code].join("\n")
+        end
+
+        Pry::Code.new(lines.compact, 0, :text).with_line_numbers.to_s
+      end
+
+      def trim_backtrace(backtrace)
+        return backtrace if opts.verbose?
+
+        size_of_backtrace = [captures[0].size, 0.5].max * 10
+        backtrace.first(size_of_backtrace)
+      end
+
+      def read_line(file, line)
+        File.open(file, 'r') do |f|
+          (line - 1).times { f.gets }
+          f.gets
+        end
+      rescue Errno::ENOENT
+        nil
+      end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Wtf)
+    Pry::Commands.add_command(Pry::Command::Wtf)
+  end
 end

data/lib/pry/config/attributable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Pry
+  class Config
+    # Attributable provides the ability to create "attribute"
+    # accessors. Attribute accessors create a standard "attr_writer" and a
+    # customised "attr_reader". This reader is Proc-aware (lazy).
+    #
+    # @since v0.13.0
+    # @api private
+    module Attributable
+      def attribute(attr_name)
+        define_method(attr_name) do
+          value = Config::Value.new(instance_variable_get("@#{attr_name}"))
+          value.call
+        end
+
+        attr_writer(attr_name)
+      end
+    end
+  end
+end

data/lib/pry/config/lazy_value.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Pry
+  class Config
+    # LazyValue is a Proc (block) wrapper. It is meant to be used as a
+    # configuration value. Subsequent `#call` calls always evaluate the given
+    # block.
+    #
+    # @example
+    #   num = 19
+    #   value = Pry::Config::LazyValue.new { num += 1 }
+    #   value.foo # => 20
+    #   value.foo # => 21
+    #   value.foo # => 22
+    #
+    # @api private
+    # @since v0.13.0
+    # @see Pry::Config::MemoizedValue
+    class LazyValue
+      def initialize(&block)
+        @block = block
+      end
+
+      def call
+        @block.call
+      end
+    end
+  end
+end

data/lib/pry/config/memoized_value.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Pry
+  class Config
+    # MemoizedValue is a Proc (block) wrapper. It is meant to be used as a
+    # configuration value. Subsequent `#call` calls return the same memoized
+    # result.
+    #
+    # @example
+    #   num = 19
+    #   value = Pry::Config::MemoizedValue.new { num += 1 }
+    #   value.call # => 20
+    #   value.call # => 20
+    #   value.call # => 20
+    #
+    # @api private
+    # @since v0.13.0
+    # @see Pry::Config::LazyValue
+    class MemoizedValue
+      def initialize(&block)
+        @block = block
+        @called = false
+        @call = nil
+      end
+
+      def call
+        return @call if @called
+
+        @called = true
+        @call = @block.call
+      end
+    end
+  end
+end

data/lib/pry/config/value.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Pry
+  class Config
+    # Value holds a value for the given attribute and decides how it should
+    # be read. Procs get called, other values are returned as is.
+    #
+    # @since v0.13.0
+    # @api private
+    class Value
+      def initialize(value)
+        @value = value
+      end
+
+      def call
+        unless [Config::MemoizedValue, Config::LazyValue].include?(@value.class)
+          return @value
+        end
+
+        @value.call
+      end
+    end
+  end
+end