yard 0.9.16 → 0.9.17

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of yard might be problematic. Click here for more details.

Files changed (566) hide show
  1. checksums.yaml +5 -5
  2. data/.yardopts +26 -26
  3. data/CHANGELOG.md +728 -728
  4. data/LEGAL +66 -66
  5. data/LICENSE +22 -22
  6. data/README.md +328 -328
  7. data/Rakefile +53 -47
  8. data/benchmarks/builtins_vs_eval.rb +24 -24
  9. data/benchmarks/concat_vs_join.rb +13 -13
  10. data/benchmarks/erb_vs_erubis.rb +54 -54
  11. data/benchmarks/format_args.rb +47 -47
  12. data/benchmarks/generation.rb +38 -38
  13. data/benchmarks/marshal_vs_dbm.rb +64 -64
  14. data/benchmarks/parsing.rb +46 -46
  15. data/benchmarks/pathname_vs_string.rb +50 -50
  16. data/benchmarks/rdoc_vs_yardoc.rb +11 -11
  17. data/benchmarks/registry_store_types.rb +49 -49
  18. data/benchmarks/ri_vs_yri.rb +19 -19
  19. data/benchmarks/ripper_parser.rb +13 -13
  20. data/benchmarks/splat_vs_flatten.rb +13 -13
  21. data/benchmarks/template_erb.rb +23 -23
  22. data/benchmarks/template_format.rb +7 -7
  23. data/benchmarks/template_profile.rb +18 -18
  24. data/benchmarks/yri_cache.rb +20 -20
  25. data/bin/yard +13 -13
  26. data/bin/yardoc +13 -13
  27. data/bin/yri +13 -13
  28. data/docs/CodeObjects.md +115 -115
  29. data/docs/GettingStarted.md +679 -679
  30. data/docs/Handlers.md +152 -152
  31. data/docs/Overview.md +61 -61
  32. data/docs/Parser.md +191 -191
  33. data/docs/Tags.md +283 -283
  34. data/docs/TagsArch.md +123 -123
  35. data/docs/Templates.md +496 -496
  36. data/docs/WhatsNew.md +1245 -1245
  37. data/docs/templates/default/fulldoc/html/full_list_tag.erb +8 -8
  38. data/docs/templates/default/fulldoc/html/setup.rb +6 -6
  39. data/docs/templates/default/layout/html/setup.rb +9 -9
  40. data/docs/templates/default/layout/html/tag_list.erb +11 -11
  41. data/docs/templates/default/yard_tags/html/list.erb +18 -18
  42. data/docs/templates/default/yard_tags/html/setup.rb +26 -26
  43. data/docs/templates/plugin.rb +70 -70
  44. data/lib/rubygems_plugin.rb +9 -9
  45. data/lib/yard.rb +69 -69
  46. data/lib/yard/autoload.rb +303 -303
  47. data/lib/yard/cli/command.rb +85 -85
  48. data/lib/yard/cli/command_parser.rb +93 -93
  49. data/lib/yard/cli/config.rb +198 -198
  50. data/lib/yard/cli/diff.rb +270 -270
  51. data/lib/yard/cli/display.rb +69 -69
  52. data/lib/yard/cli/gems.rb +84 -84
  53. data/lib/yard/cli/graph.rb +125 -125
  54. data/lib/yard/cli/help.rb +20 -20
  55. data/lib/yard/cli/i18n.rb +70 -70
  56. data/lib/yard/cli/list.rb +23 -23
  57. data/lib/yard/cli/markup_types.rb +32 -32
  58. data/lib/yard/cli/server.rb +257 -257
  59. data/lib/yard/cli/stats.rb +231 -231
  60. data/lib/yard/cli/yardoc.rb +788 -788
  61. data/lib/yard/cli/yardopts_command.rb +110 -110
  62. data/lib/yard/cli/yri.rb +215 -215
  63. data/lib/yard/code_objects/base.rb +615 -610
  64. data/lib/yard/code_objects/class_object.rb +146 -146
  65. data/lib/yard/code_objects/class_variable_object.rb +11 -11
  66. data/lib/yard/code_objects/constant_object.rb +16 -16
  67. data/lib/yard/code_objects/extended_method_object.rb +24 -24
  68. data/lib/yard/code_objects/extra_file_object.rb +131 -131
  69. data/lib/yard/code_objects/macro_object.rb +172 -172
  70. data/lib/yard/code_objects/method_object.rb +196 -196
  71. data/lib/yard/code_objects/module_object.rb +21 -21
  72. data/lib/yard/code_objects/namespace_mapper.rb +114 -114
  73. data/lib/yard/code_objects/namespace_object.rb +200 -200
  74. data/lib/yard/code_objects/proxy.rb +240 -240
  75. data/lib/yard/code_objects/root_object.rb +19 -19
  76. data/lib/yard/config.rb +270 -270
  77. data/lib/yard/core_ext/array.rb +16 -16
  78. data/lib/yard/core_ext/file.rb +69 -69
  79. data/lib/yard/core_ext/hash.rb +16 -16
  80. data/lib/yard/core_ext/insertion.rb +63 -63
  81. data/lib/yard/core_ext/module.rb +20 -20
  82. data/lib/yard/core_ext/string.rb +68 -68
  83. data/lib/yard/core_ext/symbol_hash.rb +75 -75
  84. data/lib/yard/docstring.rb +386 -378
  85. data/lib/yard/docstring_parser.rb +345 -345
  86. data/lib/yard/gem_index.rb +29 -29
  87. data/lib/yard/globals.rb +22 -22
  88. data/lib/yard/handlers/base.rb +595 -595
  89. data/lib/yard/handlers/c/alias_handler.rb +16 -16
  90. data/lib/yard/handlers/c/attribute_handler.rb +13 -13
  91. data/lib/yard/handlers/c/base.rb +129 -129
  92. data/lib/yard/handlers/c/class_handler.rb +27 -27
  93. data/lib/yard/handlers/c/constant_handler.rb +13 -13
  94. data/lib/yard/handlers/c/handler_methods.rb +211 -211
  95. data/lib/yard/handlers/c/init_handler.rb +20 -20
  96. data/lib/yard/handlers/c/method_handler.rb +45 -36
  97. data/lib/yard/handlers/c/mixin_handler.rb +21 -21
  98. data/lib/yard/handlers/c/module_handler.rb +17 -17
  99. data/lib/yard/handlers/c/override_comment_handler.rb +31 -31
  100. data/lib/yard/handlers/c/path_handler.rb +11 -11
  101. data/lib/yard/handlers/c/struct_handler.rb +13 -13
  102. data/lib/yard/handlers/c/symbol_handler.rb +8 -8
  103. data/lib/yard/handlers/processor.rb +200 -200
  104. data/lib/yard/handlers/ruby/alias_handler.rb +44 -44
  105. data/lib/yard/handlers/ruby/attribute_handler.rb +87 -87
  106. data/lib/yard/handlers/ruby/base.rb +165 -165
  107. data/lib/yard/handlers/ruby/class_condition_handler.rb +92 -92
  108. data/lib/yard/handlers/ruby/class_handler.rb +119 -119
  109. data/lib/yard/handlers/ruby/class_variable_handler.rb +17 -17
  110. data/lib/yard/handlers/ruby/comment_handler.rb +10 -10
  111. data/lib/yard/handlers/ruby/constant_handler.rb +59 -59
  112. data/lib/yard/handlers/ruby/decorator_handler_methods.rb +123 -123
  113. data/lib/yard/handlers/ruby/dsl_handler.rb +15 -15
  114. data/lib/yard/handlers/ruby/dsl_handler_methods.rb +96 -95
  115. data/lib/yard/handlers/ruby/exception_handler.rb +27 -27
  116. data/lib/yard/handlers/ruby/extend_handler.rb +22 -22
  117. data/lib/yard/handlers/ruby/legacy/alias_handler.rb +37 -37
  118. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +65 -65
  119. data/lib/yard/handlers/ruby/legacy/base.rb +245 -245
  120. data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -83
  121. data/lib/yard/handlers/ruby/legacy/class_handler.rb +113 -113
  122. data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +15 -15
  123. data/lib/yard/handlers/ruby/legacy/comment_handler.rb +10 -10
  124. data/lib/yard/handlers/ruby/legacy/constant_handler.rb +29 -29
  125. data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +17 -17
  126. data/lib/yard/handlers/ruby/legacy/exception_handler.rb +13 -13
  127. data/lib/yard/handlers/ruby/legacy/extend_handler.rb +21 -21
  128. data/lib/yard/handlers/ruby/legacy/method_handler.rb +90 -90
  129. data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -39
  130. data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +19 -19
  131. data/lib/yard/handlers/ruby/legacy/module_handler.rb +12 -12
  132. data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +22 -22
  133. data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +22 -22
  134. data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +17 -17
  135. data/lib/yard/handlers/ruby/legacy/yield_handler.rb +29 -29
  136. data/lib/yard/handlers/ruby/method_condition_handler.rb +9 -9
  137. data/lib/yard/handlers/ruby/method_handler.rb +118 -118
  138. data/lib/yard/handlers/ruby/mixin_handler.rb +37 -37
  139. data/lib/yard/handlers/ruby/module_function_handler.rb +27 -27
  140. data/lib/yard/handlers/ruby/module_handler.rb +12 -12
  141. data/lib/yard/handlers/ruby/private_class_method_handler.rb +14 -14
  142. data/lib/yard/handlers/ruby/private_constant_handler.rb +43 -43
  143. data/lib/yard/handlers/ruby/public_class_method_handler.rb +14 -14
  144. data/lib/yard/handlers/ruby/struct_handler_methods.rb +143 -143
  145. data/lib/yard/handlers/ruby/visibility_handler.rb +22 -22
  146. data/lib/yard/handlers/ruby/yield_handler.rb +31 -31
  147. data/lib/yard/i18n/locale.rb +67 -67
  148. data/lib/yard/i18n/message.rb +57 -57
  149. data/lib/yard/i18n/messages.rb +56 -56
  150. data/lib/yard/i18n/po_parser.rb +61 -61
  151. data/lib/yard/i18n/pot_generator.rb +290 -290
  152. data/lib/yard/i18n/text.rb +173 -173
  153. data/lib/yard/logging.rb +205 -205
  154. data/lib/yard/options.rb +217 -217
  155. data/lib/yard/parser/base.rb +57 -57
  156. data/lib/yard/parser/c/c_parser.rb +235 -235
  157. data/lib/yard/parser/c/comment_parser.rb +134 -134
  158. data/lib/yard/parser/c/statement.rb +64 -64
  159. data/lib/yard/parser/ruby/ast_node.rb +540 -540
  160. data/lib/yard/parser/ruby/legacy/ruby_lex.rb +1354 -1354
  161. data/lib/yard/parser/ruby/legacy/ruby_parser.rb +32 -32
  162. data/lib/yard/parser/ruby/legacy/statement.rb +66 -66
  163. data/lib/yard/parser/ruby/legacy/statement_list.rb +394 -394
  164. data/lib/yard/parser/ruby/legacy/token_list.rb +74 -74
  165. data/lib/yard/parser/ruby/ruby_parser.rb +687 -687
  166. data/lib/yard/parser/ruby/token_resolver.rb +156 -156
  167. data/lib/yard/parser/source_parser.rb +526 -526
  168. data/lib/yard/rake/yardoc_task.rb +81 -81
  169. data/lib/yard/registry.rb +439 -439
  170. data/lib/yard/registry_resolver.rb +189 -189
  171. data/lib/yard/registry_store.rb +337 -337
  172. data/lib/yard/rubygems/backports.rb +10 -10
  173. data/lib/yard/rubygems/backports/LICENSE.txt +57 -57
  174. data/lib/yard/rubygems/backports/MIT.txt +20 -20
  175. data/lib/yard/rubygems/backports/gem.rb +10 -10
  176. data/lib/yard/rubygems/backports/source_index.rb +365 -365
  177. data/lib/yard/rubygems/doc_manager.rb +90 -90
  178. data/lib/yard/rubygems/hook.rb +197 -197
  179. data/lib/yard/rubygems/specification.rb +50 -50
  180. data/lib/yard/serializers/base.rb +83 -83
  181. data/lib/yard/serializers/file_system_serializer.rb +123 -123
  182. data/lib/yard/serializers/process_serializer.rb +24 -24
  183. data/lib/yard/serializers/stdout_serializer.rb +34 -34
  184. data/lib/yard/serializers/yardoc_serializer.rb +152 -152
  185. data/lib/yard/server.rb +13 -13
  186. data/lib/yard/server/adapter.rb +100 -100
  187. data/lib/yard/server/commands/base.rb +209 -209
  188. data/lib/yard/server/commands/display_file_command.rb +29 -29
  189. data/lib/yard/server/commands/display_object_command.rb +65 -65
  190. data/lib/yard/server/commands/frames_command.rb +16 -16
  191. data/lib/yard/server/commands/library_command.rb +187 -187
  192. data/lib/yard/server/commands/library_index_command.rb +28 -28
  193. data/lib/yard/server/commands/list_command.rb +25 -25
  194. data/lib/yard/server/commands/root_request_command.rb +15 -15
  195. data/lib/yard/server/commands/search_command.rb +79 -79
  196. data/lib/yard/server/commands/static_file_command.rb +23 -23
  197. data/lib/yard/server/commands/static_file_helpers.rb +62 -62
  198. data/lib/yard/server/doc_server_helper.rb +91 -91
  199. data/lib/yard/server/doc_server_serializer.rb +39 -39
  200. data/lib/yard/server/library_version.rb +277 -277
  201. data/lib/yard/server/rack_adapter.rb +89 -89
  202. data/lib/yard/server/router.rb +187 -187
  203. data/lib/yard/server/static_caching.rb +46 -46
  204. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +127 -127
  205. data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +11 -11
  206. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +37 -37
  207. data/lib/yard/server/templates/default/layout/html/script_setup.erb +7 -7
  208. data/lib/yard/server/templates/default/layout/html/setup.rb +8 -8
  209. data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -4
  210. data/lib/yard/server/templates/default/method_details/html/setup.rb +5 -5
  211. data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +8 -8
  212. data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +14 -14
  213. data/lib/yard/server/templates/doc_server/library_list/html/listing.erb +13 -13
  214. data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +6 -6
  215. data/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -2
  216. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +52 -52
  217. data/lib/yard/server/templates/doc_server/processing/html/setup.rb +4 -4
  218. data/lib/yard/server/templates/doc_server/search/html/search.erb +18 -18
  219. data/lib/yard/server/templates/doc_server/search/html/setup.rb +9 -9
  220. data/lib/yard/server/webrick_adapter.rb +45 -45
  221. data/lib/yard/tags/default_factory.rb +191 -191
  222. data/lib/yard/tags/default_tag.rb +13 -13
  223. data/lib/yard/tags/directives.rb +616 -616
  224. data/lib/yard/tags/library.rb +633 -633
  225. data/lib/yard/tags/option_tag.rb +13 -13
  226. data/lib/yard/tags/overload_tag.rb +71 -71
  227. data/lib/yard/tags/ref_tag.rb +8 -8
  228. data/lib/yard/tags/ref_tag_list.rb +28 -28
  229. data/lib/yard/tags/tag.rb +71 -71
  230. data/lib/yard/tags/tag_format_error.rb +7 -7
  231. data/lib/yard/tags/types_explainer.rb +162 -162
  232. data/lib/yard/templates/engine.rb +186 -186
  233. data/lib/yard/templates/erb_cache.rb +23 -23
  234. data/lib/yard/templates/helpers/base_helper.rb +215 -215
  235. data/lib/yard/templates/helpers/filter_helper.rb +27 -27
  236. data/lib/yard/templates/helpers/html_helper.rb +646 -642
  237. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +78 -78
  238. data/lib/yard/templates/helpers/markup/rdoc_markdown.rb +23 -23
  239. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +109 -109
  240. data/lib/yard/templates/helpers/markup_helper.rb +172 -172
  241. data/lib/yard/templates/helpers/method_helper.rb +75 -75
  242. data/lib/yard/templates/helpers/module_helper.rb +21 -21
  243. data/lib/yard/templates/helpers/text_helper.rb +112 -112
  244. data/lib/yard/templates/helpers/uml_helper.rb +47 -47
  245. data/lib/yard/templates/section.rb +105 -105
  246. data/lib/yard/templates/template.rb +418 -418
  247. data/lib/yard/templates/template_options.rb +92 -92
  248. data/lib/yard/verifier.rb +151 -151
  249. data/lib/yard/version.rb +3 -1
  250. data/spec/cli/command_parser_spec.rb +43 -43
  251. data/spec/cli/command_spec.rb +36 -36
  252. data/spec/cli/config_spec.rb +148 -148
  253. data/spec/cli/diff_spec.rb +254 -254
  254. data/spec/cli/display_spec.rb +30 -30
  255. data/spec/cli/gems_spec.rb +81 -81
  256. data/spec/cli/graph_spec.rb +18 -18
  257. data/spec/cli/help_spec.rb +22 -22
  258. data/spec/cli/i18n_spec.rb +107 -107
  259. data/spec/cli/list_spec.rb +8 -8
  260. data/spec/cli/markup_types_spec.rb +22 -22
  261. data/spec/cli/server_spec.rb +324 -324
  262. data/spec/cli/stats_spec.rb +96 -96
  263. data/spec/cli/yard_on_yard_spec.rb +38 -38
  264. data/spec/cli/yardoc_spec.rb +862 -849
  265. data/spec/cli/yri_spec.rb +101 -101
  266. data/spec/code_objects/base_spec.rb +470 -460
  267. data/spec/code_objects/class_object_spec.rb +226 -226
  268. data/spec/code_objects/code_object_list_spec.rb +36 -36
  269. data/spec/code_objects/constants_spec.rb +116 -116
  270. data/spec/code_objects/extra_file_object_spec.rb +160 -160
  271. data/spec/code_objects/macro_object_spec.rb +150 -150
  272. data/spec/code_objects/method_object_spec.rb +184 -184
  273. data/spec/code_objects/module_object_spec.rb +142 -142
  274. data/spec/code_objects/namespace_object_spec.rb +171 -171
  275. data/spec/code_objects/proxy_spec.rb +141 -141
  276. data/spec/code_objects/spec_helper.rb +3 -3
  277. data/spec/config_spec.rb +171 -171
  278. data/spec/core_ext/array_spec.rb +13 -13
  279. data/spec/core_ext/file_spec.rb +72 -72
  280. data/spec/core_ext/hash_spec.rb +14 -14
  281. data/spec/core_ext/insertion_spec.rb +37 -37
  282. data/spec/core_ext/module_spec.rb +15 -15
  283. data/spec/core_ext/string_spec.rb +42 -42
  284. data/spec/core_ext/symbol_hash_spec.rb +89 -89
  285. data/spec/docstring_parser_spec.rb +280 -262
  286. data/spec/docstring_spec.rb +373 -364
  287. data/spec/examples.txt +1875 -1871
  288. data/spec/handlers/alias_handler_spec.rb +82 -82
  289. data/spec/handlers/attribute_handler_spec.rb +96 -96
  290. data/spec/handlers/base_spec.rb +216 -216
  291. data/spec/handlers/c/alias_handler_spec.rb +34 -34
  292. data/spec/handlers/c/attribute_handler_spec.rb +41 -41
  293. data/spec/handlers/c/class_handler_spec.rb +78 -78
  294. data/spec/handlers/c/constant_handler_spec.rb +71 -71
  295. data/spec/handlers/c/init_handler_spec.rb +48 -48
  296. data/spec/handlers/c/method_handler_spec.rb +325 -325
  297. data/spec/handlers/c/mixin_handler_spec.rb +44 -44
  298. data/spec/handlers/c/module_handler_spec.rb +71 -71
  299. data/spec/handlers/c/override_comment_handler_spec.rb +47 -47
  300. data/spec/handlers/c/path_handler_spec.rb +36 -36
  301. data/spec/handlers/c/spec_helper.rb +23 -23
  302. data/spec/handlers/c/struct_handler_spec.rb +16 -16
  303. data/spec/handlers/class_condition_handler_spec.rb +87 -87
  304. data/spec/handlers/class_handler_spec.rb +247 -247
  305. data/spec/handlers/class_method_handler_shared_examples.rb +133 -133
  306. data/spec/handlers/class_variable_handler_spec.rb +12 -12
  307. data/spec/handlers/constant_handler_spec.rb +112 -112
  308. data/spec/handlers/decorator_handler_methods_spec.rb +393 -393
  309. data/spec/handlers/dsl_handler_spec.rb +219 -219
  310. data/spec/handlers/examples/alias_handler_001.rb.txt +45 -45
  311. data/spec/handlers/examples/attribute_handler_001.rb.txt +31 -31
  312. data/spec/handlers/examples/class_condition_handler_001.rb.txt +68 -68
  313. data/spec/handlers/examples/class_handler_001.rb.txt +120 -120
  314. data/spec/handlers/examples/class_variable_handler_001.rb.txt +9 -9
  315. data/spec/handlers/examples/constant_handler_001.rb.txt +35 -35
  316. data/spec/handlers/examples/dsl_handler_001.rb.txt +154 -154
  317. data/spec/handlers/examples/exception_handler_001.rb.txt +58 -58
  318. data/spec/handlers/examples/extend_handler_001.rb.txt +15 -15
  319. data/spec/handlers/examples/method_condition_handler_001.rb.txt +9 -9
  320. data/spec/handlers/examples/method_handler_001.rb.txt +128 -128
  321. data/spec/handlers/examples/mixin_handler_001.rb.txt +37 -37
  322. data/spec/handlers/examples/module_handler_001.rb.txt +29 -29
  323. data/spec/handlers/examples/private_constant_handler_001.rb.txt +8 -8
  324. data/spec/handlers/examples/process_handler_001.rb.txt +11 -11
  325. data/spec/handlers/examples/visibility_handler_001.rb.txt +35 -35
  326. data/spec/handlers/examples/yield_handler_001.rb.txt +54 -54
  327. data/spec/handlers/exception_handler_spec.rb +49 -49
  328. data/spec/handlers/extend_handler_spec.rb +24 -24
  329. data/spec/handlers/legacy_base_spec.rb +128 -128
  330. data/spec/handlers/method_condition_handler_spec.rb +15 -15
  331. data/spec/handlers/method_handler_spec.rb +190 -190
  332. data/spec/handlers/mixin_handler_spec.rb +56 -56
  333. data/spec/handlers/module_function_handler_spec.rb +106 -106
  334. data/spec/handlers/module_handler_spec.rb +35 -35
  335. data/spec/handlers/private_class_method_handler_spec.rb +11 -11
  336. data/spec/handlers/private_constant_handler_spec.rb +25 -25
  337. data/spec/handlers/processor_spec.rb +35 -35
  338. data/spec/handlers/public_class_method_handler_spec.rb +11 -11
  339. data/spec/handlers/ruby/base_spec.rb +95 -95
  340. data/spec/handlers/ruby/legacy/base_spec.rb +84 -84
  341. data/spec/handlers/spec_helper.rb +33 -33
  342. data/spec/handlers/visibility_handler_spec.rb +44 -44
  343. data/spec/handlers/yield_handler_spec.rb +52 -52
  344. data/spec/i18n/locale_spec.rb +81 -81
  345. data/spec/i18n/message_spec.rb +52 -52
  346. data/spec/i18n/messages_spec.rb +67 -67
  347. data/spec/i18n/pot_generator_spec.rb +295 -295
  348. data/spec/i18n/text_spec.rb +184 -184
  349. data/spec/logging_spec.rb +44 -44
  350. data/spec/options_spec.rb +171 -171
  351. data/spec/parser/base_spec.rb +24 -24
  352. data/spec/parser/c_parser_spec.rb +236 -223
  353. data/spec/parser/examples/array.c.txt +6267 -6267
  354. data/spec/parser/examples/example1.rb.txt +7 -7
  355. data/spec/parser/examples/extrafile.c.txt +8 -8
  356. data/spec/parser/examples/file.c.txt +28 -0
  357. data/spec/parser/examples/multifile.c.txt +22 -22
  358. data/spec/parser/examples/namespace.cpp.txt +68 -68
  359. data/spec/parser/examples/override.c.txt +424 -424
  360. data/spec/parser/examples/parse_in_order_001.rb.txt +2 -2
  361. data/spec/parser/examples/parse_in_order_002.rb.txt +1 -1
  362. data/spec/parser/examples/tag_handler_001.rb.txt +7 -7
  363. data/spec/parser/ruby/ast_node_spec.rb +33 -33
  364. data/spec/parser/ruby/legacy/statement_list_spec.rb +299 -299
  365. data/spec/parser/ruby/legacy/token_list_spec.rb +79 -79
  366. data/spec/parser/ruby/ruby_parser_spec.rb +508 -508
  367. data/spec/parser/ruby/token_resolver_spec.rb +165 -165
  368. data/spec/parser/source_parser_spec.rb +727 -727
  369. data/spec/parser/tag_parsing_spec.rb +17 -17
  370. data/spec/rake/yardoc_task_spec.rb +118 -118
  371. data/spec/registry_spec.rb +463 -463
  372. data/spec/registry_store_spec.rb +316 -316
  373. data/spec/rubygems/doc_manager_spec.rb +112 -112
  374. data/spec/serializers/data/serialized_yardoc/checksums +1 -1
  375. data/spec/serializers/file_system_serializer_spec.rb +145 -145
  376. data/spec/serializers/spec_helper.rb +2 -2
  377. data/spec/serializers/yardoc_serializer_spec.rb +78 -78
  378. data/spec/server/adapter_spec.rb +39 -39
  379. data/spec/server/commands/base_spec.rb +91 -91
  380. data/spec/server/commands/library_command_spec.rb +39 -39
  381. data/spec/server/doc_server_helper_spec.rb +72 -72
  382. data/spec/server/doc_server_serializer_spec.rb +60 -60
  383. data/spec/server/rack_adapter_spec.rb +21 -21
  384. data/spec/server/router_spec.rb +123 -123
  385. data/spec/server/spec_helper.rb +22 -22
  386. data/spec/server/static_caching_spec.rb +47 -47
  387. data/spec/server/webrick_servlet_spec.rb +20 -20
  388. data/spec/server_spec.rb +19 -19
  389. data/spec/spec_helper.rb +212 -212
  390. data/spec/tags/default_factory_spec.rb +168 -168
  391. data/spec/tags/default_tag_spec.rb +11 -11
  392. data/spec/tags/directives_spec.rb +463 -463
  393. data/spec/tags/library_spec.rb +48 -48
  394. data/spec/tags/overload_tag_spec.rb +53 -53
  395. data/spec/tags/ref_tag_list_spec.rb +53 -53
  396. data/spec/tags/types_explainer_spec.rb +203 -203
  397. data/spec/templates/class_spec.rb +45 -45
  398. data/spec/templates/constant_spec.rb +41 -41
  399. data/spec/templates/engine_spec.rb +131 -131
  400. data/spec/templates/examples/class001.html +308 -308
  401. data/spec/templates/examples/class001.txt +36 -36
  402. data/spec/templates/examples/class002.html +39 -39
  403. data/spec/templates/examples/constant001.txt +24 -24
  404. data/spec/templates/examples/constant002.txt +6 -6
  405. data/spec/templates/examples/constant003.txt +10 -10
  406. data/spec/templates/examples/method001.html +137 -137
  407. data/spec/templates/examples/method001.txt +35 -35
  408. data/spec/templates/examples/method002.html +91 -91
  409. data/spec/templates/examples/method002.txt +20 -20
  410. data/spec/templates/examples/method003.html +165 -165
  411. data/spec/templates/examples/method003.txt +45 -45
  412. data/spec/templates/examples/method004.html +48 -48
  413. data/spec/templates/examples/method004.txt +10 -10
  414. data/spec/templates/examples/method005.html +105 -105
  415. data/spec/templates/examples/method005.txt +33 -33
  416. data/spec/templates/examples/method006.html +107 -107
  417. data/spec/templates/examples/method006.txt +20 -20
  418. data/spec/templates/examples/module001.dot +33 -33
  419. data/spec/templates/examples/module001.html +833 -833
  420. data/spec/templates/examples/module001.txt +33 -33
  421. data/spec/templates/examples/module002.html +341 -341
  422. data/spec/templates/examples/module003.html +202 -202
  423. data/spec/templates/examples/module004.html +394 -394
  424. data/spec/templates/examples/module005.html +81 -81
  425. data/spec/templates/examples/tag001.txt +82 -82
  426. data/spec/templates/helpers/base_helper_spec.rb +171 -171
  427. data/spec/templates/helpers/html_helper_spec.rb +668 -653
  428. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +65 -65
  429. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +84 -84
  430. data/spec/templates/helpers/markup_helper_spec.rb +136 -136
  431. data/spec/templates/helpers/method_helper_spec.rb +107 -107
  432. data/spec/templates/helpers/module_helper_spec.rb +35 -35
  433. data/spec/templates/helpers/shared_signature_examples.rb +126 -126
  434. data/spec/templates/helpers/text_helper_spec.rb +65 -65
  435. data/spec/templates/method_spec.rb +118 -118
  436. data/spec/templates/module_spec.rb +203 -203
  437. data/spec/templates/onefile_spec.rb +66 -66
  438. data/spec/templates/section_spec.rb +144 -144
  439. data/spec/templates/spec_helper.rb +76 -76
  440. data/spec/templates/tag_spec.rb +52 -52
  441. data/spec/templates/template_spec.rb +410 -410
  442. data/spec/verifier_spec.rb +106 -106
  443. data/templates/default/class/dot/setup.rb +7 -7
  444. data/templates/default/class/dot/superklass.erb +2 -2
  445. data/templates/default/class/html/constructor_details.erb +8 -8
  446. data/templates/default/class/html/setup.rb +2 -2
  447. data/templates/default/class/html/subclasses.erb +4 -4
  448. data/templates/default/class/setup.rb +36 -36
  449. data/templates/default/class/text/setup.rb +12 -12
  450. data/templates/default/class/text/subclasses.erb +5 -5
  451. data/templates/default/constant/text/header.erb +11 -11
  452. data/templates/default/constant/text/setup.rb +4 -4
  453. data/templates/default/docstring/html/abstract.erb +4 -4
  454. data/templates/default/docstring/html/deprecated.erb +1 -1
  455. data/templates/default/docstring/html/index.erb +5 -5
  456. data/templates/default/docstring/html/note.erb +6 -6
  457. data/templates/default/docstring/html/private.erb +4 -4
  458. data/templates/default/docstring/html/text.erb +1 -1
  459. data/templates/default/docstring/html/todo.erb +6 -6
  460. data/templates/default/docstring/setup.rb +52 -52
  461. data/templates/default/docstring/text/abstract.erb +2 -2
  462. data/templates/default/docstring/text/deprecated.erb +2 -2
  463. data/templates/default/docstring/text/index.erb +2 -2
  464. data/templates/default/docstring/text/note.erb +3 -3
  465. data/templates/default/docstring/text/private.erb +2 -2
  466. data/templates/default/docstring/text/text.erb +1 -1
  467. data/templates/default/docstring/text/todo.erb +3 -3
  468. data/templates/default/fulldoc/html/css/full_list.css +58 -58
  469. data/templates/default/fulldoc/html/css/style.css +496 -496
  470. data/templates/default/fulldoc/html/frames.erb +17 -17
  471. data/templates/default/fulldoc/html/full_list.erb +37 -37
  472. data/templates/default/fulldoc/html/full_list_class.erb +2 -2
  473. data/templates/default/fulldoc/html/full_list_file.erb +7 -7
  474. data/templates/default/fulldoc/html/full_list_method.erb +10 -10
  475. data/templates/default/fulldoc/html/js/app.js +292 -292
  476. data/templates/default/fulldoc/html/js/full_list.js +216 -216
  477. data/templates/default/fulldoc/html/js/jquery.js +3 -3
  478. data/templates/default/fulldoc/html/setup.rb +241 -241
  479. data/templates/default/layout/dot/header.erb +5 -5
  480. data/templates/default/layout/dot/setup.rb +15 -15
  481. data/templates/default/layout/html/breadcrumb.erb +11 -11
  482. data/templates/default/layout/html/files.erb +11 -11
  483. data/templates/default/layout/html/footer.erb +5 -5
  484. data/templates/default/layout/html/headers.erb +15 -15
  485. data/templates/default/layout/html/index.erb +2 -2
  486. data/templates/default/layout/html/layout.erb +23 -23
  487. data/templates/default/layout/html/listing.erb +4 -4
  488. data/templates/default/layout/html/objects.erb +32 -32
  489. data/templates/default/layout/html/script_setup.erb +4 -4
  490. data/templates/default/layout/html/search.erb +12 -12
  491. data/templates/default/layout/html/setup.rb +89 -89
  492. data/templates/default/method/html/header.erb +16 -16
  493. data/templates/default/method/setup.rb +4 -4
  494. data/templates/default/method_details/html/header.erb +2 -2
  495. data/templates/default/method_details/html/method_signature.erb +24 -24
  496. data/templates/default/method_details/html/source.erb +9 -9
  497. data/templates/default/method_details/setup.rb +11 -11
  498. data/templates/default/method_details/text/header.erb +10 -10
  499. data/templates/default/method_details/text/method_signature.erb +12 -12
  500. data/templates/default/method_details/text/setup.rb +11 -11
  501. data/templates/default/module/dot/child.erb +1 -1
  502. data/templates/default/module/dot/dependencies.erb +2 -2
  503. data/templates/default/module/dot/header.erb +6 -6
  504. data/templates/default/module/dot/info.erb +13 -13
  505. data/templates/default/module/dot/setup.rb +15 -15
  506. data/templates/default/module/html/attribute_details.erb +10 -10
  507. data/templates/default/module/html/attribute_summary.erb +8 -8
  508. data/templates/default/module/html/box_info.erb +43 -43
  509. data/templates/default/module/html/children.erb +8 -8
  510. data/templates/default/module/html/constant_summary.erb +17 -17
  511. data/templates/default/module/html/defines.erb +2 -2
  512. data/templates/default/module/html/header.erb +5 -5
  513. data/templates/default/module/html/inherited_attributes.erb +14 -14
  514. data/templates/default/module/html/inherited_constants.erb +8 -8
  515. data/templates/default/module/html/inherited_methods.erb +18 -18
  516. data/templates/default/module/html/item_summary.erb +40 -40
  517. data/templates/default/module/html/method_details_list.erb +9 -9
  518. data/templates/default/module/html/method_summary.erb +13 -13
  519. data/templates/default/module/html/methodmissing.erb +12 -12
  520. data/templates/default/module/setup.rb +167 -167
  521. data/templates/default/module/text/children.erb +9 -9
  522. data/templates/default/module/text/class_meths_list.erb +7 -7
  523. data/templates/default/module/text/extends.erb +7 -7
  524. data/templates/default/module/text/header.erb +7 -7
  525. data/templates/default/module/text/includes.erb +7 -7
  526. data/templates/default/module/text/instance_meths_list.erb +7 -7
  527. data/templates/default/module/text/setup.rb +13 -13
  528. data/templates/default/onefile/html/files.erb +4 -4
  529. data/templates/default/onefile/html/headers.erb +6 -6
  530. data/templates/default/onefile/html/layout.erb +17 -17
  531. data/templates/default/onefile/html/readme.erb +2 -2
  532. data/templates/default/onefile/html/setup.rb +62 -62
  533. data/templates/default/root/dot/child.erb +2 -2
  534. data/templates/default/root/dot/setup.rb +6 -6
  535. data/templates/default/root/html/setup.rb +2 -2
  536. data/templates/default/tags/html/example.erb +10 -10
  537. data/templates/default/tags/html/index.erb +2 -2
  538. data/templates/default/tags/html/option.erb +24 -24
  539. data/templates/default/tags/html/overload.erb +13 -13
  540. data/templates/default/tags/html/see.erb +7 -7
  541. data/templates/default/tags/html/tag.erb +20 -20
  542. data/templates/default/tags/setup.rb +57 -57
  543. data/templates/default/tags/text/example.erb +12 -12
  544. data/templates/default/tags/text/index.erb +1 -1
  545. data/templates/default/tags/text/option.erb +20 -20
  546. data/templates/default/tags/text/overload.erb +19 -19
  547. data/templates/default/tags/text/see.erb +11 -11
  548. data/templates/default/tags/text/tag.erb +13 -13
  549. data/templates/guide/class/html/setup.rb +2 -2
  550. data/templates/guide/docstring/html/setup.rb +2 -2
  551. data/templates/guide/fulldoc/html/css/style.css +108 -108
  552. data/templates/guide/fulldoc/html/js/app.js +33 -33
  553. data/templates/guide/fulldoc/html/setup.rb +74 -74
  554. data/templates/guide/layout/html/layout.erb +81 -81
  555. data/templates/guide/layout/html/setup.rb +25 -25
  556. data/templates/guide/method/html/header.erb +17 -17
  557. data/templates/guide/method/html/setup.rb +22 -22
  558. data/templates/guide/module/html/header.erb +6 -6
  559. data/templates/guide/module/html/method_list.erb +4 -4
  560. data/templates/guide/module/html/setup.rb +27 -27
  561. data/templates/guide/onefile/html/files.erb +4 -4
  562. data/templates/guide/onefile/html/setup.rb +6 -6
  563. data/templates/guide/onefile/html/toc.erb +3 -3
  564. data/templates/guide/tags/html/setup.rb +9 -9
  565. data/yard.gemspec +43 -43
  566. metadata +4 -4
@@ -1,101 +1,101 @@
1
- # frozen_string_literal: true
2
-
3
- class TestYRI < YARD::CLI::YRI
4
- public :optparse, :find_object, :cache_object
5
- def test_stub; end
6
- def print_object(*args) test_stub; super end
7
- end
8
-
9
- RSpec.describe YARD::CLI::YRI do
10
- before do
11
- @yri = TestYRI.new
12
- allow(Registry).to receive(:load)
13
- end
14
-
15
- describe "#find_object" do
16
- it "uses cache if available" do
17
- allow(@yri).to receive(:cache_object)
18
- expect(File).to receive(:exist?).with('.yardoc').and_return(false)
19
- expect(File).to receive(:exist?).with('bar.yardoc').and_return(true)
20
- expect(Registry).to receive(:load).with('bar.yardoc')
21
- expect(Registry).to receive(:at).ordered.with('Foo').and_return(nil)
22
- expect(Registry).to receive(:at).ordered.with('Foo').and_return('OBJ')
23
- @yri.instance_variable_set("@cache", 'Foo' => 'bar.yardoc')
24
- expect(@yri.find_object('Foo')).to eq 'OBJ'
25
- end
26
-
27
- it "never uses cache ahead of current directory's .yardoc" do
28
- allow(@yri).to receive(:cache_object)
29
- expect(File).to receive(:exist?).with('.yardoc').and_return(true)
30
- expect(Registry).to receive(:load).with('.yardoc')
31
- expect(Registry).to receive(:at).ordered.with('Foo').and_return(nil)
32
- expect(Registry).to receive(:at).ordered.with('Foo').and_return('OBJ')
33
- @yri.instance_variable_set("@cache", 'Foo' => 'bar.yardoc')
34
- expect(@yri.find_object('Foo')).to eq 'OBJ'
35
- expect(@yri.instance_variable_get("@search_paths")[0]).to eq '.yardoc'
36
- end
37
- end
38
-
39
- describe "#cache_object" do
40
- it "skips caching for Registry.yardoc_file" do
41
- expect(File).not_to receive(:open).with(CLI::YRI::CACHE_FILE, 'w')
42
- @yri.cache_object('Foo', Registry.yardoc_file)
43
- end
44
- end
45
-
46
- describe "#initialize" do
47
- it "loads search paths" do
48
- path = %r{/\.yard/yri_search_paths$}
49
- allow(File).to receive(:file?).and_call_original
50
- allow(File).to receive(:file?).with(%r{/\.yard/yri_cache$}).and_return(false)
51
- allow(File).to receive(:file?).with(path).and_return(true)
52
- allow(File).to receive(:readlines).with(path).and_return(%w(line1 line2))
53
- @yri = YARD::CLI::YRI.new
54
- spaths = @yri.instance_variable_get("@search_paths")
55
- expect(spaths).to include('line1')
56
- expect(spaths).to include('line2')
57
- end
58
-
59
- it "uses DEFAULT_SEARCH_PATHS prior to other paths" do
60
- YARD::CLI::YRI::DEFAULT_SEARCH_PATHS.push('foo', 'bar')
61
- path = %r{/\.yard/yri_search_paths$}
62
- allow(File).to receive(:file?).and_call_original
63
- allow(File).to receive(:file?).with(%r{/\.yard/yri_cache$}).and_return(false)
64
- allow(File).to receive(:file?).with(path).and_return(true)
65
- allow(File).to receive(:readlines).with(path).and_return(%w(line1 line2))
66
- @yri = YARD::CLI::YRI.new
67
- spaths = @yri.instance_variable_get("@search_paths")
68
- expect(spaths[0, 4]).to eq %w(foo bar line1 line2)
69
- YARD::CLI::YRI::DEFAULT_SEARCH_PATHS.replace([])
70
- end
71
- end
72
-
73
- describe "#run" do
74
- it "searches for objects and print their documentation" do
75
- obj = YARD::CodeObjects::ClassObject.new(:root, 'Foo')
76
- expect(@yri).to receive(:print_object).with(obj)
77
- @yri.run('Foo')
78
- Registry.clear
79
- end
80
-
81
- it "prints usage if no object is provided" do
82
- expect(@yri).to receive(:print_usage)
83
- expect(@yri).to receive(:exit).with(1)
84
- @yri.run('')
85
- end
86
-
87
- it "prints 'no documentation exists for object' if object is not found" do
88
- expect(STDERR).to receive(:puts).with("No documentation for `Foo'")
89
- expect(@yri).to receive(:exit).with(1)
90
- @yri.run('Foo')
91
- end
92
-
93
- it "ensures output is serialized" do
94
- YARD::CodeObjects::ClassObject.new(:root, 'Foo')
95
- allow(@yri).to receive(:test_stub) do
96
- expect(@yri.instance_variable_get(:@serializer)).to receive(:serialize).once
97
- end
98
- @yri.run('Foo')
99
- end
100
- end
101
- end
1
+ # frozen_string_literal: true
2
+
3
+ class TestYRI < YARD::CLI::YRI
4
+ public :optparse, :find_object, :cache_object
5
+ def test_stub; end
6
+ def print_object(*args) test_stub; super end
7
+ end
8
+
9
+ RSpec.describe YARD::CLI::YRI do
10
+ before do
11
+ @yri = TestYRI.new
12
+ allow(Registry).to receive(:load)
13
+ end
14
+
15
+ describe "#find_object" do
16
+ it "uses cache if available" do
17
+ allow(@yri).to receive(:cache_object)
18
+ expect(File).to receive(:exist?).with('.yardoc').and_return(false)
19
+ expect(File).to receive(:exist?).with('bar.yardoc').and_return(true)
20
+ expect(Registry).to receive(:load).with('bar.yardoc')
21
+ expect(Registry).to receive(:at).ordered.with('Foo').and_return(nil)
22
+ expect(Registry).to receive(:at).ordered.with('Foo').and_return('OBJ')
23
+ @yri.instance_variable_set("@cache", 'Foo' => 'bar.yardoc')
24
+ expect(@yri.find_object('Foo')).to eq 'OBJ'
25
+ end
26
+
27
+ it "never uses cache ahead of current directory's .yardoc" do
28
+ allow(@yri).to receive(:cache_object)
29
+ expect(File).to receive(:exist?).with('.yardoc').and_return(true)
30
+ expect(Registry).to receive(:load).with('.yardoc')
31
+ expect(Registry).to receive(:at).ordered.with('Foo').and_return(nil)
32
+ expect(Registry).to receive(:at).ordered.with('Foo').and_return('OBJ')
33
+ @yri.instance_variable_set("@cache", 'Foo' => 'bar.yardoc')
34
+ expect(@yri.find_object('Foo')).to eq 'OBJ'
35
+ expect(@yri.instance_variable_get("@search_paths")[0]).to eq '.yardoc'
36
+ end
37
+ end
38
+
39
+ describe "#cache_object" do
40
+ it "skips caching for Registry.yardoc_file" do
41
+ expect(File).not_to receive(:open).with(CLI::YRI::CACHE_FILE, 'w')
42
+ @yri.cache_object('Foo', Registry.yardoc_file)
43
+ end
44
+ end
45
+
46
+ describe "#initialize" do
47
+ it "loads search paths" do
48
+ path = %r{/\.yard/yri_search_paths$}
49
+ allow(File).to receive(:file?).and_call_original
50
+ allow(File).to receive(:file?).with(%r{/\.yard/yri_cache$}).and_return(false)
51
+ allow(File).to receive(:file?).with(path).and_return(true)
52
+ allow(File).to receive(:readlines).with(path).and_return(%w(line1 line2))
53
+ @yri = YARD::CLI::YRI.new
54
+ spaths = @yri.instance_variable_get("@search_paths")
55
+ expect(spaths).to include('line1')
56
+ expect(spaths).to include('line2')
57
+ end
58
+
59
+ it "uses DEFAULT_SEARCH_PATHS prior to other paths" do
60
+ YARD::CLI::YRI::DEFAULT_SEARCH_PATHS.push('foo', 'bar')
61
+ path = %r{/\.yard/yri_search_paths$}
62
+ allow(File).to receive(:file?).and_call_original
63
+ allow(File).to receive(:file?).with(%r{/\.yard/yri_cache$}).and_return(false)
64
+ allow(File).to receive(:file?).with(path).and_return(true)
65
+ allow(File).to receive(:readlines).with(path).and_return(%w(line1 line2))
66
+ @yri = YARD::CLI::YRI.new
67
+ spaths = @yri.instance_variable_get("@search_paths")
68
+ expect(spaths[0, 4]).to eq %w(foo bar line1 line2)
69
+ YARD::CLI::YRI::DEFAULT_SEARCH_PATHS.replace([])
70
+ end
71
+ end
72
+
73
+ describe "#run" do
74
+ it "searches for objects and print their documentation" do
75
+ obj = YARD::CodeObjects::ClassObject.new(:root, 'Foo')
76
+ expect(@yri).to receive(:print_object).with(obj)
77
+ @yri.run('Foo')
78
+ Registry.clear
79
+ end
80
+
81
+ it "prints usage if no object is provided" do
82
+ expect(@yri).to receive(:print_usage)
83
+ expect(@yri).to receive(:exit).with(1)
84
+ @yri.run('')
85
+ end
86
+
87
+ it "prints 'no documentation exists for object' if object is not found" do
88
+ expect(STDERR).to receive(:puts).with("No documentation for `Foo'")
89
+ expect(@yri).to receive(:exit).with(1)
90
+ @yri.run('Foo')
91
+ end
92
+
93
+ it "ensures output is serialized" do
94
+ YARD::CodeObjects::ClassObject.new(:root, 'Foo')
95
+ allow(@yri).to receive(:test_stub) do
96
+ expect(@yri.instance_variable_get(:@serializer)).to receive(:serialize).once
97
+ end
98
+ @yri.run('Foo')
99
+ end
100
+ end
101
+ end
@@ -1,460 +1,470 @@
1
- # frozen_string_literal: true
2
- require File.dirname(__FILE__) + '/spec_helper'
3
-
4
- RSpec.describe YARD::CodeObjects::Base do
5
- before { Registry.clear }
6
-
7
- it "does not allow empty object name" do
8
- expect { Base.new(:root, '') }.to raise_error(ArgumentError)
9
- end
10
-
11
- it "returns a unique instance of any registered object" do
12
- obj = ClassObject.new(:root, :Me)
13
- obj2 = ClassObject.new(:root, :Me)
14
- expect(obj.object_id).to eq obj2.object_id
15
-
16
- obj3 = ModuleObject.new(obj, :Too)
17
- obj4 = CodeObjects::Base.new(obj3, :Hello)
18
- obj4.parent = obj
19
-
20
- obj5 = CodeObjects::Base.new(obj3, :hello)
21
- expect(obj4.object_id).not_to eq obj5.object_id
22
- end
23
-
24
- it "creates a new object if cached object is not of the same class" do
25
- expect(ConstantObject.new(:root, "MYMODULE")).to be_instance_of(ConstantObject)
26
- expect(ModuleObject.new(:root, "MYMODULE")).to be_instance_of(ModuleObject)
27
- expect(ClassObject.new(:root, "MYMODULE")).to be_instance_of(ClassObject)
28
- expect(YARD::Registry.at("MYMODULE")).to be_instance_of(ClassObject)
29
- end
30
-
31
- it "simplifies complex namespace paths" do
32
- obj = ClassObject.new(:root, "A::B::C::D")
33
- expect(obj.name).to eq :D
34
- expect(obj.path).to eq "A::B::C::D"
35
- expect(obj.namespace).to eq P("A::B::C")
36
- end
37
-
38
- # @bug gh-552
39
- it "simplifies complex namespace paths when path starts with ::" do
40
- obj = ClassObject.new(:root, "::A::B::C::D")
41
- expect(obj.name).to eq :D
42
- expect(obj.path).to eq "A::B::C::D"
43
- expect(obj.namespace).to eq P("A::B::C")
44
- end
45
-
46
- it "calls the block again if #new is called on an existing object" do
47
- o1 = ClassObject.new(:root, :Me) do |o|
48
- o.docstring = "DOCSTRING"
49
- end
50
-
51
- o2 = ClassObject.new(:root, :Me) do |o|
52
- o.docstring = "NOT_DOCSTRING"
53
- end
54
-
55
- expect(o1.object_id).to eq o2.object_id
56
- expect(o1.docstring).to eq "NOT_DOCSTRING"
57
- expect(o2.docstring).to eq "NOT_DOCSTRING"
58
- end
59
-
60
- it "allows complex name and converts it to namespace" do
61
- obj = CodeObjects::Base.new(nil, "A::B")
62
- expect(obj.namespace.path).to eq "A"
63
- expect(obj.name).to eq :B
64
- end
65
-
66
- it "allows namespace to be nil and not register in the Registry" do
67
- obj = CodeObjects::Base.new(nil, :Me)
68
- expect(obj.namespace).to eq nil
69
- expect(Registry.at(:Me)).to eq nil
70
- end
71
-
72
- it "allows namespace to be a NamespaceObject" do
73
- ns = ModuleObject.new(:root, :Name)
74
- obj = CodeObjects::Base.new(ns, :Me)
75
- expect(obj.namespace).to eq ns
76
- end
77
-
78
- it "allows :root to be the shorthand namespace of `Registry.root`" do
79
- obj = CodeObjects::Base.new(:root, :Me)
80
- expect(obj.namespace).to eq Registry.root
81
- end
82
-
83
- it "does not allow any other types as namespace" do
84
- expect { CodeObjects::Base.new("ROOT!", :Me) }.to raise_error(ArgumentError)
85
- end
86
-
87
- it "registers itself in the registry if namespace is supplied" do
88
- obj = ModuleObject.new(:root, :Me)
89
- expect(Registry.at(:Me)).to eq obj
90
-
91
- obj2 = ModuleObject.new(obj, :Too)
92
- expect(Registry.at(:"Me::Too")).to eq obj2
93
- end
94
-
95
- describe "#[]=" do
96
- it "sets any attribute" do
97
- obj = ModuleObject.new(:root, :YARD)
98
- obj[:some_attr] = "hello"
99
- expect(obj[:some_attr]).to eq "hello"
100
- end
101
-
102
- it "uses the accessor method if available" do
103
- obj = CodeObjects::Base.new(:root, :YARD)
104
- obj[:source] = "hello"
105
- expect(obj.source).to eq "hello"
106
- obj.source = "unhello"
107
- expect(obj[:source]).to eq "unhello"
108
- end
109
- end
110
-
111
- it "sets attributes via attr= through method_missing" do
112
- obj = CodeObjects::Base.new(:root, :YARD)
113
- obj.something = 2
114
- expect(obj.something).to eq 2
115
- expect(obj[:something]).to eq 2
116
- end
117
-
118
- it "exists in the parent's #children after creation" do
119
- obj = ModuleObject.new(:root, :YARD)
120
- obj2 = MethodObject.new(obj, :testing)
121
- expect(obj.children).to include(obj2)
122
- end
123
-
124
- it "properly re-indents source starting from 0 indentation" do
125
- obj = CodeObjects::Base.new(nil, :test)
126
- obj.source = <<-eof
127
- def mymethod
128
- if x == 2 &&
129
- 5 == 5
130
- 3
131
- else
132
- 1
133
- end
134
- end
135
- eof
136
- expect(obj.source).to eq "def mymethod\n if x == 2 &&\n 5 == 5\n 3\n else\n 1\n end\nend"
137
-
138
- Registry.clear
139
- Parser::SourceParser.parse_string <<-eof
140
- def key?(key)
141
- super(key)
142
- end
143
- eof
144
- expect(Registry.at('#key?').source).to eq "def key?(key)\n super(key)\nend"
145
-
146
- Registry.clear
147
- Parser::SourceParser.parse_string <<-eof
148
- def key?(key)
149
- if x == 2
150
- puts key
151
- else
152
- exit
153
- end
154
- end
155
- eof
156
- expect(Registry.at('#key?').source).to eq "def key?(key)\n if x == 2\n puts key\n else\n exit\n end\nend"
157
- end
158
-
159
- it "does not add newlines to source when parsing sub blocks" do
160
- Parser::SourceParser.parse_string <<-eof
161
- module XYZ
162
- module ZYX
163
- class ABC
164
- def msg
165
- hello_world
166
- end
167
- end
168
- end
169
- end
170
- eof
171
- expect(Registry.at('XYZ::ZYX::ABC#msg').source).to eq "def msg\n hello_world\nend"
172
- end
173
-
174
- it "handles source for 'def x; end'" do
175
- Registry.clear
176
- Parser::SourceParser.parse_string "def x; 2 end"
177
- expect(Registry.at('#x').source).to eq "def x; 2 end"
178
- end
179
-
180
- it "sets file and line information" do
181
- Parser::SourceParser.parse_string <<-eof
182
- class X; end
183
- eof
184
- expect(Registry.at(:X).file).to eq '(stdin)'
185
- expect(Registry.at(:X).line).to eq 1
186
- end
187
-
188
- it "maintains all file associations when objects are defined multiple times in one file" do
189
- Parser::SourceParser.parse_string <<-eof
190
- class X; end
191
- class X; end
192
- class X; end
193
- eof
194
-
195
- expect(Registry.at(:X).file).to eq '(stdin)'
196
- expect(Registry.at(:X).line).to eq 1
197
- expect(Registry.at(:X).files).to eq [['(stdin)', 1], ['(stdin)', 2], ['(stdin)', 3]]
198
- end
199
-
200
- it "maintains all file associations when objects are defined multiple times in multiple files" do
201
- 3.times do |i|
202
- allow(File).to receive(:read_binary).and_return("class X; end")
203
- Parser::SourceParser.new.parse("file#{i + 1}.rb")
204
- end
205
-
206
- expect(Registry.at(:X).file).to eq 'file1.rb'
207
- expect(Registry.at(:X).line).to eq 1
208
- expect(Registry.at(:X).files).to eq [['file1.rb', 1], ['file2.rb', 1], ['file3.rb', 1]]
209
- end
210
-
211
- it "prioritizes the definition with a docstring when returning #file" do
212
- Parser::SourceParser.parse_string <<-eof
213
- class X; end
214
- class X; end
215
- # docstring
216
- class X; end
217
- eof
218
-
219
- expect(Registry.at(:X).file).to eq '(stdin)'
220
- expect(Registry.at(:X).line).to eq 4
221
- expect(Registry.at(:X).files).to eq [['(stdin)', 4], ['(stdin)', 1], ['(stdin)', 2]]
222
- end
223
-
224
- describe "#format" do
225
- it "sends object to Templates.render" do
226
- object = MethodObject.new(:root, :method)
227
- expect(Templates::Engine).to receive(:render).with(:x => 1, :object => object, :type => object.type)
228
- object.format :x => 1
229
- end
230
-
231
- it "does not change options object class" do
232
- opts = YARD::Templates::TemplateOptions.new
233
- opts.type = "test"
234
- object = MethodObject.new(:root, :method)
235
- expect(Templates::Engine).to receive(:render).with kind_of(YARD::Templates::TemplateOptions)
236
- object.format(opts)
237
- end
238
- end
239
-
240
- describe "#source_type" do
241
- it "defaults to :ruby" do
242
- object = MethodObject.new(:root, :method)
243
- expect(object.source_type).to eq :ruby
244
- end
245
- end
246
-
247
- describe "#relative_path" do
248
- it "accepts a string" do
249
- YARD.parse_string "module A; class B; end; class C; end; end"
250
- expect(Registry.at('A::B').relative_path(Registry.at('A::C'))).to eq(
251
- Registry.at('A::B').relative_path('A::C')
252
- )
253
- end
254
-
255
- it "returns full class name when objects share a common class prefix" do
256
- YARD.parse_string "module User; end; module UserManager; end"
257
- expect(Registry.at('User').relative_path('UserManager')).to eq 'UserManager'
258
- expect(Registry.at('User').relative_path(Registry.at('UserManager'))).to eq 'UserManager'
259
- end
260
-
261
- it "returns the relative path when they share a common namespace" do
262
- YARD.parse_string "module A; class B; end; class C; end; end"
263
- expect(Registry.at('A::B').relative_path(Registry.at('A::C'))).to eq 'C'
264
- YARD.parse_string "module Foo; module A; end; module B; def foo; end end end"
265
- expect(Registry.at('Foo::A').relative_path(Registry.at('Foo::B#foo'))).to eq 'B#foo'
266
- end
267
-
268
- it "returns the full path if they don't have a common namespace" do
269
- YARD.parse_string "module A; class B; end; end; module D; class C; end; end"
270
- expect(Registry.at('A::B').relative_path('D::C')).to eq 'D::C'
271
- YARD.parse_string 'module C::B::C; module Apple; end; module Ant; end end'
272
- expect(Registry.at('C::B::C::Apple').relative_path('C::B::C::Ant')).to eq 'Ant'
273
- YARD.parse_string 'module OMG::ABC; end; class Object; end'
274
- expect(Registry.at('OMG::ABC').relative_path('Object')).to eq "Object"
275
- YARD.parse_string("class YARD::Config; MYCONST = 1; end")
276
- expect(Registry.at('YARD::Config').relative_path('YARD::Config::MYCONST')).to eq "MYCONST"
277
- end
278
-
279
- it "returns a relative path for class methods" do
280
- YARD.parse_string "module A; def self.b; end; def self.c; end; end"
281
- expect(Registry.at('A.b').relative_path('A.c')).to eq 'c'
282
- expect(Registry.at('A').relative_path('A.c')).to eq 'c'
283
- end
284
-
285
- it "returns a relative path for instance methods" do
286
- YARD.parse_string "module A; def b; end; def c; end; end"
287
- expect(Registry.at('A#b').relative_path('A#c')).to eq '#c'
288
- expect(Registry.at('A').relative_path('A#c')).to eq '#c'
289
- end
290
-
291
- it "returns full path if relative path is to parent namespace" do
292
- YARD.parse_string "module A; module B; end end"
293
- expect(Registry.at('A::B').relative_path('A')).to eq 'A'
294
- end
295
-
296
- it "only returns name for relative path to self" do
297
- YARD.parse_string("class A::B::C; def foo; end end")
298
- expect(Registry.at('A::B::C').relative_path('A::B::C')).to eq 'C'
299
- expect(Registry.at('A::B::C#foo').relative_path('A::B::C#foo')).to eq '#foo'
300
- end
301
- end
302
-
303
- describe "#docstring=" do
304
- it "converts string into Docstring when #docstring= is set" do
305
- o = ClassObject.new(:root, :Me)
306
- o.docstring = "DOCSTRING"
307
- expect(o.docstring).to be_instance_of(Docstring)
308
- end
309
-
310
- it "sets docstring to docstring of other object if docstring is '(see Path)'" do
311
- ClassObject.new(:root, :AnotherObject) {|x| x.docstring = "FOO" }
312
- o = ClassObject.new(:root, :Me)
313
- o.docstring = '(see AnotherObject)'
314
- expect(o.docstring).to eq "FOO"
315
- end
316
-
317
- it "does not copy docstring mid-docstring" do
318
- doc = "Hello.\n(see file.rb)\nmore documentation"
319
- o = ClassObject.new(:root, :Me)
320
- o.docstring = doc
321
- expect(o.docstring).to eq doc
322
- end
323
-
324
- it "allows extra docstring after (see Path)" do
325
- ClassObject.new(:root, :AnotherObject) {|x| x.docstring = "FOO" }
326
- o = ClassObject.new(:root, :Me)
327
- o.docstring = Docstring.new("(see AnotherObject)\n\nEXTRA\n@api private", o)
328
- expect(o.docstring).to eq "FOO\n\nEXTRA"
329
- expect(o.docstring).to have_tag(:api)
330
- end
331
- end
332
-
333
- describe "#docstring" do
334
- it "returns an empty string if docstring was '(see Path)' and Path is not resolved" do
335
- o = ClassObject.new(:root, :Me)
336
- o.docstring = '(see AnotherObject)'
337
- expect(o.docstring).to eq ""
338
- end
339
-
340
- it "returns docstring when object is resolved" do
341
- o = ClassObject.new(:root, :Me)
342
- o.docstring = '(see AnotherObject)'
343
- expect(o.docstring).to eq ""
344
- ClassObject.new(:root, :AnotherObject) {|x| x.docstring = "FOO" }
345
- expect(o.docstring).to eq "FOO"
346
- end
347
-
348
- describe "localization" do
349
- it "returns localized docstring" do
350
- fr_locale = YARD::I18n::Locale.new('fr')
351
- allow(fr_locale).to receive(:translate).with('Hello').and_return('Bonjour')
352
-
353
- o = ClassObject.new(:root, :Me)
354
- o.docstring = 'Hello'
355
- expect(o.docstring).to eq 'Hello'
356
-
357
- allow(Registry).to receive(:locale).with('fr').and_return(fr_locale)
358
- expect(o.docstring('fr')).to eq "Bonjour"
359
- end
360
-
361
- it "returns localized docstring tag" do
362
- o = CodeObjects::MethodObject.new(:root, 'Hello#message')
363
- o.docstring.add_tag(Tags::Tag.new('return', 'Hello'))
364
-
365
- fr_locale = YARD::I18n::Locale.new('fr')
366
- allow(fr_locale).to receive(:translate).with('Hello').and_return('Bonjour')
367
- allow(Registry).to receive(:locale).with('fr').and_return(fr_locale)
368
-
369
- expect(o.docstring('fr').tags.map(&:text)).to eq ['Bonjour']
370
- end
371
-
372
- it "returns updated localized docstring" do
373
- fr_locale = YARD::I18n::Locale.new('fr')
374
- allow(Registry).to receive(:locale).with('fr').and_return(fr_locale)
375
-
376
- o = ClassObject.new(:root, :Me)
377
- o.docstring = 'Hello'
378
- expect(o.docstring).to eq 'Hello'
379
-
380
- allow(fr_locale).to receive(:translate).with('Hello').and_return('Bonjour')
381
- expect(o.docstring('fr')).to eq "Bonjour"
382
-
383
- o.docstring = 'World'
384
- allow(fr_locale).to receive(:translate).with('World').and_return('Monde')
385
- expect(o.docstring('fr')).to eq "Monde"
386
- expect(o.docstring).to eq 'World'
387
- end
388
- end
389
- end
390
-
391
- describe "#add_file" do
392
- it "only adds a file/line combination once" do
393
- o = ClassObject.new(:root, :Me)
394
- o.add_file('filename', 12)
395
- expect(o.files).to eq [['filename', 12]]
396
- o.add_file('filename', 12)
397
- expect(o.files).to eq [['filename', 12]]
398
- o.add_file('filename', 40) # different line
399
- expect(o.files).to eq [['filename', 12], ['filename', 40]]
400
- end
401
- end
402
-
403
- describe "#copy_to" do
404
- it "copies all data to new object" do
405
- YARD.parse_string <<-eof
406
- private
407
- # A docstring
408
- # @return [String] a tag
409
- def foo(a, b, c)
410
- source_code_here
411
- end
412
- eof
413
- foo_c = MethodObject.new(:root, :foo, :class)
414
- Registry.at('#foo').copy_to(foo_c)
415
- expect(foo_c.scope).to eq :class
416
- expect(foo_c.visibility).to eq :private
417
- expect(foo_c.type).to eq :method
418
- expect(foo_c.class).to eq MethodObject
419
- expect(foo_c.path).to eq '::foo'
420
- expect(foo_c.docstring).to eq "A docstring"
421
- expect(foo_c.tag(:return).types).to eq ['String']
422
- expect(foo_c.file).to eq '(stdin)'
423
- expect(foo_c.line).to eq 4
424
- expect(foo_c.source).to match(/source_code_here/)
425
- expect(foo_c.signature).to eq 'def foo(a, b, c)'
426
- expect(foo_c.parameters).to eq [['a', nil], ['b', nil], ['c', nil]]
427
- end
428
-
429
- it "returns the copied object" do
430
- YARD.parse_string 'def foo; end'
431
- foo_c = MethodObject.new(:root, :foo, :class)
432
- expect(Registry.at('#foo').copy_to(foo_c)).to eq foo_c
433
- end
434
-
435
- it "copies docstring and rewrite tags to new object" do
436
- YARD.parse_string <<-eof
437
- # @return [String] a tag
438
- def foo; end
439
- eof
440
- foo_c = MethodObject.new(:root, :foo, :class)
441
- foo_i = Registry.at('#foo')
442
- foo_i.copy_to(foo_c)
443
- expect(foo_i.tags).not_to eq foo_c.tags
444
- expect(foo_c.tags.first.object).to eq foo_c
445
- end
446
-
447
- it "only copies #copyable_attributes" do
448
- foo = MethodObject.new(:root, :foo)
449
- expect(foo).to receive(:copyable_attributes).and_return %w(a b c)
450
- expect(foo).to receive(:instance_variable_get).with('@a').and_return(1)
451
- expect(foo).to receive(:instance_variable_get).with('@b').and_return(2)
452
- expect(foo).to receive(:instance_variable_get).with('@c').and_return(3)
453
- bar = MethodObject.new(:root, :bar)
454
- expect(bar).to receive(:instance_variable_set).with('@a', 1)
455
- expect(bar).to receive(:instance_variable_set).with('@b', 2)
456
- expect(bar).to receive(:instance_variable_set).with('@c', 3)
457
- foo.copy_to(bar)
458
- end
459
- end
460
- end
1
+ # frozen_string_literal: true
2
+ require File.dirname(__FILE__) + '/spec_helper'
3
+
4
+ RSpec.describe YARD::CodeObjects::Base do
5
+ before { Registry.clear }
6
+
7
+ it "does not allow empty object name" do
8
+ expect { Base.new(:root, '') }.to raise_error(ArgumentError)
9
+ end
10
+
11
+ it "returns a unique instance of any registered object" do
12
+ obj = ClassObject.new(:root, :Me)
13
+ obj2 = ClassObject.new(:root, :Me)
14
+ expect(obj.object_id).to eq obj2.object_id
15
+
16
+ obj3 = ModuleObject.new(obj, :Too)
17
+ obj4 = CodeObjects::Base.new(obj3, :Hello)
18
+ obj4.parent = obj
19
+
20
+ obj5 = CodeObjects::Base.new(obj3, :hello)
21
+ expect(obj4.object_id).not_to eq obj5.object_id
22
+ end
23
+
24
+ it "creates a new object if cached object is not of the same class" do
25
+ expect(ConstantObject.new(:root, "MYMODULE")).to be_instance_of(ConstantObject)
26
+ expect(ModuleObject.new(:root, "MYMODULE")).to be_instance_of(ModuleObject)
27
+ expect(ClassObject.new(:root, "MYMODULE")).to be_instance_of(ClassObject)
28
+ expect(YARD::Registry.at("MYMODULE")).to be_instance_of(ClassObject)
29
+ end
30
+
31
+ it "simplifies complex namespace paths" do
32
+ obj = ClassObject.new(:root, "A::B::C::D")
33
+ expect(obj.name).to eq :D
34
+ expect(obj.path).to eq "A::B::C::D"
35
+ expect(obj.namespace).to eq P("A::B::C")
36
+ end
37
+
38
+ # @bug gh-552
39
+ it "simplifies complex namespace paths when path starts with ::" do
40
+ obj = ClassObject.new(:root, "::A::B::C::D")
41
+ expect(obj.name).to eq :D
42
+ expect(obj.path).to eq "A::B::C::D"
43
+ expect(obj.namespace).to eq P("A::B::C")
44
+ end
45
+
46
+ it "calls the block again if #new is called on an existing object" do
47
+ o1 = ClassObject.new(:root, :Me) do |o|
48
+ o.docstring = "DOCSTRING"
49
+ end
50
+
51
+ o2 = ClassObject.new(:root, :Me) do |o|
52
+ o.docstring = "NOT_DOCSTRING"
53
+ end
54
+
55
+ expect(o1.object_id).to eq o2.object_id
56
+ expect(o1.docstring).to eq "NOT_DOCSTRING"
57
+ expect(o2.docstring).to eq "NOT_DOCSTRING"
58
+ end
59
+
60
+ it "allows complex name and converts it to namespace" do
61
+ obj = CodeObjects::Base.new(nil, "A::B")
62
+ expect(obj.namespace.path).to eq "A"
63
+ expect(obj.name).to eq :B
64
+ end
65
+
66
+ it "allows namespace to be nil and not register in the Registry" do
67
+ obj = CodeObjects::Base.new(nil, :Me)
68
+ expect(obj.namespace).to eq nil
69
+ expect(Registry.at(:Me)).to eq nil
70
+ end
71
+
72
+ it "allows namespace to be a NamespaceObject" do
73
+ ns = ModuleObject.new(:root, :Name)
74
+ obj = CodeObjects::Base.new(ns, :Me)
75
+ expect(obj.namespace).to eq ns
76
+ end
77
+
78
+ it "allows :root to be the shorthand namespace of `Registry.root`" do
79
+ obj = CodeObjects::Base.new(:root, :Me)
80
+ expect(obj.namespace).to eq Registry.root
81
+ end
82
+
83
+ it "does not allow any other types as namespace" do
84
+ expect { CodeObjects::Base.new("ROOT!", :Me) }.to raise_error(ArgumentError)
85
+ end
86
+
87
+ it "registers itself in the registry if namespace is supplied" do
88
+ obj = ModuleObject.new(:root, :Me)
89
+ expect(Registry.at(:Me)).to eq obj
90
+
91
+ obj2 = ModuleObject.new(obj, :Too)
92
+ expect(Registry.at(:"Me::Too")).to eq obj2
93
+ end
94
+
95
+ describe "#[]=" do
96
+ it "sets any attribute" do
97
+ obj = ModuleObject.new(:root, :YARD)
98
+ obj[:some_attr] = "hello"
99
+ expect(obj[:some_attr]).to eq "hello"
100
+ end
101
+
102
+ it "uses the accessor method if available" do
103
+ obj = CodeObjects::Base.new(:root, :YARD)
104
+ obj[:source] = "hello"
105
+ expect(obj.source).to eq "hello"
106
+ obj.source = "unhello"
107
+ expect(obj[:source]).to eq "unhello"
108
+ end
109
+ end
110
+
111
+ it "sets attributes via attr= through method_missing" do
112
+ obj = CodeObjects::Base.new(:root, :YARD)
113
+ obj.something = 2
114
+ expect(obj.something).to eq 2
115
+ expect(obj[:something]).to eq 2
116
+ end
117
+
118
+ it "exists in the parent's #children after creation" do
119
+ obj = ModuleObject.new(:root, :YARD)
120
+ obj2 = MethodObject.new(obj, :testing)
121
+ expect(obj.children).to include(obj2)
122
+ end
123
+
124
+ # @bug gh-1209
125
+ it "removes prior defined objects at the same path from namespace's children" do
126
+ Registry.clear
127
+ obj = ModuleObject.new(:root, :YARD)
128
+ ConstantObject.new(obj, :Testing)
129
+ ClassObject.new(obj, :Testing)
130
+ expect(obj.children.map {|o| o.type.to_sym }).to eq [:class]
131
+ expect(Registry.at('YARD::Testing').type).to eq :class
132
+ end
133
+
134
+ it "properly re-indents source starting from 0 indentation" do
135
+ obj = CodeObjects::Base.new(nil, :test)
136
+ obj.source = <<-eof
137
+ def mymethod
138
+ if x == 2 &&
139
+ 5 == 5
140
+ 3
141
+ else
142
+ 1
143
+ end
144
+ end
145
+ eof
146
+ expect(obj.source).to eq "def mymethod\n if x == 2 &&\n 5 == 5\n 3\n else\n 1\n end\nend"
147
+
148
+ Registry.clear
149
+ Parser::SourceParser.parse_string <<-eof
150
+ def key?(key)
151
+ super(key)
152
+ end
153
+ eof
154
+ expect(Registry.at('#key?').source).to eq "def key?(key)\n super(key)\nend"
155
+
156
+ Registry.clear
157
+ Parser::SourceParser.parse_string <<-eof
158
+ def key?(key)
159
+ if x == 2
160
+ puts key
161
+ else
162
+ exit
163
+ end
164
+ end
165
+ eof
166
+ expect(Registry.at('#key?').source).to eq "def key?(key)\n if x == 2\n puts key\n else\n exit\n end\nend"
167
+ end
168
+
169
+ it "does not add newlines to source when parsing sub blocks" do
170
+ Parser::SourceParser.parse_string <<-eof
171
+ module XYZ
172
+ module ZYX
173
+ class ABC
174
+ def msg
175
+ hello_world
176
+ end
177
+ end
178
+ end
179
+ end
180
+ eof
181
+ expect(Registry.at('XYZ::ZYX::ABC#msg').source).to eq "def msg\n hello_world\nend"
182
+ end
183
+
184
+ it "handles source for 'def x; end'" do
185
+ Registry.clear
186
+ Parser::SourceParser.parse_string "def x; 2 end"
187
+ expect(Registry.at('#x').source).to eq "def x; 2 end"
188
+ end
189
+
190
+ it "sets file and line information" do
191
+ Parser::SourceParser.parse_string <<-eof
192
+ class X; end
193
+ eof
194
+ expect(Registry.at(:X).file).to eq '(stdin)'
195
+ expect(Registry.at(:X).line).to eq 1
196
+ end
197
+
198
+ it "maintains all file associations when objects are defined multiple times in one file" do
199
+ Parser::SourceParser.parse_string <<-eof
200
+ class X; end
201
+ class X; end
202
+ class X; end
203
+ eof
204
+
205
+ expect(Registry.at(:X).file).to eq '(stdin)'
206
+ expect(Registry.at(:X).line).to eq 1
207
+ expect(Registry.at(:X).files).to eq [['(stdin)', 1], ['(stdin)', 2], ['(stdin)', 3]]
208
+ end
209
+
210
+ it "maintains all file associations when objects are defined multiple times in multiple files" do
211
+ 3.times do |i|
212
+ allow(File).to receive(:read_binary).and_return("class X; end")
213
+ Parser::SourceParser.new.parse("file#{i + 1}.rb")
214
+ end
215
+
216
+ expect(Registry.at(:X).file).to eq 'file1.rb'
217
+ expect(Registry.at(:X).line).to eq 1
218
+ expect(Registry.at(:X).files).to eq [['file1.rb', 1], ['file2.rb', 1], ['file3.rb', 1]]
219
+ end
220
+
221
+ it "prioritizes the definition with a docstring when returning #file" do
222
+ Parser::SourceParser.parse_string <<-eof
223
+ class X; end
224
+ class X; end
225
+ # docstring
226
+ class X; end
227
+ eof
228
+
229
+ expect(Registry.at(:X).file).to eq '(stdin)'
230
+ expect(Registry.at(:X).line).to eq 4
231
+ expect(Registry.at(:X).files).to eq [['(stdin)', 4], ['(stdin)', 1], ['(stdin)', 2]]
232
+ end
233
+
234
+ describe "#format" do
235
+ it "sends object to Templates.render" do
236
+ object = MethodObject.new(:root, :method)
237
+ expect(Templates::Engine).to receive(:render).with(:x => 1, :object => object, :type => object.type)
238
+ object.format :x => 1
239
+ end
240
+
241
+ it "does not change options object class" do
242
+ opts = YARD::Templates::TemplateOptions.new
243
+ opts.type = "test"
244
+ object = MethodObject.new(:root, :method)
245
+ expect(Templates::Engine).to receive(:render).with kind_of(YARD::Templates::TemplateOptions)
246
+ object.format(opts)
247
+ end
248
+ end
249
+
250
+ describe "#source_type" do
251
+ it "defaults to :ruby" do
252
+ object = MethodObject.new(:root, :method)
253
+ expect(object.source_type).to eq :ruby
254
+ end
255
+ end
256
+
257
+ describe "#relative_path" do
258
+ it "accepts a string" do
259
+ YARD.parse_string "module A; class B; end; class C; end; end"
260
+ expect(Registry.at('A::B').relative_path(Registry.at('A::C'))).to eq(
261
+ Registry.at('A::B').relative_path('A::C')
262
+ )
263
+ end
264
+
265
+ it "returns full class name when objects share a common class prefix" do
266
+ YARD.parse_string "module User; end; module UserManager; end"
267
+ expect(Registry.at('User').relative_path('UserManager')).to eq 'UserManager'
268
+ expect(Registry.at('User').relative_path(Registry.at('UserManager'))).to eq 'UserManager'
269
+ end
270
+
271
+ it "returns the relative path when they share a common namespace" do
272
+ YARD.parse_string "module A; class B; end; class C; end; end"
273
+ expect(Registry.at('A::B').relative_path(Registry.at('A::C'))).to eq 'C'
274
+ YARD.parse_string "module Foo; module A; end; module B; def foo; end end end"
275
+ expect(Registry.at('Foo::A').relative_path(Registry.at('Foo::B#foo'))).to eq 'B#foo'
276
+ end
277
+
278
+ it "returns the full path if they don't have a common namespace" do
279
+ YARD.parse_string "module A; class B; end; end; module D; class C; end; end"
280
+ expect(Registry.at('A::B').relative_path('D::C')).to eq 'D::C'
281
+ YARD.parse_string 'module C::B::C; module Apple; end; module Ant; end end'
282
+ expect(Registry.at('C::B::C::Apple').relative_path('C::B::C::Ant')).to eq 'Ant'
283
+ YARD.parse_string 'module OMG::ABC; end; class Object; end'
284
+ expect(Registry.at('OMG::ABC').relative_path('Object')).to eq "Object"
285
+ YARD.parse_string("class YARD::Config; MYCONST = 1; end")
286
+ expect(Registry.at('YARD::Config').relative_path('YARD::Config::MYCONST')).to eq "MYCONST"
287
+ end
288
+
289
+ it "returns a relative path for class methods" do
290
+ YARD.parse_string "module A; def self.b; end; def self.c; end; end"
291
+ expect(Registry.at('A.b').relative_path('A.c')).to eq 'c'
292
+ expect(Registry.at('A').relative_path('A.c')).to eq 'c'
293
+ end
294
+
295
+ it "returns a relative path for instance methods" do
296
+ YARD.parse_string "module A; def b; end; def c; end; end"
297
+ expect(Registry.at('A#b').relative_path('A#c')).to eq '#c'
298
+ expect(Registry.at('A').relative_path('A#c')).to eq '#c'
299
+ end
300
+
301
+ it "returns full path if relative path is to parent namespace" do
302
+ YARD.parse_string "module A; module B; end end"
303
+ expect(Registry.at('A::B').relative_path('A')).to eq 'A'
304
+ end
305
+
306
+ it "only returns name for relative path to self" do
307
+ YARD.parse_string("class A::B::C; def foo; end end")
308
+ expect(Registry.at('A::B::C').relative_path('A::B::C')).to eq 'C'
309
+ expect(Registry.at('A::B::C#foo').relative_path('A::B::C#foo')).to eq '#foo'
310
+ end
311
+ end
312
+
313
+ describe "#docstring=" do
314
+ it "converts string into Docstring when #docstring= is set" do
315
+ o = ClassObject.new(:root, :Me)
316
+ o.docstring = "DOCSTRING"
317
+ expect(o.docstring).to be_instance_of(Docstring)
318
+ end
319
+
320
+ it "sets docstring to docstring of other object if docstring is '(see Path)'" do
321
+ ClassObject.new(:root, :AnotherObject) {|x| x.docstring = "FOO" }
322
+ o = ClassObject.new(:root, :Me)
323
+ o.docstring = '(see AnotherObject)'
324
+ expect(o.docstring).to eq "FOO"
325
+ end
326
+
327
+ it "does not copy docstring mid-docstring" do
328
+ doc = "Hello.\n(see file.rb)\nmore documentation"
329
+ o = ClassObject.new(:root, :Me)
330
+ o.docstring = doc
331
+ expect(o.docstring).to eq doc
332
+ end
333
+
334
+ it "allows extra docstring after (see Path)" do
335
+ ClassObject.new(:root, :AnotherObject) {|x| x.docstring = "FOO" }
336
+ o = ClassObject.new(:root, :Me)
337
+ o.docstring = Docstring.new("(see AnotherObject)\n\nEXTRA\n@api private", o)
338
+ expect(o.docstring).to eq "FOO\n\nEXTRA"
339
+ expect(o.docstring).to have_tag(:api)
340
+ end
341
+ end
342
+
343
+ describe "#docstring" do
344
+ it "returns an empty string if docstring was '(see Path)' and Path is not resolved" do
345
+ o = ClassObject.new(:root, :Me)
346
+ o.docstring = '(see AnotherObject)'
347
+ expect(o.docstring).to eq ""
348
+ end
349
+
350
+ it "returns docstring when object is resolved" do
351
+ o = ClassObject.new(:root, :Me)
352
+ o.docstring = '(see AnotherObject)'
353
+ expect(o.docstring).to eq ""
354
+ ClassObject.new(:root, :AnotherObject) {|x| x.docstring = "FOO" }
355
+ expect(o.docstring).to eq "FOO"
356
+ end
357
+
358
+ describe "localization" do
359
+ it "returns localized docstring" do
360
+ fr_locale = YARD::I18n::Locale.new('fr')
361
+ allow(fr_locale).to receive(:translate).with('Hello').and_return('Bonjour')
362
+
363
+ o = ClassObject.new(:root, :Me)
364
+ o.docstring = 'Hello'
365
+ expect(o.docstring).to eq 'Hello'
366
+
367
+ allow(Registry).to receive(:locale).with('fr').and_return(fr_locale)
368
+ expect(o.docstring('fr')).to eq "Bonjour"
369
+ end
370
+
371
+ it "returns localized docstring tag" do
372
+ o = CodeObjects::MethodObject.new(:root, 'Hello#message')
373
+ o.docstring.add_tag(Tags::Tag.new('return', 'Hello'))
374
+
375
+ fr_locale = YARD::I18n::Locale.new('fr')
376
+ allow(fr_locale).to receive(:translate).with('Hello').and_return('Bonjour')
377
+ allow(Registry).to receive(:locale).with('fr').and_return(fr_locale)
378
+
379
+ expect(o.docstring('fr').tags.map(&:text)).to eq ['Bonjour']
380
+ end
381
+
382
+ it "returns updated localized docstring" do
383
+ fr_locale = YARD::I18n::Locale.new('fr')
384
+ allow(Registry).to receive(:locale).with('fr').and_return(fr_locale)
385
+
386
+ o = ClassObject.new(:root, :Me)
387
+ o.docstring = 'Hello'
388
+ expect(o.docstring).to eq 'Hello'
389
+
390
+ allow(fr_locale).to receive(:translate).with('Hello').and_return('Bonjour')
391
+ expect(o.docstring('fr')).to eq "Bonjour"
392
+
393
+ o.docstring = 'World'
394
+ allow(fr_locale).to receive(:translate).with('World').and_return('Monde')
395
+ expect(o.docstring('fr')).to eq "Monde"
396
+ expect(o.docstring).to eq 'World'
397
+ end
398
+ end
399
+ end
400
+
401
+ describe "#add_file" do
402
+ it "only adds a file/line combination once" do
403
+ o = ClassObject.new(:root, :Me)
404
+ o.add_file('filename', 12)
405
+ expect(o.files).to eq [['filename', 12]]
406
+ o.add_file('filename', 12)
407
+ expect(o.files).to eq [['filename', 12]]
408
+ o.add_file('filename', 40) # different line
409
+ expect(o.files).to eq [['filename', 12], ['filename', 40]]
410
+ end
411
+ end
412
+
413
+ describe "#copy_to" do
414
+ it "copies all data to new object" do
415
+ YARD.parse_string <<-eof
416
+ private
417
+ # A docstring
418
+ # @return [String] a tag
419
+ def foo(a, b, c)
420
+ source_code_here
421
+ end
422
+ eof
423
+ foo_c = MethodObject.new(:root, :foo, :class)
424
+ Registry.at('#foo').copy_to(foo_c)
425
+ expect(foo_c.scope).to eq :class
426
+ expect(foo_c.visibility).to eq :private
427
+ expect(foo_c.type).to eq :method
428
+ expect(foo_c.class).to eq MethodObject
429
+ expect(foo_c.path).to eq '::foo'
430
+ expect(foo_c.docstring).to eq "A docstring"
431
+ expect(foo_c.tag(:return).types).to eq ['String']
432
+ expect(foo_c.file).to eq '(stdin)'
433
+ expect(foo_c.line).to eq 4
434
+ expect(foo_c.source).to match(/source_code_here/)
435
+ expect(foo_c.signature).to eq 'def foo(a, b, c)'
436
+ expect(foo_c.parameters).to eq [['a', nil], ['b', nil], ['c', nil]]
437
+ end
438
+
439
+ it "returns the copied object" do
440
+ YARD.parse_string 'def foo; end'
441
+ foo_c = MethodObject.new(:root, :foo, :class)
442
+ expect(Registry.at('#foo').copy_to(foo_c)).to eq foo_c
443
+ end
444
+
445
+ it "copies docstring and rewrite tags to new object" do
446
+ YARD.parse_string <<-eof
447
+ # @return [String] a tag
448
+ def foo; end
449
+ eof
450
+ foo_c = MethodObject.new(:root, :foo, :class)
451
+ foo_i = Registry.at('#foo')
452
+ foo_i.copy_to(foo_c)
453
+ expect(foo_i.tags).not_to eq foo_c.tags
454
+ expect(foo_c.tags.first.object).to eq foo_c
455
+ end
456
+
457
+ it "only copies #copyable_attributes" do
458
+ foo = MethodObject.new(:root, :foo)
459
+ expect(foo).to receive(:copyable_attributes).and_return %w(a b c)
460
+ expect(foo).to receive(:instance_variable_get).with('@a').and_return(1)
461
+ expect(foo).to receive(:instance_variable_get).with('@b').and_return(2)
462
+ expect(foo).to receive(:instance_variable_get).with('@c').and_return(3)
463
+ bar = MethodObject.new(:root, :bar)
464
+ expect(bar).to receive(:instance_variable_set).with('@a', 1)
465
+ expect(bar).to receive(:instance_variable_set).with('@b', 2)
466
+ expect(bar).to receive(:instance_variable_set).with('@c', 3)
467
+ foo.copy_to(bar)
468
+ end
469
+ end
470
+ end