pry 0.9.12.6 → 0.10.0.pre2

data/lib/pry/history_array.rb

@@ -1,6 +1,6 @@
 class Pry
   # A history array is an array to which you can only add elements. Older
-  # entries are removed progressively, so that the aray never contains more than
+  # entries are removed progressively, so that the array never contains more than
   # N elements.
   #
   # History arrays are used by Pry to store the output of the last commands.
@@ -89,6 +89,11 @@ class Pry
       ((@count - size)...@count).map { |n| @hash[n] }
     end
 
+    # Returns [Hash] copy of the internal @hash history
+    def to_h
+      @hash.dup
+    end
+
     def pop!
       @hash.delete @count - 1
       @count -= 1

data/lib/pry/hooks.rb

@@ -18,11 +18,11 @@ class Pry
     # @param [Hash] hash The hash to convert to `Pry::Hooks`.
     # @return [Pry::Hooks] The resulting `Pry::Hooks` instance.
     def self.from_hash(hash)
+      return hash if hash.instance_of?(self)
       instance = new
       hash.each do |k, v|
         instance.add_hook(k, nil, v)
       end
-
       instance
     end
 
@@ -49,22 +49,6 @@ class Pry
       @errors ||= []
     end
 
-    # FIXME:
-    # This is a hack to alert people of the new API.
-    def [](event_name)
-      warn "`Pry.hooks[]` is deprecated! Please use the new `Pry::Hooks` API! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
-
-      get_hook(event_name, nil)
-    end
-
-    # FIXME:
-    # This is a hack to alert people of the new API.
-    def []=(event_name, callable)
-      warn "`Pry.hooks[]=` is deprecated! Please use the new `Pry::Hooks` API! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
-
-      add_hook(event_name, nil, callable)
-    end
-
     # Destructively merge the contents of two `Pry:Hooks` instances.
     # @param [Pry::Hooks] other The `Pry::Hooks` instance to merge
     # @return [Pry:Hooks] Returns the receiver.
@@ -146,18 +130,14 @@ class Pry
     def exec_hook(event_name, *args, &block)
       @hooks[event_name] ||= []
 
-      # silence warnings to get rid of 1.8's "warning: multiple values
-      # for a block parameter" warnings
-      Pry::Helpers::BaseHelpers.silence_warnings do
-        @hooks[event_name].map do |hook_name, callable|
-          begin
-            callable.call(*args, &block)
-          rescue RescuableException => e
-            errors << e
-            e
-          end
-        end.last
-      end
+      @hooks[event_name].map do |hook_name, callable|
+        begin
+          callable.call(*args, &block)
+        rescue RescuableException => e
+          errors << e
+          e
+        end
+      end.last
     end
 
     # Return the number of hook functions registered for the `event_name` event.

data/lib/pry/indent.rb

@@ -94,8 +94,8 @@ class Pry
       indent = new
       lines = str.split("\n")
       n = line_number - 1
-      to_indent = lines[0...n] + (lines[n] || "").split("def").first(1)
-      indent.indent(to_indent.join("\n") + "\n")
+      to_indent = lines[0...n] << (lines[n] || "").split("def").first(1)
+      indent.indent(to_indent.join("\n") << "\n")
       indent.module_nesting
     end
 
@@ -320,7 +320,7 @@ class Pry
     # [ ["class", "Foo"], ["module", "Bar::Baz"], ["class <<", "self"] ]
     #
     # A nil value in the @module_nesting array happens in two places: either
-    # when @awaiting_token is true and we're still waiting for the string to
+    # when @awaiting_class is true and we're still waiting for the string to
     # fill that space, or when a parse was rejected.
     #
     # At the moment this function is quite restricted about what formats it will
@@ -341,7 +341,7 @@ class Pry
           @module_nesting.last[1] = token if kind == :class
           @awaiting_class = false
         else
-          # leave @nesting[-1][
+          # leave @module_nesting[-1]
           @awaiting_class = false
         end
       end
@@ -384,13 +384,13 @@ class Pry
     # @return [String]
     def correct_indentation(prompt, code, overhang=0)
       prompt = prompt.delete("\001\002")
-      full_line = prompt + code
+      line_to_measure = Pry::Helpers::Text.strip_color(prompt) << code
       whitespace = ' ' * overhang
 
       _, cols = Terminal.screen_size
 
       cols = cols.to_i
-      lines = cols != 0 ? (full_line.length / cols + 1) : 1
+      lines = (cols != 0 ? (line_to_measure.length / cols + 1) : 1).to_i
 
       if Pry::Helpers::BaseHelpers.windows_ansi?
         move_up   = "\e[#{lines}F"

data/lib/pry/input_completer.rb

@@ -0,0 +1,242 @@
+# taken from irb
+# Implements tab completion for Readline in Pry
+class Pry::InputCompleter
+  NUMERIC_REGEXP            = /^(-?(0[dbo])?[0-9_]+(\.[0-9_]+)?([eE]-?[0-9]+)?)\.([^.]*)$/
+  ARRAY_REGEXP              = /^([^\]]*\])\.([^.]*)$/
+  SYMBOL_REGEXP             = /^(:[^:.]*)$/
+  SYMBOL_METHOD_CALL_REGEXP = /^(:[^:.]+)\.([^.]*)$/
+  REGEX_REGEXP              = /^(\/[^\/]*\/)\.([^.]*)$/
+  PROC_OR_HASH_REGEXP       = /^([^\}]*\})\.([^.]*)$/
+  TOPLEVEL_LOOKUP_REGEXP    = /^::([A-Z][^:\.\(]*)$/
+  CONSTANT_REGEXP           = /^([A-Z][A-Za-z0-9]*)$/
+  CONSTANT_OR_METHOD_REGEXP = /^([A-Z].*)::([^:.]*)$/
+  HEX_REGEXP                = /^(-?0x[0-9a-fA-F_]+)\.([^.]*)$/
+  GLOBALVARIABLE_REGEXP     = /^(\$[^.]*)$/
+  VARIABLE_REGEXP           = /^([^."].*)\.([^.]*)$/
+
+  ReservedWords = [
+                   "BEGIN", "END",
+                   "alias", "and",
+                   "begin", "break",
+                   "case", "class",
+                   "def", "defined", "do",
+                   "else", "elsif", "end", "ensure",
+                   "false", "for",
+                   "if", "in",
+                   "module",
+                   "next", "nil", "not",
+                   "or",
+                   "redo", "rescue", "retry", "return",
+                   "self", "super",
+                   "then", "true",
+                   "undef", "unless", "until",
+                   "when", "while",
+                   "yield" ]
+
+  Operators = [
+               "%", "&", "*", "**", "+",  "-",  "/",
+               "<", "<<", "<=", "<=>", "==", "===", "=~", ">", ">=", ">>",
+               "[]", "[]=", "^", "!", "!=", "!~"
+              ]
+
+  WORD_ESCAPE_STR = " \t\n\"\\'`><=;|&{("
+
+  def initialize(input, pry = nil)
+    @pry = pry
+    @input = input
+    @input.basic_word_break_characters = WORD_ESCAPE_STR if @input.respond_to?(:basic_word_break_characters=)
+    @input.completion_append_character = nil if @input.respond_to?(:completion_append_character=)
+  end
+
+  #
+  # Return a new completion proc for use by Readline.
+  #
+  def call(str, options = {})
+    custom_completions = options[:custom_completions] || []
+    # if there are multiple contexts e.g. cd 1/2/3
+    # get new target for 1/2 and find candidates for 3
+    path, input = build_path(str)
+
+    if path.call.empty?
+      target = options[:target]
+    else
+      # Assume the user is tab-completing the 'cd' command
+      begin
+        target = Pry::ObjectPath.new(path.call, @pry.binding_stack).resolve.last
+      # but if that doesn't work, assume they're doing division with no spaces
+      rescue Pry::CommandError
+        target = options[:target]
+      end
+    end
+
+    begin
+      bind = target
+      # Complete stdlib symbols
+      case input
+      when REGEX_REGEXP # Regexp
+        receiver = $1
+        message = Regexp.quote($2)
+        candidates = Regexp.instance_methods.collect(&:to_s)
+        select_message(path, receiver, message, candidates)
+      when ARRAY_REGEXP # Array
+        receiver = $1
+        message = Regexp.quote($2)
+        candidates = Array.instance_methods.collect(&:to_s)
+        select_message(path, receiver, message, candidates)
+      when PROC_OR_HASH_REGEXP # Proc or Hash
+        receiver = $1
+        message = Regexp.quote($2)
+        candidates = Proc.instance_methods.collect(&:to_s)
+        candidates |= Hash.instance_methods.collect(&:to_s)
+        select_message(path, receiver, message, candidates)
+      when SYMBOL_REGEXP # Symbol
+        if Symbol.respond_to?(:all_symbols)
+          sym        = Regexp.quote($1)
+          candidates = Symbol.all_symbols.collect{|s| ":" << s.id2name}
+          candidates.grep(/^#{sym}/)
+        else
+          []
+        end
+      when TOPLEVEL_LOOKUP_REGEXP # Absolute Constant or class methods
+        receiver = $1
+        candidates = Object.constants.collect(&:to_s)
+        candidates.grep(/^#{receiver}/).collect{|e| "::" << e}
+      when CONSTANT_REGEXP # Constant
+        message = $1
+        begin
+          context = target.eval("self")
+          context = context.class unless context.respond_to? :constants
+                                    candidates = context.constants.collect(&:to_s)
+                                  rescue
+                                    candidates = []
+                                  end
+          candidates = candidates.grep(/^#{message}/).collect(&path)
+        when CONSTANT_OR_METHOD_REGEXP # Constant or class methods
+          receiver = $1
+          message = Regexp.quote($2)
+          begin
+            candidates = eval("#{receiver}.constants.collect(&:to_s)", bind)
+            candidates |= eval("#{receiver}.methods.collect(&:to_s)", bind)
+          rescue Pry::RescuableException
+            candidates = []
+          end
+          candidates.grep(/^#{message}/).collect{|e| receiver << "::" << e}
+        when SYMBOL_METHOD_CALL_REGEXP # method call on a Symbol
+          receiver = $1
+          message = Regexp.quote($2)
+          candidates = Symbol.instance_methods.collect(&:to_s)
+          select_message(path, receiver, message, candidates)
+        when NUMERIC_REGEXP
+          # Numeric
+          receiver = $1
+          message = Regexp.quote($5)
+          begin
+            candidates = eval(receiver, bind).methods.collect(&:to_s)
+          rescue Pry::RescuableException
+            candidates = []
+          end
+          select_message(path, receiver, message, candidates)
+        when HEX_REGEXP
+          # Numeric(0xFFFF)
+          receiver = $1
+          message = Regexp.quote($2)
+          begin
+            candidates = eval(receiver, bind).methods.collect(&:to_s)
+          rescue Pry::RescuableException
+            candidates = []
+          end
+          select_message(path, receiver, message, candidates)
+        when GLOBALVARIABLE_REGEXP # global
+          regmessage = Regexp.new(Regexp.quote($1))
+          candidates = global_variables.collect(&:to_s).grep(regmessage)
+        when VARIABLE_REGEXP # variable
+          receiver = $1
+          message = Regexp.quote($2)
+
+          gv = eval("global_variables", bind).collect(&:to_s)
+          lv = eval("local_variables", bind).collect(&:to_s)
+          cv = eval("self.class.constants", bind).collect(&:to_s)
+
+          if (gv | lv | cv).include?(receiver) or /^[A-Z]/ =~ receiver && /\./ !~ receiver
+            # foo.func and foo is local var. OR
+            # Foo::Bar.func
+            begin
+              candidates = eval("#{receiver}.methods", bind).collect(&:to_s)
+            rescue Pry::RescuableException
+              candidates = []
+            end
+          else
+            # func1.func2
+            candidates = []
+            ObjectSpace.each_object(Module){|m|
+              begin
+                name = m.name.to_s
+              rescue Pry::RescuableException
+                name = ""
+              end
+              next if name != "IRB::Context" and
+              /^(IRB|SLex|RubyLex|RubyToken)/ =~ name
+
+              # jruby doesn't always provide #instance_methods() on each
+              # object.
+              if m.respond_to?(:instance_methods)
+                candidates.concat m.instance_methods(false).collect(&:to_s)
+              end
+            }
+            candidates.sort!
+            candidates.uniq!
+          end
+          select_message(path, receiver, message, candidates)
+        when /^\.([^.]*)$/
+          # Unknown(maybe String)
+          receiver = ""
+          message = Regexp.quote($1)
+          candidates = String.instance_methods(true).collect(&:to_s)
+          select_message(path, receiver, message, candidates)
+        else
+          candidates = eval(
+                            "methods | private_methods | local_variables | " \
+                            "self.class.constants | instance_variables",
+                            bind
+                            ).collect(&:to_s)
+
+          if eval("respond_to?(:class_variables)", bind)
+            candidates += eval("class_variables", bind).collect(&:to_s)
+          end
+          candidates = (candidates|ReservedWords|custom_completions).grep(/^#{Regexp.quote(input)}/)
+          candidates.collect(&path)
+        end
+      rescue Pry::RescuableException
+        []
+      end
+    end
+
+    def select_message(path, receiver, message, candidates)
+      candidates.grep(/^#{message}/).collect { |e|
+        case e
+        when /^[a-zA-Z_]/
+          path.call(receiver + "." << e)
+        when /^[0-9]/
+        when *Operators
+          #receiver + " " << e
+        end
+      }.compact
+    end
+
+    # build_path seperates the input into two parts: path and input.
+    # input is the partial string that should be completed
+    # path is a proc that takes an input and builds a full path.
+    def build_path(input)
+      # check to see if the input is a regex
+      return proc {|i| i.to_s }, input if input[/\/\./]
+      trailing_slash = input.end_with?('/')
+      contexts = input.chomp('/').split(/\//)
+      input = contexts[-1]
+      path = proc do |i|
+        p = contexts[0..-2].push(i).join('/')
+        p += '/' if trailing_slash && !i.nil?
+        p
+      end
+      return path, input
+    end
+end

data/lib/pry/input_lock.rb

@@ -0,0 +1,132 @@
+require 'thread'
+
+class Pry
+  # There is one InputLock per input (such as STDIN) as two REPLs on the same
+  # input makes things delirious. InputLock serializes accesses to the input so
+  # that threads to not conflict with each other. The latest thread to request
+  # ownership of the input wins.
+  class InputLock
+    class Interrupt < Exception; end
+
+    class << self
+      attr_accessor :input_locks
+      attr_accessor :global_lock
+    end
+
+    self.input_locks = {}
+    self.global_lock = Mutex.new
+
+    def self.for(input)
+      # XXX This method leaks memory, as we never unregister an input once we
+      # are done with it. Fortunately, the leak is tiny (or so we hope).  In
+      # usual scenarios, we would leak the StringIO that is passed to be
+      # evaluated from the command line.
+      global_lock.synchronize do
+        input_locks[input] ||= Pry::InputLock.new
+      end
+    end
+
+    def initialize
+      @mutex = Mutex.new
+      @cond = ConditionVariable.new
+      @owners = []
+      @interruptible = false
+    end
+
+    # Adds ourselves to the ownership list. The last one in the list may access
+    # the input through interruptible_region().
+    def __with_ownership(&block)
+      @mutex.synchronize do
+        # Three cases:
+        # 1) There are no owners, in this case we are good to go.
+        # 2) The current owner of the input is not reading the input (it might
+        #    just be evaluating some ruby that the user typed).
+        #    The current owner will figure out that it cannot go back to reading
+        #    the input since we are adding ourselves to the @owners list, which
+        #    in turns makes us the current owner.
+        # 3) The owner of the input is in the interruptible region, reading from
+        #    the input. It's safe to send an Interrupt exception to interrupt
+        #    the owner. It will then proceed like in case 2).
+        #    We wait until the owner sets the interruptible flag back
+        #    to false, meaning that he's out of the interruptible region.
+        #    Note that the owner may receive multiple interrupts since, but that
+        #    should be okay (and trying to avoid it is futile anyway).
+        while @interruptible
+          @owners.last.raise Interrupt
+          @cond.wait(@mutex)
+        end
+        @owners << Thread.current
+      end
+
+      block.call
+
+    ensure
+      @mutex.synchronize do
+        # We are releasing any desire to have the input ownership by removing
+        # ourselves from the list.
+        @owners.delete(Thread.current)
+
+        # We need to wake up the thread at the end of the @owners list, but
+        # sadly Ruby doesn't allow us to choose which one we wake up, so we wake
+        # them all up.
+        @cond.broadcast
+      end
+    end
+
+    def with_ownership(&block)
+      # If we are in a nested with_ownership() call (nested pry context), we do nothing.
+      nested = @mutex.synchronize { @owners.include?(Thread.current) }
+      nested ? block.call : __with_ownership(&block)
+    end
+
+    def enter_interruptible_region
+      @mutex.synchronize do
+        # We patiently wait until we are the owner. This may happen as another
+        # thread calls with_ownership() because of a binding.pry happening in
+        # another thread.
+        @cond.wait(@mutex) until @owners.last == Thread.current
+
+        # We are the legitimate owner of the input. We mark ourselves as
+        # interruptible, so other threads can send us an Interrupt exception
+        # while we are blocking from reading the input.
+        @interruptible = true
+      end
+    end
+
+    def leave_interruptible_region
+      @mutex.synchronize do
+        # We check if we are still the owner, because we could have received an
+        # Interrupt right after the following @cond.broadcast, making us retry.
+        @interruptible = false if @owners.last == Thread.current
+        @cond.broadcast
+      end
+    rescue Interrupt
+      # We need to guard against a spurious interrupt delivered while we are
+      # trying to acquire the lock (the rescue block is no longer in our scope).
+      retry
+    end
+
+    def interruptible_region(&block)
+      enter_interruptible_region
+
+      # XXX Note that there is a chance that we get the interrupt right after
+      # the readline call succeeded, but we'll never know, and we will retry the
+      # call, discarding that piece of input.
+      block.call
+
+    rescue Interrupt
+      # We were asked to back off. The one requesting the interrupt will be
+      # waiting on the conditional for the interruptible flag to change to false.
+      # Note that there can be some inefficiency, as we could immediately
+      # succeed in enter_interruptible_region(), even before the one requesting
+      # the ownership has the chance to register itself as an owner.
+      # To mitigate the issue, we sleep a little bit.
+      leave_interruptible_region
+      sleep 0.01
+      retry
+
+    ensure
+      leave_interruptible_region
+    end
+  end
+end