mirror of
https://github.com/pry/pry.git
synced 2022-11-09 12:35:05 -05:00
add support tab-completing arbitrarily long paths
This commit is contained in:
parent
fd486641fe
commit
3841563fb2
2 changed files with 164 additions and 80 deletions
|
@ -43,34 +43,48 @@ class Pry
|
||||||
# @param [Array<String>] commands The array of Pry commands.
|
# @param [Array<String>] commands The array of Pry commands.
|
||||||
def self.build_completion_proc(target, pry=nil, commands=[""])
|
def self.build_completion_proc(target, pry=nil, commands=[""])
|
||||||
proc do |input|
|
proc do |input|
|
||||||
|
|
||||||
|
# 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(input)
|
||||||
|
|
||||||
|
unless path.call.empty?
|
||||||
|
target, _ = Pry::Helpers::BaseHelpers.context_from_object_path(path.call, pry)
|
||||||
|
target = target.last
|
||||||
|
end
|
||||||
|
|
||||||
begin
|
begin
|
||||||
bind = target
|
bind = target
|
||||||
|
|
||||||
case input
|
case input
|
||||||
|
|
||||||
|
|
||||||
|
# Complete stdlib symbols
|
||||||
|
|
||||||
when /^(\/[^\/]*\/)\.([^.]*)$/
|
when /^(\/[^\/]*\/)\.([^.]*)$/
|
||||||
# Regexp
|
# Regexp
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
|
|
||||||
candidates = Regexp.instance_methods.collect{|m| m.to_s}
|
candidates = Regexp.instance_methods.collect(&:to_s)
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^([^\]]*\])\.([^.]*)$/
|
when /^([^\]]*\])\.([^.]*)$/
|
||||||
# Array
|
# Array
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
|
|
||||||
candidates = Array.instance_methods.collect{|m| m.to_s}
|
candidates = Array.instance_methods.collect(&:to_s)
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^([^\}]*\})\.([^.]*)$/
|
when /^([^\}]*\})\.([^.]*)$/
|
||||||
# Proc or Hash
|
# Proc or Hash
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
|
|
||||||
candidates = Proc.instance_methods.collect{|m| m.to_s}
|
candidates = Proc.instance_methods.collect(&:to_s)
|
||||||
candidates |= Hash.instance_methods.collect{|m| m.to_s}
|
candidates |= Hash.instance_methods.collect(&:to_s)
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^(:[^:.]*)$/
|
when /^(:[^:.]*)$/
|
||||||
# Symbol
|
# Symbol
|
||||||
|
@ -86,16 +100,25 @@ class Pry
|
||||||
when /^::([A-Z][^:\.\(]*)$/
|
when /^::([A-Z][^:\.\(]*)$/
|
||||||
# Absolute Constant or class methods
|
# Absolute Constant or class methods
|
||||||
receiver = $1
|
receiver = $1
|
||||||
candidates = Object.constants.collect{|m| m.to_s}
|
candidates = Object.constants.collect(&:to_s)
|
||||||
candidates.grep(/^#{receiver}/).collect{|e| "::" + e}
|
candidates.grep(/^#{receiver}/).collect{|e| "::" + e}
|
||||||
|
|
||||||
when /^([A-Z].*)::([^:.]*)$/
|
|
||||||
|
# Complete target symbols
|
||||||
|
|
||||||
|
when /^([A-Z][A-Za-z0-9]*)$/
|
||||||
|
# Constant
|
||||||
|
message = $1
|
||||||
|
candidates = target.eval("self.class.constants").collect(&:to_s)
|
||||||
|
candidates.grep(/^#{message}/).collect(&path)
|
||||||
|
|
||||||
|
when /^([A-Z].*)::([^:.]*)$/
|
||||||
# Constant or class methods
|
# Constant or class methods
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
begin
|
begin
|
||||||
candidates = eval("#{receiver}.constants.collect{|m| m.to_s}", bind)
|
candidates = eval("#{receiver}.constants.collect(&:to_s)", bind)
|
||||||
candidates |= eval("#{receiver}.methods.collect{|m| m.to_s}", bind)
|
candidates |= eval("#{receiver}.methods.collect(&:to_s)", bind)
|
||||||
rescue RescuableException
|
rescue RescuableException
|
||||||
candidates = []
|
candidates = []
|
||||||
end
|
end
|
||||||
|
@ -106,8 +129,8 @@ class Pry
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
|
|
||||||
candidates = Symbol.instance_methods.collect{|m| m.to_s}
|
candidates = Symbol.instance_methods.collect(&:to_s)
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^(-?(0[dbo])?[0-9_]+(\.[0-9_]+)?([eE]-?[0-9]+)?)\.([^.]*)$/
|
when /^(-?(0[dbo])?[0-9_]+(\.[0-9_]+)?([eE]-?[0-9]+)?)\.([^.]*)$/
|
||||||
# Numeric
|
# Numeric
|
||||||
|
@ -115,42 +138,43 @@ class Pry
|
||||||
message = Regexp.quote($5)
|
message = Regexp.quote($5)
|
||||||
|
|
||||||
begin
|
begin
|
||||||
candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
|
candidates = eval(receiver, bind).methods.collect(&:to_s)
|
||||||
rescue RescuableException
|
rescue RescuableException
|
||||||
candidates = []
|
candidates = []
|
||||||
end
|
end
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^(-?0x[0-9a-fA-F_]+)\.([^.]*)$/
|
when /^(-?0x[0-9a-fA-F_]+)\.([^.]*)$/#
|
||||||
# Numeric(0xFFFF)
|
# Numeric(0xFFFF)
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
|
|
||||||
begin
|
begin
|
||||||
candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
|
candidates = eval(receiver, bind).methods.collect(&:to_s)
|
||||||
rescue RescuableException
|
rescue RescuableException
|
||||||
candidates = []
|
candidates = []
|
||||||
end
|
end
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^(\$[^.]*)$/
|
when /^(\$[^.]*)$/
|
||||||
|
# Global variables
|
||||||
regmessage = Regexp.new(Regexp.quote($1))
|
regmessage = Regexp.new(Regexp.quote($1))
|
||||||
candidates = global_variables.collect{|m| m.to_s}.grep(regmessage)
|
candidates = global_variables.collect(&:to_s).grep(regmessage)
|
||||||
|
|
||||||
when /^([^."].*)\.([^.]*)$/
|
when /^([^."].*)\.([^.]*)$/
|
||||||
# variable
|
# Variable
|
||||||
receiver = $1
|
receiver = $1
|
||||||
message = Regexp.quote($2)
|
message = Regexp.quote($2)
|
||||||
|
|
||||||
gv = eval("global_variables", bind).collect{|m| m.to_s}
|
gv = eval("global_variables", bind).collect(&:to_s)
|
||||||
lv = eval("local_variables", bind).collect{|m| m.to_s}
|
lv = eval("local_variables", bind).collect(&:to_s)
|
||||||
cv = eval("self.class.constants", bind).collect{|m| m.to_s}
|
cv = eval("self.class.constants", bind).collect(&:to_s)
|
||||||
|
|
||||||
if (gv | lv | cv).include?(receiver) or /^[A-Z]/ =~ receiver && /\./ !~ receiver
|
if (gv | lv | cv).include?(receiver) or /^[A-Z]/ =~ receiver && /\./ !~ receiver
|
||||||
# foo.func and foo is local var. OR
|
# foo.func and foo is local var. OR
|
||||||
# Foo::Bar.func
|
# Foo::Bar.func
|
||||||
begin
|
begin
|
||||||
candidates = eval("#{receiver}.methods", bind).collect{|m| m.to_s}
|
candidates = eval("#{receiver}.methods", bind).collect(&:to_s)
|
||||||
rescue RescuableException
|
rescue RescuableException
|
||||||
candidates = []
|
candidates = []
|
||||||
end
|
end
|
||||||
|
@ -169,49 +193,35 @@ class Pry
|
||||||
# jruby doesn't always provide #instance_methods() on each
|
# jruby doesn't always provide #instance_methods() on each
|
||||||
# object.
|
# object.
|
||||||
if m.respond_to?(:instance_methods)
|
if m.respond_to?(:instance_methods)
|
||||||
candidates.concat m.instance_methods(false).collect{|x| x.to_s}
|
candidates.concat m.instance_methods(false).collect(&:to_s)
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
candidates.sort!
|
candidates.sort!
|
||||||
candidates.uniq!
|
candidates.uniq!
|
||||||
end
|
end
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
when /^(\.{2}\/)(.*)$/
|
|
||||||
# previous scope (../) *
|
|
||||||
stack = pry.binding_stack.dup
|
|
||||||
stack.pop
|
|
||||||
if stack.length >= 1
|
|
||||||
receiver = $1
|
|
||||||
message = $2
|
|
||||||
scope = stack[-1]
|
|
||||||
|
|
||||||
ivars = eval("instance_variables", scope)
|
|
||||||
locals = eval("local_variables", scope)
|
|
||||||
select_message(receiver, message, ivars + locals)
|
|
||||||
end
|
|
||||||
|
|
||||||
when /^\.([^.]*)$/
|
when /^\.([^.]*)$/
|
||||||
# unknown(maybe String)
|
# Unknown(maybe String)
|
||||||
|
|
||||||
receiver = ""
|
receiver = ""
|
||||||
message = Regexp.quote($1)
|
message = Regexp.quote($1)
|
||||||
|
|
||||||
candidates = String.instance_methods(true).collect{|m| m.to_s}
|
candidates = String.instance_methods(true).collect(&:to_s)
|
||||||
select_message(receiver, message, candidates)
|
select_message(path, receiver, message, candidates)
|
||||||
|
|
||||||
else
|
else
|
||||||
|
|
||||||
candidates = eval(
|
candidates = eval(
|
||||||
"methods | private_methods | local_variables | " \
|
"methods | private_methods | local_variables | " \
|
||||||
"self.class.constants | instance_variables",
|
"self.class.constants | instance_variables",
|
||||||
bind
|
bind
|
||||||
).collect{|m| m.to_s}
|
).collect(&:to_s)
|
||||||
|
|
||||||
if eval("respond_to?(:class_variables)", bind)
|
if eval("respond_to?(:class_variables)", bind)
|
||||||
candidates += eval("class_variables", bind).collect { |m| m.to_s }
|
candidates += eval("class_variables", bind).collect(&:to_s)
|
||||||
end
|
end
|
||||||
|
candidates = (candidates|ReservedWords|commands).grep(/^#{Regexp.quote(input)}/)
|
||||||
(candidates|ReservedWords|commands).grep(/^#{Regexp.quote(input)}/)
|
candidates.collect(&path)
|
||||||
end
|
end
|
||||||
rescue RescuableException
|
rescue RescuableException
|
||||||
[]
|
[]
|
||||||
|
@ -219,21 +229,33 @@ class Pry
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def self.select_message(receiver, message, candidates)
|
def self.select_message(path, receiver, message, candidates)
|
||||||
candidates.grep(/^#{message}/).collect do |e|
|
candidates.grep(/^#{message}/).collect do |e|
|
||||||
if receiver.match(/^\.{2}\//)
|
case e
|
||||||
receiver + e.to_s
|
when /^[a-zA-Z_]/
|
||||||
else
|
path.call(receiver + "." + e)
|
||||||
case e
|
when /^[0-9]/
|
||||||
when /^[a-zA-Z_]/
|
when *Operators
|
||||||
receiver + "." + e
|
#receiver + " " + e
|
||||||
when /^[0-9]/
|
|
||||||
when *Operators
|
|
||||||
#receiver + " " + e
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def self.build_path(input)
|
||||||
|
return proc {|input| input.to_s }, input if input[/\/\./]
|
||||||
|
|
||||||
|
trailing_slash = input[-1] == '/'
|
||||||
|
contexts = input.chomp('/').split(/\//)
|
||||||
|
input = contexts[-1]
|
||||||
|
|
||||||
|
path = proc do |input|
|
||||||
|
p = contexts[0..-2].push(input).join('/')
|
||||||
|
p += '/' if trailing_slash && !input.nil?
|
||||||
|
p
|
||||||
|
end
|
||||||
|
|
||||||
|
return path, input
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,16 @@
|
||||||
require 'helper'
|
require 'helper'
|
||||||
|
|
||||||
|
def new_completer(bind, pry=nil)
|
||||||
|
Pry::InputCompleter.build_completion_proc(Pry.binding_for(bind), pry)
|
||||||
|
end
|
||||||
|
|
||||||
|
def completer_test(bind, pry=nil, assert_flag=true)
|
||||||
|
completer = new_completer(bind, pry)
|
||||||
|
test = proc {|symbol| completer.call(symbol[0..-2]).include?(symbol).should == assert_flag}
|
||||||
|
return proc {|*symbols| symbols.each(&test) }
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
describe Pry::InputCompleter do
|
describe Pry::InputCompleter do
|
||||||
|
|
||||||
before do
|
before do
|
||||||
|
@ -33,33 +44,83 @@ describe Pry::InputCompleter do
|
||||||
it 'should complete instance variables' do
|
it 'should complete instance variables' do
|
||||||
object = Object.new
|
object = Object.new
|
||||||
|
|
||||||
|
# set variables in appropriate scope
|
||||||
object.instance_variable_set(:'@name', 'Pry')
|
object.instance_variable_set(:'@name', 'Pry')
|
||||||
object.class.send(:class_variable_set, :'@@number', 10)
|
object.class.send(:class_variable_set, :'@@number', 10)
|
||||||
|
|
||||||
object.instance_variables.map { |v| v.to_sym } \
|
# check to see if variables are in scope
|
||||||
.include?(:'@name').should == true
|
object.instance_variables.
|
||||||
|
map { |v| v.to_sym }.
|
||||||
|
include?(:'@name').should == true
|
||||||
|
|
||||||
object.class.class_variables.map { |v| v.to_sym } \
|
object.class.class_variables.
|
||||||
.include?(:'@@number').should == true
|
map { |v| v.to_sym }.
|
||||||
|
include?(:'@@number').should == true
|
||||||
completer = Pry::InputCompleter.build_completion_proc(
|
|
||||||
Pry.binding_for(object)
|
|
||||||
)
|
|
||||||
|
|
||||||
# Complete instance variables.
|
# Complete instance variables.
|
||||||
completer.call('@na').include?('@name').should == true
|
b = Pry.binding_for(object)
|
||||||
completer.call('@name.down').include?('@name.downcase').should == true
|
completer_test(b).call('@name', '@name.downcase')
|
||||||
|
|
||||||
# Complete class variables.
|
# Complete class variables.
|
||||||
completer = Pry::InputCompleter.build_completion_proc(
|
b = Pry.binding_for(object.class)
|
||||||
Pry.binding_for(object.class)
|
completer_test(b).call('@@number', '@@number.class')
|
||||||
)
|
|
||||||
|
|
||||||
completer.call('@@nu').include?('@@number').should == true
|
|
||||||
completer.call('@@number.cl').include?('@@number.class').should == true
|
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'should complete previous scope' do
|
it 'should complete for stdlib symbols' do
|
||||||
|
|
||||||
|
o = Object.new
|
||||||
|
# Regexp
|
||||||
|
completer_test(o).call('/foo/.extend')
|
||||||
|
|
||||||
|
# Array
|
||||||
|
completer_test(o).call('[1].push')
|
||||||
|
|
||||||
|
# Hash
|
||||||
|
completer_test(o).call('{"a" => "b"}.keys')
|
||||||
|
|
||||||
|
# Proc
|
||||||
|
completer_test(o).call('{2}.call')
|
||||||
|
|
||||||
|
# Symbol
|
||||||
|
completer_test(o).call(':symbol.to_s')
|
||||||
|
|
||||||
|
# Absolute Constant
|
||||||
|
completer_test(o).call('::IndexError')
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'should complete for target symbols' do
|
||||||
|
o = Object.new
|
||||||
|
|
||||||
|
# Constant
|
||||||
|
module Mod
|
||||||
|
Con = 'Constant'
|
||||||
|
module Mod2
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
completer_test(Mod).call('Con')
|
||||||
|
|
||||||
|
# Constants or Class Methods
|
||||||
|
completer_test(o).call('Mod::Con')
|
||||||
|
|
||||||
|
# Symbol
|
||||||
|
foo = :symbol
|
||||||
|
completer_test(o).call(':symbol')
|
||||||
|
|
||||||
|
# Variables
|
||||||
|
class << o
|
||||||
|
attr_accessor :foo
|
||||||
|
end
|
||||||
|
o.foo = 'bar'
|
||||||
|
completer_test(binding).call('o.foo')
|
||||||
|
|
||||||
|
# trailing slash
|
||||||
|
new_completer(Mod).call('Mod2/').include?('Mod2/').should == true
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'should complete for arbitrary scopes' do
|
||||||
module Bar
|
module Bar
|
||||||
@barvar = :bar
|
@barvar = :bar
|
||||||
end
|
end
|
||||||
|
@ -74,11 +135,12 @@ describe Pry::InputCompleter do
|
||||||
stack.push(Pry.binding_for(Baz))
|
stack.push(Pry.binding_for(Baz))
|
||||||
stack.push(Pry.binding_for(Bar))
|
stack.push(Pry.binding_for(Bar))
|
||||||
|
|
||||||
completer = Pry::InputCompleter.build_completion_proc(
|
b = Pry.binding_for(Bar)
|
||||||
Pry.binding_for(Bar), pry
|
completer_test(b, pry).call("../@bazvar")
|
||||||
)
|
|
||||||
|
completer_test(binding, pry).call('/Bar')
|
||||||
|
|
||||||
completer.call('../@').include?("../@bazvar").should == true
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue