Module | YARD::Registry |
In: |
lib/yard/registry.rb
|
The Registry is the centralized data store for all {CodeObjects} created during parsing. The storage is a key value store with the object‘s path (see {CodeObjects::Base#path}) as the key and the object itself as the value. Object paths must be unique to be stored in the Registry. All lookups for objects are done on the singleton Registry instance using the {Registry.at} or {Registry.resolve} methods.
The registry is saved to a "yardoc file" (actually a directory), which can be loaded back to perform any lookups. See {Registry.load!} and {Registry.save} for information on saving and loading of a yardoc file.
The registry class is a singleton class that is accessed directly in many places across YARD. To mitigate threading issues, YARD (0.6.5+) makes the Registry thread local. This means all access to a registry for a specific object set must occur in the originating thread.
@example Loading the Registry
Registry.load!('/path/to/yardocfile') # loads all objects into memory Registry.at('YARD::CodeObjects::Base').docstring # => "+Base+ is the superclass of all code objects ..."
@example Getting an object by a specific path
Registry.at('YARD::CodeObjects::Base#docstring')
@example Performing a lookup on a method anywhere in the inheritance tree
Registry.resolve(P('YARD::CodeObjects::Base'), '#docstring', true)
DEFAULT_YARDOC_FILE | = | ".yardoc" |
LOCAL_YARDOC_INDEX | = | File.expand_path('~/.yard/gem_index') |
at | -> | [] |
single_object_db | [RW] |
Whether or not the Registry storage should load everything into a single object
database (for disk efficiency), or spread them out (for load time efficiency).
@note Setting this attribute to nil will offload the decision to the {RegistryStore storage adapter}. @return [Boolean, nil] if this value is set to nil, the storage adapter will decide how to store the data. |
yardoc_file | [RW] | Gets/sets the yardoc filename @return [String] the yardoc filename @see DEFAULT_YARDOC_FILE |
Returns all objects in the registry that match one of the types provided in the types list (if types is provided).
@example Returns all objects
Registry.all
@example Returns all classes and modules
Registry.all(:class, :module)
@param [Array<Symbol>] types an optional list of types to narrow the
objects down by. Equivalent to performing a select: +Registry.all.select {|o| types.include(o.type) }+
@return [Array<CodeObjects::Base>] the list of objects found @see CodeObjects::Base#type
Deletes an object from the registry @param [CodeObjects::Base] object the object to remove @return [void]
Loads the registry and/or parses a list of files
@example Loads the yardoc file or parses files ‘a’, ‘b’ and ‘c’ (but not both)
Registry.load(['a', 'b', 'c'])
@example Reparses files ‘a’ and ‘b’ regardless of whether yardoc file exists
Registry.load(['a', 'b'], true)
@param [String, Array] files if files is an Array, it should represent
a list of files that YARD should parse into the registry. If reload is set to false and the yardoc file already exists, these files are skipped. If files is a String, it should represent the yardoc file to load into the registry.
@param [Boolean] reparse if reparse is false and a yardoc file already
exists, any files passed in will be ignored.
@return [Registry] the registry object (for chaining) @raise [ArgumentError] if files is not a String or Array
Loads a yardoc file and forces all objects cached on disk into memory. Equivalent to calling {load_yardoc} followed by {load_all}
@param [String] file the yardoc file to load @return [Registry] the registry object (for chaining) @see load_yardoc @see load_all @since 0.5.1
The assumed types of a list of paths. This method is used by CodeObjects::Base @return [{String => Symbol}] a set of unresolved paths and their assumed type @private @deprecated The registry no longer globally tracks proxy types.
Registers a new object with the registry
@param [CodeObjects::Base] object the object to register @return [CodeObjects::Base] the registered object
Attempts to find an object by name starting at namespace, performing a lookup similar to Ruby‘s method of resolving a constant in a namespace.
@example Looks for instance method reverse starting from A::B::C
Registry.resolve(P("A::B::C"), "#reverse")
@example Looks for a constant in the root namespace
Registry.resolve(nil, 'CONSTANT')
@example Looks for a class method respecting the inheritance tree
Registry.resolve(myclass, 'mymethod', true)
@example Looks for a constant but returns a proxy if not found
Registry.resolve(P('A::B::C'), 'D', false, true) # => #<yardoc proxy A::B::C::D>
@example Looks for a complex path from a namespace
Registry.resolve(P('A::B'), 'B::D') # => #<yardoc class A::B::D>
@param [CodeObjects::NamespaceObject, nil] namespace the starting namespace
(module or class). If +nil+ or +:root+, starts from the {root} object.
@param [String, Symbol] name the name (or complex path) to look for from
+namespace+.
@param [Boolean] inheritance Follows inheritance chain (mixins, superclass)
when performing name resolution if set to +true+.
@param [Boolean] proxy_fallback If true, returns a proxy representing
the unresolved path (namespace + name) if no object is found.
@param [Symbol, nil] type the {CodeObjects::Base#type} that the resolved
object must be equal to. No type checking if nil.
@return [CodeObjects::Base] the object if it is found @return [CodeObjects::Proxy] a Proxy representing the object if
+proxy_fallback+ is +true+.
@return [nil] if proxy_fallback is false and no object was found. @see P
The root namespace object. @return [CodeObjects::RootObject] the root object in the namespace
Returns the .yardoc file associated with a gem.
@param [String] gem the name of the gem to search for @param [String] ver_require an optional Gem version requirement @param [Boolean] for_writing whether or not the method should search
for writable locations
@return [String] if for_writing is set to true, returns the best
location suitable to write the .yardoc file. Otherwise, the first existing location associated with the gem's .yardoc file.
@return [nil] if for_writing is set to false and no yardoc file
is found, returns nil.