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,10 @@
1
+ <% scopes(attr_listing) do |list, scope| %>
2
+ <div id="<%= scope %>_attr_details" class="attr_details">
3
+ <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
4
+ <% list.each_with_index do |meth, i| %>
5
+ <% rw = meth.attr_info %>
6
+ <span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
7
+ <%= yieldall :object => meth, :owner => object, :index => i %>
8
+ <% end %>
9
+ </div>
10
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% groups(attr_listing, "Attribute") do |list, name| %>
2
+ <h2><%= name %> <small><a href="#" class="summary_toggle">collapse</a></small></h2>
3
+ <ul class="summary">
4
+ <% list.each do |meth| %>
5
+ <%= yieldall :item => meth %>
6
+ <% end %>
7
+ </ul>
8
+ <% end %>
@@ -0,0 +1,43 @@
1
+ <div class="box_info">
2
+ <% if CodeObjects::ClassObject === object && object.superclass %>
3
+ <dl>
4
+ <dt>Inherits:</dt>
5
+ <dd>
6
+ <span class="inheritName"><%= linkify object.superclass %></span>
7
+ <% if object.superclass.name != :BasicObject %>
8
+ <ul class="fullTree">
9
+ <li><%= linkify P(:Object) %></li>
10
+ <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
11
+ <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
12
+ <% end %>
13
+ </ul>
14
+ <a href="#" class="inheritanceTree">show all</a>
15
+ <% end %>
16
+ </dd>
17
+ </dl>
18
+ <% end %>
19
+
20
+ <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
21
+ <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
22
+ <dl>
23
+ <dt><%= name %>:</dt>
24
+ <dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
25
+ </dl>
26
+ <% end %>
27
+ <% end %>
28
+
29
+ <% if (mixed_into = mixed_into(object)).size > 0 %>
30
+ <dl>
31
+ <dt>Included in:</dt>
32
+ <dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
33
+ </dl>
34
+ <% end %>
35
+
36
+ <% unless object.root? %>
37
+ <dl>
38
+ <dt>Defined in:</dt>
39
+ <dd><%= erb(:defines) %></dd>
40
+ </dl>
41
+ <% end %>
42
+ </div>
43
+
@@ -0,0 +1,8 @@
1
+ <h2>Defined Under Namespace</h2>
2
+ <p class="children">
3
+ <% @inner.each do |name, list| %>
4
+ <% if list.size > 0 %>
5
+ <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
6
+ <% end %>
7
+ <% end %>
8
+ </p>
@@ -0,0 +1,17 @@
1
+ <% if constant_listing.size > 0 %>
2
+ <% groups(constant_listing, "Constant") do |list, name| %>
3
+ <h2>
4
+ <%= name %>
5
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
6
+ </h2>
7
+
8
+ <dl class="constants">
9
+ <% list.each do |cnst| %>
10
+ <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
11
+ <%= yieldall :object => cnst %>
12
+ </dt>
13
+ <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
14
+ <% end %>
15
+ </dl>
16
+ <% end %>
17
+ <% end %>
@@ -0,0 +1,3 @@
1
+ <%= object.file ? object.file : '(unknown)' %><% if object.files.size > 1 %><span class="defines">,<br>
2
+ <%= object.files[1..-1].map {|f| f.first }.join(",<br> ") %></span>
3
+ <% end %>
@@ -0,0 +1,5 @@
1
+ <h1><%= format_object_title(object) %>
2
+ <% if object.has_tag?(:abstract) %><span class="abstract note title">Abstract</span><% end %>
3
+ <% if object.has_tag?(:deprecated) %><span class="deprecated note title">Deprecated</span><% end %>
4
+ <% if object.has_tag?(:api) && object.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
5
+ </h1>
@@ -0,0 +1,14 @@
1
+ <% found_method = false %>
2
+ <% inherited_attr_list do |superclass, attribs| %>
3
+ <% if attr_listing.size == 0 && !found_method %><h2>Instance Attribute Summary</h2><% end %>
4
+ <% found_method = true %>
5
+ <h3 class="inherited">Attributes <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
6
+ <p class="inherited"><%= attribs.map do |method|
7
+ name = method.name(true).gsub(/=$/, '')
8
+ if superclass.type == :module && object.instance_mixins.include?(superclass)
9
+ name = "##{name}" unless name =~ /^#/
10
+ end
11
+ linkify(method, name)
12
+ end.join(", ")
13
+ %></p>
14
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% found_const = false %>
2
+ <% inherited_constant_list do |superclass, consts| %>
3
+ <% if constant_listing.size == 0 && !found_const %><h2>Constant Summary</h2><% end %>
4
+ <% found_const = true %>
5
+ <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %>
6
+ from <%= linkify superclass %></h3>
7
+ <p class="inherited"><%= consts.map {|c| linkify c }.join(", ") %></p>
8
+ <% end %>
@@ -0,0 +1,20 @@
1
+ <% found_method = false %>
2
+ <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
3
+ <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
4
+ <% next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false %>
5
+ <% meths = prune_method_listing(superclass.meths(:included => false, :inherited => false)) %>
6
+ <% meths.reject! {|m| object.child(:scope => m.scope, :name => m.name) != nil } %>
7
+ <% meths.reject! {|m| m.is_alias? || m.is_attribute? } %>
8
+ <% meths.reject! {|m| m.group && object.groups && object.groups.include?(m.group) } %>
9
+ <% next if meths.size == 0 %>
10
+ <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
11
+ <% found_method = true %>
12
+ <h3 class="inherited">Methods <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
13
+ <p class="inherited"><%=
14
+ meths.sort_by {|o| o.name.to_s }.map do |m|
15
+ name = m.name(true)
16
+ name = name.gsub(/^#/,'') if superclass.type == :module && object.class_mixins.include?(superclass)
17
+ linkify(m, name)
18
+ end.join(", ")
19
+ %></p>
20
+ <% end %>
@@ -0,0 +1,40 @@
1
+ <li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
2
+ <span class="summary_signature">
3
+ <% if @item.tags(:overload).size == 1 %>
4
+ <%= signature(@item.tag(:overload), true, false, !@item.attr_info) %>
5
+ <% else %>
6
+ <%= signature(@item, true, false, !@item.attr_info) %>
7
+ <% end %>
8
+
9
+ <% if @item.aliases.size > 0 %>
10
+ (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
11
+ <% end %>
12
+ </span>
13
+ <% if object != @item.namespace %>
14
+ <span class="note title not_defined_here">
15
+ <%= @item.namespace.type == :class ? 'inherited' : (@item.scope == :class ? 'extended' : 'included') %>
16
+ from <%= linkify @item, object.relative_path(@item.namespace) %>
17
+ </span>
18
+ <% end %>
19
+ <% if @item.constructor? %>
20
+ <span class="note title constructor">constructor</span>
21
+ <% end %>
22
+ <% if rw = @item.attr_info %>
23
+ <% if !run_verifier([rw[:read]].compact).empty? && run_verifier([rw[:write]].compact).empty? %>
24
+ <span class="note title readonly">readonly</span>
25
+ <% end %>
26
+ <% if !run_verifier([rw[:write]].compact).empty? && run_verifier([rw[:read]].compact).empty? %>
27
+ <span class="note title writeonly">writeonly</span>
28
+ <% end %>
29
+ <% end %>
30
+ <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
31
+ <% if @item.has_tag?(:abstract) %><span class="abstract note title">abstract</span><% end %>
32
+ <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
33
+ <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
34
+
35
+ <% if @item.has_tag?(:deprecated) %>
36
+ <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
37
+ <% else %>
38
+ <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
39
+ <% end %>
40
+ </li>
@@ -0,0 +1,9 @@
1
+ <% scopes(method_listing(false)) do |list, scope| %>
2
+ <div id="<%= scope %>_method_details" class="method_details_list">
3
+ <h2><%= scope.to_s.capitalize %> Method Details</h2>
4
+
5
+ <% list.each_with_index do |meth, i| %>
6
+ <%= yieldall :object => meth, :owner => object, :index => i %>
7
+ <% end %>
8
+ </div>
9
+ <% end %>
@@ -0,0 +1,22 @@
1
+ <% if method_listing.size > 0 %>
2
+ <% groups(method_listing) do |list, name| %>
3
+ <h2>
4
+ <%= name %>
5
+ <small><a href="#" class="summary_toggle">collapse</a></small>
6
+ </h2>
7
+
8
+ <ul class="summary">
9
+ <% list.each do |meth| %>
10
+ <%= yieldall :item => meth %>
11
+ <% end %>
12
+ </ul>
13
+ <% (inherited_methods_by_group[name] || {}).each do |superclass, meths| %>
14
+ <h3 class="inherited">Methods <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
15
+ <p class="inherited"><%= meths.sort_by {|o| o.name.to_s }.map {|m|
16
+ mname = m.name(true)
17
+ mname = mname.gsub(/^#/, '') if superclass.type == :module && object.class_mixins.include?(superclass)
18
+ linkify(m, mname)
19
+ }.join(", ") %></p>
20
+ <% end %>
21
+ <% end %>
22
+ <% end %>
@@ -0,0 +1,12 @@
1
+ <div id="method_missing_details" class="method_details_list">
2
+ <h2>Dynamic Method Handling</h2>
3
+ <p class="notice <%= @mm.namespace == object ? 'this' : 'super' %>">
4
+ This class handles dynamic methods through the <tt>method_missing</tt> method
5
+ <% if @mm.namespace != object %>
6
+ in the class <%= linkify @mm, @mm.namespace.path %>
7
+ <% end %>
8
+ </p>
9
+ <% if @mm.namespace == object %>
10
+ <%= yieldall :object => @mm, :index => 0 %>
11
+ <% end %>
12
+ </div>
@@ -0,0 +1 @@
1
+ <h2>Overview</h2>
@@ -0,0 +1,187 @@
1
+ # frozen_string_literal: true
2
+ include Helpers::ModuleHelper
3
+
4
+ def init
5
+ sections :header, :box_info, :pre_docstring, T('docstring'), :children,
6
+ :constant_summary, [T('docstring')], :inherited_constants,
7
+ :attribute_summary, [:item_summary], :inherited_attributes,
8
+ :method_summary, [:item_summary], :inherited_methods,
9
+ :methodmissing, [T('method_details')],
10
+ :attribute_details, [T('method_details')],
11
+ :method_details_list, [T('method_details')]
12
+ end
13
+
14
+ def pre_docstring
15
+ return if object.docstring.blank?
16
+ erb(:pre_docstring)
17
+ end
18
+
19
+ def children
20
+ @inner = [[:modules, []], [:classes, []]]
21
+ object.children.each do |child|
22
+ @inner[0][1] << child if child.type == :module
23
+ @inner[1][1] << child if child.type == :class
24
+ end
25
+ @inner.map! {|v| [v[0], run_verifier(v[1].sort_by {|o| o.name.to_s })] }
26
+ return if (@inner[0][1].size + @inner[1][1].size) == 0
27
+ erb(:children)
28
+ end
29
+
30
+ def methodmissing
31
+ mms = object.meths(:inherited => true, :included => true)
32
+ @mm = mms.find {|o| o.name == :method_missing && o.scope == :instance }
33
+ erb(:methodmissing) if @mm
34
+ end
35
+
36
+ def method_listing(include_specials = true)
37
+ return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
38
+ return @meths if defined?(@meths) && @meths
39
+ @meths = object.meths(:inherited => false, :included => !options.embed_mixins.empty?)
40
+ unless options.embed_mixins.empty?
41
+ @meths = @meths.reject {|m| options.embed_mixins_match?(m.namespace) == false }
42
+ end
43
+ @meths = sort_listing(prune_method_listing(@meths))
44
+ @meths
45
+ end
46
+
47
+ def special_method?(meth)
48
+ return true if meth.name(true) == '#method_missing'
49
+ return true if meth.constructor?
50
+ false
51
+ end
52
+
53
+ def attr_listing
54
+ return @attrs if defined?(@attrs) && @attrs
55
+ @attrs = []
56
+ object.inheritance_tree(true).each do |superclass|
57
+ next if superclass.is_a?(CodeObjects::Proxy)
58
+ next if !options.embed_mixins.empty? &&
59
+ !options.embed_mixins_match?(superclass)
60
+ [:class, :instance].each do |scope|
61
+ superclass.attributes[scope].each do |_name, rw|
62
+ attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first
63
+ @attrs << attr if attr
64
+ end
65
+ end
66
+ break if options.embed_mixins.empty?
67
+ end
68
+ @attrs = sort_listing(@attrs)
69
+ end
70
+
71
+ def constant_listing
72
+ return @constants if defined?(@constants) && @constants
73
+ @constants = object.constants(:included => false, :inherited => false)
74
+ @constants += object.cvars
75
+ @constants = run_verifier(@constants)
76
+ @constants
77
+ end
78
+
79
+ def sort_listing(list)
80
+ list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
81
+ end
82
+
83
+ def inherited_attr_list
84
+ object.inheritance_tree(true)[1..-1].each do |superclass|
85
+ next if superclass.is_a?(YARD::CodeObjects::Proxy)
86
+ next if !options.embed_mixins.empty? && options.embed_mixins_match?(superclass) != false
87
+ attribs = superclass.attributes[:instance]
88
+ attribs = attribs.select {|name, _rw| object.child(:scope => :instance, :name => name).nil? }
89
+ attribs = attribs.sort_by {|args| args.first.to_s }.map {|_n, m| m[:read] || m[:write] }
90
+ attribs = prune_method_listing(attribs, false)
91
+ yield superclass, attribs unless attribs.empty?
92
+ end
93
+ end
94
+
95
+ def inherited_constant_list
96
+ object.inheritance_tree(true)[1..-1].each do |superclass|
97
+ next if superclass.is_a?(YARD::CodeObjects::Proxy)
98
+ next if !options.embed_mixins.empty? && options.embed_mixins_match?(superclass) != false
99
+ consts = superclass.constants(:included => false, :inherited => false)
100
+ consts = consts.select {|const| object.child(:type => :constant, :name => const.name).nil? }
101
+ consts = consts.sort_by {|const| const.name.to_s }
102
+ consts = run_verifier(consts)
103
+ yield superclass, consts unless consts.empty?
104
+ end
105
+ end
106
+
107
+ def inherited_methods_by_group
108
+ return @inherited_meths_by_group if defined?(@inherited_meths_by_group)
109
+ @inherited_meths_by_group = {}
110
+ return @inherited_meths_by_group unless object.groups
111
+
112
+ object.inheritance_tree(true)[1..-1].each do |superclass|
113
+ next if superclass.is_a?(YARD::CodeObjects::Proxy)
114
+ next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
115
+ meths = prune_method_listing(superclass.meths(:included => false, :inherited => false))
116
+ meths.reject! {|m| object.child(:scope => m.scope, :name => m.name) != nil }
117
+ meths.reject! {|m| m.is_alias? || m.is_attribute? }
118
+ meths.each do |m|
119
+ next unless m.group && object.groups.include?(m.group)
120
+ (@inherited_meths_by_group[m.group] ||= {})[superclass] ||= []
121
+ @inherited_meths_by_group[m.group][superclass] << m
122
+ end
123
+ end
124
+ @inherited_meths_by_group
125
+ end
126
+
127
+ def docstring_full(obj)
128
+ docstring = obj.tags(:overload).size == 1 && obj.docstring.empty? ?
129
+ obj.tag(:overload).docstring : obj.docstring
130
+
131
+ if docstring.summary.empty? && obj.tags(:return).size == 1 && obj.tag(:return).text
132
+ docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/, &:upcase).strip)
133
+ end
134
+
135
+ docstring
136
+ end
137
+
138
+ def docstring_summary(obj)
139
+ docstring_full(obj).summary
140
+ end
141
+
142
+ def groups(list, type = "Method")
143
+ groups_data = object.groups
144
+ if groups_data
145
+ list.each {|m| groups_data |= [m.group] if m.group && owner != m.namespace }
146
+ others = list.select {|m| !m.group || !groups_data.include?(m.group) }
147
+ groups_data.each do |name|
148
+ items = list.select {|m| m.group == name }
149
+ yield(items, name) unless items.empty?
150
+ end
151
+ else
152
+ others = []
153
+ group_data = {}
154
+ list.each do |itm|
155
+ if itm.group
156
+ (group_data[itm.group] ||= []) << itm
157
+ else
158
+ others << itm
159
+ end
160
+ end
161
+ group_data.each {|group, items| yield(items, group) unless items.empty? }
162
+ end
163
+
164
+ return if others.empty?
165
+ if others.first.respond_to?(:scope)
166
+ scopes(others) {|items, scope| yield(items, "#{scope.to_s.capitalize} #{type} Summary") }
167
+ else
168
+ yield(others, "#{type} Summary")
169
+ end
170
+ end
171
+
172
+ def scopes(list)
173
+ [:class, :instance].each do |scope|
174
+ items = list.select {|m| m.scope == scope }
175
+ yield(items, scope) unless items.empty?
176
+ end
177
+ end
178
+
179
+ def mixed_into(object)
180
+ unless globals.mixed_into
181
+ globals.mixed_into = {}
182
+ list = run_verifier Registry.all(:class, :module)
183
+ list.each {|o| o.mixins.each {|m| (globals.mixed_into[m.path] ||= []) << o } }
184
+ end
185
+
186
+ globals.mixed_into[object.path] || []
187
+ end
@@ -0,0 +1,10 @@
1
+ Defined Under Namespace:
2
+ ------------------------
3
+
4
+ <% @inner.each do |name, list| %>
5
+ <% if list.size > 0 %>
6
+ <% text = list.map {|c| c.name }.join(", ") + " (#{name})" %>
7
+ <%= indent(wrap(text)) %>
8
+
9
+ <% end %>
10
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% if class_meths.size > 0 %>
2
+ Class methods:
3
+ --------------
4
+
5
+ <%= indent wrap(class_meths.map {|o| o.name.to_s }.join(", "), 68) %>
6
+
7
+
8
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% if object.mixins(:class).size > 0 %>
2
+ Extended by:
3
+ ------------
4
+
5
+ <%= indent wrap(object.mixins(:class).join(", "), 68) %>
6
+
7
+
8
+ <% end %>
@@ -0,0 +1,7 @@
1
+ <%= title_align_right format_object_title(object) %>
2
+
3
+ <%= yieldall %>
4
+
5
+ <%= hr %>
6
+
7
+
@@ -0,0 +1,8 @@
1
+ <% if object.mixins(:instance).size > 0 %>
2
+ Includes:
3
+ ---------
4
+
5
+ <%= indent wrap(object.mixins(:instance).join(", "), 68) %>
6
+
7
+
8
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <% if instance_meths.size > 0 %>
2
+ Instance methods:
3
+ -----------------
4
+
5
+ <%= indent wrap(instance_meths.map {|o| o.name.to_s }.join(", "), 68) %>
6
+
7
+
8
+ <% end %>
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ def init
3
+ sections :header, [T('docstring')], :children, :includes, :extends,
4
+ :class_meths_list, :instance_meths_list
5
+ end
6
+
7
+ def class_meths
8
+ @classmeths ||= method_listing.select {|o| o.scope == :class }
9
+ end
10
+
11
+ def instance_meths
12
+ @instmeths ||= method_listing.select {|o| o.scope == :instance }
13
+ end
@@ -0,0 +1,5 @@
1
+ <% @files.each do |file| %>
2
+ <% @file = file %>
3
+ <h2><%= file.title %></h2>
4
+ <%= diskfile %>
5
+ <% end %>
@@ -0,0 +1,8 @@
1
+ <style type="text/css">
2
+ <%= @css_data %>
3
+ html { width: auto; height: auto; }
4
+ body { display: block; margin: 1rem; width: auto; }
5
+ </style>
6
+ <script type="text/javascript">
7
+ <%= @js_data %>
8
+ </script>
@@ -0,0 +1,16 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="<%= charset %>">
5
+ <title><%= defined?(@title) ? @title : '' %></title>
6
+ <%= erb(:headers) %>
7
+ </head>
8
+ <body>
9
+ <div id="content">
10
+ <h1><%= defined?(@title) ? @title : '' %></h1>
11
+ <%= yieldall %>
12
+ </div>
13
+
14
+ <%= erb(:footer) %>
15
+ </body>
16
+ </html>
@@ -0,0 +1,3 @@
1
+ <div id="readme">
2
+ <%= htmlify(parse_top_comments_from_file) %>
3
+ </div>
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+ include T('default/layout/html')
3
+ include YARD::Parser::Ruby::Legacy
4
+
5
+ def init
6
+ override_serializer
7
+ @object = YARD::Registry.root
8
+ @files.shift
9
+ @objects.delete(YARD::Registry.root)
10
+ @objects.unshift(YARD::Registry.root)
11
+ sections :layout, [:readme, :files, :all_objects]
12
+ end
13
+
14
+ def all_objects
15
+ @objects.map {|obj| obj.format(options) }.join("\n")
16
+ end
17
+
18
+ def layout
19
+ layout = Object.new.extend(T('layout'))
20
+ @css_data = layout.stylesheets.map {|sheet| read_asset(sheet) }.join("\n")
21
+ @js_data = layout.javascripts.map {|script| read_asset(script) }.join("")
22
+
23
+ erb(:layout)
24
+ end
25
+
26
+ def read_asset(file)
27
+ file = T('fulldoc').find_file(file)
28
+ return unless file
29
+ data = File.read(file)
30
+ superfile = self.class.find_nth_file('fulldoc', 2)
31
+ data.gsub!('{{{__super__}}}', superfile ? IO.read(superfile) : "")
32
+ data
33
+ end
34
+
35
+ private
36
+
37
+ def parse_top_comments_from_file
38
+ return unless defined?(@readme) && @readme
39
+ return @readme.contents unless @readme.filename =~ /\.rb$/
40
+ data = ""
41
+ tokens = TokenList.new(@readme.contents)
42
+ tokens.each do |token|
43
+ break unless token.is_a?(RubyToken::TkCOMMENT) || token.is_a?(RubyToken::TkNL)
44
+ data += (token.text[/\A#\s{0,1}(.*)/, 1] || "\n")
45
+ end
46
+ YARD::Docstring.new(data)
47
+ end
48
+
49
+ def override_serializer
50
+ return if @serializer.nil?
51
+ class << @serializer
52
+ define_method(:serialize) do |object, data|
53
+ return unless object == 'index.html'
54
+ super(object, data)
55
+ end
56
+
57
+ define_method(:serialized_path) do |object|
58
+ return object if object.is_a?(String)
59
+ 'index.html'
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,3 @@
1
+ <% if inner = yieldall.gsub("\n", '') %>
2
+ Root [label="{<%= inner %>}" rank=sink];
3
+ <% end %>
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+ include T('default/module/dot')
3
+
4
+ def format_path(_object)
5
+ ""
6
+ end
@@ -0,0 +1,2 @@
1
+ # frozen_string_literal: true
2
+ include T('default/module/html')
@@ -0,0 +1,11 @@
1
+ <% if object.has_tag?(:example) %>
2
+ <div class="examples">
3
+ <h4 class="tag_title">Examples:</h4>
4
+ <% object.tags(:example).each do |tag| %>
5
+ <% unless tag.name.empty? %>
6
+ <h5 class="example_title"><%= htmlify_line(tag.name) %></h5>
7
+ <% end %>
8
+ <pre class="example code"><code><%= html_syntax_highlight(tag.text) %></code></pre>
9
+ <% end %>
10
+ </div>
11
+ <% end %>
@@ -0,0 +1,3 @@
1
+ <div class="tags">
2
+ <%= yieldall %>
3
+ </div>