pry 0.12.1 → 0.14.1

data/lib/pry/pry_instance.rb

@@ -1,4 +1,8 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'method_source'
+require 'ostruct'
+
 ##
 # Pry is a powerful alternative to the standard IRB shell for Ruby. It
 # features syntax highlighting, a flexible plugin architecture, runtime
@@ -23,6 +27,8 @@
 
 # rubocop:disable Metrics/ClassLength
 class Pry
+  extend Pry::Forwardable
+
   attr_accessor :binding_stack
   attr_accessor :custom_completions
   attr_accessor :eval_string
@@ -33,7 +39,6 @@ class Pry
   attr_accessor :last_dir
 
   attr_reader :last_exception
-  attr_reader :command_state
   attr_reader :exit_value
 
   # @since v0.12.0
@@ -44,8 +49,13 @@ class Pry
 
   attr_reader :config
 
-  extend Pry::Config::Convenience
-  config_shortcut(*Pry::Config.shortcuts)
+  def_delegators(
+    :@config, :input, :input=, :output, :output=, :commands,
+    :commands=, :print, :print=, :exception_handler, :exception_handler=,
+    :hooks, :hooks=, :color, :color=, :pager, :pager=, :editor, :editor=,
+    :memory_size, :memory_size=, :extra_sticky_locals, :extra_sticky_locals=
+  )
+
   EMPTY_COMPLETIONS = [].freeze
 
   # Create a new {Pry} instance.
@@ -58,7 +68,7 @@ class Pry
   #   The object to use for commands.
   # @option options [Hash] :hooks
   #   The defined hook Procs.
-  # @option options [Array<Proc>] :prompt
+  # @option options [Pry::Prompt] :prompt
   #   The array of Procs to use for prompts.
   # @option options [Proc] :print
   #   The Proc to use for printing return values.
@@ -70,13 +80,11 @@ class Pry
   #   The initial context for this session.
   def initialize(options = {})
     @binding_stack = []
-    @indent        = Pry::Indent.new
-    @command_state = {}
-    @eval_string   = ""
+    @indent        = Pry::Indent.new(self)
+    @eval_string   = ''.dup
     @backtrace     = options.delete(:backtrace) || caller
     target = options.delete(:target)
-    @config = Pry::Config.new
-    config.merge!(options)
+    @config = self.class.config.merge(options)
     push_prompt(config.prompt)
     @input_ring = Pry::Ring.new(config.memory_size)
     @output_ring = Pry::Ring.new(config.memory_size)
@@ -85,14 +93,18 @@ class Pry
     @input_ring << nil
     push_initial_binding(target)
     exec_hook(:when_started, target, options, self)
+    @prompt_warn = false
   end
 
   # This is the prompt at the top of the prompt stack.
-  # @return [Array<Proc>] the current prompt
+  # @return [Pry::Prompt] the current prompt
   def prompt
     prompt_stack.last
   end
 
+  # Sets the Pry prompt.
+  # @param [Pry::Prompt] new_prompt
+  # @return [void]
   def prompt=(new_prompt)
     if prompt_stack.empty?
       push_prompt new_prompt
@@ -135,7 +147,11 @@ class Pry
 
     Pry.critical_section do
       completer = config.completer.new(config.input, self)
-      completer.call str, target: current_binding, custom_completions: custom_completions.call.push(*sticky_locals.keys)
+      completer.call(
+        str,
+        target: current_binding,
+        custom_completions: custom_completions.call.push(*sticky_locals.keys)
+      )
     end
   end
 
@@ -148,20 +164,20 @@ class Pry
   # @param [Object] value
   #   The value to set the local to.
   #
-  # @param [Binding] b
+  # @param [Binding] binding
   #   The binding to set the local on.
   #
   # @return [Object]
   #   The value the local was set to.
   #
-  def inject_local(name, value, b)
-    value = Proc === value ? value.call : value
-    if b.respond_to?(:local_variable_set)
-      b.local_variable_set name, value
+  def inject_local(name, value, binding)
+    value = value.is_a?(Proc) ? value.call : value
+    if binding.respond_to?(:local_variable_set)
+      binding.local_variable_set name, value
     else # < 2.1
       begin
         Pry.current[:pry_local] = value
-        b.eval "#{name} = ::Pry.current[:pry_local]"
+        binding.eval "#{name} = ::Pry.current[:pry_local]"
       ensure
         Pry.current[:pry_local] = nil
       end
@@ -198,9 +214,10 @@ class Pry
   end
 
   def sticky_locals
-    { _in_: input_ring,
+    {
+      _in_: input_ring,
       _out_: output_ring,
-      _pry_: self,
+      pry_instance: self,
       _ex_: last_exception && last_exception.wrapped_exception,
       _file_: last_file,
       _dir_: last_dir,
@@ -212,7 +229,7 @@ class Pry
   # Reset the current eval string. If the user has entered part of a multiline
   # expression, this discards that input.
   def reset_eval_string
-    @eval_string = ""
+    @eval_string = ''.dup
   end
 
   # Pass a line of input to Pry.
@@ -243,7 +260,7 @@ class Pry
       exit_value = catch(:breakout) do
         handle_line(line, options)
         # We use 'return !@stopped' here instead of 'return true' so that if
-        # handle_line has stopped this pry instance (e.g. by opening _pry_.repl and
+        # handle_line has stopped this pry instance (e.g. by opening pry_instance.repl and
         # then popping all the bindings) we still exit immediately.
         return !@stopped
       end
@@ -256,94 +273,10 @@ class Pry
     # TODO: make this configurable?
     raise exception if exception
 
-    return false
+    false
   end
 
-  def handle_line(line, options)
-    if line.nil?
-      config.control_d_handler.call(@eval_string, self)
-      return
-    end
-
-    ensure_correct_encoding!(line)
-    Pry.history << line unless options[:generated]
-
-    @suppress_output = false
-    inject_sticky_locals!
-    begin
-      if !process_command_safely(line)
-        @eval_string << "#{line.chomp}\n" if !line.empty? || !@eval_string.empty?
-      end
-    rescue RescuableException => e
-      self.last_exception = e
-      result = e
-
-      Pry.critical_section do
-        show_result(result)
-      end
-      return
-    end
-
-    # This hook is supposed to be executed after each line of ruby code
-    # has been read (regardless of whether eval_string is yet a complete expression)
-    exec_hook :after_read, eval_string, self
-
-    begin
-      complete_expr = Pry::Code.complete_expression?(@eval_string)
-    rescue SyntaxError => e
-      output.puts "SyntaxError: #{e.message.sub(/.*syntax error, */m, '')}"
-      reset_eval_string
-    end
-
-    if complete_expr
-      if @eval_string =~ /;\Z/ || @eval_string.empty? || @eval_string =~ /\A *#.*\n\z/
-        @suppress_output = true
-      end
-
-      # A bug in jruby makes java.lang.Exception not rescued by
-      # `rescue Pry::RescuableException` clause.
-      #
-      # * https://github.com/pry/pry/issues/854
-      # * https://jira.codehaus.org/browse/JRUBY-7100
-      #
-      # Until that gets fixed upstream, treat java.lang.Exception
-      # as an additional exception to be rescued explicitly.
-      #
-      # This workaround has a side effect: java exceptions specified
-      # in `Pry.config.exception_whitelist` are ignored.
-      jruby_exceptions = []
-      if Helpers::Platform.jruby?
-        jruby_exceptions << Java::JavaLang::Exception
-      end
-
-      begin
-        # Reset eval string, in case we're evaluating Ruby that does something
-        # like open a nested REPL on this instance.
-        eval_string = @eval_string
-        reset_eval_string
-
-        result = evaluate_ruby(eval_string)
-      rescue RescuableException, *jruby_exceptions => e
-        # Eliminate following warning:
-        # warning: singleton on non-persistent Java type X
-        # (http://wiki.jruby.org/Persistence)
-        if Helpers::Platform.jruby? && e.class.respond_to?('__persistent__')
-          e.class.__persistent__ = true
-        end
-        self.last_exception = e
-        result = e
-      end
-
-      Pry.critical_section do
-        show_result(result)
-      end
-    end
-
-    throw(:breakout) if current_binding.nil?
-  end
-  private :handle_line
-
-  # Potentially deprecated — Use `Pry::REPL.new(pry, :target => target).start`
+  # Potentially deprecated. Use `Pry::REPL.new(pry, :target => target).start`
   # (If nested sessions are going to exist, this method is fine, but a goal is
   # to come up with an alternative to nested sessions altogether.)
   def repl(target = nil)
@@ -367,8 +300,6 @@ class Pry
       exception_handler.call(output, result, self)
     elsif should_print?
       print.call(output, result, self)
-    else
-      # nothin'
     end
   rescue RescuableException => e
     # Being uber-paranoid here, given that this exception arose because we couldn't
@@ -376,7 +307,7 @@ class Pry
     # the exception either.
     begin
       output.puts "(pry) output error: #{e.inspect}\n#{e.backtrace.join("\n")}"
-    rescue RescuableException => e
+    rescue RescuableException
       if last_result_is_exception?
         output.puts "(pry) output error: failed to show exception"
       else
@@ -387,16 +318,6 @@ class Pry
     output.flush if output.respond_to?(:flush)
   end
 
-  # Force `eval_string` into the encoding of `val`. [Issue #284]
-  def ensure_correct_encoding!(val)
-    if @eval_string.empty? &&
-        val.respond_to?(:encoding) &&
-        val.encoding != @eval_string.encoding
-      @eval_string.force_encoding(val.encoding)
-    end
-  end
-  private :ensure_correct_encoding!
-
   # If the given line is a valid command, process it in the context of the
   # current `eval_string` and binding.
   # @param [String] val The line to process.
@@ -404,7 +325,8 @@ class Pry
   def process_command(val)
     val = val.lstrip if /^\s\S/ !~ val
     val = val.chomp
-    result = commands.process_line(val,
+    result = commands.process_line(
+      val,
       target: current_binding,
       output: output,
       eval_string: @eval_string,
@@ -419,11 +341,11 @@ class Pry
     # command was matched and invoked then `result.command?` returns true,
     # otherwise it returns false.
     if result.command?
-      if !result.void_command?
+      unless result.void_command?
         # the command that was invoked was non-void (had a return value) and so we make
         # the value of the current expression equal to the return value
         # of the command.
-        @eval_string.replace "::Pry.current[:pry_cmd_result].retval\n"
+        @eval_string = "::Pry.current[:pry_cmd_result].retval\n"
       end
       true
     else
@@ -437,7 +359,9 @@ class Pry
   # @return [Boolean] `true` if `val` is a command, `false` otherwise
   def process_command_safely(val)
     process_command(val)
-  rescue CommandError, Pry::Slop::InvalidOptionError, MethodSource::SourceNotFoundError => e
+  rescue CommandError,
+         Pry::Slop::InvalidOptionError,
+         MethodSource::SourceNotFoundError => e
     Pry.last_internal_error = e
     output.puts "Error: #{e.message}"
     true
@@ -449,7 +373,8 @@ class Pry
   # @example
   #   pry_instance.run_command("ls -m")
   def run_command(val)
-    commands.process_line(val,
+    commands.process_line(
+      val,
       eval_string: @eval_string,
       target: current_binding,
       pry_instance: self,
@@ -471,8 +396,8 @@ class Pry
     hooks.exec_hook(name, *args, &block).tap do
       hooks.errors[e_before..-1].each do |e|
         output.puts "#{name} hook failed: #{e.class}: #{e.message}"
-        output.puts "#{e.backtrace.first}"
-        output.puts "(see _pry_.hooks.errors to debug)"
+        output.puts e.backtrace.first.to_s
+        output.puts "(see pry_instance.hooks.errors to debug)"
       end
     end
   end
@@ -488,15 +413,11 @@ class Pry
     self.last_result = result unless code =~ /\A\s*\z/
   end
 
-  #
   # Set the last exception for a session.
-  #
-  # @param [Exception] e
-  #   the last exception.
-  #
-  def last_exception=(e)
-    last_exception = Pry::LastException.new(e)
+  # @param [Exception] exception The last exception.
+  def last_exception=(exception)
     @last_result_is_exception = true
+    last_exception = Pry::LastException.new(exception)
     @output_ring << last_exception
     @last_exception = last_exception
   end
@@ -507,10 +428,10 @@ class Pry
   def update_input_history(code)
     # Always push to the @input_ring as the @output_ring is always pushed to.
     @input_ring << code
-    if code
-      Pry.line_buffer.push(*code.each_line)
-      Pry.current_line += code.lines.count
-    end
+    return unless code
+
+    Pry.line_buffer.push(*code.each_line)
+    Pry.current_line += code.lines.count
   end
 
   # @return [Boolean] True if the last result is an exception that was raised,
@@ -533,21 +454,37 @@ class Pry
     object = current_binding.eval('self')
     open_token = @indent.open_delimiters.last || @indent.stack.last
 
-    c = Pry::Config.assign({
-        object: object,
-        nesting_level: binding_stack.size - 1,
-        open_token: open_token,
-        session_line: Pry.history.session_line_count + 1,
-        history_line: Pry.history.history_line_count + 1,
-        expr_number: input_ring.count,
-        _pry_: self,
-        binding_stack: binding_stack,
-        input_ring: input_ring,
-        eval_string: @eval_string,
-        cont: !@eval_string.empty?
-      })
+    c = OpenStruct.new(
+      object: object,
+      nesting_level: binding_stack.size - 1,
+      open_token: open_token,
+      session_line: Pry.history.session_line_count + 1,
+      history_line: Pry.history.history_line_count + 1,
+      expr_number: input_ring.count,
+      pry_instance: self,
+      binding_stack: binding_stack,
+      input_ring: input_ring,
+      eval_string: @eval_string,
+      cont: !@eval_string.empty?
+    )
 
     Pry.critical_section do
+      # If input buffer is empty, then use normal prompt. Otherwise use the wait
+      # prompt (indicating multi-line expression).
+      if prompt.is_a?(Pry::Prompt)
+        prompt_proc = eval_string.empty? ? prompt.wait_proc : prompt.incomplete_proc
+        return prompt_proc.call(c.object, c.nesting_level, c.pry_instance)
+      end
+
+      unless @prompt_warn
+        @prompt_warn = true
+        Kernel.warn(
+          "warning: setting prompt with help of " \
+          "`Pry.config.prompt = [proc {}, proc {}]` is deprecated. " \
+          "Use Pry::Prompt API instead"
+        )
+      end
+
       # If input buffer is empty then use normal prompt
       if eval_string.empty?
         generate_prompt(Array(prompt).first, c)
@@ -558,44 +495,30 @@ class Pry
     end
   end
 
-  def generate_prompt(prompt_proc, conf)
-    if prompt_proc.arity == 1
-      prompt_proc.call(conf)
-    else
-      prompt_proc.call(conf.object, conf.nesting_level, conf._pry_)
-    end
-  end
-  private :generate_prompt
-
-  # the array that the prompt stack is stored in
-  def prompt_stack
-    @prompt_stack ||= Array.new
-  end
-  private :prompt_stack
-
   # Pushes the current prompt onto a stack that it can be restored from later.
   # Use this if you wish to temporarily change the prompt.
-  # @param [Array<Proc>] new_prompt
-  # @return [Array<Proc>] new_prompt
+  #
   # @example
-  #    new_prompt = [ proc { '>' }, proc { '>>' } ]
-  #    push_prompt(new_prompt) # => new_prompt
+  #   push_prompt(Pry::Prompt[:my_prompt])
+  #
+  # @param [Pry::Prompt] new_prompt
+  # @return [Pry::Prompt] new_prompt
   def push_prompt(new_prompt)
     prompt_stack.push new_prompt
   end
 
-  # Pops the current prompt off of the prompt stack.
-  # If the prompt you are popping is the last prompt, it will not be popped.
-  # Use this to restore the previous prompt.
-  # @return [Array<Proc>] Prompt being popped.
+  # Pops the current prompt off of the prompt stack. If the prompt you are
+  # popping is the last prompt, it will not be popped. Use this to restore the
+  # previous prompt.
+  #
   # @example
-  #    prompt1 = [ proc { '>' }, proc { '>>' } ]
-  #    prompt2 = [ proc { '$' }, proc { '>' } ]
-  #    pry = Pry.new :prompt => prompt1
-  #    pry.push_prompt(prompt2)
+  #    pry = Pry.new(prompt: Pry::Prompt[:my_prompt1])
+  #    pry.push_prompt(Pry::Prompt[:my_prompt2])
   #    pry.pop_prompt # => prompt2
   #    pry.pop_prompt # => prompt1
   #    pry.pop_prompt # => prompt1
+  #
+  # @return [Pry::Prompt] the prompt being popped
   def pop_prompt
     prompt_stack.size > 1 ? prompt_stack.pop : prompt
   end
@@ -603,7 +526,7 @@ class Pry
   undef :pager if method_defined? :pager
   # Returns the currently configured pager
   # @example
-  #   _pry_.pager.page text
+  #   pry_instance.pager.page text
   def pager
     Pry::Pager.new(self)
   end
@@ -611,7 +534,7 @@ class Pry
   undef :output if method_defined? :output
   # Returns an output device
   # @example
-  #   _pry_.output.puts "ohai!"
+  #   pry_instance.output.puts "ohai!"
   def output
     Pry::Output.new(self)
   end
@@ -637,7 +560,7 @@ class Pry
                   raise ArgumentError, "wrong number of arguments"
                 elsif !args.first.respond_to?(:exception)
                   raise TypeError, "exception class/object expected"
-                elsif args.length === 1
+                elsif args.size == 1
                   args.first.exception
                 else
                   args.first.exception(args[1])
@@ -645,7 +568,7 @@ class Pry
 
     raise TypeError, "exception object expected" unless exception.is_a? Exception
 
-    exception.set_backtrace(args.length === 3 ? args[2] : caller(1))
+    exception.set_backtrace(args.size == 3 ? args[2] : caller(1))
 
     if force || binding_stack.one?
       binding_stack.clear
@@ -656,14 +579,123 @@ class Pry
     end
   end
 
-  def raise_up(*args); raise_up_common(false, *args); end
+  def raise_up(*args)
+    raise_up_common(false, *args)
+  end
 
-  def raise_up!(*args); raise_up_common(true, *args); end
+  def raise_up!(*args)
+    raise_up_common(true, *args)
+  end
 
   # Convenience accessor for the `quiet` config key.
   # @return [Boolean]
   def quiet?
     config.quiet
   end
+
+  private
+
+  def handle_line(line, options)
+    if line.nil?
+      config.control_d_handler.call(self)
+      return
+    end
+
+    ensure_correct_encoding!(line)
+    Pry.history << line unless options[:generated]
+
+    @suppress_output = false
+    inject_sticky_locals!
+    begin
+      unless process_command_safely(line)
+        @eval_string += "#{line.chomp}\n" if !line.empty? || !@eval_string.empty?
+      end
+    rescue RescuableException => e
+      self.last_exception = e
+      result = e
+
+      Pry.critical_section do
+        show_result(result)
+      end
+      return
+    end
+
+    # This hook is supposed to be executed after each line of ruby code
+    # has been read (regardless of whether eval_string is yet a complete expression)
+    exec_hook :after_read, eval_string, self
+
+    begin
+      complete_expr = Pry::Code.complete_expression?(@eval_string)
+    rescue SyntaxError => e
+      output.puts e.message.gsub(/^.*syntax error, */, "SyntaxError: ")
+      reset_eval_string
+    end
+
+    if complete_expr
+      if @eval_string =~ /;\Z/ || @eval_string.empty? || @eval_string =~ /\A *#.*\n\z/
+        @suppress_output = true
+      end
+
+      # A bug in jruby makes java.lang.Exception not rescued by
+      # `rescue Pry::RescuableException` clause.
+      #
+      # * https://github.com/pry/pry/issues/854
+      # * https://jira.codehaus.org/browse/JRUBY-7100
+      #
+      # Until that gets fixed upstream, treat java.lang.Exception
+      # as an additional exception to be rescued explicitly.
+      #
+      # This workaround has a side effect: java exceptions specified
+      # in `Pry.config.unrescued_exceptions` are ignored.
+      jruby_exceptions = []
+      jruby_exceptions << Java::JavaLang::Exception if Helpers::Platform.jruby?
+
+      begin
+        # Reset eval string, in case we're evaluating Ruby that does something
+        # like open a nested REPL on this instance.
+        eval_string = @eval_string
+        reset_eval_string
+
+        result = evaluate_ruby(eval_string)
+      rescue RescuableException, *jruby_exceptions => e
+        # Eliminate following warning:
+        # warning: singleton on non-persistent Java type X
+        # (http://wiki.jruby.org/Persistence)
+        if Helpers::Platform.jruby? && e.class.respond_to?('__persistent__')
+          e.class.__persistent__ = true
+        end
+        self.last_exception = e
+        result = e
+      end
+
+      Pry.critical_section do
+        show_result(result)
+      end
+    end
+
+    throw(:breakout) if current_binding.nil?
+  end
+
+  # Force `eval_string` into the encoding of `val`. [Issue #284]
+  def ensure_correct_encoding!(val)
+    if @eval_string.empty? &&
+       val.respond_to?(:encoding) &&
+       val.encoding != @eval_string.encoding
+      @eval_string.force_encoding(val.encoding)
+    end
+  end
+
+  def generate_prompt(prompt_proc, conf)
+    if prompt_proc.arity == 1
+      prompt_proc.call(conf)
+    else
+      prompt_proc.call(conf.object, conf.nesting_level, conf.pry_instance)
+    end
+  end
+
+  # the array that the prompt stack is stored in
+  def prompt_stack
+    @prompt_stack ||= []
+  end
 end
 # rubocop:enable Metrics/ClassLength