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,83 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ClassConditionHandler)
3
+ # @since 0.5.4
4
+ class YARD::Handlers::Ruby::Legacy::ClassConditionHandler < YARD::Handlers::Ruby::Legacy::Base
5
+ namespace_only
6
+ handles TkIF, TkELSIF, TkUNLESS
7
+
8
+ process do
9
+ condition = parse_condition
10
+ if condition.nil?
11
+ # Parse both blocks if we're unsure of the condition
12
+ parse_then_block
13
+ parse_else_block
14
+ elsif condition
15
+ parse_then_block
16
+ else
17
+ parse_else_block
18
+ end
19
+ end
20
+
21
+ protected
22
+
23
+ # Parses the condition part of the if/unless statement
24
+ #
25
+ # @return [true, false, nil] true if the condition can be definitely
26
+ # parsed to true, false if not, and nil if the condition cannot be
27
+ # parsed with certainty (it's dynamic)
28
+ # @since 0.5.5
29
+ def parse_condition
30
+ condition = nil
31
+
32
+ # Right now we can handle very simple unary conditions like:
33
+ # if true
34
+ # if false
35
+ # if 0
36
+ # if 100 (not 0)
37
+ # if defined? SOME_CONSTANT
38
+ #
39
+ # The last case will do a lookup in the registry and then one
40
+ # in the Ruby world (using eval).
41
+ case statement.tokens[1..-1].to_s.strip
42
+ when /^(\d+)$/
43
+ condition = $1 != "0"
44
+ when /^defined\?\s*\(?\s*([A-Za-z0-9:_]+?)\s*\)?$/
45
+ # defined? keyword used, let's see if we can look up the name
46
+ # in the registry, then we'll try using Ruby's powers. eval() is not
47
+ # *too* dangerous here since code is not actually executed.
48
+ name = $1
49
+ obj = YARD::Registry.resolve(namespace, name, true)
50
+ begin
51
+ condition = true if obj || Object.instance_eval("defined? #{name}")
52
+ rescue SyntaxError, NameError
53
+ condition = false
54
+ end
55
+ when "true"
56
+ condition = true
57
+ when "false"
58
+ condition = false
59
+ end
60
+
61
+ if TkUNLESS === statement.tokens.first
62
+ condition = !condition unless condition.nil?
63
+ end
64
+ condition
65
+ end
66
+
67
+ # @since 0.5.5
68
+ def parse_then_block
69
+ parse_block(:visibility => visibility)
70
+ end
71
+
72
+ # @since 0.5.5
73
+ def parse_else_block
74
+ return unless statement.block
75
+ stmtlist = YARD::Parser::Ruby::Legacy::StatementList
76
+ stmtlist.new(statement.block).each do |stmt|
77
+ next unless TkELSE === stmt.tokens.first
78
+ push_state(:visibility => visibility) do
79
+ parser.process(stmtlist.new(stmt.block))
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,113 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ClassHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ClassHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ include YARD::Handlers::Ruby::StructHandlerMethods
5
+ handles TkCLASS
6
+ namespace_only
7
+
8
+ process do
9
+ if statement.tokens.to_s =~ /^class\s+(#{NAMESPACEMATCH})\s*(?:<\s*(.+)|\Z)/m
10
+ classname = $1
11
+ superclass_def = $2
12
+ superclass = parse_superclass($2)
13
+ classname = classname.gsub(/\s/, '')
14
+ if superclass == "Struct"
15
+ is_a_struct = true
16
+ superclass = struct_superclass_name(superclass_def)
17
+ create_struct_superclass(superclass, superclass_def)
18
+ end
19
+ undocsuper = superclass_def && superclass.nil?
20
+
21
+ klass = register ClassObject.new(namespace, classname) do |o|
22
+ o.superclass = superclass if superclass
23
+ o.superclass.type = :class if o.superclass.is_a?(Proxy)
24
+ end
25
+ if is_a_struct
26
+ parse_struct_subclass(klass, superclass_def)
27
+ elsif klass
28
+ create_attributes(klass, members_from_tags(klass))
29
+ end
30
+ parse_block(:namespace => klass)
31
+
32
+ if undocsuper
33
+ raise YARD::Parser::UndocumentableError, 'superclass (class was added without superclass)'
34
+ end
35
+ elsif statement.tokens.to_s =~ /^class\s*<<\s*([\w\:\s]+)/
36
+ classname = $1.gsub(/\s/, '')
37
+ proxy = Proxy.new(namespace, classname)
38
+
39
+ # Allow constants to reference class names
40
+ if ConstantObject === proxy
41
+ if proxy.value =~ /\A#{NAMESPACEMATCH}\Z/
42
+ proxy = Proxy.new(namespace, proxy.value)
43
+ else
44
+ raise YARD::Parser::UndocumentableError, "constant class reference '#{classname}'"
45
+ end
46
+ end
47
+
48
+ if classname == "self"
49
+ parse_block(:namespace => namespace, :scope => :class)
50
+ elsif classname[0, 1] =~ /[A-Z]/
51
+ register ClassObject.new(namespace, classname) if Proxy === proxy
52
+ parse_block(:namespace => proxy, :scope => :class)
53
+ else
54
+ raise YARD::Parser::UndocumentableError, "class '#{classname}'"
55
+ end
56
+ else
57
+ raise YARD::Parser::UndocumentableError, "class: #{statement.tokens}"
58
+ end
59
+ end
60
+
61
+ private
62
+
63
+ # Extracts the parameter list from the Struct.new declaration and returns it
64
+ # formatted as a list of member names. Expects the user will have used symbols
65
+ # to define the struct member names
66
+ #
67
+ # @param [String] superstring the string declaring the superclass
68
+ # @return [Array<String>] a list of member names
69
+ def extract_parameters(superstring)
70
+ paramstring = superstring.match(/\A(O?Struct)\.new\((.*?)\)/)[2]
71
+ paramstring.split(",").select {|x| x.strip[0, 1] == ":" }.map {|x| x.strip[1..-1] } # the 1..-1 chops the leading :
72
+ end
73
+
74
+ def create_struct_superclass(superclass, superclass_def)
75
+ return if superclass == "Struct"
76
+ the_super = register ClassObject.new(P("Struct"), superclass[8..-1]) do |o|
77
+ o.superclass = "Struct"
78
+ end
79
+ parse_struct_subclass(the_super, superclass_def)
80
+ the_super
81
+ end
82
+
83
+ def struct_superclass_name(superclass)
84
+ match = superclass.match(/\A(Struct)\.new\((.*?)\)/)
85
+ if match
86
+ paramstring = match[2].split(",")
87
+ first = paramstring.first.strip
88
+ if first[0, 1] =~ /['"]/ && first[-1, 1] =~ /['"]/ && first !~ /\#\{/
89
+ return "Struct::#{first[1..-2]}"
90
+ end
91
+ end
92
+ "Struct"
93
+ end
94
+
95
+ def parse_struct_subclass(klass, superclass_def)
96
+ # Bounce if there's no parens
97
+ return unless superclass_def =~ /O?Struct\.new\((.*?)\)/
98
+ members = extract_parameters(superclass_def)
99
+ create_attributes(klass, members)
100
+ end
101
+
102
+ def parse_superclass(superclass)
103
+ case superclass
104
+ when /\A(#{NAMESPACEMATCH})(?:\s|\Z)/,
105
+ /\A(Struct|OStruct)\.new/,
106
+ /\ADelegateClass\((.+?)\)\s*\Z/,
107
+ /\A(#{NAMESPACEMATCH})\(/
108
+ $1
109
+ when "self"
110
+ namespace.path
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ClassVariableHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ClassVariableHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ HANDLER_MATCH = /\A@@\w+\s*=\s*/m
5
+ handles HANDLER_MATCH
6
+ namespace_only
7
+
8
+ process do
9
+ name, value = *statement.tokens.to_s.split(/\s*=\s*/, 2)
10
+ register ClassVariableObject.new(namespace, name) do |o|
11
+ o.source = statement
12
+ o.value = value.strip
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::CommentHandler)
3
+ class YARD::Handlers::Ruby::Legacy::CommentHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles TkCOMMENT
5
+ namespace_only
6
+
7
+ process do
8
+ register_docstring(nil)
9
+ end
10
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ConstantHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ConstantHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ include YARD::Handlers::Ruby::StructHandlerMethods
5
+ HANDLER_MATCH = /\A[A-Z]\w*\s*=[^=]\s*/m
6
+ handles HANDLER_MATCH
7
+ namespace_only
8
+
9
+ process do
10
+ name, value = *statement.tokens.to_s.split(/\s*=\s*/, 2)
11
+ if value =~ /\A\s*Struct.new(?:\s*\(?|\b)/
12
+ process_structclass(name, $')
13
+ else
14
+ register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value.strip }
15
+ end
16
+ end
17
+
18
+ private
19
+
20
+ def process_structclass(classname, parameters)
21
+ klass = create_class(classname, P(:Struct))
22
+ create_attributes(klass, extract_parameters(parameters))
23
+ end
24
+
25
+ def extract_parameters(parameters)
26
+ members = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(parameters), TkSYMBOL)
27
+ members.map(&:to_s)
28
+ end
29
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ module YARD
3
+ module Handlers
4
+ module Ruby
5
+ module Legacy
6
+ # (see Ruby::DSLHandler)
7
+ class DSLHandler < Base
8
+ include CodeObjects
9
+ include DSLHandlerMethods
10
+ handles TkIDENTIFIER
11
+ namespace_only
12
+ process { handle_comments }
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ExceptionHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ExceptionHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles(/\Araise(\s|\(|\Z)/)
5
+
6
+ process do
7
+ return unless owner.is_a?(MethodObject) # Only methods yield
8
+ return if owner.has_tag?(:raise)
9
+
10
+ klass = statement.tokens.to_s[/^raise[\(\s]*(#{NAMESPACEMATCH})\s*(?:\)|,|\s(?:if|unless|until)|;|(?:(?:\.|\:\:)\s*)?new|$)/, 1]
11
+ owner.add_tag YARD::Tags::Tag.new(:raise, '', klass) if klass
12
+ end
13
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ExtendHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ExtendHandler < YARD::Handlers::Ruby::Legacy::MixinHandler
4
+ handles(/\Aextend(\s|\()/)
5
+ namespace_only
6
+
7
+ def scope; :class end
8
+
9
+ private
10
+
11
+ def process_mixin(mixin)
12
+ if mixin == "self"
13
+ if namespace.is_a?(ClassObject)
14
+ raise UndocumentableError, "extend(self) statement on class"
15
+ end
16
+ namespace.mixins(scope) << namespace
17
+ else
18
+ super
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,90 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::MethodHandler)
3
+ class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles TkDEF
5
+
6
+ process do
7
+ nobj = namespace
8
+ mscope = scope
9
+
10
+ if statement.tokens.to_s =~ /^def\s+(#{METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
11
+ meth = $1
12
+ args = $2
13
+ meth.gsub!(/\s+/, '')
14
+ args = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(args), :all)
15
+ args.map! do |a|
16
+ k, v, r = *a.split(/(:)|=/, 2)
17
+ if r
18
+ k += v
19
+ v = r
20
+ end
21
+ [k.strip, (v ? v.strip : nil)]
22
+ end if args
23
+ else
24
+ raise YARD::Parser::UndocumentableError, "method: invalid name"
25
+ end
26
+
27
+ # Class method if prefixed by self(::|.) or Module(::|.)
28
+ if meth =~ /(?:#{NSEPQ}|#{CSEPQ})([^#{NSEP}#{CSEPQ}]+)$/
29
+ mscope = :class
30
+ meth = $1
31
+ prefix = $`
32
+ if prefix =~ /^[a-z]/ && prefix != "self"
33
+ raise YARD::Parser::UndocumentableError, 'method defined on object instance'
34
+ end
35
+ nobj = P(namespace, prefix) unless prefix == "self"
36
+ end
37
+
38
+ nobj = P(namespace, nobj.value) while nobj.type == :constant
39
+ obj = register MethodObject.new(nobj, meth, mscope) do |o|
40
+ o.explicit = true
41
+ o.parameters = args
42
+ end
43
+
44
+ # delete any aliases referencing old method
45
+ nobj.aliases.each do |aobj, name|
46
+ next unless name == obj.name
47
+ nobj.aliases.delete(aobj)
48
+ end if nobj.is_a?(NamespaceObject)
49
+
50
+ if mscope == :instance && meth == "initialize"
51
+ unless obj.has_tag?(:return)
52
+ obj.add_tag(YARD::Tags::Tag.new(:return,
53
+ "a new instance of #{namespace.name}", namespace.name.to_s))
54
+ end
55
+ elsif mscope == :class && obj.docstring.blank? && %w(inherited included
56
+ extended method_added method_removed method_undefined).include?(meth)
57
+ obj.add_tag(YARD::Tags::Tag.new(:private, nil))
58
+ elsif meth.to_s =~ /\?$/
59
+ if obj.tag(:return) && (obj.tag(:return).types || []).empty?
60
+ obj.tag(:return).types = ['Boolean']
61
+ elsif obj.tag(:return).nil?
62
+ unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
63
+ obj.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
64
+ end
65
+ end
66
+ end
67
+
68
+ if obj.has_tag?(:option)
69
+ # create the options parameter if its missing
70
+ obj.tags(:option).each do |option|
71
+ expected_param = option.name
72
+ unless obj.tags(:param).find {|x| x.name == expected_param }
73
+ new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
74
+ obj.add_tag(new_tag)
75
+ end
76
+ end
77
+ end
78
+
79
+ info = obj.attr_info
80
+ if info
81
+ if meth.to_s =~ /=$/ # writer
82
+ info[:write] = obj if info[:read]
83
+ elsif info[:write]
84
+ info[:read] = obj
85
+ end
86
+ end
87
+
88
+ parse_block(:owner => obj) # mainly for yield/exceptions
89
+ end
90
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::MixinHandler)
3
+ class YARD::Handlers::Ruby::Legacy::MixinHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles(/\Ainclude(\s|\()/)
5
+ namespace_only
6
+
7
+ process do
8
+ errors = []
9
+ statement.tokens[1..-1].to_s.split(/\s*,\s*/).reverse.each do |mixin|
10
+ mixin = mixin.strip
11
+ begin
12
+ process_mixin(mixin)
13
+ rescue YARD::Parser::UndocumentableError => err
14
+ errors << err.message
15
+ end
16
+ end
17
+
18
+ unless errors.empty?
19
+ msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
20
+ raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}"
21
+ end
22
+ end
23
+
24
+ private
25
+
26
+ def process_mixin(mixin)
27
+ mixmatch = mixin[/\A(#{NAMESPACEMATCH})/, 1]
28
+ raise YARD::Parser::UndocumentableError unless mixmatch
29
+
30
+ case obj = Proxy.new(namespace, mixmatch)
31
+ when ConstantObject # If a constant is included, use its value as the real object
32
+ obj = Proxy.new(namespace, obj.value, :module)
33
+ else
34
+ obj = Proxy.new(namespace, mixmatch, :module)
35
+ end
36
+
37
+ namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
38
+ end
39
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ModuleFunctionHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ModuleFunctionHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles(/\A(module_function)(\s|\(|$)/)
5
+ namespace_only
6
+
7
+ process do
8
+ if statement.tokens.size == 1
9
+ self.scope = :module
10
+ else
11
+ tokval_list(statement.tokens[2..-1], :attr).each do |name|
12
+ instance_method = MethodObject.new(namespace, name)
13
+ class_method = MethodObject.new(namespace, name, :module)
14
+ instance_method.copy_to(class_method)
15
+ class_method.visibility = :public
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::ModuleHandler)
3
+ class YARD::Handlers::Ruby::Legacy::ModuleHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles TkMODULE
5
+ namespace_only
6
+
7
+ process do
8
+ modname = statement.tokens.to_s[/^module\s+(#{NAMESPACEMATCH})/, 1]
9
+ mod = register ModuleObject.new(namespace, modname)
10
+ parse_block(:namespace => mod)
11
+ end
12
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::PrivateClassMethodHandler)
3
+ class YARD::Handlers::Ruby::Legacy::PrivateClassMethodHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles(/\Aprivate_class_method(\s|\(|$)/)
5
+ namespace_only
6
+
7
+ process do
8
+ tokval_list(statement.tokens[2..-1], :attr).each do |name|
9
+ privatize_class_method name
10
+ end
11
+ end
12
+
13
+ private
14
+
15
+ def privatize_class_method(name)
16
+ method = Proxy.new(namespace, name)
17
+ ensure_loaded!(method)
18
+ method.visibility = :private
19
+ rescue YARD::Handlers::NamespaceMissingError
20
+ raise UndocumentableError, "private visibility set on unrecognized method: #{name}"
21
+ end
22
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::PrivateConstantHandler)
3
+ class YARD::Handlers::Ruby::Legacy::PrivateConstantHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles(/\Aprivate_constant(\s|\(|$)/)
5
+ namespace_only
6
+
7
+ process do
8
+ tokval_list(statement.tokens[2..-1], :attr, TkCONSTANT).each do |name|
9
+ privatize_constant name
10
+ end
11
+ end
12
+
13
+ private
14
+
15
+ def privatize_constant(name)
16
+ const = Proxy.new(namespace, name)
17
+ ensure_loaded!(const)
18
+ const.visibility = :private
19
+ rescue NamespaceMissingError
20
+ raise UndocumentableError, "private visibility set on unrecognized constant: #{name}"
21
+ end
22
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::VisibilityHandler)
3
+ class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles(/\A(protected|private|public)(\s|\(|$)/)
5
+ namespace_only
6
+
7
+ process do
8
+ vis = statement.tokens.first.text
9
+ if statement.tokens.size == 1
10
+ self.visibility = vis
11
+ globals.visibility_origin = :keyword
12
+ else
13
+ tokval_list(statement.tokens[2..-1], :attr).each do |name|
14
+ MethodObject.new(namespace, name, scope) { |o| o.visibility = vis }
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+ # (see Ruby::YieldHandler)
3
+ class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
4
+ handles TkYIELD
5
+
6
+ process do
7
+ return unless owner.is_a?(MethodObject) # Only methods yield
8
+ return if owner.has_tag? :yield # Don't override yield tags
9
+ return if owner.has_tag? :yieldparam # Same thing.
10
+
11
+ yieldtag = YARD::Tags::Tag.new(:yield, "", [])
12
+ tokval_list(statement.tokens[2..-1], Token).each do |item|
13
+ item = item.inspect unless item.is_a?(String)
14
+ if item == "self"
15
+ yieldtag.types << '_self'
16
+ owner.add_tag YARD::Tags::Tag.new(:yieldparam,
17
+ "the object that the method was called on", owner.namespace.path, '_self')
18
+ elsif item == "super"
19
+ yieldtag.types << '_super'
20
+ owner.add_tag YARD::Tags::Tag.new(:yieldparam,
21
+ "the result of the method from the superclass", nil, '_super')
22
+ else
23
+ yieldtag.types << item
24
+ end
25
+ end
26
+
27
+ owner.add_tag(yieldtag) unless yieldtag.types.empty?
28
+ end
29
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ # Handles a conditional inside a method
3
+ class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
4
+ handles :if_mod, :unless_mod
5
+
6
+ process do
7
+ parse_block(statement.then_block, :owner => owner)
8
+ end
9
+ end
@@ -0,0 +1,104 @@
1
+ # frozen_string_literal: true
2
+ # Handles a method definition
3
+ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
4
+ include YARD::Handlers::Common::MethodHandler
5
+
6
+ handles :def, :defs
7
+
8
+ process do
9
+ meth = statement.method_name(true).to_s
10
+ args = format_args
11
+ blk = statement.block
12
+ nobj = namespace
13
+ mscope = scope
14
+ if statement.type == :defs
15
+ if statement[0][0].type == :ident
16
+ raise YARD::Parser::UndocumentableError, 'method defined on object instance'
17
+ end
18
+ nobj = P(namespace, statement[0].source) if statement[0][0].type == :const
19
+ mscope = :class
20
+ end
21
+
22
+ nobj = P(namespace, nobj.value) while nobj.type == :constant
23
+ obj = register MethodObject.new(nobj, meth, mscope) do |o|
24
+ o.explicit = true
25
+ o.parameters = args
26
+ end
27
+
28
+ # delete any aliases referencing old method
29
+ nobj.aliases.each do |aobj, name|
30
+ next unless name == obj.name
31
+ nobj.aliases.delete(aobj)
32
+ end if nobj.is_a?(NamespaceObject)
33
+
34
+ if obj.constructor?
35
+ unless obj.has_tag?(:return)
36
+ obj.add_tag(YARD::Tags::Tag.new(:return,
37
+ "a new instance of #{namespace.name}", namespace.name.to_s))
38
+ end
39
+ elsif mscope == :class && obj.docstring.blank? && %w(inherited included
40
+ extended method_added method_removed method_undefined).include?(meth)
41
+ obj.add_tag(YARD::Tags::Tag.new(:private, nil))
42
+ elsif meth.to_s =~ /\?$/
43
+ add_predicate_return_tag(obj)
44
+ end
45
+
46
+ if obj.has_tag?(:option)
47
+ # create the options parameter if its missing
48
+ obj.tags(:option).each do |option|
49
+ expected_param = option.name
50
+ unless obj.tags(:param).find {|x| x.name == expected_param }
51
+ new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
52
+ obj.add_tag(new_tag)
53
+ end
54
+ end
55
+ end
56
+
57
+ info = obj.attr_info
58
+ if info
59
+ if meth.to_s =~ /=$/ # writer
60
+ info[:write] = obj if info[:read]
61
+ elsif info[:write]
62
+ info[:read] = obj
63
+ end
64
+ end
65
+
66
+ parse_block(blk, :owner => obj) # mainly for yield/exceptions
67
+ end
68
+
69
+ def format_args
70
+ return [] unless args = statement.parameters
71
+
72
+ params = []
73
+
74
+ if args.unnamed_required_params
75
+ params += args.unnamed_required_params.map {|a| [a.source, nil] }
76
+ end
77
+
78
+ if args.unnamed_optional_params
79
+ params += args.unnamed_optional_params.map do |a|
80
+ [a[0].source, a[1].source]
81
+ end
82
+ end
83
+
84
+ params << ['*' + args.splat_param.source, nil] if args.splat_param
85
+
86
+ if args.unnamed_end_params
87
+ params += args.unnamed_end_params.map {|a| [a.source, nil] }
88
+ end
89
+
90
+ if args.named_params
91
+ params += args.named_params.map do |a|
92
+ [a[0].source, a[1] ? a[1].source : nil]
93
+ end
94
+ end
95
+
96
+ if args.double_splat_param
97
+ params << ['**' + args.double_splat_param.source, nil]
98
+ end
99
+
100
+ params << ['&' + args.block_param.source, nil] if args.block_param && !args.args_forward
101
+
102
+ params
103
+ end
104
+ end