pry 0.10.2-i386-mswin32 → 1.0.0.pre1-i386-mswin32

data/lib/pry/pry_instance.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+require "pry/indent"
+
 ##
 # Pry is a powerful alternative to the standard IRB shell for Ruby. It
 # features syntax highlighting, a flexible plugin architecture, runtime
@@ -20,27 +21,54 @@
 # * https://github.com/pry/pry
 # * the IRC channel, which is #pry on the Freenode network
 #
-
 class Pry
-  attr_accessor :binding_stack
+  attr_accessor :input
+  attr_accessor :output
+  attr_accessor :commands
+  attr_accessor :print
+  attr_accessor :exception_handler
+  attr_accessor :quiet
+  alias :quiet? :quiet
+
   attr_accessor :custom_completions
+
+  attr_accessor :binding_stack
   attr_accessor :eval_string
-  attr_accessor :backtrace
-  attr_accessor :suppress_output
+
   attr_accessor :last_result
   attr_accessor :last_file
   attr_accessor :last_dir
 
   attr_reader :last_exception
-  attr_reader :command_state
-  attr_reader :exit_value
+
   attr_reader :input_array
   attr_reader :output_array
-  attr_reader :config
 
-  extend Pry::Config::Convenience
-  config_shortcut(*Pry::Config.shortcuts)
-  EMPTY_COMPLETIONS = [].freeze
+  attr_accessor :backtrace
+
+  attr_accessor :extra_sticky_locals
+
+  attr_accessor :suppress_output
+
+  # This is exposed via Pry::Command#state.
+  attr_reader :command_state
+
+  attr_reader :exit_value
+
+  attr_reader :hooks # Special treatment as we want to alert people of the
+                     # changed API.
+
+  # FIXME: This is a hack to alert people of the new API.
+  # @param [Pry::Hooks] hooks
+  def hooks=(hooks)
+    if hooks.is_a?(Hash)
+      warn "Hash-based hooks are now deprecated! Use a `Pry::Hooks` object " \
+           "instead! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
+      @hooks = Pry::Hooks.from_hash(hooks)
+    else
+      @hooks = hooks
+    end
+  end
 
   # Create a new {Pry} instance.
   # @param [Hash] options
@@ -67,38 +95,40 @@ class Pry
     @indent        = Pry::Indent.new
     @command_state = {}
     @eval_string   = ""
-    @backtrace     = options.delete(:backtrace) || caller
-    target = options.delete(:target)
-    @config = Pry::Config.new
-    config.merge!(options)
-    push_prompt(config.prompt)
-    @input_array  = Pry::HistoryArray.new config.memory_size
-    @output_array = Pry::HistoryArray.new config.memory_size
-    @custom_completions = config.command_completions
-    set_last_result nil
-    @input_array << nil
-    push_initial_binding(target)
-    exec_hook(:when_started, target, options, self)
-  end
+    @backtrace     = options[:backtrace] || caller
 
-  # The current prompt.
-  # This is the prompt at the top of the prompt stack.
-  #
-  # @example
-  #    self.prompt = Pry::SIMPLE_PROMPT
-  #    self.prompt # => Pry::SIMPLE_PROMPT
-  #
-  # @return [Array<Proc>] Current prompt.
-  def prompt
-    prompt_stack.last
-  end
+    refresh_config(options)
 
-  def prompt=(new_prompt)
-    if prompt_stack.empty?
-      push_prompt new_prompt
-    else
-      prompt_stack[-1] = new_prompt
+    push_initial_binding(options[:target])
+
+    set_last_result nil
+    @input_array << nil # add empty input so _in_ and _out_ match
+
+    # yield the binding_stack to the hook for modification
+    exec_hook(:when_started, options[:target], options, self)
+  end
+
+  # Refresh the Pry instance settings from the Pry class.
+  # Allows options to be specified to override settings from Pry class.
+  # @param [Hash] options The options to override Pry class settings
+  #   for this instance.
+  def refresh_config(options={})
+    defaults   = {}
+    attributes = [
+                   :input, :output, :commands, :print, :quiet,
+                   :exception_handler, :hooks, :custom_completions,
+                   :prompt, :memory_size, :extra_sticky_locals
+                 ]
+
+    attributes.each do |attribute|
+      defaults[attribute] = Pry.send attribute
     end
+
+    defaults.merge!(options).each do |key, value|
+      send("#{key}=", value) if respond_to?("#{key}=")
+    end
+
+    true
   end
 
   # Initialize this instance by pushing its initial context into the binding
@@ -121,60 +151,55 @@ class Pry
     binding_stack << Pry.binding_for(object)
   end
 
+  # The current prompt.
+  # This is the prompt at the top of the prompt stack.
   #
-  # Generate completions.
-  #
-  # @param [String] input
-  #   What the user has typed so far
-  #
-  # @return [Array<String>]
-  #   Possible completions
+  # @example
+  #    self.prompt = Pry::SIMPLE_PROMPT
+  #    self.prompt # => Pry::SIMPLE_PROMPT
   #
-  def complete(str)
-    return EMPTY_COMPLETIONS unless config.completer
+  # @return [Array<Proc>] Current prompt.
+  def prompt
+    prompt_stack.last
+  end
+
+  def prompt=(new_prompt)
+    if prompt_stack.empty?
+      push_prompt new_prompt
+    else
+      prompt_stack[-1] = new_prompt
+    end
+  end
+
+  # Generate completions.
+  # @param [String] input What the user has typed so far
+  # @return [Array<String>] Possible completions
+  def complete(input)
     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)
+      Pry.config.completer.call(input, :target => current_binding,
+                                       :pry  => self,
+                                       :custom_completions => instance_eval(&custom_completions))
     end
   end
 
-  #
   # Injects a local variable into the provided binding.
-  #
-  # @param [String] name
-  #   The name of the local to inject.
-  #
-  # @param [Object] value
-  #   The value to set the local to.
-  #
-  # @param [Binding] b
-  #   The binding to set the local on.
-  #
-  # @return [Object]
-  #   The value the local was set to.
-  #
+  # @param [String] name The name of the local to inject.
+  # @param [Object] value The value to set the local to.
+  # @param [Binding] b 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
-    else # < 2.1
-      begin
-        Pry.current[:pry_local] = value
-        b.eval "#{name} = ::Pry.current[:pry_local]"
-      ensure
-        Pry.current[:pry_local] = nil
-      end
-    end
+    Pry.current[:pry_local] = value.is_a?(Proc) ? value.call : value
+    b.eval("#{name} = ::Pry.current[:pry_local]")
+  ensure
+    Pry.current[:pry_local] = nil
   end
 
-  undef :memory_size if method_defined? :memory_size
   # @return [Integer] The maximum amount of objects remembered by the inp and
   #   out arrays. Defaults to 100.
   def memory_size
     @output_array.max_size
   end
 
-  undef :memory_size= if method_defined? :memory_size=
   def memory_size=(size)
     @input_array  = Pry::HistoryArray.new(size)
     @output_array = Pry::HistoryArray.new(size)
@@ -193,19 +218,21 @@ class Pry
   # @yield The block that defines the content of the local. The local
   #   will be refreshed at each tick of the repl loop.
   def add_sticky_local(name, &block)
-    config.extra_sticky_locals[name] = block
+    sticky_locals[name] = block
   end
 
+  # @return [Hash] The currently defined sticky locals.
   def sticky_locals
-    { _in_: input_array,
-      _out_: output_array,
-      _pry_: self,
-      _ex_: last_exception && last_exception.wrapped_exception,
-      _file_: last_file,
-      _dir_: last_dir,
-      _: proc { last_result },
-      __: proc { output_array[-2] }
-    }.merge(config.extra_sticky_locals)
+    @sticky_locals ||= {
+      :_in_   => proc { @input_array },
+      :_out_  => proc { @output_array },
+      :_pry_  => self,
+      :_ex_   => proc { last_exception },
+      :_file_ => proc { last_file },
+      :_dir_  => proc { last_dir },
+      :_      => proc { last_result },
+      :__     => proc { @output_array[-2] }
+    }.merge(extra_sticky_locals)
   end
 
   # Reset the current eval string. If the user has entered part of a multiline
@@ -222,7 +249,7 @@ class Pry
   # 1. Pry commands will be executed immediately if the line matches.
   # 2. Partial lines of input will be queued up until a complete expression has
   #    been accepted.
-  # 3. Output is written to `#output` in pretty colours, not returned.
+  # 3. Output is written to {#output} in pretty colours, not returned.
   #
   # Once this method has raised an exception or returned false, this instance
   # is no longer usable. {#exit_value} will return the session's breakout
@@ -259,7 +286,7 @@ class Pry
 
   def handle_line(line, options)
     if line.nil?
-      config.control_d_handler.call(@eval_string, self)
+      Pry.config.control_d_handler.call(@eval_string, self)
       return
     end
 
@@ -298,22 +325,6 @@ class Pry
         @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 Pry::Helpers::BaseHelpers.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.
@@ -321,13 +332,7 @@ class Pry
         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 Pry::Helpers::BaseHelpers.jruby? && e.class.respond_to?('__persistent__')
-          e.class.__persistent__ = true
-        end
+      rescue RescuableException => e
         self.last_exception = e
         result = e
       end
@@ -341,10 +346,19 @@ class Pry
   end
   private :handle_line
 
-  # 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.)
+  # @deprecated Use `Pry::REPL.new(pry, :target => target).start` instead.
   def repl(target = nil)
+    @@repl_warning ||= (warn Pry::Helpers::CommandHelpers.unindent(<<-S); true)
+      DEPRECATION: Pry#repl is deprecated. Instead, use
+
+        Pry::REPL.new(pry, :target => target).start
+
+      where pry is the Pry instance you called #repl on and target is the
+      optional target parameter of #repl.
+
+      Call stack:
+        #{caller.join("\n" + (' ' * 8))}
+    S
     Pry::REPL.new(self, :target => target).start
   end
 
@@ -364,7 +378,7 @@ class Pry
     if last_result_is_exception?
       exception_handler.call(output, result, self)
     elsif should_print?
-      print.call(output, result, self)
+      print.call(output, result)
     else
       # nothin'
     end
@@ -427,7 +441,7 @@ class Pry
     end
   end
 
-  # Same as process_command, but outputs exceptions to `#output` instead of
+  # Same as process_command, but outputs exceptions to {#output} instead of
   # raising.
   # @param [String] val  The line to process.
   # @return [Boolean] `true` if `val` is a command, `false` otherwise
@@ -484,17 +498,27 @@ 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] ex
+  def last_exception=(ex)
+    class << ex
+      attr_accessor :file, :line, :bt_index
+      def bt_source_location_for(index)
+        backtrace[index] =~ /(.*):(\d+)/
+        [$1, $2.to_i]
+      end
+
+      def inc_bt_index
+        @bt_index = (@bt_index + 1) % backtrace.size
+      end
+    end
+
+    ex.bt_index = 0
+    ex.file, ex.line = ex.bt_source_location_for(0)
+
     @last_result_is_exception = true
-    @output_array << last_exception
-    @last_exception = last_exception
+    @output_array << ex
+    @last_exception = ex
   end
 
   # Update Pry's internal state after evalling code.
@@ -505,7 +529,7 @@ class Pry
     @input_array << code
     if code
       Pry.line_buffer.push(*code.each_line)
-      Pry.current_line += code.lines.count
+      Pry.current_line += code.each_line.count
     end
   end
 
@@ -531,7 +555,7 @@ class Pry
     open_token = @indent.open_delimiters.any? ? @indent.open_delimiters.last :
       @indent.stack.last
 
-    c = Pry::Config.from_hash({
+    c = OpenStruct.new(
                        :object         => object,
                        :nesting_level  => binding_stack.size - 1,
                        :open_token     => open_token,
@@ -542,7 +566,7 @@ class Pry
                        :binding_stack  => binding_stack,
                        :input_array    => input_array,
                        :eval_string    => @eval_string,
-                       :cont           => !@eval_string.empty?})
+                       :cont           => !@eval_string.empty?)
 
     Pry.critical_section do
       # If input buffer is empty then use normal prompt
@@ -598,22 +622,6 @@ class Pry
     prompt_stack.size > 1 ? prompt_stack.pop : prompt
   end
 
-  undef :pager if method_defined? :pager
-  # Returns the currently configured pager
-  # @example
-  #   _pry_.pager.page text
-  def pager
-    Pry::Pager.new(self)
-  end
-
-  undef :output if method_defined? :output
-  # Returns an output device
-  # @example
-  #   _pry_.output.puts "ohai!"
-  def output
-    Pry::Output.new(self)
-  end
-
   # Raise an exception out of Pry.
   #
   # See Kernel#raise for documentation of parameters.
@@ -655,10 +663,4 @@ class Pry
   end
   def raise_up(*args); raise_up_common(false, *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
 end