Module: IRB::InputCompletor
Do not use. This module is for internal use only.
Relationships & Source Files | |
Defined in: | lib/irb/completion.rb |
Constant Summary
-
BASIC_WORD_BREAK_CHARACTERS =
# File 'lib/irb/completion.rb', line 39" \t\n`><=;|&{("
-
CompletionProc =
# File 'lib/irb/completion.rb', line 126lambda { |target, preposing = nil, postposing = nil| if preposing && postposing result = CompletionRequireProc.(target, preposing, postposing) unless result result = retrieve_completion_data(target).compact.map{ |i| i.encode(Encoding.default_external) } end result else retrieve_completion_data(target).compact.map{ |i| i.encode(Encoding.default_external) } end }
-
CompletionRequireProc =
# File 'lib/irb/completion.rb', line 91lambda { |target, preposing = nil, postposing = nil| if target =~ /\A(['"])([^'"]+)\Z/ quote = $1 actual_target = $2 else return nil # It's not String literal end tokens = RubyLex.ripper_lex_without_warning(preposing.gsub(/\s*\z/, '')) tok = nil tokens.reverse_each do |t| unless [:on_lparen, :on_sp, :on_ignored_sp, :on_nl, :on_ignored_nl, :on_comment].include?(t.event) tok = t break end end result = [] if tok && tok.event == :on_ident && tok.state == Ripper::EXPR_CMDARG case tok.tok when 'require' result = retrieve_files_to_require_from_load_path.select { |path| path.start_with?(actual_target) }.map { |path| quote + path } when 'require_relative' result = retrieve_files_to_require_relative_from_current_dir.select { |path| path.start_with?(actual_target) }.map { |path| quote + path } end end result }
-
Operators =
Set of available operators in Ruby
%w[% & * ** + - / < << <= <=> == === =~ > >= >> [] []= ^ ! != !~]
-
PerfectMatchedProc =
# File 'lib/irb/completion.rb', line 369->(matched, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding) { begin require 'rdoc' rescue LoadError return end RDocRIDriver ||= RDoc::RI::Driver.new if matched =~ /\A(?:::)?RubyVM/ and not ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER'] IRB.__send__(:easter_egg) return end namespace = retrieve_completion_data(matched, bind: bind, doc_namespace: true) return unless namespace if namespace.is_a?(Array) out = RDoc::Markup::Document.new namespace.each do |m| begin RDocRIDriver.add_method(out, m) rescue RDoc::RI::Driver::NotFoundError end end RDocRIDriver.display(out) else begin RDocRIDriver.display_names([namespace]) rescue RDoc::RI::Driver::NotFoundError end end }
-
ReservedWords =
Set of reserved words used by Ruby, you should not use these for constants or variables
%w[ __ENCODING__ __LINE__ __FILE__ 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 ]
Class Method Summary
-
.absolute_path?(p) ⇒ Boolean
TODO Remove this method after 2.6 EOL.
- .ignored_modules
- .retrieve_completion_data(input, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding, doc_namespace: false)
- .retrieve_files_to_require_from_load_path
- .retrieve_files_to_require_relative_from_current_dir
- .retrieve_gem_and_system_load_path
- .select_message(receiver, message, candidates, sep = ".")
Class Method Details
.absolute_path?(p) ⇒ Boolean
TODO Remove this method after 2.6 EOL.
# File 'lib/irb/completion.rb', line 41
def self.absolute_path?(p) # TODO Remove this method after 2.6 EOL. if File.respond_to?(:absolute_path?) File.absolute_path?(p) else if File.absolute_path(p) == p true else false end end end
.ignored_modules
[ GitHub ]# File 'lib/irb/completion.rb', line 418
def self.ignored_modules # We could cache the result, but this is very fast already. # By using this approach, we avoid Module#name calls, which are # relatively slow when there are a lot of anonymous modules defined. s = {} scanner = lambda do |m| next if s.include?(m) # IRB::ExtendCommandBundle::EXCB recurses. s[m] = true m.constants(false).each do |c| value = m.const_get(c) scanner.call(value) if value.is_a?(Module) end end %i(IRB RubyLex).each do |sym| next unless Object.const_defined?(sym) scanner.call(Object.const_get(sym)) end s.delete(IRB::Context) if defined?(IRB::Context) s end
.retrieve_completion_data(input, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding, doc_namespace: false)
[ GitHub ]# File 'lib/irb/completion.rb', line 138
def self.retrieve_completion_data(input, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding, doc_namespace: false) case input when /^((["'`]).*\2)\.([^.]*)$/ # String receiver = $1 = $3 candidates = String.instance_methods.collect{|m| m.to_s} if doc_namespace "String.#{}" else (receiver, , candidates) end when /^(\/[^\/]*\/)\.([^.]*)$/ # Regexp receiver = $1 = $2 candidates = Regexp.instance_methods.collect{|m| m.to_s} if doc_namespace "Regexp.#{}" else (receiver, , candidates) end when /^([^\]]*\])\.([^.]*)$/ # Array receiver = $1 = $2 candidates = Array.instance_methods.collect{|m| m.to_s} if doc_namespace "Array.#{}" else (receiver, , candidates) end when /^([^\}]*\})\.([^.]*)$/ # Proc or Hash receiver = $1 = $2 proc_candidates = Proc.instance_methods.collect{|m| m.to_s} hash_candidates = Hash.instance_methods.collect{|m| m.to_s} if doc_namespace ["Proc.#{}", "Hash.#{}"] else (receiver, , proc_candidates | hash_candidates) end when /^(:[^:.]*)$/ # Symbol return nil if doc_namespace sym = $1 candidates = Symbol.all_symbols.collect do |s| ":" + s.id2name.encode(Encoding.default_external) rescue EncodingError # ignore end candidates.grep(/^#{Regexp.quote(sym)}/) when /^::([A-Z][^:\.\(\)]*)$/ # Absolute Constant or class methods receiver = $1 candidates = Object.constants.collect{|m| m.to_s} if doc_namespace candidates.find { |i| i == receiver } else candidates.grep(/^#{receiver}/).collect{|e| "::" + e} end when /^([A-Z].*)::([^:.]*)$/ # Constant or class methods receiver = $1 = $2 begin candidates = eval("#{receiver}.constants.collect{|m| m.to_s}", bind) candidates |= eval("#{receiver}.methods.collect{|m| m.to_s}", bind) rescue Exception candidates = [] end if doc_namespace "#{receiver}::#{}" else (receiver, , candidates, "::") end when /^(:[^:.]+)(\.|::)([^.]*)$/ # Symbol receiver = $1 sep = $2 = $3 candidates = Symbol.instance_methods.collect{|m| m.to_s} if doc_namespace "Symbol.#{}" else (receiver, , candidates, sep) end when /^(?<num>-?(?:0[dbo])?[0-9_](?:\.[0-9_])?(?:(?:[eE][-]?[0-9])?i?|r)?)(?<sep>\.|::)(?<mes>[^.]*)$/ # Numeric receiver = $~[:num] sep = $~[:sep] = $~[:mes] begin instance = eval(receiver, bind) if doc_namespace "#{instance.class.name}.#{}" else candidates = instance.methods.collect{|m| m.to_s} (receiver, , candidates, sep) end rescue Exception if doc_namespace nil else candidates = [] end end when /^(-?0x[0-9a-fA-F_]+)(\.|::)([^.]*)$/ # Numeric(0xFFFF) receiver = $1 sep = $2 = $3 begin instance = eval(receiver, bind) if doc_namespace "#{instance.class.name}.#{}" else candidates = instance.methods.collect{|m| m.to_s} (receiver, , candidates, sep) end rescue Exception if doc_namespace nil else candidates = [] end end when /^(\$[^.]*)$/ # global var gvar = $1 all_gvars = global_variables.collect{|m| m.to_s} if doc_namespace all_gvars.find{ |i| i == gvar } else all_gvars.grep(Regexp.new(Regexp.quote(gvar))) end when /^([^.:"].*)(\.|::)([^.]*)$/ # variable.func or func.func receiver = $1 sep = $2 = $3 gv = eval("global_variables", bind).collect{|m| m.to_s}.push("true", "false", "nil") lv = eval("local_variables", bind).collect{|m| m.to_s} iv = eval("instance_variables", bind).collect{|m| m.to_s} cv = eval("self.class.constants", bind).collect{|m| m.to_s} if (gv | lv | iv | cv).include?(receiver) or /^[A-Z]/ =~ receiver && /\./ !~ receiver # foo.func and foo is var. OR # foo::func and foo is var. OR # foo::Const and foo is var. OR # Foo::Bar.func begin candidates = [] rec = eval(receiver, bind) if sep == "::" and rec.kind_of?(Module) candidates = rec.constants.collect{|m| m.to_s} end candidates |= rec.methods.collect{|m| m.to_s} rescue Exception candidates = [] end else # func1.func2 candidates = [] to_ignore = ignored_modules ObjectSpace.each_object(Module){|m| next if (to_ignore.include?(m) rescue true) candidates.concat m.instance_methods(false).collect{|x| x.to_s} } candidates.sort! candidates.uniq! end if doc_namespace rec_class = rec.is_a?(Module) ? rec : rec.class "#{rec_class.name}#{sep}#{candidates.find{ |i| i == }}" else (receiver, , candidates, sep) end when /^\.([^.]*)$/ # unknown(maybe String) receiver = "" = $1 candidates = String.instance_methods(true).collect{|m| m.to_s} if doc_namespace "String.#{candidates.find{ |i| i == }}" else (receiver, , candidates) end else if doc_namespace vars = eval("local_variables | instance_variables", bind).collect{|m| m.to_s} perfect_match_var = vars.find{|m| m.to_s == input} if perfect_match_var eval("#{perfect_match_var}.class.name", bind) else candidates = eval("methods | private_methods | local_variables | instance_variables | self.class.constants", bind).collect{|m| m.to_s} candidates |= ReservedWords candidates.find{ |i| i == input } end else candidates = eval("methods | private_methods | local_variables | instance_variables | self.class.constants", bind).collect{|m| m.to_s} candidates |= ReservedWords candidates.grep(/^#{Regexp.quote(input)}/) end end end
.retrieve_files_to_require_from_load_path
[ GitHub ]# File 'lib/irb/completion.rb', line 66
def self.retrieve_files_to_require_from_load_path @@files_from_load_path ||= ( shortest = [] rest = retrieve_gem_and_system_load_path.each_with_object([]) { |path, result| begin names = Dir.glob("**/*.{rb,#{RbConfig::CONFIG['DLEXT']}}", base: path) rescue Errno::ENOENT nil end next if names.empty? names.map! { |n| n.sub(/\.(rb|#{RbConfig::CONFIG['DLEXT']})\z/, '') }.sort! shortest << names.shift result.concat(names) } shortest.sort! | rest ) end
.retrieve_files_to_require_relative_from_current_dir
[ GitHub ]# File 'lib/irb/completion.rb', line 85
def self.retrieve_files_to_require_relative_from_current_dir @@files_from_current_dir ||= Dir.glob("**/*.{rb,#{RbConfig::CONFIG['DLEXT']}}", base: '.').map { |path| path.sub(/\.(rb|#{RbConfig::CONFIG['DLEXT']})\z/, '') } end
.retrieve_gem_and_system_load_path
[ GitHub ]# File 'lib/irb/completion.rb', line 53
def self.retrieve_gem_and_system_load_path gem_paths = Gem::Specification.latest_specs(true).map { |s| s.require_paths.map { |p| if absolute_path?(p) p else File.join(s.full_gem_path, p) end } }.flatten if defined?(Gem::Specification) (gem_paths.to_a | $LOAD_PATH).sort end
.select_message(receiver, message, candidates, sep = ".")
[ GitHub ]# File 'lib/irb/completion.rb', line 406
def self. (receiver, , candidates, sep = ".") candidates.grep(/^#{Regexp.quote( )}/).collect do |e| case e when /^[a-zA-Z_]/ receiver + sep + e when /^[0-9]/ when *Operators #receiver + " " + e end end end