/
autoload.rb
308 lines (281 loc) · 16.2 KB
/
autoload.rb
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
# frozen_string_literal: true
# @private
def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
module YARD
module CLI # Namespace for command-line interface components
autoload :Command, __p('cli/command')
autoload :CommandParser, __p('cli/command_parser')
autoload :Config, __p('cli/config')
autoload :Diff, __p('cli/diff')
autoload :Display, __p('cli/display')
autoload :Gems, __p('cli/gems')
autoload :Graph, __p('cli/graph')
autoload :Help, __p('cli/help')
autoload :List, __p('cli/list')
autoload :MarkupTypes, __p('cli/markup_types')
autoload :Server, __p('cli/server')
autoload :Stats, __p('cli/stats')
autoload :Yardoc, __p('cli/yardoc')
autoload :YardoptsCommand, __p('cli/yardopts_command')
autoload :YRI, __p('cli/yri')
autoload :I18n, __p('cli/i18n')
end
# A "code object" is defined as any entity in the Ruby language.
# Classes, modules, methods, class variables and constants are the
# major objects, but DSL languages can create their own by inheriting
# from {CodeObjects::Base}.
module CodeObjects
autoload :Base, __p('code_objects/base')
autoload :CodeObjectList, __p('code_objects/base')
autoload :ClassObject, __p('code_objects/class_object')
autoload :ClassVariableObject, __p('code_objects/class_variable_object')
autoload :ConstantObject, __p('code_objects/constant_object')
autoload :ExtendedMethodObject, __p('code_objects/extended_method_object')
autoload :ExtraFileObject, __p('code_objects/extra_file_object')
autoload :MacroObject, __p('code_objects/macro_object')
autoload :MethodObject, __p('code_objects/method_object')
autoload :ModuleObject, __p('code_objects/module_object')
autoload :NamespaceMapper, __p('code_objects/namespace_mapper')
autoload :NamespaceObject, __p('code_objects/namespace_object')
autoload :Proxy, __p('code_objects/proxy')
autoload :ProxyMethodError, __p('code_objects/proxy')
autoload :RootObject, __p('code_objects/root_object')
autoload :BUILTIN_ALL, __p('code_objects/base')
autoload :BUILTIN_CLASSES, __p('code_objects/base')
autoload :BUILTIN_MODULES, __p('code_objects/base')
autoload :BUILTIN_EXCEPTIONS, __p('code_objects/base')
autoload :CONSTANTMATCH, __p('code_objects/base')
autoload :CONSTANTSTART, __p('code_objects/base')
autoload :METHODMATCH, __p('code_objects/base')
autoload :METHODNAMEMATCH, __p('code_objects/base')
autoload :NAMESPACEMATCH, __p('code_objects/base')
autoload :NSEP, __p('code_objects/base')
autoload :NSEPQ, __p('code_objects/base')
autoload :ISEP, __p('code_objects/base')
autoload :ISEPQ, __p('code_objects/base')
autoload :CSEP, __p('code_objects/base')
autoload :CSEPQ, __p('code_objects/base')
end
# Handlers are called during the data processing part of YARD's
# parsing phase. This allows YARD as well as any custom extension to
# analyze source and generate {CodeObjects} to be stored for later use.
module Handlers
# Shared logic between C and Ruby handlers.
module Common
autoload :MethodHandler, __p('handlers/common/method_handler')
end
# CRuby Handlers
# @since 0.8.0
module C
autoload :Base, __p('handlers/c/base')
autoload :AliasHandler, __p('handlers/c/alias_handler')
autoload :AttributeHandler, __p('handlers/c/attribute_handler')
autoload :ClassHandler, __p('handlers/c/class_handler')
autoload :ConstantHandler, __p('handlers/c/constant_handler')
autoload :HandlerMethods, __p('handlers/c/handler_methods')
autoload :InitHandler, __p('handlers/c/init_handler')
autoload :MethodHandler, __p('handlers/c/method_handler')
autoload :MixinHandler, __p('handlers/c/mixin_handler')
autoload :ModuleHandler, __p('handlers/c/module_handler')
autoload :OverrideCommentHandler, __p('handlers/c/override_comment_handler')
autoload :PathHandler, __p('handlers/c/path_handler')
autoload :StructHandler, __p('handlers/c/struct_handler')
autoload :SymbolHandler, __p('handlers/c/symbol_handler')
end
module Ruby # All Ruby handlers
module Legacy # Handlers for old Ruby 1.8 parser
autoload :Base, __p('handlers/ruby/legacy/base')
autoload :AliasHandler, __p('handlers/ruby/legacy/alias_handler')
autoload :AttributeHandler, __p('handlers/ruby/legacy/attribute_handler')
autoload :ClassHandler, __p('handlers/ruby/legacy/class_handler')
autoload :ClassConditionHandler, __p('handlers/ruby/legacy/class_condition_handler')
autoload :ClassVariableHandler, __p('handlers/ruby/legacy/class_variable_handler')
autoload :CommentHandler, __p('handlers/ruby/legacy/comment_handler')
autoload :ConstantHandler, __p('handlers/ruby/legacy/constant_handler')
autoload :DSLHandler, __p('handlers/ruby/legacy/dsl_handler')
autoload :ExceptionHandler, __p('handlers/ruby/legacy/exception_handler')
autoload :ExtendHandler, __p('handlers/ruby/legacy/extend_handler')
autoload :MethodHandler, __p('handlers/ruby/legacy/method_handler')
autoload :MixinHandler, __p('handlers/ruby/legacy/mixin_handler')
autoload :ModuleHandler, __p('handlers/ruby/legacy/module_handler')
autoload :ModuleFunctionHandler, __p('handlers/ruby/legacy/module_function_handler')
autoload :PrivateClassMethodHandler, __p('handlers/ruby/legacy/private_class_method_handler')
autoload :PrivateConstantHandler, __p('handlers/ruby/legacy/private_constant_handler')
autoload :VisibilityHandler, __p('handlers/ruby/legacy/visibility_handler')
autoload :YieldHandler, __p('handlers/ruby/legacy/yield_handler')
end
autoload :Base, __p('handlers/ruby/base')
autoload :AliasHandler, __p('handlers/ruby/alias_handler')
autoload :AttributeHandler, __p('handlers/ruby/attribute_handler')
autoload :ClassHandler, __p('handlers/ruby/class_handler')
autoload :ClassConditionHandler, __p('handlers/ruby/class_condition_handler')
autoload :ClassVariableHandler, __p('handlers/ruby/class_variable_handler')
autoload :CommentHandler, __p('handlers/ruby/comment_handler')
autoload :ConstantHandler, __p('handlers/ruby/constant_handler')
autoload :DecoratorHandlerMethods, __p('handlers/ruby/decorator_handler_methods')
autoload :DSLHandler, __p('handlers/ruby/dsl_handler')
autoload :DSLHandlerMethods, __p('handlers/ruby/dsl_handler_methods')
autoload :ExceptionHandler, __p('handlers/ruby/exception_handler')
autoload :ExtendHandler, __p('handlers/ruby/extend_handler')
autoload :MethodHandler, __p('handlers/ruby/method_handler')
autoload :MethodConditionHandler, __p('handlers/ruby/method_condition_handler')
autoload :MixinHandler, __p('handlers/ruby/mixin_handler')
autoload :ModuleHandler, __p('handlers/ruby/module_handler')
autoload :ModuleFunctionHandler, __p('handlers/ruby/module_function_handler')
autoload :PrivateClassMethodHandler, __p('handlers/ruby/private_class_method_handler')
autoload :PrivateConstantHandler, __p('handlers/ruby/private_constant_handler')
autoload :PublicClassMethodHandler, __p('handlers/ruby/public_class_method_handler')
autoload :StructHandlerMethods, __p('handlers/ruby/struct_handler_methods')
autoload :VisibilityHandler, __p('handlers/ruby/visibility_handler')
autoload :YieldHandler, __p('handlers/ruby/yield_handler')
end
autoload :Base, __p('handlers/base')
autoload :HandlerAborted, __p('handlers/base')
autoload :NamespaceMissingError, __p('handlers/base')
autoload :Processor, __p('handlers/processor')
end
# Namespace for internationalization (i18n)
# @since 0.8.0
module I18n
autoload :Locale, __p('i18n/locale')
autoload :Message, __p('i18n/message')
autoload :Messages, __p('i18n/messages')
autoload :PotGenerator, __p('i18n/pot_generator')
autoload :Text, __p('i18n/text')
end
# The parser namespace holds all parsing engines used by YARD.
# Currently only Ruby and C (Ruby) parsers are implemented.
module Parser
module C # CRuby Parsing components
autoload :BodyStatement, __p('parser/c/statement')
autoload :Comment, __p('parser/c/statement')
autoload :CommentParser, __p('parser/c/comment_parser')
autoload :CParser, __p('parser/c/c_parser')
autoload :Statement, __p('parser/c/statement')
autoload :ToplevelStatement, __p('parser/c/statement')
end
module Ruby # Ruby parsing components.
module Legacy # Handles Ruby parsing in Ruby 1.8.
autoload :RipperParser, __p('parser/ruby/legacy/ruby_parser')
autoload :RubyParser, __p('parser/ruby/legacy/ruby_parser')
autoload :RubyToken, __p('parser/ruby/legacy/ruby_lex')
autoload :Statement, __p('parser/ruby/legacy/statement')
autoload :StatementList, __p('parser/ruby/legacy/statement_list')
autoload :TokenList, __p('parser/ruby/legacy/token_list')
end
autoload :AstNode, __p('parser/ruby/ast_node')
autoload :RubyParser, __p('parser/ruby/ruby_parser')
autoload :TokenResolver, __p('parser/ruby/token_resolver')
end
autoload :Base, __p('parser/base')
autoload :ParserSyntaxError, __p('parser/source_parser')
autoload :SourceParser, __p('parser/source_parser')
autoload :UndocumentableError, __p('parser/source_parser')
end
module Rake # Holds Rake tasks used by YARD
autoload :YardocTask, __p('rake/yardoc_task')
end
module Serializers # Namespace for components that serialize to various endpoints
autoload :Base, __p('serializers/base')
autoload :FileSystemSerializer, __p('serializers/file_system_serializer')
autoload :ProcessSerializer, __p('serializers/process_serializer')
autoload :StdoutSerializer, __p('serializers/stdout_serializer')
autoload :YardocSerializer, __p('serializers/yardoc_serializer')
end
# Namespace for classes and modules that handle serving documentation over HTTP
#
# == Implementing a Custom Server
# To customize the YARD server, see the {Adapter} and {Router} classes.
#
# == Rack Middleware
# If you want to use the YARD server as a Rack middleware, see the documentation
# in {RackMiddleware}.
#
# @since 0.6.0
module Server
require __p('server')
# Commands implement specific kinds of server responses which are routed
# to by the {Router} class. To implement a custom command, subclass {Commands::Base}.
module Commands
autoload :Base, __p('server/commands/base')
autoload :DisplayFileCommand, __p('server/commands/display_file_command')
autoload :DisplayObjectCommand, __p('server/commands/display_object_command')
autoload :FramesCommand, __p('server/commands/frames_command')
autoload :ListCommand, __p('server/commands/list_command')
autoload :LibraryCommand, __p('server/commands/library_command')
autoload :LibraryIndexCommand, __p('server/commands/library_index_command')
autoload :RootRequestCommand, __p('server/commands/root_request_command')
autoload :SearchCommand, __p('server/commands/search_command')
autoload :StaticFileCommand, __p('server/commands/static_file_command')
autoload :StaticFileHelpers, __p('server/commands/static_file_helpers')
end
autoload :Adapter, __p('server/adapter')
autoload :DocServerSerializer, __p('server/doc_server_serializer')
autoload :DocServerHelper, __p('server/doc_server_helper')
autoload :FinishRequest, __p('server/adapter')
autoload :LibraryVersion, __p('server/library_version')
autoload :NotFoundError, __p('server/adapter')
autoload :RackAdapter, __p('server/rack_adapter')
autoload :RackMiddleware, __p('server/rack_adapter')
autoload :Router, __p('server/router')
autoload :StaticCaching, __p('server/static_caching')
autoload :WebrickAdapter, __p('server/webrick_adapter')
autoload :WebrickServlet, __p('server/webrick_adapter')
end
module Tags # Namespace for Tag components
autoload :AttributeDirective, __p('tags/directives')
autoload :DefaultFactory, __p('tags/default_factory')
autoload :DefaultTag, __p('tags/default_tag')
autoload :Directive, __p('tags/directives')
autoload :EndGroupDirective, __p('tags/directives')
autoload :GroupDirective, __p('tags/directives')
autoload :Library, __p('tags/library')
autoload :MacroDirective, __p('tags/directives')
autoload :MethodDirective, __p('tags/directives')
autoload :OptionTag, __p('tags/option_tag')
autoload :OverloadTag, __p('tags/overload_tag')
autoload :ParseDirective, __p('tags/directives')
autoload :RefTag, __p('tags/ref_tag')
autoload :RefTagList, __p('tags/ref_tag_list')
autoload :ScopeDirective, __p('tags/directives')
autoload :Tag, __p('tags/tag')
autoload :TagFormatError, __p('tags/tag_format_error')
autoload :TypesExplainer, __p('tags/types_explainer')
autoload :VisibilityDirective, __p('tags/directives')
end
# Namespace for templating system
module Templates
module Helpers # Namespace for template helpers
module Markup # Namespace for markup providers
autoload :RDocMarkup, __p('templates/helpers/markup/rdoc_markup')
autoload :RDocMarkdown, __p('templates/helpers/markup/rdoc_markdown')
end
autoload :BaseHelper, __p('templates/helpers/base_helper')
autoload :FilterHelper, __p('templates/helpers/filter_helper')
autoload :HtmlHelper, __p('templates/helpers/html_helper')
autoload :HtmlSyntaxHighlightHelper, __p('templates/helpers/html_syntax_highlight_helper')
autoload :MarkupHelper, __p('templates/helpers/markup_helper')
autoload :MethodHelper, __p('templates/helpers/method_helper')
autoload :ModuleHelper, __p('templates/helpers/module_helper')
autoload :TextHelper, __p('templates/helpers/text_helper')
autoload :UMLHelper, __p('templates/helpers/uml_helper')
end
autoload :Engine, __p('templates/engine')
autoload :ErbCache, __p('templates/erb_cache')
autoload :Section, __p('templates/section')
autoload :Template, __p('templates/template')
autoload :TemplateOptions, __p('templates/template_options')
end
autoload :Config, __p('config')
autoload :Docstring, __p('docstring')
autoload :DocstringParser, __p('docstring_parser')
autoload :GemIndex, __p('gem_index')
autoload :Logger, __p('logging')
autoload :Options, __p('options')
autoload :Registry, __p('registry')
autoload :RegistryResolver, __p('registry_resolver')
autoload :RegistryStore, __p('registry_store')
autoload :StubProxy, __p('serializers/yardoc_serializer')
autoload :Verifier, __p('verifier')
end
undef __p