hyper-pro-gem 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (380) hide show
  1. checksums.yaml +7 -0
  2. data/hyper-pro-gem.gemspec +12 -0
  3. data/yard-0.9.44/CHANGELOG.md +983 -0
  4. data/yard-0.9.44/LEGAL +94 -0
  5. data/yard-0.9.44/LICENSE +22 -0
  6. data/yard-0.9.44/README.md +329 -0
  7. data/yard-0.9.44/bin/yard +13 -0
  8. data/yard-0.9.44/bin/yardoc +13 -0
  9. data/yard-0.9.44/bin/yri +13 -0
  10. data/yard-0.9.44/docs/CodeObjects.md +115 -0
  11. data/yard-0.9.44/docs/GettingStarted.md +705 -0
  12. data/yard-0.9.44/docs/Handlers.md +152 -0
  13. data/yard-0.9.44/docs/Overview.md +61 -0
  14. data/yard-0.9.44/docs/Parser.md +166 -0
  15. data/yard-0.9.44/docs/Tags.md +304 -0
  16. data/yard-0.9.44/docs/TagsArch.md +123 -0
  17. data/yard-0.9.44/docs/Templates.md +497 -0
  18. data/yard-0.9.44/docs/WhatsNew.md +1297 -0
  19. data/yard-0.9.44/docs/images/code-objects-class-diagram.png +0 -0
  20. data/yard-0.9.44/docs/images/handlers-class-diagram.png +0 -0
  21. data/yard-0.9.44/docs/images/overview-class-diagram.png +0 -0
  22. data/yard-0.9.44/docs/images/parser-class-diagram.png +0 -0
  23. data/yard-0.9.44/docs/images/tags-class-diagram.png +0 -0
  24. data/yard-0.9.44/docs/templates/default/fulldoc/html/full_list_tag.erb +9 -0
  25. data/yard-0.9.44/docs/templates/default/fulldoc/html/setup.rb +6 -0
  26. data/yard-0.9.44/docs/templates/default/layout/html/setup.rb +9 -0
  27. data/yard-0.9.44/docs/templates/default/layout/html/tag_list.erb +11 -0
  28. data/yard-0.9.44/docs/templates/default/yard_tags/html/list.erb +18 -0
  29. data/yard-0.9.44/docs/templates/default/yard_tags/html/setup.rb +26 -0
  30. data/yard-0.9.44/docs/templates/plugin.rb +70 -0
  31. data/yard-0.9.44/lib/rubygems_plugin.rb +9 -0
  32. data/yard-0.9.44/lib/yard/autoload.rb +328 -0
  33. data/yard-0.9.44/lib/yard/cli/command.rb +85 -0
  34. data/yard-0.9.44/lib/yard/cli/command_parser.rb +93 -0
  35. data/yard-0.9.44/lib/yard/cli/config.rb +198 -0
  36. data/yard-0.9.44/lib/yard/cli/diff.rb +278 -0
  37. data/yard-0.9.44/lib/yard/cli/display.rb +69 -0
  38. data/yard-0.9.44/lib/yard/cli/gems.rb +84 -0
  39. data/yard-0.9.44/lib/yard/cli/graph.rb +125 -0
  40. data/yard-0.9.44/lib/yard/cli/help.rb +20 -0
  41. data/yard-0.9.44/lib/yard/cli/i18n.rb +70 -0
  42. data/yard-0.9.44/lib/yard/cli/list.rb +23 -0
  43. data/yard-0.9.44/lib/yard/cli/markup_types.rb +32 -0
  44. data/yard-0.9.44/lib/yard/cli/server.rb +266 -0
  45. data/yard-0.9.44/lib/yard/cli/stats.rb +234 -0
  46. data/yard-0.9.44/lib/yard/cli/yardoc.rb +791 -0
  47. data/yard-0.9.44/lib/yard/cli/yardopts_command.rb +110 -0
  48. data/yard-0.9.44/lib/yard/cli/yri.rb +215 -0
  49. data/yard-0.9.44/lib/yard/code_objects/base.rb +626 -0
  50. data/yard-0.9.44/lib/yard/code_objects/class_object.rb +146 -0
  51. data/yard-0.9.44/lib/yard/code_objects/class_variable_object.rb +11 -0
  52. data/yard-0.9.44/lib/yard/code_objects/constant_object.rb +16 -0
  53. data/yard-0.9.44/lib/yard/code_objects/extended_method_object.rb +24 -0
  54. data/yard-0.9.44/lib/yard/code_objects/extra_file_object.rb +135 -0
  55. data/yard-0.9.44/lib/yard/code_objects/macro_object.rb +171 -0
  56. data/yard-0.9.44/lib/yard/code_objects/method_object.rb +196 -0
  57. data/yard-0.9.44/lib/yard/code_objects/module_object.rb +21 -0
  58. data/yard-0.9.44/lib/yard/code_objects/namespace_mapper.rb +141 -0
  59. data/yard-0.9.44/lib/yard/code_objects/namespace_object.rb +200 -0
  60. data/yard-0.9.44/lib/yard/code_objects/proxy.rb +245 -0
  61. data/yard-0.9.44/lib/yard/code_objects/root_object.rb +19 -0
  62. data/yard-0.9.44/lib/yard/config.rb +274 -0
  63. data/yard-0.9.44/lib/yard/core_ext/array.rb +16 -0
  64. data/yard-0.9.44/lib/yard/core_ext/file.rb +69 -0
  65. data/yard-0.9.44/lib/yard/core_ext/hash.rb +16 -0
  66. data/yard-0.9.44/lib/yard/core_ext/insertion.rb +63 -0
  67. data/yard-0.9.44/lib/yard/core_ext/module.rb +11 -0
  68. data/yard-0.9.44/lib/yard/core_ext/string.rb +68 -0
  69. data/yard-0.9.44/lib/yard/core_ext/symbol_hash.rb +75 -0
  70. data/yard-0.9.44/lib/yard/docstring.rb +386 -0
  71. data/yard-0.9.44/lib/yard/docstring_parser.rb +344 -0
  72. data/yard-0.9.44/lib/yard/gem_index.rb +29 -0
  73. data/yard-0.9.44/lib/yard/globals.rb +22 -0
  74. data/yard-0.9.44/lib/yard/handlers/base.rb +617 -0
  75. data/yard-0.9.44/lib/yard/handlers/c/alias_handler.rb +16 -0
  76. data/yard-0.9.44/lib/yard/handlers/c/attribute_handler.rb +13 -0
  77. data/yard-0.9.44/lib/yard/handlers/c/base.rb +164 -0
  78. data/yard-0.9.44/lib/yard/handlers/c/class_handler.rb +27 -0
  79. data/yard-0.9.44/lib/yard/handlers/c/constant_handler.rb +13 -0
  80. data/yard-0.9.44/lib/yard/handlers/c/handler_methods.rb +212 -0
  81. data/yard-0.9.44/lib/yard/handlers/c/init_handler.rb +20 -0
  82. data/yard-0.9.44/lib/yard/handlers/c/method_handler.rb +45 -0
  83. data/yard-0.9.44/lib/yard/handlers/c/mixin_handler.rb +21 -0
  84. data/yard-0.9.44/lib/yard/handlers/c/module_handler.rb +17 -0
  85. data/yard-0.9.44/lib/yard/handlers/c/override_comment_handler.rb +31 -0
  86. data/yard-0.9.44/lib/yard/handlers/c/path_handler.rb +11 -0
  87. data/yard-0.9.44/lib/yard/handlers/c/struct_handler.rb +13 -0
  88. data/yard-0.9.44/lib/yard/handlers/c/symbol_handler.rb +8 -0
  89. data/yard-0.9.44/lib/yard/handlers/common/method_handler.rb +19 -0
  90. data/yard-0.9.44/lib/yard/handlers/processor.rb +200 -0
  91. data/yard-0.9.44/lib/yard/handlers/rbs/attribute_handler.rb +79 -0
  92. data/yard-0.9.44/lib/yard/handlers/rbs/base.rb +38 -0
  93. data/yard-0.9.44/lib/yard/handlers/rbs/constant_handler.rb +18 -0
  94. data/yard-0.9.44/lib/yard/handlers/rbs/method_handler.rb +327 -0
  95. data/yard-0.9.44/lib/yard/handlers/rbs/mixin_handler.rb +20 -0
  96. data/yard-0.9.44/lib/yard/handlers/rbs/namespace_handler.rb +26 -0
  97. data/yard-0.9.44/lib/yard/handlers/ruby/alias_handler.rb +45 -0
  98. data/yard-0.9.44/lib/yard/handlers/ruby/attribute_handler.rb +90 -0
  99. data/yard-0.9.44/lib/yard/handlers/ruby/base.rb +165 -0
  100. data/yard-0.9.44/lib/yard/handlers/ruby/class_condition_handler.rb +92 -0
  101. data/yard-0.9.44/lib/yard/handlers/ruby/class_handler.rb +119 -0
  102. data/yard-0.9.44/lib/yard/handlers/ruby/class_variable_handler.rb +17 -0
  103. data/yard-0.9.44/lib/yard/handlers/ruby/comment_handler.rb +10 -0
  104. data/yard-0.9.44/lib/yard/handlers/ruby/constant_handler.rb +73 -0
  105. data/yard-0.9.44/lib/yard/handlers/ruby/decorator_handler_methods.rb +123 -0
  106. data/yard-0.9.44/lib/yard/handlers/ruby/dsl_handler.rb +15 -0
  107. data/yard-0.9.44/lib/yard/handlers/ruby/dsl_handler_methods.rb +96 -0
  108. data/yard-0.9.44/lib/yard/handlers/ruby/exception_handler.rb +27 -0
  109. data/yard-0.9.44/lib/yard/handlers/ruby/extend_handler.rb +22 -0
  110. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/alias_handler.rb +37 -0
  111. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/attribute_handler.rb +65 -0
  112. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/base.rb +245 -0
  113. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -0
  114. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/class_handler.rb +113 -0
  115. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +15 -0
  116. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/comment_handler.rb +10 -0
  117. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/constant_handler.rb +29 -0
  118. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/dsl_handler.rb +17 -0
  119. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/exception_handler.rb +13 -0
  120. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/extend_handler.rb +21 -0
  121. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/method_handler.rb +90 -0
  122. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -0
  123. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/module_function_handler.rb +19 -0
  124. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/module_handler.rb +12 -0
  125. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +22 -0
  126. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +22 -0
  127. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/visibility_handler.rb +18 -0
  128. data/yard-0.9.44/lib/yard/handlers/ruby/legacy/yield_handler.rb +29 -0
  129. data/yard-0.9.44/lib/yard/handlers/ruby/method_condition_handler.rb +9 -0
  130. data/yard-0.9.44/lib/yard/handlers/ruby/method_handler.rb +104 -0
  131. data/yard-0.9.44/lib/yard/handlers/ruby/mixin_handler.rb +61 -0
  132. data/yard-0.9.44/lib/yard/handlers/ruby/module_function_handler.rb +39 -0
  133. data/yard-0.9.44/lib/yard/handlers/ruby/module_handler.rb +12 -0
  134. data/yard-0.9.44/lib/yard/handlers/ruby/private_class_method_handler.rb +14 -0
  135. data/yard-0.9.44/lib/yard/handlers/ruby/private_constant_handler.rb +43 -0
  136. data/yard-0.9.44/lib/yard/handlers/ruby/public_class_method_handler.rb +14 -0
  137. data/yard-0.9.44/lib/yard/handlers/ruby/struct_handler_methods.rb +143 -0
  138. data/yard-0.9.44/lib/yard/handlers/ruby/visibility_handler.rb +35 -0
  139. data/yard-0.9.44/lib/yard/handlers/ruby/yield_handler.rb +31 -0
  140. data/yard-0.9.44/lib/yard/i18n/locale.rb +67 -0
  141. data/yard-0.9.44/lib/yard/i18n/message.rb +57 -0
  142. data/yard-0.9.44/lib/yard/i18n/messages.rb +56 -0
  143. data/yard-0.9.44/lib/yard/i18n/po_parser.rb +61 -0
  144. data/yard-0.9.44/lib/yard/i18n/pot_generator.rb +290 -0
  145. data/yard-0.9.44/lib/yard/i18n/text.rb +173 -0
  146. data/yard-0.9.44/lib/yard/logging.rb +260 -0
  147. data/yard-0.9.44/lib/yard/open_struct.rb +67 -0
  148. data/yard-0.9.44/lib/yard/options.rb +217 -0
  149. data/yard-0.9.44/lib/yard/parser/base.rb +57 -0
  150. data/yard-0.9.44/lib/yard/parser/c/c_parser.rb +235 -0
  151. data/yard-0.9.44/lib/yard/parser/c/comment_parser.rb +134 -0
  152. data/yard-0.9.44/lib/yard/parser/c/statement.rb +66 -0
  153. data/yard-0.9.44/lib/yard/parser/rbs/rbs_parser.rb +325 -0
  154. data/yard-0.9.44/lib/yard/parser/rbs/statement.rb +75 -0
  155. data/yard-0.9.44/lib/yard/parser/ruby/ast_node.rb +559 -0
  156. data/yard-0.9.44/lib/yard/parser/ruby/legacy/irb/slex.rb +294 -0
  157. data/yard-0.9.44/lib/yard/parser/ruby/legacy/ruby_lex.rb +1360 -0
  158. data/yard-0.9.44/lib/yard/parser/ruby/legacy/ruby_parser.rb +32 -0
  159. data/yard-0.9.44/lib/yard/parser/ruby/legacy/statement.rb +68 -0
  160. data/yard-0.9.44/lib/yard/parser/ruby/legacy/statement_list.rb +394 -0
  161. data/yard-0.9.44/lib/yard/parser/ruby/legacy/token_list.rb +74 -0
  162. data/yard-0.9.44/lib/yard/parser/ruby/ruby_parser.rb +792 -0
  163. data/yard-0.9.44/lib/yard/parser/ruby/token_resolver.rb +158 -0
  164. data/yard-0.9.44/lib/yard/parser/source_parser.rb +526 -0
  165. data/yard-0.9.44/lib/yard/rake/yardoc_task.rb +81 -0
  166. data/yard-0.9.44/lib/yard/registry.rb +439 -0
  167. data/yard-0.9.44/lib/yard/registry_resolver.rb +225 -0
  168. data/yard-0.9.44/lib/yard/registry_store.rb +342 -0
  169. data/yard-0.9.44/lib/yard/rubygems/backports/LICENSE.txt +57 -0
  170. data/yard-0.9.44/lib/yard/rubygems/backports/MIT.txt +20 -0
  171. data/yard-0.9.44/lib/yard/rubygems/backports/gem.rb +10 -0
  172. data/yard-0.9.44/lib/yard/rubygems/backports/source_index.rb +365 -0
  173. data/yard-0.9.44/lib/yard/rubygems/backports.rb +10 -0
  174. data/yard-0.9.44/lib/yard/rubygems/doc_manager.rb +90 -0
  175. data/yard-0.9.44/lib/yard/rubygems/hook.rb +197 -0
  176. data/yard-0.9.44/lib/yard/rubygems/specification.rb +50 -0
  177. data/yard-0.9.44/lib/yard/serializers/base.rb +83 -0
  178. data/yard-0.9.44/lib/yard/serializers/file_system_serializer.rb +123 -0
  179. data/yard-0.9.44/lib/yard/serializers/process_serializer.rb +24 -0
  180. data/yard-0.9.44/lib/yard/serializers/stdout_serializer.rb +34 -0
  181. data/yard-0.9.44/lib/yard/serializers/yardoc_serializer.rb +152 -0
  182. data/yard-0.9.44/lib/yard/server/adapter.rb +100 -0
  183. data/yard-0.9.44/lib/yard/server/commands/base.rb +203 -0
  184. data/yard-0.9.44/lib/yard/server/commands/display_file_command.rb +29 -0
  185. data/yard-0.9.44/lib/yard/server/commands/display_object_command.rb +65 -0
  186. data/yard-0.9.44/lib/yard/server/commands/frames_command.rb +16 -0
  187. data/yard-0.9.44/lib/yard/server/commands/library_command.rb +187 -0
  188. data/yard-0.9.44/lib/yard/server/commands/library_index_command.rb +28 -0
  189. data/yard-0.9.44/lib/yard/server/commands/list_command.rb +25 -0
  190. data/yard-0.9.44/lib/yard/server/commands/root_request_command.rb +15 -0
  191. data/yard-0.9.44/lib/yard/server/commands/search_command.rb +79 -0
  192. data/yard-0.9.44/lib/yard/server/commands/static_file_command.rb +23 -0
  193. data/yard-0.9.44/lib/yard/server/commands/static_file_helpers.rb +60 -0
  194. data/yard-0.9.44/lib/yard/server/doc_server_helper.rb +91 -0
  195. data/yard-0.9.44/lib/yard/server/doc_server_serializer.rb +39 -0
  196. data/yard-0.9.44/lib/yard/server/http_utils.rb +512 -0
  197. data/yard-0.9.44/lib/yard/server/library_version.rb +277 -0
  198. data/yard-0.9.44/lib/yard/server/rack_adapter.rb +97 -0
  199. data/yard-0.9.44/lib/yard/server/router.rb +187 -0
  200. data/yard-0.9.44/lib/yard/server/static_caching.rb +77 -0
  201. data/yard-0.9.44/lib/yard/server/templates/default/fulldoc/html/css/custom.css +207 -0
  202. data/yard-0.9.44/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
  203. data/yard-0.9.44/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +203 -0
  204. data/yard-0.9.44/lib/yard/server/templates/default/layout/html/breadcrumb.erb +21 -0
  205. data/yard-0.9.44/lib/yard/server/templates/default/layout/html/script_setup.erb +7 -0
  206. data/yard-0.9.44/lib/yard/server/templates/default/layout/html/setup.rb +8 -0
  207. data/yard-0.9.44/lib/yard/server/templates/default/method_details/html/permalink.erb +6 -0
  208. data/yard-0.9.44/lib/yard/server/templates/default/method_details/html/setup.rb +5 -0
  209. data/yard-0.9.44/lib/yard/server/templates/doc_server/library_list/html/headers.erb +8 -0
  210. data/yard-0.9.44/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +13 -0
  211. data/yard-0.9.44/lib/yard/server/templates/doc_server/library_list/html/listing.erb +13 -0
  212. data/yard-0.9.44/lib/yard/server/templates/doc_server/library_list/html/setup.rb +6 -0
  213. data/yard-0.9.44/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -0
  214. data/yard-0.9.44/lib/yard/server/templates/doc_server/processing/html/processing.erb +58 -0
  215. data/yard-0.9.44/lib/yard/server/templates/doc_server/processing/html/setup.rb +4 -0
  216. data/yard-0.9.44/lib/yard/server/templates/doc_server/search/html/search.erb +18 -0
  217. data/yard-0.9.44/lib/yard/server/templates/doc_server/search/html/setup.rb +9 -0
  218. data/yard-0.9.44/lib/yard/server/webrick_adapter.rb +45 -0
  219. data/yard-0.9.44/lib/yard/server.rb +13 -0
  220. data/yard-0.9.44/lib/yard/tags/default_factory.rb +192 -0
  221. data/yard-0.9.44/lib/yard/tags/default_tag.rb +13 -0
  222. data/yard-0.9.44/lib/yard/tags/directives.rb +631 -0
  223. data/yard-0.9.44/lib/yard/tags/library.rb +633 -0
  224. data/yard-0.9.44/lib/yard/tags/option_tag.rb +13 -0
  225. data/yard-0.9.44/lib/yard/tags/overload_tag.rb +72 -0
  226. data/yard-0.9.44/lib/yard/tags/ref_tag.rb +8 -0
  227. data/yard-0.9.44/lib/yard/tags/ref_tag_list.rb +28 -0
  228. data/yard-0.9.44/lib/yard/tags/tag.rb +72 -0
  229. data/yard-0.9.44/lib/yard/tags/tag_format_error.rb +7 -0
  230. data/yard-0.9.44/lib/yard/tags/types_explainer.rb +288 -0
  231. data/yard-0.9.44/lib/yard/templates/engine.rb +185 -0
  232. data/yard-0.9.44/lib/yard/templates/erb_cache.rb +23 -0
  233. data/yard-0.9.44/lib/yard/templates/helpers/base_helper.rb +215 -0
  234. data/yard-0.9.44/lib/yard/templates/helpers/filter_helper.rb +27 -0
  235. data/yard-0.9.44/lib/yard/templates/helpers/html_helper.rb +688 -0
  236. data/yard-0.9.44/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +83 -0
  237. data/yard-0.9.44/lib/yard/templates/helpers/markup/html_entities.rb +2140 -0
  238. data/yard-0.9.44/lib/yard/templates/helpers/markup/hybrid_markdown.rb +2131 -0
  239. data/yard-0.9.44/lib/yard/templates/helpers/markup/rdoc_markdown.rb +23 -0
  240. data/yard-0.9.44/lib/yard/templates/helpers/markup/rdoc_markup.rb +112 -0
  241. data/yard-0.9.44/lib/yard/templates/helpers/markup_helper.rb +175 -0
  242. data/yard-0.9.44/lib/yard/templates/helpers/method_helper.rb +77 -0
  243. data/yard-0.9.44/lib/yard/templates/helpers/module_helper.rb +21 -0
  244. data/yard-0.9.44/lib/yard/templates/helpers/text_helper.rb +112 -0
  245. data/yard-0.9.44/lib/yard/templates/helpers/uml_helper.rb +47 -0
  246. data/yard-0.9.44/lib/yard/templates/section.rb +103 -0
  247. data/yard-0.9.44/lib/yard/templates/template.rb +420 -0
  248. data/yard-0.9.44/lib/yard/templates/template_options.rb +91 -0
  249. data/yard-0.9.44/lib/yard/verifier.rb +151 -0
  250. data/yard-0.9.44/lib/yard/version.rb +6 -0
  251. data/yard-0.9.44/lib/yard.rb +75 -0
  252. data/yard-0.9.44/po/ja.po +31108 -0
  253. data/yard-0.9.44/templates/default/class/dot/setup.rb +7 -0
  254. data/yard-0.9.44/templates/default/class/dot/superklass.erb +3 -0
  255. data/yard-0.9.44/templates/default/class/html/constructor_details.erb +8 -0
  256. data/yard-0.9.44/templates/default/class/html/setup.rb +2 -0
  257. data/yard-0.9.44/templates/default/class/html/subclasses.erb +4 -0
  258. data/yard-0.9.44/templates/default/class/setup.rb +36 -0
  259. data/yard-0.9.44/templates/default/class/text/setup.rb +12 -0
  260. data/yard-0.9.44/templates/default/class/text/subclasses.erb +5 -0
  261. data/yard-0.9.44/templates/default/constant/text/header.erb +11 -0
  262. data/yard-0.9.44/templates/default/constant/text/setup.rb +4 -0
  263. data/yard-0.9.44/templates/default/docstring/html/abstract.erb +4 -0
  264. data/yard-0.9.44/templates/default/docstring/html/deprecated.erb +1 -0
  265. data/yard-0.9.44/templates/default/docstring/html/index.erb +5 -0
  266. data/yard-0.9.44/templates/default/docstring/html/note.erb +6 -0
  267. data/yard-0.9.44/templates/default/docstring/html/private.erb +4 -0
  268. data/yard-0.9.44/templates/default/docstring/html/returns_void.erb +1 -0
  269. data/yard-0.9.44/templates/default/docstring/html/text.erb +1 -0
  270. data/yard-0.9.44/templates/default/docstring/html/todo.erb +6 -0
  271. data/yard-0.9.44/templates/default/docstring/setup.rb +52 -0
  272. data/yard-0.9.44/templates/default/docstring/text/abstract.erb +2 -0
  273. data/yard-0.9.44/templates/default/docstring/text/deprecated.erb +2 -0
  274. data/yard-0.9.44/templates/default/docstring/text/index.erb +2 -0
  275. data/yard-0.9.44/templates/default/docstring/text/note.erb +4 -0
  276. data/yard-0.9.44/templates/default/docstring/text/private.erb +2 -0
  277. data/yard-0.9.44/templates/default/docstring/text/returns_void.erb +1 -0
  278. data/yard-0.9.44/templates/default/docstring/text/text.erb +1 -0
  279. data/yard-0.9.44/templates/default/docstring/text/todo.erb +4 -0
  280. data/yard-0.9.44/templates/default/fulldoc/html/css/common.css +1 -0
  281. data/yard-0.9.44/templates/default/fulldoc/html/css/full_list.css +206 -0
  282. data/yard-0.9.44/templates/default/fulldoc/html/css/style.css +1089 -0
  283. data/yard-0.9.44/templates/default/fulldoc/html/frames.erb +22 -0
  284. data/yard-0.9.44/templates/default/fulldoc/html/full_list.erb +40 -0
  285. data/yard-0.9.44/templates/default/fulldoc/html/full_list_class.erb +2 -0
  286. data/yard-0.9.44/templates/default/fulldoc/html/full_list_file.erb +7 -0
  287. data/yard-0.9.44/templates/default/fulldoc/html/full_list_method.erb +10 -0
  288. data/yard-0.9.44/templates/default/fulldoc/html/js/app.js +801 -0
  289. data/yard-0.9.44/templates/default/fulldoc/html/js/full_list.js +334 -0
  290. data/yard-0.9.44/templates/default/fulldoc/html/js/jquery.js +4 -0
  291. data/yard-0.9.44/templates/default/fulldoc/html/setup.rb +249 -0
  292. data/yard-0.9.44/templates/default/layout/dot/header.erb +6 -0
  293. data/yard-0.9.44/templates/default/layout/dot/setup.rb +15 -0
  294. data/yard-0.9.44/templates/default/layout/html/breadcrumb.erb +11 -0
  295. data/yard-0.9.44/templates/default/layout/html/files.erb +11 -0
  296. data/yard-0.9.44/templates/default/layout/html/footer.erb +5 -0
  297. data/yard-0.9.44/templates/default/layout/html/headers.erb +15 -0
  298. data/yard-0.9.44/templates/default/layout/html/index.erb +2 -0
  299. data/yard-0.9.44/templates/default/layout/html/layout.erb +26 -0
  300. data/yard-0.9.44/templates/default/layout/html/listing.erb +4 -0
  301. data/yard-0.9.44/templates/default/layout/html/objects.erb +32 -0
  302. data/yard-0.9.44/templates/default/layout/html/script_setup.erb +4 -0
  303. data/yard-0.9.44/templates/default/layout/html/search.erb +13 -0
  304. data/yard-0.9.44/templates/default/layout/html/setup.rb +89 -0
  305. data/yard-0.9.44/templates/default/method/html/header.erb +17 -0
  306. data/yard-0.9.44/templates/default/method/setup.rb +4 -0
  307. data/yard-0.9.44/templates/default/method/text/header.erb +1 -0
  308. data/yard-0.9.44/templates/default/method_details/html/header.erb +3 -0
  309. data/yard-0.9.44/templates/default/method_details/html/method_signature.erb +25 -0
  310. data/yard-0.9.44/templates/default/method_details/html/source.erb +10 -0
  311. data/yard-0.9.44/templates/default/method_details/setup.rb +11 -0
  312. data/yard-0.9.44/templates/default/method_details/text/header.erb +10 -0
  313. data/yard-0.9.44/templates/default/method_details/text/method_signature.erb +12 -0
  314. data/yard-0.9.44/templates/default/method_details/text/setup.rb +11 -0
  315. data/yard-0.9.44/templates/default/module/dot/child.erb +1 -0
  316. data/yard-0.9.44/templates/default/module/dot/dependencies.erb +3 -0
  317. data/yard-0.9.44/templates/default/module/dot/header.erb +6 -0
  318. data/yard-0.9.44/templates/default/module/dot/info.erb +14 -0
  319. data/yard-0.9.44/templates/default/module/dot/setup.rb +15 -0
  320. data/yard-0.9.44/templates/default/module/html/attribute_details.erb +10 -0
  321. data/yard-0.9.44/templates/default/module/html/attribute_summary.erb +8 -0
  322. data/yard-0.9.44/templates/default/module/html/box_info.erb +43 -0
  323. data/yard-0.9.44/templates/default/module/html/children.erb +8 -0
  324. data/yard-0.9.44/templates/default/module/html/constant_summary.erb +17 -0
  325. data/yard-0.9.44/templates/default/module/html/defines.erb +3 -0
  326. data/yard-0.9.44/templates/default/module/html/header.erb +5 -0
  327. data/yard-0.9.44/templates/default/module/html/inherited_attributes.erb +14 -0
  328. data/yard-0.9.44/templates/default/module/html/inherited_constants.erb +8 -0
  329. data/yard-0.9.44/templates/default/module/html/inherited_methods.erb +20 -0
  330. data/yard-0.9.44/templates/default/module/html/item_summary.erb +40 -0
  331. data/yard-0.9.44/templates/default/module/html/method_details_list.erb +9 -0
  332. data/yard-0.9.44/templates/default/module/html/method_summary.erb +22 -0
  333. data/yard-0.9.44/templates/default/module/html/methodmissing.erb +12 -0
  334. data/yard-0.9.44/templates/default/module/html/pre_docstring.erb +1 -0
  335. data/yard-0.9.44/templates/default/module/setup.rb +187 -0
  336. data/yard-0.9.44/templates/default/module/text/children.erb +10 -0
  337. data/yard-0.9.44/templates/default/module/text/class_meths_list.erb +8 -0
  338. data/yard-0.9.44/templates/default/module/text/extends.erb +8 -0
  339. data/yard-0.9.44/templates/default/module/text/header.erb +7 -0
  340. data/yard-0.9.44/templates/default/module/text/includes.erb +8 -0
  341. data/yard-0.9.44/templates/default/module/text/instance_meths_list.erb +8 -0
  342. data/yard-0.9.44/templates/default/module/text/setup.rb +13 -0
  343. data/yard-0.9.44/templates/default/onefile/html/files.erb +5 -0
  344. data/yard-0.9.44/templates/default/onefile/html/headers.erb +8 -0
  345. data/yard-0.9.44/templates/default/onefile/html/layout.erb +16 -0
  346. data/yard-0.9.44/templates/default/onefile/html/readme.erb +3 -0
  347. data/yard-0.9.44/templates/default/onefile/html/setup.rb +62 -0
  348. data/yard-0.9.44/templates/default/root/dot/child.erb +3 -0
  349. data/yard-0.9.44/templates/default/root/dot/setup.rb +6 -0
  350. data/yard-0.9.44/templates/default/root/html/setup.rb +2 -0
  351. data/yard-0.9.44/templates/default/tags/html/example.erb +11 -0
  352. data/yard-0.9.44/templates/default/tags/html/index.erb +3 -0
  353. data/yard-0.9.44/templates/default/tags/html/option.erb +24 -0
  354. data/yard-0.9.44/templates/default/tags/html/overload.erb +14 -0
  355. data/yard-0.9.44/templates/default/tags/html/see.erb +8 -0
  356. data/yard-0.9.44/templates/default/tags/html/tag.erb +20 -0
  357. data/yard-0.9.44/templates/default/tags/setup.rb +57 -0
  358. data/yard-0.9.44/templates/default/tags/text/example.erb +12 -0
  359. data/yard-0.9.44/templates/default/tags/text/index.erb +1 -0
  360. data/yard-0.9.44/templates/default/tags/text/option.erb +20 -0
  361. data/yard-0.9.44/templates/default/tags/text/overload.erb +19 -0
  362. data/yard-0.9.44/templates/default/tags/text/see.erb +11 -0
  363. data/yard-0.9.44/templates/default/tags/text/tag.erb +13 -0
  364. data/yard-0.9.44/templates/guide/class/html/setup.rb +2 -0
  365. data/yard-0.9.44/templates/guide/docstring/html/setup.rb +2 -0
  366. data/yard-0.9.44/templates/guide/fulldoc/html/css/style.css +358 -0
  367. data/yard-0.9.44/templates/guide/fulldoc/html/js/app.js +61 -0
  368. data/yard-0.9.44/templates/guide/fulldoc/html/setup.rb +74 -0
  369. data/yard-0.9.44/templates/guide/layout/html/layout.erb +78 -0
  370. data/yard-0.9.44/templates/guide/layout/html/setup.rb +25 -0
  371. data/yard-0.9.44/templates/guide/method/html/header.erb +18 -0
  372. data/yard-0.9.44/templates/guide/method/html/setup.rb +22 -0
  373. data/yard-0.9.44/templates/guide/module/html/header.erb +7 -0
  374. data/yard-0.9.44/templates/guide/module/html/method_list.erb +5 -0
  375. data/yard-0.9.44/templates/guide/module/html/setup.rb +27 -0
  376. data/yard-0.9.44/templates/guide/onefile/html/files.erb +4 -0
  377. data/yard-0.9.44/templates/guide/onefile/html/setup.rb +6 -0
  378. data/yard-0.9.44/templates/guide/onefile/html/toc.erb +3 -0
  379. data/yard-0.9.44/templates/guide/tags/html/setup.rb +9 -0
  380. metadata +419 -0
@@ -0,0 +1,9 @@
1
+ <% even_odd = 'odd' %>
2
+ <% collect_tags.each do |tag| %>
3
+ <li class="<%= even_odd %> <%= tag.object.has_tag?(:deprecated) ? 'deprecated' : '' %>">
4
+ <div class="item">
5
+ <span class="object_link"><%= tag_link(tag) %></span>
6
+ </div>
7
+ </li>
8
+ <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
9
+ <% end %>
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+ def generate_tag_list
3
+ @list_title = "Tag List"
4
+ @list_type = "tag"
5
+ asset('tag_list.html', erb(:full_list))
6
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ def init
3
+ super
4
+ sections.place(:tag_list).after_any(:files)
5
+ end
6
+
7
+ def menu_lists
8
+ super + [{:type => 'tag', :title => 'Tags', :search_title => 'Tag List'}]
9
+ end
@@ -0,0 +1,11 @@
1
+ <h2>Tag Listing</h2>
2
+ <p>The following are a brief list of tags that can be used in YARD formatted
3
+ documentation. See <%= link_file "docs/Tags.md" %> for information on using tags.</p>
4
+ <ul id="tags" class="index_inline_list">
5
+ <% n = 1 %>
6
+ <% collect_tags.each do |tag| %>
7
+ <li class="r<%= n %>"><%= tag_link(tag) %></li>
8
+ <% n = n == 2 ? 1 : 2 %>
9
+ <% end %>
10
+ </ul>
11
+ <div class="clear"></div>
@@ -0,0 +1,18 @@
1
+ <% [["Tag", all_tags], ["Directive", all_directives]].each do |(name, list)| %>
2
+ <h2><%= name %> List</h2>
3
+
4
+ <% list.each_with_index do |tag, i| %>
5
+ <div class="method_details <%= i == 0 ? 'first' : '' %>">
6
+ <h3 class="signature"
7
+ id="<%= tag.name %>" toc-title="<%= tag_link_name(tag) %>">
8
+ <%= tag_signature tag %>
9
+ </h3>
10
+ <% if name == "Directive" %>
11
+ <%= yieldall :object => P("YARD::Tags::#{tag.text}") %>
12
+ <% else %>
13
+ <%= yieldall :object => tag.object %>
14
+ <% end %>
15
+ </div>
16
+ <% end %>
17
+
18
+ <% end%>
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+ def init
3
+ sections :list, [T('docstring')]
4
+ end
5
+
6
+ def tag_signature(tag)
7
+ types = tag.types || []
8
+ signature = "<strong>#{tag_link_name(tag)}</strong> "
9
+ sig_tag = tag.object.tag('yard.signature')
10
+ extra = sig_tag.text if sig_tag
11
+ extra ||= case types.first
12
+ when 'with_name'
13
+ "name description"
14
+ when 'with_types'
15
+ "[Types] description"
16
+ when 'with_types_and_name'
17
+ "name [Types] description"
18
+ when 'with_title_and_text'
19
+ "title\ndescription"
20
+ when 'with_types_and_title'
21
+ "[Types] title\ndescription"
22
+ else
23
+ "description"
24
+ end
25
+ signature + h(extra).gsub(/\n/, "<br>&nbsp;&nbsp;&nbsp;")
26
+ end
@@ -0,0 +1,70 @@
1
+ # frozen_string_literal: true
2
+ include YARD
3
+ include Templates
4
+
5
+ module TagTemplateHelper
6
+ def all_tags
7
+ Registry.all(:method).map {|m| m.tag('yard.tag') }.compact
8
+ end
9
+
10
+ def all_directives
11
+ Registry.all(:method).map {|m| m.tag('yard.directive') }.compact
12
+ end
13
+
14
+ def collect_tags
15
+ (all_tags + all_directives).sort_by(&:name)
16
+ end
17
+
18
+ def tag_link(tag)
19
+ link_file("docs/Tags.md", tag_link_name(tag), tag.name)
20
+ end
21
+
22
+ def tag_link_name(tag)
23
+ prefix = tag.tag_name == 'yard.directive' ? '@!' : '@'
24
+ h(prefix + tag.name)
25
+ end
26
+
27
+ # Wrap url_for and url_for_file to rewrite object when generating docs for
28
+ # yard.tag/directive objects.
29
+ %w(url_for url_for_file).each do |meth|
30
+ self.class.send(:define_method, meth) do
31
+ if object.is_a?(CodeObjects::Base) &&
32
+ (object.tag('yard.tag') || object.tag('yard.directive') ||
33
+ (object.type == :class && object.superclass.name == :Directive))
34
+ obj = object
35
+ self.object = Registry.root
36
+ url = super
37
+ self.object = obj
38
+ url
39
+ else
40
+ super
41
+ end
42
+ end
43
+ end
44
+
45
+ def linkify(*args)
46
+ if args.first.is_a?(String)
47
+ case args.first
48
+ when "yard:include_tags"
49
+ return T('yard_tags').run(options)
50
+ when /^tag:(\S+)/
51
+ tag_name = $1
52
+ suffix = "tag"
53
+ if tag_name =~ /^!/
54
+ tag_name = tag_name[1..-1]
55
+ suffix = "directive"
56
+ end
57
+
58
+ obj = Registry.at("YARD::Tags::Library##{tag_name}_#{suffix}")
59
+ return tag_link(obj.tag("yard.#{suffix}")) if obj
60
+
61
+ log.warn "Cannot find tag: #{args.first}"
62
+ return args.first
63
+ end
64
+ end
65
+ super
66
+ end
67
+ end
68
+
69
+ Template.extra_includes << TagTemplateHelper
70
+ Engine.register_template_path(File.dirname(__FILE__))
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ if defined?(Gem::VERSION) && Gem::VERSION >= "2.0."
3
+ require File.expand_path(File.dirname(__FILE__) + '/yard/rubygems/hook')
4
+ else
5
+ unless defined?(Gem::DocManager.load_yardoc)
6
+ require File.expand_path(File.dirname(__FILE__) + '/yard/rubygems/specification')
7
+ require File.expand_path(File.dirname(__FILE__) + '/yard/rubygems/doc_manager')
8
+ end
9
+ end
@@ -0,0 +1,328 @@
1
+ # frozen_string_literal: true
2
+ # @private
3
+ def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
4
+
5
+ module YARD
6
+ module CLI # Namespace for command-line interface components
7
+ autoload :Command, __p('cli/command')
8
+ autoload :CommandParser, __p('cli/command_parser')
9
+ autoload :Config, __p('cli/config')
10
+ autoload :Diff, __p('cli/diff')
11
+ autoload :Display, __p('cli/display')
12
+ autoload :Gems, __p('cli/gems')
13
+ autoload :Graph, __p('cli/graph')
14
+ autoload :Help, __p('cli/help')
15
+ autoload :List, __p('cli/list')
16
+ autoload :MarkupTypes, __p('cli/markup_types')
17
+ autoload :Server, __p('cli/server')
18
+ autoload :Stats, __p('cli/stats')
19
+ autoload :Yardoc, __p('cli/yardoc')
20
+ autoload :YardoptsCommand, __p('cli/yardopts_command')
21
+ autoload :YRI, __p('cli/yri')
22
+ autoload :I18n, __p('cli/i18n')
23
+ end
24
+
25
+ # A "code object" is defined as any entity in the Ruby language.
26
+ # Classes, modules, methods, class variables and constants are the
27
+ # major objects, but DSL languages can create their own by inheriting
28
+ # from {CodeObjects::Base}.
29
+ module CodeObjects
30
+ autoload :Base, __p('code_objects/base')
31
+ autoload :CodeObjectList, __p('code_objects/base')
32
+ autoload :ClassObject, __p('code_objects/class_object')
33
+ autoload :ClassVariableObject, __p('code_objects/class_variable_object')
34
+ autoload :ConstantObject, __p('code_objects/constant_object')
35
+ autoload :ExtendedMethodObject, __p('code_objects/extended_method_object')
36
+ autoload :ExtraFileObject, __p('code_objects/extra_file_object')
37
+ autoload :MacroObject, __p('code_objects/macro_object')
38
+ autoload :MethodObject, __p('code_objects/method_object')
39
+ autoload :ModuleObject, __p('code_objects/module_object')
40
+ autoload :NamespaceMapper, __p('code_objects/namespace_mapper')
41
+ autoload :NamespaceObject, __p('code_objects/namespace_object')
42
+ autoload :Proxy, __p('code_objects/proxy')
43
+ autoload :ProxyMethodError, __p('code_objects/proxy')
44
+ autoload :RootObject, __p('code_objects/root_object')
45
+
46
+ autoload :BUILTIN_ALL, __p('code_objects/base')
47
+ autoload :BUILTIN_CLASSES, __p('code_objects/base')
48
+ autoload :BUILTIN_MODULES, __p('code_objects/base')
49
+ autoload :BUILTIN_EXCEPTIONS, __p('code_objects/base')
50
+ autoload :CONSTANTMATCH, __p('code_objects/base')
51
+ autoload :CONSTANTSTART, __p('code_objects/base')
52
+ autoload :METHODMATCH, __p('code_objects/base')
53
+ autoload :METHODNAMEMATCH, __p('code_objects/base')
54
+ autoload :NAMESPACEMATCH, __p('code_objects/base')
55
+ autoload :NSEP, __p('code_objects/base')
56
+ autoload :NSEPQ, __p('code_objects/base')
57
+ autoload :ISEP, __p('code_objects/base')
58
+ autoload :ISEPQ, __p('code_objects/base')
59
+ autoload :CSEP, __p('code_objects/base')
60
+ autoload :CSEPQ, __p('code_objects/base')
61
+ end
62
+
63
+ # Handlers are called during the data processing part of YARD's
64
+ # parsing phase. This allows YARD as well as any custom extension to
65
+ # analyze source and generate {CodeObjects} to be stored for later use.
66
+ module Handlers
67
+ # Shared logic between C and Ruby handlers.
68
+ module Common
69
+ autoload :MethodHandler, __p('handlers/common/method_handler')
70
+ end
71
+
72
+ # RBS type signature handlers
73
+ module RBS
74
+ autoload :Base, __p('handlers/rbs/base')
75
+ autoload :AttributeHandler, __p('handlers/rbs/attribute_handler')
76
+ autoload :ConstantHandler, __p('handlers/rbs/constant_handler')
77
+ autoload :MethodHandler, __p('handlers/rbs/method_handler')
78
+ autoload :MixinHandler, __p('handlers/rbs/mixin_handler')
79
+ autoload :NamespaceHandler, __p('handlers/rbs/namespace_handler')
80
+ end
81
+
82
+ # CRuby Handlers
83
+ # @since 0.8.0
84
+ module C
85
+ autoload :Base, __p('handlers/c/base')
86
+
87
+ autoload :AliasHandler, __p('handlers/c/alias_handler')
88
+ autoload :AttributeHandler, __p('handlers/c/attribute_handler')
89
+ autoload :ClassHandler, __p('handlers/c/class_handler')
90
+ autoload :ConstantHandler, __p('handlers/c/constant_handler')
91
+ autoload :HandlerMethods, __p('handlers/c/handler_methods')
92
+ autoload :InitHandler, __p('handlers/c/init_handler')
93
+ autoload :MethodHandler, __p('handlers/c/method_handler')
94
+ autoload :MixinHandler, __p('handlers/c/mixin_handler')
95
+ autoload :ModuleHandler, __p('handlers/c/module_handler')
96
+ autoload :OverrideCommentHandler, __p('handlers/c/override_comment_handler')
97
+ autoload :PathHandler, __p('handlers/c/path_handler')
98
+ autoload :StructHandler, __p('handlers/c/struct_handler')
99
+ autoload :SymbolHandler, __p('handlers/c/symbol_handler')
100
+ end
101
+
102
+ module Ruby # All Ruby handlers
103
+ module Legacy # Handlers for old Ruby 1.8 parser
104
+ autoload :Base, __p('handlers/ruby/legacy/base')
105
+
106
+ autoload :AliasHandler, __p('handlers/ruby/legacy/alias_handler')
107
+ autoload :AttributeHandler, __p('handlers/ruby/legacy/attribute_handler')
108
+ autoload :ClassHandler, __p('handlers/ruby/legacy/class_handler')
109
+ autoload :ClassConditionHandler, __p('handlers/ruby/legacy/class_condition_handler')
110
+ autoload :ClassVariableHandler, __p('handlers/ruby/legacy/class_variable_handler')
111
+ autoload :CommentHandler, __p('handlers/ruby/legacy/comment_handler')
112
+ autoload :ConstantHandler, __p('handlers/ruby/legacy/constant_handler')
113
+ autoload :DSLHandler, __p('handlers/ruby/legacy/dsl_handler')
114
+ autoload :ExceptionHandler, __p('handlers/ruby/legacy/exception_handler')
115
+ autoload :ExtendHandler, __p('handlers/ruby/legacy/extend_handler')
116
+ autoload :MethodHandler, __p('handlers/ruby/legacy/method_handler')
117
+ autoload :MixinHandler, __p('handlers/ruby/legacy/mixin_handler')
118
+ autoload :ModuleHandler, __p('handlers/ruby/legacy/module_handler')
119
+ autoload :ModuleFunctionHandler, __p('handlers/ruby/legacy/module_function_handler')
120
+ autoload :PrivateClassMethodHandler, __p('handlers/ruby/legacy/private_class_method_handler')
121
+ autoload :PrivateConstantHandler, __p('handlers/ruby/legacy/private_constant_handler')
122
+ autoload :VisibilityHandler, __p('handlers/ruby/legacy/visibility_handler')
123
+ autoload :YieldHandler, __p('handlers/ruby/legacy/yield_handler')
124
+ end
125
+
126
+ autoload :Base, __p('handlers/ruby/base')
127
+
128
+ autoload :AliasHandler, __p('handlers/ruby/alias_handler')
129
+ autoload :AttributeHandler, __p('handlers/ruby/attribute_handler')
130
+ autoload :ClassHandler, __p('handlers/ruby/class_handler')
131
+ autoload :ClassConditionHandler, __p('handlers/ruby/class_condition_handler')
132
+ autoload :ClassVariableHandler, __p('handlers/ruby/class_variable_handler')
133
+ autoload :CommentHandler, __p('handlers/ruby/comment_handler')
134
+ autoload :ConstantHandler, __p('handlers/ruby/constant_handler')
135
+ autoload :DecoratorHandlerMethods, __p('handlers/ruby/decorator_handler_methods')
136
+ autoload :DSLHandler, __p('handlers/ruby/dsl_handler')
137
+ autoload :DSLHandlerMethods, __p('handlers/ruby/dsl_handler_methods')
138
+ autoload :ExceptionHandler, __p('handlers/ruby/exception_handler')
139
+ autoload :ExtendHandler, __p('handlers/ruby/extend_handler')
140
+ autoload :MethodHandler, __p('handlers/ruby/method_handler')
141
+ autoload :MethodConditionHandler, __p('handlers/ruby/method_condition_handler')
142
+ autoload :MixinHandler, __p('handlers/ruby/mixin_handler')
143
+ autoload :ModuleHandler, __p('handlers/ruby/module_handler')
144
+ autoload :ModuleFunctionHandler, __p('handlers/ruby/module_function_handler')
145
+ autoload :PrivateClassMethodHandler, __p('handlers/ruby/private_class_method_handler')
146
+ autoload :PrivateConstantHandler, __p('handlers/ruby/private_constant_handler')
147
+ autoload :PublicClassMethodHandler, __p('handlers/ruby/public_class_method_handler')
148
+ autoload :StructHandlerMethods, __p('handlers/ruby/struct_handler_methods')
149
+ autoload :VisibilityHandler, __p('handlers/ruby/visibility_handler')
150
+ autoload :YieldHandler, __p('handlers/ruby/yield_handler')
151
+ end
152
+
153
+ autoload :Base, __p('handlers/base')
154
+ autoload :HandlerAborted, __p('handlers/base')
155
+ autoload :NamespaceMissingError, __p('handlers/base')
156
+ autoload :Processor, __p('handlers/processor')
157
+ end
158
+
159
+ # Namespace for internationalization (i18n)
160
+ # @since 0.8.0
161
+ module I18n
162
+ autoload :Locale, __p('i18n/locale')
163
+ autoload :Message, __p('i18n/message')
164
+ autoload :Messages, __p('i18n/messages')
165
+ autoload :PotGenerator, __p('i18n/pot_generator')
166
+ autoload :Text, __p('i18n/text')
167
+ end
168
+
169
+ # The parser namespace holds all parsing engines used by YARD.
170
+ # Currently only Ruby and C (Ruby) parsers are implemented.
171
+ module Parser
172
+ module C # CRuby Parsing components
173
+ autoload :BodyStatement, __p('parser/c/statement')
174
+ autoload :Comment, __p('parser/c/statement')
175
+ autoload :CommentParser, __p('parser/c/comment_parser')
176
+ autoload :CParser, __p('parser/c/c_parser')
177
+ autoload :Statement, __p('parser/c/statement')
178
+ autoload :ToplevelStatement, __p('parser/c/statement')
179
+ end
180
+
181
+ module Ruby # Ruby parsing components.
182
+ module Legacy # Handles Ruby parsing in Ruby 1.8.
183
+ autoload :RubyParser, __p('parser/ruby/legacy/ruby_parser')
184
+ autoload :RubyToken, __p('parser/ruby/legacy/ruby_lex')
185
+ autoload :Statement, __p('parser/ruby/legacy/statement')
186
+ autoload :StatementList, __p('parser/ruby/legacy/statement_list')
187
+ autoload :TokenList, __p('parser/ruby/legacy/token_list')
188
+ end
189
+
190
+ autoload :AstNode, __p('parser/ruby/ast_node')
191
+ autoload :RubyParser, __p('parser/ruby/ruby_parser')
192
+ autoload :RipperParser, __p('parser/ruby/ruby_parser')
193
+ autoload :TokenResolver, __p('parser/ruby/token_resolver')
194
+ end
195
+
196
+ # RBS type signature parser
197
+ module RBS
198
+ autoload :RbsParser, __p('parser/rbs/rbs_parser')
199
+ autoload :Statement, __p('parser/rbs/statement')
200
+ end
201
+
202
+ autoload :Base, __p('parser/base')
203
+ autoload :ParserSyntaxError, __p('parser/source_parser')
204
+ autoload :SourceParser, __p('parser/source_parser')
205
+ autoload :UndocumentableError, __p('parser/source_parser')
206
+ end
207
+
208
+ module Rake # Holds Rake tasks used by YARD
209
+ autoload :YardocTask, __p('rake/yardoc_task')
210
+ end
211
+
212
+ module Serializers # Namespace for components that serialize to various endpoints
213
+ autoload :Base, __p('serializers/base')
214
+ autoload :FileSystemSerializer, __p('serializers/file_system_serializer')
215
+ autoload :ProcessSerializer, __p('serializers/process_serializer')
216
+ autoload :StdoutSerializer, __p('serializers/stdout_serializer')
217
+ autoload :YardocSerializer, __p('serializers/yardoc_serializer')
218
+ end
219
+
220
+ # Namespace for classes and modules that handle serving documentation over HTTP
221
+ #
222
+ # == Implementing a Custom Server
223
+ # To customize the YARD server, see the {Adapter} and {Router} classes.
224
+ #
225
+ # == Rack Middleware
226
+ # If you want to use the YARD server as a Rack middleware, see the documentation
227
+ # in {RackMiddleware}.
228
+ #
229
+ # @since 0.6.0
230
+ module Server
231
+ require __p('server')
232
+
233
+ # Commands implement specific kinds of server responses which are routed
234
+ # to by the {Router} class. To implement a custom command, subclass {Commands::Base}.
235
+ module Commands
236
+ autoload :Base, __p('server/commands/base')
237
+ autoload :DisplayFileCommand, __p('server/commands/display_file_command')
238
+ autoload :DisplayObjectCommand, __p('server/commands/display_object_command')
239
+ autoload :FramesCommand, __p('server/commands/frames_command')
240
+ autoload :ListCommand, __p('server/commands/list_command')
241
+ autoload :LibraryCommand, __p('server/commands/library_command')
242
+ autoload :LibraryIndexCommand, __p('server/commands/library_index_command')
243
+ autoload :RootRequestCommand, __p('server/commands/root_request_command')
244
+ autoload :SearchCommand, __p('server/commands/search_command')
245
+ autoload :StaticFileCommand, __p('server/commands/static_file_command')
246
+ autoload :StaticFileHelpers, __p('server/commands/static_file_helpers')
247
+ end
248
+
249
+ autoload :Adapter, __p('server/adapter')
250
+ autoload :DocServerSerializer, __p('server/doc_server_serializer')
251
+ autoload :DocServerHelper, __p('server/doc_server_helper')
252
+ autoload :FinishRequest, __p('server/adapter')
253
+ autoload :LibraryVersion, __p('server/library_version')
254
+ autoload :NotFoundError, __p('server/adapter')
255
+ autoload :HTTPUtils, __p('server/http_utils')
256
+ autoload :RackAdapter, __p('server/rack_adapter')
257
+ autoload :RackMiddleware, __p('server/rack_adapter')
258
+ autoload :Router, __p('server/router')
259
+ autoload :StaticCaching, __p('server/static_caching')
260
+ autoload :WebrickAdapter, __p('server/webrick_adapter')
261
+ autoload :WebrickServlet, __p('server/webrick_adapter')
262
+ end
263
+
264
+ module Tags # Namespace for Tag components
265
+ autoload :AttributeDirective, __p('tags/directives')
266
+ autoload :DefaultFactory, __p('tags/default_factory')
267
+ autoload :DefaultTag, __p('tags/default_tag')
268
+ autoload :Directive, __p('tags/directives')
269
+ autoload :EndGroupDirective, __p('tags/directives')
270
+ autoload :GroupDirective, __p('tags/directives')
271
+ autoload :Library, __p('tags/library')
272
+ autoload :MacroDirective, __p('tags/directives')
273
+ autoload :MethodDirective, __p('tags/directives')
274
+ autoload :OptionTag, __p('tags/option_tag')
275
+ autoload :OverloadTag, __p('tags/overload_tag')
276
+ autoload :ParseDirective, __p('tags/directives')
277
+ autoload :RefTag, __p('tags/ref_tag')
278
+ autoload :RefTagList, __p('tags/ref_tag_list')
279
+ autoload :ScopeDirective, __p('tags/directives')
280
+ autoload :Tag, __p('tags/tag')
281
+ autoload :TagFormatError, __p('tags/tag_format_error')
282
+ autoload :TypesExplainer, __p('tags/types_explainer')
283
+ autoload :VisibilityDirective, __p('tags/directives')
284
+ end
285
+
286
+ # Namespace for templating system
287
+ module Templates
288
+ module Helpers # Namespace for template helpers
289
+ module Markup # Namespace for markup providers
290
+ autoload :HtmlEntities, __p('templates/helpers/markup/html_entities')
291
+ autoload :HybridMarkdown, __p('templates/helpers/markup/hybrid_markdown')
292
+ autoload :RDocMarkup, __p('templates/helpers/markup/rdoc_markup')
293
+ autoload :RDocMarkdown, __p('templates/helpers/markup/rdoc_markdown')
294
+ end
295
+
296
+ autoload :BaseHelper, __p('templates/helpers/base_helper')
297
+ autoload :FilterHelper, __p('templates/helpers/filter_helper')
298
+ autoload :HtmlHelper, __p('templates/helpers/html_helper')
299
+ autoload :HtmlSyntaxHighlightHelper, __p('templates/helpers/html_syntax_highlight_helper')
300
+ autoload :MarkupHelper, __p('templates/helpers/markup_helper')
301
+ autoload :MethodHelper, __p('templates/helpers/method_helper')
302
+ autoload :ModuleHelper, __p('templates/helpers/module_helper')
303
+ autoload :TextHelper, __p('templates/helpers/text_helper')
304
+ autoload :UMLHelper, __p('templates/helpers/uml_helper')
305
+ end
306
+
307
+ autoload :Engine, __p('templates/engine')
308
+ autoload :ErbCache, __p('templates/erb_cache')
309
+ autoload :Section, __p('templates/section')
310
+ autoload :Template, __p('templates/template')
311
+ autoload :TemplateOptions, __p('templates/template_options')
312
+ end
313
+
314
+ autoload :Config, __p('config')
315
+ autoload :Docstring, __p('docstring')
316
+ autoload :DocstringParser, __p('docstring_parser')
317
+ autoload :GemIndex, __p('gem_index')
318
+ autoload :Logger, __p('logging')
319
+ autoload :OpenStruct, __p('open_struct')
320
+ autoload :Options, __p('options')
321
+ autoload :Registry, __p('registry')
322
+ autoload :RegistryResolver, __p('registry_resolver')
323
+ autoload :RegistryStore, __p('registry_store')
324
+ autoload :StubProxy, __p('serializers/yardoc_serializer')
325
+ autoload :Verifier, __p('verifier')
326
+ end
327
+
328
+ undef __p
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+ require 'optparse'
3
+
4
+ module YARD
5
+ module CLI
6
+ # Abstract base class for CLI utilities. Provides some helper methods for
7
+ # the option parser
8
+ #
9
+ # @abstract
10
+ # @since 0.6.0
11
+ class Command
12
+ # Helper method to run the utility on an instance.
13
+ # @see #run
14
+ def self.run(*args) new.run(*args) end
15
+
16
+ def description; '' end
17
+
18
+ protected
19
+
20
+ # Adds a set of common options to the tail of the OptionParser
21
+ #
22
+ # @param [OptionParser] opts the option parser object
23
+ # @return [void]
24
+ def common_options(opts)
25
+ opts.separator ""
26
+ opts.separator "Other options:"
27
+ opts.on('-e', '--load FILE', 'A Ruby script to load before running command.') do |file|
28
+ load_script(file)
29
+ end
30
+ opts.on('--plugin PLUGIN', 'Load a YARD plugin (gem with `yard-\' prefix)') do |name|
31
+ # Not actually necessary to load here, this is done at boot in YARD::Config.load_plugins
32
+ # YARD::Config.load_plugin(name)
33
+ end
34
+ opts.on('--legacy', 'Use old style Ruby parser and handlers. ',
35
+ ' Always on in 1.8.x.') do
36
+ YARD::Parser::SourceParser.parser_type = :ruby18
37
+ end
38
+ opts.on('--safe', 'Enable safe mode for this instance') do
39
+ # Parsed in YARD::Config.load
40
+ end
41
+ opts.on_tail('-q', '--quiet', 'Show no warnings.') { log.level = Logger::ERROR }
42
+ opts.on_tail('--verbose', 'Show more information.') { log.level = Logger::INFO }
43
+ opts.on_tail('--debug', 'Show debugging information.') { log.level = Logger::DEBUG }
44
+ opts.on_tail('--backtrace', 'Show stack traces') { log.show_backtraces = true }
45
+ opts.on_tail('-v', '--version', 'Show version.') { log.puts "yard #{YARD::VERSION}"; exit }
46
+ opts.on_tail('-h', '--help', 'Show this help.') { log.puts opts; exit }
47
+ end
48
+
49
+ # Parses the option and gracefully handles invalid switches
50
+ #
51
+ # @param [OptionParser] opts the option parser object
52
+ # @param [Array<String>] args the arguments passed from input. This
53
+ # array will be modified.
54
+ # @return [void]
55
+ def parse_options(opts, args)
56
+ opts.parse!(args)
57
+ rescue OptionParser::ParseError => err
58
+ unrecognized_option(err)
59
+ args.shift if args.first && args.first[0, 1] != '-'
60
+ retry
61
+ end
62
+
63
+ # Loads a Ruby script. If <tt>Config.options[:safe_mode]</tt> is enabled,
64
+ # this method will do nothing.
65
+ #
66
+ # @param [String] file the path to the script to load
67
+ # @since 0.6.2
68
+ def load_script(file)
69
+ return if YARD::Config.options[:safe_mode]
70
+ load(file)
71
+ rescue LoadError => load_exception
72
+ log.error "The file `#{file}' could not be loaded:\n#{load_exception}"
73
+ exit 1
74
+ end
75
+
76
+ # Callback when an unrecognize option is parsed
77
+ #
78
+ # @param [OptionParser::ParseError] err the exception raised by the
79
+ # option parser
80
+ def unrecognized_option(err)
81
+ log.warn "Unrecognized/#{err.message}"
82
+ end
83
+ end
84
+ end
85
+ end