Module: Pry::InputCompleter

Defined in:
lib/pry/completion.rb

Overview

Implements tab completion for Readline in Pry

Constant Summary

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 =
[
  "%", "&", "*", "**", "+",  "-",  "/",
  "<", "<<", "<=", "<=>", "==", "===", "=~", ">", ">=", ">>",
  "[]", "[]=", "^", "!", "!=", "!~"
]

Class Method Summary (collapse)

Class Method Details

+ (Object) build_completion_proc(target, pry = nil, commands = [""])

Return a new completion proc for use by Readline.

Parameters:

  • target (Binding)

    The current binding context.

  • commands (Array<String>) (defaults to: [""])

    The array of Pry commands.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/pry/completion.rb', line 66

def self.build_completion_proc(target, pry=nil, commands=[""])

  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
      bind = target

      case input


      # Complete stdlib symbols

      when /^(\/[^\/]*\/)\.([^.]*)$/
        # Regexp
        receiver = $1
        message = Regexp.quote($2)

        candidates = Regexp.instance_methods.collect(&:to_s)
        select_message(path, receiver, message, candidates)

      when /^([^\]]*\])\.([^.]*)$/
        # Array
        receiver = $1
        message = Regexp.quote($2)

        candidates = Array.instance_methods.collect(&:to_s)
        select_message(path, receiver, message, candidates)

      when /^([^\}]*\})\.([^.]*)$/
        # 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
        if Symbol.respond_to?(:all_symbols)
          sym        = Regexp.quote($1)
          candidates = Symbol.all_symbols.collect{|s| ":" + s.id2name}

          candidates.grep(/^#{sym}/)
        else
          []
        end

      when /^::([A-Z][^:\.\(]*)$/
        # Absolute Constant or class methods
        receiver = $1
        candidates = Object.constants.collect(&:to_s)
        candidates.grep(/^#{receiver}/).collect{|e| "::" + e}


      # Complete target symbols

      when /^([A-Z][A-Za-z0-9]*)$/
        # 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 /^([A-Z].*)::([^:.]*)$/
        # 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 RescuableException
          candidates = []
        end
        candidates.grep(/^#{message}/).collect{|e| receiver + "::" + e}

      when /^(:[^:.]+)\.([^.]*)$/
        # Symbol
        receiver = $1
        message = Regexp.quote($2)

        candidates = Symbol.instance_methods.collect(&:to_s)
        select_message(path, receiver, message, candidates)

      when /^(-?(0[dbo])?[0-9_]+(\.[0-9_]+)?([eE]-?[0-9]+)?)\.([^.]*)$/
        # Numeric
        receiver = $1
        message = Regexp.quote($5)

        begin
          candidates = eval(receiver, bind).methods.collect(&:to_s)
        rescue RescuableException
          candidates = []
        end
        select_message(path, receiver, message, candidates)

      when /^(-?0x[0-9a-fA-F_]+)\.([^.]*)$/#
        # Numeric(0xFFFF)
        receiver = $1
        message = Regexp.quote($2)

        begin
          candidates = eval(receiver, bind).methods.collect(&:to_s)
        rescue RescuableException
          candidates = []
        end
        select_message(path, receiver, message, candidates)

      when /^(\$[^.]*)$/
        # Global variables
        regmessage = Regexp.new(Regexp.quote($1))
        candidates = global_variables.collect(&:to_s).grep(regmessage)

      when /^([^."].*)\.([^.]*)$/
        # 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 RescuableException
            candidates = []
          end
        else
          # func1.func2
          candidates = []
          ObjectSpace.each_object(Module){|m|
            begin
              name = m.name.to_s
            rescue 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|commands).grep(/^#{Regexp.quote(input)}/)
        candidates.collect(&path)
      end
    rescue RescuableException
      []
    end
  end
end

+ (Object) build_path(input)

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.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/pry/completion.rb', line 277

def self.build_path(input)

  # check to see if the input is a regex
  return proc {|input| input.to_s }, input if input[/\/\./]

  trailing_slash = input.end_with?('/')
  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

+ (Object) select_message(path, receiver, message, candidates)



262
263
264
265
266
267
268
269
270
271
272
# File 'lib/pry/completion.rb', line 262

def self.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