1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
|
# frozen_string_literal: false
require "pathname"
require "irb"
require_relative "helper"
module TestIRB
class CompletionTest < TestCase
def completion_candidates(target, bind)
IRB::RegexpCompletor.new.completion_candidates('', target, '', bind: bind)
end
def doc_namespace(target, bind)
IRB::RegexpCompletor.new.doc_namespace('', target, '', bind: bind)
end
class CommandCompletionTest < CompletionTest
def test_command_completion
completor = IRB::RegexpCompletor.new
binding.eval("some_var = 1")
# completion for help command's argument should only include command names
assert_include(completor.completion_candidates('help ', 's', '', bind: binding), 'show_source')
assert_not_include(completor.completion_candidates('help ', 's', '', bind: binding), 'some_var')
assert_include(completor.completion_candidates('', 'show_s', '', bind: binding), 'show_source')
assert_not_include(completor.completion_candidates(';', 'show_s', '', bind: binding), 'show_source')
end
end
class MethodCompletionTest < CompletionTest
def test_complete_string
assert_include(completion_candidates("'foo'.up", binding), "'foo'.upcase")
# completing 'foo bar'.up
assert_include(completion_candidates("bar'.up", binding), "bar'.upcase")
assert_equal("String.upcase", doc_namespace("'foo'.upcase", binding))
end
def test_complete_regexp
assert_include(completion_candidates("/foo/.ma", binding), "/foo/.match")
# completing /foo bar/.ma
assert_include(completion_candidates("bar/.ma", binding), "bar/.match")
assert_equal("Regexp.match", doc_namespace("/foo/.match", binding))
end
def test_complete_array
assert_include(completion_candidates("[].an", binding), "[].any?")
assert_equal("Array.any?", doc_namespace("[].any?", binding))
end
def test_complete_hash_and_proc
# hash
assert_include(completion_candidates("{}.an", binding), "{}.any?")
assert_equal(["Hash.any?", "Proc.any?"], doc_namespace("{}.any?", binding))
# proc
assert_include(completion_candidates("{}.bin", binding), "{}.binding")
assert_equal(["Hash.binding", "Proc.binding"], doc_namespace("{}.binding", binding))
end
def test_complete_numeric
assert_include(completion_candidates("1.positi", binding), "1.positive?")
assert_equal("Integer.positive?", doc_namespace("1.positive?", binding))
assert_include(completion_candidates("1r.positi", binding), "1r.positive?")
assert_equal("Rational.positive?", doc_namespace("1r.positive?", binding))
assert_include(completion_candidates("0xFFFF.positi", binding), "0xFFFF.positive?")
assert_equal("Integer.positive?", doc_namespace("0xFFFF.positive?", binding))
assert_empty(completion_candidates("1i.positi", binding))
end
def test_complete_symbol
assert_include(completion_candidates(":foo.to_p", binding), ":foo.to_proc")
assert_equal("Symbol.to_proc", doc_namespace(":foo.to_proc", binding))
end
def test_complete_class
assert_include(completion_candidates("String.ne", binding), "String.new")
assert_equal("String.new", doc_namespace("String.new", binding))
end
end
class RequireComepletionTest < CompletionTest
def test_complete_require
candidates = IRB::RegexpCompletor.new.completion_candidates("require ", "'irb", "", bind: binding)
%w['irb/init 'irb/ruby-lex].each do |word|
assert_include candidates, word
end
# Test cache
candidates = IRB::RegexpCompletor.new.completion_candidates("require ", "'irb", "", bind: binding)
%w['irb/init 'irb/ruby-lex].each do |word|
assert_include candidates, word
end
# Test string completion not disturbed by require completion
candidates = IRB::RegexpCompletor.new.completion_candidates("'string ", "'.", "", bind: binding)
assert_include candidates, "'.upcase"
end
def test_complete_require_with_pathname_in_load_path
temp_dir = Dir.mktmpdir
File.write(File.join(temp_dir, "foo.rb"), "test")
test_path = Pathname.new(temp_dir)
$LOAD_PATH << test_path
candidates = IRB::RegexpCompletor.new.completion_candidates("require ", "'foo", "", bind: binding)
assert_include candidates, "'foo"
ensure
$LOAD_PATH.pop if test_path
FileUtils.remove_entry(temp_dir) if temp_dir
end
def test_complete_require_with_string_convertable_in_load_path
temp_dir = Dir.mktmpdir
File.write(File.join(temp_dir, "foo.rb"), "test")
object = Object.new
object.define_singleton_method(:to_s) { temp_dir }
$LOAD_PATH << object
candidates = IRB::RegexpCompletor.new.completion_candidates("require ", "'foo", "", bind: binding)
assert_include candidates, "'foo"
ensure
$LOAD_PATH.pop if object
FileUtils.remove_entry(temp_dir) if temp_dir
end
def test_complete_require_with_malformed_object_in_load_path
object = Object.new
def object.to_s; raise; end
$LOAD_PATH << object
assert_nothing_raised do
IRB::RegexpCompletor.new.completion_candidates("require ", "'foo", "", bind: binding)
end
ensure
$LOAD_PATH.pop if object
end
def test_complete_require_library_name_first
# Test that library name is completed first with subdirectories
candidates = IRB::RegexpCompletor.new.completion_candidates("require ", "'irb", "", bind: binding)
assert_equal "'irb", candidates.first
end
def test_complete_require_relative
candidates = Dir.chdir(__dir__ + "/../..") do
IRB::RegexpCompletor.new.completion_candidates("require_relative ", "'lib/irb", "", bind: binding)
end
%w['lib/irb/init 'lib/irb/ruby-lex].each do |word|
assert_include candidates, word
end
# Test cache
candidates = Dir.chdir(__dir__ + "/../..") do
IRB::RegexpCompletor.new.completion_candidates("require_relative ", "'lib/irb", "", bind: binding)
end
%w['lib/irb/init 'lib/irb/ruby-lex].each do |word|
assert_include candidates, word
end
end
end
class VariableCompletionTest < CompletionTest
def test_complete_variable
# Bug fix issues https://github.com/ruby/irb/issues/368
# Variables other than `str_example` and `@str_example` are defined to ensure that irb completion does not cause unintended behavior
str_example = ''
@str_example = ''
private_methods = ''
methods = ''
global_variables = ''
local_variables = ''
instance_variables = ''
# suppress "assigned but unused variable" warning
str_example.clear
@str_example.clear
private_methods.clear
methods.clear
global_variables.clear
local_variables.clear
instance_variables.clear
assert_include(completion_candidates("str_examp", binding), "str_example")
assert_equal("String", doc_namespace("str_example", binding))
assert_equal("String.to_s", doc_namespace("str_example.to_s", binding))
assert_include(completion_candidates("@str_examp", binding), "@str_example")
assert_equal("String", doc_namespace("@str_example", binding))
assert_equal("String.to_s", doc_namespace("@str_example.to_s", binding))
end
def test_complete_sort_variables
xzy, xzy_1, xzy2 = '', '', ''
xzy.clear
xzy_1.clear
xzy2.clear
candidates = completion_candidates("xz", binding)
assert_equal(%w[xzy xzy2 xzy_1], candidates)
end
end
class ConstantCompletionTest < CompletionTest
class Foo
B3 = 1
B1 = 1
B2 = 1
end
def test_complete_constants
assert_equal(["Foo"], completion_candidates("Fo", binding))
assert_equal(["Foo::B1", "Foo::B2", "Foo::B3"], completion_candidates("Foo::B", binding))
assert_equal(["Foo::B1.positive?"], completion_candidates("Foo::B1.pos", binding))
assert_equal(["::Forwardable"], completion_candidates("::Fo", binding))
assert_equal("Forwardable", doc_namespace("::Forwardable", binding))
end
end
def test_not_completing_empty_string
assert_equal([], completion_candidates("", binding))
assert_equal([], completion_candidates(" ", binding))
assert_equal([], completion_candidates("\t", binding))
assert_equal(nil, doc_namespace("", binding))
end
def test_complete_symbol
symbols = %w"UTF-16LE UTF-7".map do |enc|
"K".force_encoding(enc).to_sym
rescue
end
symbols += [:aiueo, :"aiu eo"]
candidates = completion_candidates(":a", binding)
assert_include(candidates, ":aiueo")
assert_not_include(candidates, ":aiu eo")
assert_empty(completion_candidates(":irb_unknown_symbol_abcdefg", binding))
# Do not complete empty symbol for performance reason
assert_empty(completion_candidates(":", binding))
end
def test_complete_invalid_three_colons
assert_empty(completion_candidates(":::A", binding))
assert_empty(completion_candidates(":::", binding))
end
def test_complete_absolute_constants_with_special_characters
assert_empty(completion_candidates("::A:", binding))
assert_empty(completion_candidates("::A.", binding))
assert_empty(completion_candidates("::A(", binding))
assert_empty(completion_candidates("::A)", binding))
assert_empty(completion_candidates("::A[", binding))
end
def test_complete_reserved_words
candidates = completion_candidates("de", binding)
%w[def defined?].each do |word|
assert_include candidates, word
end
candidates = completion_candidates("__", binding)
%w[__ENCODING__ __LINE__ __FILE__].each do |word|
assert_include candidates, word
end
end
def test_complete_methods
obj = Object.new
obj.singleton_class.class_eval {
def public_hoge; end
private def private_hoge; end
# Support for overriding #methods etc.
def methods; end
def private_methods; end
def global_variables; end
def local_variables; end
def instance_variables; end
}
bind = obj.instance_exec { binding }
assert_include(completion_candidates("public_hog", bind), "public_hoge")
assert_include(doc_namespace("public_hoge", bind), "public_hoge")
assert_include(completion_candidates("private_hog", bind), "private_hoge")
assert_include(doc_namespace("private_hoge", bind), "private_hoge")
end
end
class DeprecatedInputCompletorTest < TestCase
def setup
save_encodings
@verbose, $VERBOSE = $VERBOSE, nil
IRB.init_config(nil)
IRB.conf[:VERBOSE] = false
IRB.conf[:MAIN_CONTEXT] = IRB::Context.new(IRB::WorkSpace.new(binding))
end
def teardown
restore_encodings
$VERBOSE = @verbose
end
def test_completion_proc
assert_include(IRB::InputCompletor::CompletionProc.call('1.ab'), '1.abs')
assert_include(IRB::InputCompletor::CompletionProc.call('1.ab', '', ''), '1.abs')
end
def test_retrieve_completion_data
assert_include(IRB::InputCompletor.retrieve_completion_data('1.ab'), '1.abs')
assert_equal(IRB::InputCompletor.retrieve_completion_data('1.abs', doc_namespace: true), 'Integer.abs')
bind = eval('a = 1; binding')
assert_include(IRB::InputCompletor.retrieve_completion_data('a.ab', bind: bind), 'a.abs')
assert_equal(IRB::InputCompletor.retrieve_completion_data('a.abs', bind: bind, doc_namespace: true), 'Integer.abs')
end
end
end
|