class RBS::Annotate::RDocSource
Attributes
with_gems_dir
[RW]
bool
with_home_dir
[RW]
bool
with_site_dir
[RW]
bool
with_system_dir
[RW]
bool
Public Class Methods
() → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 12 def initialize self.with_system_dir = true self.with_gems_dir = false self.with_site_dir = false self.with_home_dir = false @extra_dirs = [] @stores = [] end
Public Instance Methods
(TypeName) → Array[::RDoc::Markup::Document | ::RDoc::Comment | ::String]?
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 64 def class_docs(typename) if classes = find_class(typename) classes.map {|klass| klass.comment } end end
() { () → Array[RDoc::CodeObject]? } → Array[RDoc::Markup::Document]?
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 47 def docs if ds = yield unless ds.empty? ds.map do |code_object| case comment = code_object.comment when String raise when RDoc::Comment comment.parse when RDoc::Markup::Document comment end end end end end
Extract documents from CodeObjects
(TypeName, Symbol, singleton: bool) → Array[RDoc::Attr]?
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 117 def find_attribute(typename, name, singleton:) if klasss = find_class(typename) # @type var attrs: Array[RDoc::Attr] attrs = [] klasss.each do |kls| attrs.concat(kls.attributes.select {|attr| attr.singleton == singleton && attr.name == name.to_s }) end attrs unless attrs.empty? end end
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 33 def find_class(typename) classes = [] #: Array[::RDoc::ClassModule] @stores.each do |store| if klass = store.find_class_or_module(typename.relative!.to_s) classes << klass end end unless classes.empty? classes end end
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 70 def find_const(const_name) namespace = if const_name.namespace.empty? TypeName.parse("::Object") else const_name.namespace.to_type_name end if classes = find_class(namespace) # @type var consts: Array[RDoc::Constant] consts = [] classes.each do |klass| if const = klass.constants.find {|c| c.name == const_name.name.to_s } consts << const end end unless consts.empty? consts end end end
(TypeName, instance_method: Symbol) → Array[RDoc::AnyMethod]?
(TypeName, singleton_method: Symbol) → Array[RDoc::AnyMethod]?
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 94 def find_method(typename, instance_method: nil, singleton_method: nil) if classes = find_class(typename) # @type var methods: Array[RDoc::AnyMethod] methods = [] classes.each do |klass| klass.method_list.each do |method| if instance_method && !method.singleton && method.name == instance_method.to_s methods << method end if singleton_method && method.singleton && method.name == singleton_method.to_s methods << method end end end unless methods.empty? methods end end end
() → void
Source
# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/rdoc_source.rb, line 22 def load @stores.clear() RDoc::RI::Paths.each(with_system_dir, with_site_dir, with_home_dir, with_gems_dir ? :latest : false, *extra_dirs.map(&:to_s)) do |path, type| store = RDoc::Store.new(RDoc::Options.new, path:, type:) store.load_all @stores << store end end