deg-yard 0.8.7.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 (558) hide show
  1. data/.travis.yml +39 -0
  2. data/.yardopts +25 -0
  3. data/.yardopts_guide +19 -0
  4. data/.yardopts_i18n +22 -0
  5. data/Gemfile +35 -0
  6. data/LEGAL +66 -0
  7. data/LICENSE +22 -0
  8. data/README.md +609 -0
  9. data/Rakefile +66 -0
  10. data/benchmarks/builtins_vs_eval.rb +23 -0
  11. data/benchmarks/concat_vs_join.rb +12 -0
  12. data/benchmarks/erb_vs_erubis.rb +53 -0
  13. data/benchmarks/format_args.rb +46 -0
  14. data/benchmarks/generation.rb +37 -0
  15. data/benchmarks/marshal_vs_dbm.rb +63 -0
  16. data/benchmarks/parsing.rb +46 -0
  17. data/benchmarks/pathname_vs_string.rb +50 -0
  18. data/benchmarks/rdoc_vs_yardoc.rb +10 -0
  19. data/benchmarks/registry_store_types.rb +48 -0
  20. data/benchmarks/ri_vs_yri.rb +18 -0
  21. data/benchmarks/ripper_parser.rb +12 -0
  22. data/benchmarks/splat_vs_flatten.rb +12 -0
  23. data/benchmarks/template_erb.rb +22 -0
  24. data/benchmarks/template_format.rb +6 -0
  25. data/benchmarks/template_profile.rb +17 -0
  26. data/benchmarks/yri_cache.rb +19 -0
  27. data/bin/yard +12 -0
  28. data/bin/yardoc +12 -0
  29. data/bin/yri +12 -0
  30. data/docs/CodeObjects.md +115 -0
  31. data/docs/GettingStarted.md +592 -0
  32. data/docs/Handlers.md +152 -0
  33. data/docs/Overview.md +61 -0
  34. data/docs/Parser.md +191 -0
  35. data/docs/Tags.md +282 -0
  36. data/docs/TagsArch.md +123 -0
  37. data/docs/Templates.md +496 -0
  38. data/docs/WhatsNew.md +1244 -0
  39. data/docs/images/code-objects-class-diagram.png +0 -0
  40. data/docs/images/handlers-class-diagram.png +0 -0
  41. data/docs/images/overview-class-diagram.png +0 -0
  42. data/docs/images/parser-class-diagram.png +0 -0
  43. data/docs/images/tags-class-diagram.png +0 -0
  44. data/docs/templates/default/fulldoc/html/full_list_tag.erb +7 -0
  45. data/docs/templates/default/fulldoc/html/setup.rb +6 -0
  46. data/docs/templates/default/layout/html/setup.rb +8 -0
  47. data/docs/templates/default/layout/html/tag_list.erb +11 -0
  48. data/docs/templates/default/yard_tags/html/list.erb +18 -0
  49. data/docs/templates/default/yard_tags/html/setup.rb +27 -0
  50. data/docs/templates/plugin.rb +65 -0
  51. data/lib/rubygems_plugin.rb +4 -0
  52. data/lib/yard/autoload.rb +290 -0
  53. data/lib/yard/cli/command.rb +84 -0
  54. data/lib/yard/cli/command_parser.rb +92 -0
  55. data/lib/yard/cli/config.rb +136 -0
  56. data/lib/yard/cli/diff.rb +270 -0
  57. data/lib/yard/cli/display.rb +68 -0
  58. data/lib/yard/cli/gems.rb +83 -0
  59. data/lib/yard/cli/graph.rb +126 -0
  60. data/lib/yard/cli/help.rb +18 -0
  61. data/lib/yard/cli/i18n.rb +69 -0
  62. data/lib/yard/cli/list.rb +22 -0
  63. data/lib/yard/cli/markup_types.rb +33 -0
  64. data/lib/yard/cli/server.rb +253 -0
  65. data/lib/yard/cli/stats.rb +213 -0
  66. data/lib/yard/cli/yardoc.rb +752 -0
  67. data/lib/yard/cli/yardopts_command.rb +109 -0
  68. data/lib/yard/cli/yri.rb +214 -0
  69. data/lib/yard/code_objects/base.rb +585 -0
  70. data/lib/yard/code_objects/class_object.rb +143 -0
  71. data/lib/yard/code_objects/class_variable_object.rb +8 -0
  72. data/lib/yard/code_objects/constant_object.rb +13 -0
  73. data/lib/yard/code_objects/extended_method_object.rb +23 -0
  74. data/lib/yard/code_objects/extra_file_object.rb +128 -0
  75. data/lib/yard/code_objects/macro_object.rb +172 -0
  76. data/lib/yard/code_objects/method_object.rb +191 -0
  77. data/lib/yard/code_objects/module_object.rb +18 -0
  78. data/lib/yard/code_objects/namespace_object.rb +200 -0
  79. data/lib/yard/code_objects/proxy.rb +258 -0
  80. data/lib/yard/code_objects/root_object.rb +17 -0
  81. data/lib/yard/config.rb +269 -0
  82. data/lib/yard/core_ext/array.rb +15 -0
  83. data/lib/yard/core_ext/file.rb +65 -0
  84. data/lib/yard/core_ext/hash.rb +15 -0
  85. data/lib/yard/core_ext/insertion.rb +60 -0
  86. data/lib/yard/core_ext/module.rb +19 -0
  87. data/lib/yard/core_ext/string.rb +67 -0
  88. data/lib/yard/core_ext/symbol_hash.rb +73 -0
  89. data/lib/yard/docstring.rb +362 -0
  90. data/lib/yard/docstring_parser.rb +321 -0
  91. data/lib/yard/globals.rb +18 -0
  92. data/lib/yard/handlers/base.rb +597 -0
  93. data/lib/yard/handlers/c/alias_handler.rb +15 -0
  94. data/lib/yard/handlers/c/attribute_handler.rb +13 -0
  95. data/lib/yard/handlers/c/base.rb +110 -0
  96. data/lib/yard/handlers/c/class_handler.rb +26 -0
  97. data/lib/yard/handlers/c/constant_handler.rb +12 -0
  98. data/lib/yard/handlers/c/handler_methods.rb +166 -0
  99. data/lib/yard/handlers/c/init_handler.rb +18 -0
  100. data/lib/yard/handlers/c/method_handler.rb +35 -0
  101. data/lib/yard/handlers/c/mixin_handler.rb +13 -0
  102. data/lib/yard/handlers/c/module_handler.rb +16 -0
  103. data/lib/yard/handlers/c/override_comment_handler.rb +30 -0
  104. data/lib/yard/handlers/c/path_handler.rb +10 -0
  105. data/lib/yard/handlers/c/struct_handler.rb +12 -0
  106. data/lib/yard/handlers/c/symbol_handler.rb +7 -0
  107. data/lib/yard/handlers/processor.rb +201 -0
  108. data/lib/yard/handlers/ruby/alias_handler.rb +41 -0
  109. data/lib/yard/handlers/ruby/attribute_handler.rb +82 -0
  110. data/lib/yard/handlers/ruby/base.rb +164 -0
  111. data/lib/yard/handlers/ruby/class_condition_handler.rb +86 -0
  112. data/lib/yard/handlers/ruby/class_handler.rb +121 -0
  113. data/lib/yard/handlers/ruby/class_variable_handler.rb +16 -0
  114. data/lib/yard/handlers/ruby/comment_handler.rb +9 -0
  115. data/lib/yard/handlers/ruby/constant_handler.rb +45 -0
  116. data/lib/yard/handlers/ruby/dsl_handler.rb +14 -0
  117. data/lib/yard/handlers/ruby/dsl_handler_methods.rb +77 -0
  118. data/lib/yard/handlers/ruby/exception_handler.rb +26 -0
  119. data/lib/yard/handlers/ruby/extend_handler.rb +21 -0
  120. data/lib/yard/handlers/ruby/legacy/alias_handler.rb +34 -0
  121. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +60 -0
  122. data/lib/yard/handlers/ruby/legacy/base.rb +250 -0
  123. data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -0
  124. data/lib/yard/handlers/ruby/legacy/class_handler.rb +111 -0
  125. data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +14 -0
  126. data/lib/yard/handlers/ruby/legacy/comment_handler.rb +9 -0
  127. data/lib/yard/handlers/ruby/legacy/constant_handler.rb +28 -0
  128. data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +16 -0
  129. data/lib/yard/handlers/ruby/legacy/exception_handler.rb +12 -0
  130. data/lib/yard/handlers/ruby/legacy/extend_handler.rb +20 -0
  131. data/lib/yard/handlers/ruby/legacy/method_handler.rb +85 -0
  132. data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -0
  133. data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +18 -0
  134. data/lib/yard/handlers/ruby/legacy/module_handler.rb +11 -0
  135. data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +21 -0
  136. data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +16 -0
  137. data/lib/yard/handlers/ruby/legacy/yield_handler.rb +28 -0
  138. data/lib/yard/handlers/ruby/method_condition_handler.rb +8 -0
  139. data/lib/yard/handlers/ruby/method_handler.rb +92 -0
  140. data/lib/yard/handlers/ruby/mixin_handler.rb +36 -0
  141. data/lib/yard/handlers/ruby/module_function_handler.rb +26 -0
  142. data/lib/yard/handlers/ruby/module_handler.rb +11 -0
  143. data/lib/yard/handlers/ruby/private_constant_handler.rb +36 -0
  144. data/lib/yard/handlers/ruby/struct_handler_methods.rb +141 -0
  145. data/lib/yard/handlers/ruby/visibility_handler.rb +24 -0
  146. data/lib/yard/handlers/ruby/yield_handler.rb +30 -0
  147. data/lib/yard/i18n/locale.rb +74 -0
  148. data/lib/yard/i18n/message.rb +56 -0
  149. data/lib/yard/i18n/messages.rb +55 -0
  150. data/lib/yard/i18n/pot_generator.rb +280 -0
  151. data/lib/yard/i18n/text.rb +173 -0
  152. data/lib/yard/logging.rb +190 -0
  153. data/lib/yard/options.rb +216 -0
  154. data/lib/yard/parser/base.rb +56 -0
  155. data/lib/yard/parser/c/c_parser.rb +231 -0
  156. data/lib/yard/parser/c/comment_parser.rb +131 -0
  157. data/lib/yard/parser/c/statement.rb +63 -0
  158. data/lib/yard/parser/ruby/ast_node.rb +496 -0
  159. data/lib/yard/parser/ruby/legacy/ruby_lex.rb +1378 -0
  160. data/lib/yard/parser/ruby/legacy/ruby_parser.rb +31 -0
  161. data/lib/yard/parser/ruby/legacy/statement.rb +65 -0
  162. data/lib/yard/parser/ruby/legacy/statement_list.rb +384 -0
  163. data/lib/yard/parser/ruby/legacy/token_list.rb +71 -0
  164. data/lib/yard/parser/ruby/ruby_parser.rb +625 -0
  165. data/lib/yard/parser/source_parser.rb +517 -0
  166. data/lib/yard/rake/yardoc_task.rb +74 -0
  167. data/lib/yard/registry.rb +438 -0
  168. data/lib/yard/registry_store.rb +319 -0
  169. data/lib/yard/rubygems/backports/LICENSE.txt +57 -0
  170. data/lib/yard/rubygems/backports/MIT.txt +20 -0
  171. data/lib/yard/rubygems/backports/gem.rb +9 -0
  172. data/lib/yard/rubygems/backports/source_index.rb +370 -0
  173. data/lib/yard/rubygems/backports.rb +8 -0
  174. data/lib/yard/rubygems/doc_manager.rb +88 -0
  175. data/lib/yard/rubygems/specification.rb +41 -0
  176. data/lib/yard/serializers/base.rb +80 -0
  177. data/lib/yard/serializers/file_system_serializer.rb +90 -0
  178. data/lib/yard/serializers/process_serializer.rb +24 -0
  179. data/lib/yard/serializers/stdout_serializer.rb +32 -0
  180. data/lib/yard/serializers/yardoc_serializer.rb +124 -0
  181. data/lib/yard/server/adapter.rb +100 -0
  182. data/lib/yard/server/commands/base.rb +192 -0
  183. data/lib/yard/server/commands/display_file_command.rb +24 -0
  184. data/lib/yard/server/commands/display_object_command.rb +58 -0
  185. data/lib/yard/server/commands/frames_command.rb +15 -0
  186. data/lib/yard/server/commands/library_command.rb +148 -0
  187. data/lib/yard/server/commands/library_index_command.rb +24 -0
  188. data/lib/yard/server/commands/list_command.rb +24 -0
  189. data/lib/yard/server/commands/search_command.rb +78 -0
  190. data/lib/yard/server/commands/static_file_command.rb +57 -0
  191. data/lib/yard/server/doc_server_helper.rb +76 -0
  192. data/lib/yard/server/doc_server_serializer.rb +33 -0
  193. data/lib/yard/server/library_version.rb +227 -0
  194. data/lib/yard/server/rack_adapter.rb +88 -0
  195. data/lib/yard/server/router.rb +176 -0
  196. data/lib/yard/server/static_caching.rb +45 -0
  197. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +78 -0
  198. data/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
  199. data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +12 -0
  200. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +46 -0
  201. data/lib/yard/server/templates/default/layout/html/script_setup.erb +8 -0
  202. data/lib/yard/server/templates/default/layout/html/setup.rb +7 -0
  203. data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -0
  204. data/lib/yard/server/templates/default/method_details/html/setup.rb +4 -0
  205. data/lib/yard/server/templates/doc_server/library_list/html/contents.erb +13 -0
  206. data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +26 -0
  207. data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +12 -0
  208. data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +3 -0
  209. data/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -0
  210. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +51 -0
  211. data/lib/yard/server/templates/doc_server/processing/html/setup.rb +3 -0
  212. data/lib/yard/server/templates/doc_server/search/html/search.erb +18 -0
  213. data/lib/yard/server/templates/doc_server/search/html/setup.rb +8 -0
  214. data/lib/yard/server/webrick_adapter.rb +43 -0
  215. data/lib/yard/server.rb +11 -0
  216. data/lib/yard/tags/default_factory.rb +176 -0
  217. data/lib/yard/tags/default_tag.rb +12 -0
  218. data/lib/yard/tags/directives.rb +599 -0
  219. data/lib/yard/tags/library.rb +630 -0
  220. data/lib/yard/tags/option_tag.rb +12 -0
  221. data/lib/yard/tags/overload_tag.rb +66 -0
  222. data/lib/yard/tags/ref_tag.rb +7 -0
  223. data/lib/yard/tags/ref_tag_list.rb +27 -0
  224. data/lib/yard/tags/tag.rb +57 -0
  225. data/lib/yard/tags/tag_format_error.rb +6 -0
  226. data/lib/yard/templates/engine.rb +185 -0
  227. data/lib/yard/templates/erb_cache.rb +22 -0
  228. data/lib/yard/templates/helpers/base_helper.rb +212 -0
  229. data/lib/yard/templates/helpers/filter_helper.rb +26 -0
  230. data/lib/yard/templates/helpers/html_helper.rb +599 -0
  231. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +59 -0
  232. data/lib/yard/templates/helpers/markup/rdoc_markdown.rb +22 -0
  233. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +106 -0
  234. data/lib/yard/templates/helpers/markup_helper.rb +169 -0
  235. data/lib/yard/templates/helpers/method_helper.rb +74 -0
  236. data/lib/yard/templates/helpers/module_helper.rb +19 -0
  237. data/lib/yard/templates/helpers/text_helper.rb +95 -0
  238. data/lib/yard/templates/helpers/uml_helper.rb +46 -0
  239. data/lib/yard/templates/section.rb +106 -0
  240. data/lib/yard/templates/template.rb +407 -0
  241. data/lib/yard/templates/template_options.rb +88 -0
  242. data/lib/yard/verifier.rb +148 -0
  243. data/lib/yard/version.rb +3 -0
  244. data/lib/yard.rb +71 -0
  245. data/po/ja.po +31118 -0
  246. data/spec/cli/command_parser_spec.rb +43 -0
  247. data/spec/cli/command_spec.rb +36 -0
  248. data/spec/cli/config_spec.rb +92 -0
  249. data/spec/cli/diff_spec.rb +260 -0
  250. data/spec/cli/display_spec.rb +30 -0
  251. data/spec/cli/gems_spec.rb +81 -0
  252. data/spec/cli/graph_spec.rb +17 -0
  253. data/spec/cli/help_spec.rb +22 -0
  254. data/spec/cli/i18n_spec.rb +111 -0
  255. data/spec/cli/list_spec.rb +8 -0
  256. data/spec/cli/markup_types_spec.rb +22 -0
  257. data/spec/cli/server_spec.rb +327 -0
  258. data/spec/cli/stats_spec.rb +90 -0
  259. data/spec/cli/yardoc_spec.rb +804 -0
  260. data/spec/cli/yri_spec.rb +99 -0
  261. data/spec/code_objects/base_spec.rb +438 -0
  262. data/spec/code_objects/class_object_spec.rb +225 -0
  263. data/spec/code_objects/code_object_list_spec.rb +33 -0
  264. data/spec/code_objects/constants_spec.rb +82 -0
  265. data/spec/code_objects/extra_file_object_spec.rb +147 -0
  266. data/spec/code_objects/macro_object_spec.rb +148 -0
  267. data/spec/code_objects/method_object_spec.rb +175 -0
  268. data/spec/code_objects/module_object_spec.rb +141 -0
  269. data/spec/code_objects/namespace_object_spec.rb +170 -0
  270. data/spec/code_objects/proxy_spec.rb +140 -0
  271. data/spec/code_objects/spec_helper.rb +3 -0
  272. data/spec/config_spec.rb +176 -0
  273. data/spec/core_ext/array_spec.rb +14 -0
  274. data/spec/core_ext/file_spec.rb +68 -0
  275. data/spec/core_ext/hash_spec.rb +14 -0
  276. data/spec/core_ext/insertion_spec.rb +37 -0
  277. data/spec/core_ext/module_spec.rb +15 -0
  278. data/spec/core_ext/string_spec.rb +42 -0
  279. data/spec/core_ext/symbol_hash_spec.rb +86 -0
  280. data/spec/docstring_parser_spec.rb +228 -0
  281. data/spec/docstring_spec.rb +335 -0
  282. data/spec/handlers/alias_handler_spec.rb +80 -0
  283. data/spec/handlers/attribute_handler_spec.rb +94 -0
  284. data/spec/handlers/base_spec.rb +206 -0
  285. data/spec/handlers/c/alias_handler_spec.rb +33 -0
  286. data/spec/handlers/c/attribute_handler_spec.rb +40 -0
  287. data/spec/handlers/c/class_handler_spec.rb +63 -0
  288. data/spec/handlers/c/constant_handler_spec.rb +68 -0
  289. data/spec/handlers/c/init_handler_spec.rb +47 -0
  290. data/spec/handlers/c/method_handler_spec.rb +229 -0
  291. data/spec/handlers/c/mixin_handler_spec.rb +27 -0
  292. data/spec/handlers/c/module_handler_spec.rb +38 -0
  293. data/spec/handlers/c/override_comment_handler_spec.rb +46 -0
  294. data/spec/handlers/c/path_handler_spec.rb +35 -0
  295. data/spec/handlers/c/spec_helper.rb +13 -0
  296. data/spec/handlers/c/struct_handler_spec.rb +15 -0
  297. data/spec/handlers/class_condition_handler_spec.rb +67 -0
  298. data/spec/handlers/class_handler_spec.rb +246 -0
  299. data/spec/handlers/class_variable_handler_spec.rb +11 -0
  300. data/spec/handlers/constant_handler_spec.rb +64 -0
  301. data/spec/handlers/dsl_handler_spec.rb +197 -0
  302. data/spec/handlers/examples/alias_handler_001.rb.txt +44 -0
  303. data/spec/handlers/examples/attribute_handler_001.rb.txt +32 -0
  304. data/spec/handlers/examples/class_condition_handler_001.rb.txt +69 -0
  305. data/spec/handlers/examples/class_handler_001.rb.txt +120 -0
  306. data/spec/handlers/examples/class_variable_handler_001.rb.txt +10 -0
  307. data/spec/handlers/examples/constant_handler_001.rb.txt +25 -0
  308. data/spec/handlers/examples/dsl_handler_001.rb.txt +125 -0
  309. data/spec/handlers/examples/exception_handler_001.rb.txt +59 -0
  310. data/spec/handlers/examples/extend_handler_001.rb.txt +16 -0
  311. data/spec/handlers/examples/method_condition_handler_001.rb.txt +10 -0
  312. data/spec/handlers/examples/method_handler_001.rb.txt +126 -0
  313. data/spec/handlers/examples/mixin_handler_001.rb.txt +37 -0
  314. data/spec/handlers/examples/module_handler_001.rb.txt +29 -0
  315. data/spec/handlers/examples/private_constant_handler_001.rb.txt +8 -0
  316. data/spec/handlers/examples/process_handler_001.rb.txt +11 -0
  317. data/spec/handlers/examples/visibility_handler_001.rb.txt +32 -0
  318. data/spec/handlers/examples/yield_handler_001.rb.txt +54 -0
  319. data/spec/handlers/exception_handler_spec.rb +48 -0
  320. data/spec/handlers/extend_handler_spec.rb +23 -0
  321. data/spec/handlers/legacy_base_spec.rb +128 -0
  322. data/spec/handlers/method_condition_handler_spec.rb +14 -0
  323. data/spec/handlers/method_handler_spec.rb +184 -0
  324. data/spec/handlers/mixin_handler_spec.rb +55 -0
  325. data/spec/handlers/module_function_handler_spec.rb +105 -0
  326. data/spec/handlers/module_handler_spec.rb +34 -0
  327. data/spec/handlers/private_constant_handler_spec.rb +24 -0
  328. data/spec/handlers/processor_spec.rb +34 -0
  329. data/spec/handlers/ruby/base_spec.rb +94 -0
  330. data/spec/handlers/ruby/legacy/base_spec.rb +82 -0
  331. data/spec/handlers/spec_helper.rb +33 -0
  332. data/spec/handlers/visibility_handler_spec.rb +39 -0
  333. data/spec/handlers/yield_handler_spec.rb +51 -0
  334. data/spec/i18n/locale_spec.rb +68 -0
  335. data/spec/i18n/message_spec.rb +52 -0
  336. data/spec/i18n/messages_spec.rb +67 -0
  337. data/spec/i18n/pot_generator_spec.rb +262 -0
  338. data/spec/i18n/text_spec.rb +180 -0
  339. data/spec/logging_spec.rb +35 -0
  340. data/spec/options_spec.rb +171 -0
  341. data/spec/parser/base_spec.rb +24 -0
  342. data/spec/parser/c_parser_spec.rb +171 -0
  343. data/spec/parser/examples/array.c.txt +3887 -0
  344. data/spec/parser/examples/example1.rb.txt +8 -0
  345. data/spec/parser/examples/extrafile.c.txt +8 -0
  346. data/spec/parser/examples/multifile.c.txt +22 -0
  347. data/spec/parser/examples/override.c.txt +424 -0
  348. data/spec/parser/examples/parse_in_order_001.rb.txt +2 -0
  349. data/spec/parser/examples/parse_in_order_002.rb.txt +2 -0
  350. data/spec/parser/examples/tag_handler_001.rb.txt +8 -0
  351. data/spec/parser/ruby/ast_node_spec.rb +33 -0
  352. data/spec/parser/ruby/legacy/statement_list_spec.rb +299 -0
  353. data/spec/parser/ruby/legacy/token_list_spec.rb +77 -0
  354. data/spec/parser/ruby/ruby_parser_spec.rb +334 -0
  355. data/spec/parser/source_parser_spec.rb +717 -0
  356. data/spec/parser/tag_parsing_spec.rb +18 -0
  357. data/spec/rake/yardoc_task_spec.rb +101 -0
  358. data/spec/registry_spec.rb +393 -0
  359. data/spec/registry_store_spec.rb +315 -0
  360. data/spec/rubygems/doc_manager_spec.rb +112 -0
  361. data/spec/serializers/data/serialized_yardoc/checksums +1 -0
  362. data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
  363. data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
  364. data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
  365. data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
  366. data/spec/serializers/data/serialized_yardoc/proxy_types +2 -0
  367. data/spec/serializers/file_system_serializer_spec.rb +124 -0
  368. data/spec/serializers/spec_helper.rb +2 -0
  369. data/spec/serializers/yardoc_serializer_spec.rb +46 -0
  370. data/spec/server/adapter_spec.rb +38 -0
  371. data/spec/server/commands/base_spec.rb +87 -0
  372. data/spec/server/commands/library_command_spec.rb +39 -0
  373. data/spec/server/commands/static_file_command_spec.rb +84 -0
  374. data/spec/server/doc_server_helper_spec.rb +53 -0
  375. data/spec/server/doc_server_serializer_spec.rb +45 -0
  376. data/spec/server/rack_adapter_spec.rb +20 -0
  377. data/spec/server/router_spec.rb +122 -0
  378. data/spec/server/spec_helper.rb +17 -0
  379. data/spec/server/static_caching_spec.rb +39 -0
  380. data/spec/server/webrick_servlet_spec.rb +20 -0
  381. data/spec/server_spec.rb +10 -0
  382. data/spec/spec_helper.rb +128 -0
  383. data/spec/tags/default_factory_spec.rb +152 -0
  384. data/spec/tags/default_tag_spec.rb +11 -0
  385. data/spec/tags/directives_spec.rb +453 -0
  386. data/spec/tags/library_spec.rb +34 -0
  387. data/spec/tags/overload_tag_spec.rb +53 -0
  388. data/spec/tags/ref_tag_list_spec.rb +53 -0
  389. data/spec/templates/class_spec.rb +44 -0
  390. data/spec/templates/constant_spec.rb +40 -0
  391. data/spec/templates/engine_spec.rb +121 -0
  392. data/spec/templates/examples/class001.html +280 -0
  393. data/spec/templates/examples/class001.txt +36 -0
  394. data/spec/templates/examples/class002.html +35 -0
  395. data/spec/templates/examples/constant001.txt +25 -0
  396. data/spec/templates/examples/constant002.txt +7 -0
  397. data/spec/templates/examples/constant003.txt +11 -0
  398. data/spec/templates/examples/method001.html +130 -0
  399. data/spec/templates/examples/method001.txt +35 -0
  400. data/spec/templates/examples/method002.html +86 -0
  401. data/spec/templates/examples/method002.txt +20 -0
  402. data/spec/templates/examples/method003.html +159 -0
  403. data/spec/templates/examples/method003.txt +45 -0
  404. data/spec/templates/examples/method004.html +44 -0
  405. data/spec/templates/examples/method004.txt +10 -0
  406. data/spec/templates/examples/method005.html +99 -0
  407. data/spec/templates/examples/method005.txt +33 -0
  408. data/spec/templates/examples/module001.dot +33 -0
  409. data/spec/templates/examples/module001.html +825 -0
  410. data/spec/templates/examples/module001.txt +33 -0
  411. data/spec/templates/examples/module002.html +318 -0
  412. data/spec/templates/examples/module003.html +185 -0
  413. data/spec/templates/examples/module004.html +387 -0
  414. data/spec/templates/examples/tag001.txt +82 -0
  415. data/spec/templates/helpers/base_helper_spec.rb +175 -0
  416. data/spec/templates/helpers/html_helper_spec.rb +612 -0
  417. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +48 -0
  418. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +93 -0
  419. data/spec/templates/helpers/markup_helper_spec.rb +135 -0
  420. data/spec/templates/helpers/method_helper_spec.rb +82 -0
  421. data/spec/templates/helpers/shared_signature_examples.rb +123 -0
  422. data/spec/templates/helpers/text_helper_spec.rb +44 -0
  423. data/spec/templates/method_spec.rb +102 -0
  424. data/spec/templates/module_spec.rb +181 -0
  425. data/spec/templates/onefile_spec.rb +64 -0
  426. data/spec/templates/section_spec.rb +146 -0
  427. data/spec/templates/spec_helper.rb +73 -0
  428. data/spec/templates/tag_spec.rb +51 -0
  429. data/spec/templates/template_spec.rb +409 -0
  430. data/spec/verifier_spec.rb +106 -0
  431. data/templates/default/class/dot/setup.rb +6 -0
  432. data/templates/default/class/dot/superklass.erb +3 -0
  433. data/templates/default/class/html/constructor_details.erb +8 -0
  434. data/templates/default/class/html/setup.rb +1 -0
  435. data/templates/default/class/html/subclasses.erb +4 -0
  436. data/templates/default/class/setup.rb +36 -0
  437. data/templates/default/class/text/setup.rb +11 -0
  438. data/templates/default/class/text/subclasses.erb +5 -0
  439. data/templates/default/constant/text/header.erb +11 -0
  440. data/templates/default/constant/text/setup.rb +3 -0
  441. data/templates/default/docstring/html/abstract.erb +4 -0
  442. data/templates/default/docstring/html/deprecated.erb +1 -0
  443. data/templates/default/docstring/html/index.erb +5 -0
  444. data/templates/default/docstring/html/note.erb +6 -0
  445. data/templates/default/docstring/html/private.erb +4 -0
  446. data/templates/default/docstring/html/returns_void.erb +1 -0
  447. data/templates/default/docstring/html/text.erb +1 -0
  448. data/templates/default/docstring/html/todo.erb +6 -0
  449. data/templates/default/docstring/setup.rb +51 -0
  450. data/templates/default/docstring/text/abstract.erb +2 -0
  451. data/templates/default/docstring/text/deprecated.erb +2 -0
  452. data/templates/default/docstring/text/index.erb +2 -0
  453. data/templates/default/docstring/text/note.erb +4 -0
  454. data/templates/default/docstring/text/private.erb +2 -0
  455. data/templates/default/docstring/text/returns_void.erb +1 -0
  456. data/templates/default/docstring/text/text.erb +1 -0
  457. data/templates/default/docstring/text/todo.erb +4 -0
  458. data/templates/default/fulldoc/html/css/common.css +1 -0
  459. data/templates/default/fulldoc/html/css/full_list.css +57 -0
  460. data/templates/default/fulldoc/html/css/style.css +338 -0
  461. data/templates/default/fulldoc/html/frames.erb +28 -0
  462. data/templates/default/fulldoc/html/full_list.erb +40 -0
  463. data/templates/default/fulldoc/html/full_list_class.erb +2 -0
  464. data/templates/default/fulldoc/html/full_list_file.erb +5 -0
  465. data/templates/default/fulldoc/html/full_list_method.erb +8 -0
  466. data/templates/default/fulldoc/html/js/app.js +214 -0
  467. data/templates/default/fulldoc/html/js/full_list.js +178 -0
  468. data/templates/default/fulldoc/html/js/jquery.js +4 -0
  469. data/templates/default/fulldoc/html/setup.rb +199 -0
  470. data/templates/default/layout/dot/header.erb +6 -0
  471. data/templates/default/layout/dot/setup.rb +14 -0
  472. data/templates/default/layout/html/breadcrumb.erb +13 -0
  473. data/templates/default/layout/html/files.erb +11 -0
  474. data/templates/default/layout/html/footer.erb +5 -0
  475. data/templates/default/layout/html/headers.erb +14 -0
  476. data/templates/default/layout/html/index.erb +2 -0
  477. data/templates/default/layout/html/layout.erb +20 -0
  478. data/templates/default/layout/html/listing.erb +4 -0
  479. data/templates/default/layout/html/objects.erb +32 -0
  480. data/templates/default/layout/html/script_setup.erb +5 -0
  481. data/templates/default/layout/html/search.erb +8 -0
  482. data/templates/default/layout/html/setup.rb +71 -0
  483. data/templates/default/method/html/header.erb +16 -0
  484. data/templates/default/method/setup.rb +3 -0
  485. data/templates/default/method/text/header.erb +1 -0
  486. data/templates/default/method_details/html/header.erb +3 -0
  487. data/templates/default/method_details/html/method_signature.erb +25 -0
  488. data/templates/default/method_details/html/source.erb +10 -0
  489. data/templates/default/method_details/setup.rb +10 -0
  490. data/templates/default/method_details/text/header.erb +10 -0
  491. data/templates/default/method_details/text/method_signature.erb +12 -0
  492. data/templates/default/method_details/text/setup.rb +10 -0
  493. data/templates/default/module/dot/child.erb +1 -0
  494. data/templates/default/module/dot/dependencies.erb +3 -0
  495. data/templates/default/module/dot/header.erb +6 -0
  496. data/templates/default/module/dot/info.erb +14 -0
  497. data/templates/default/module/dot/setup.rb +14 -0
  498. data/templates/default/module/html/attribute_details.erb +10 -0
  499. data/templates/default/module/html/attribute_summary.erb +8 -0
  500. data/templates/default/module/html/box_info.erb +37 -0
  501. data/templates/default/module/html/children.erb +8 -0
  502. data/templates/default/module/html/constant_summary.erb +13 -0
  503. data/templates/default/module/html/defines.erb +3 -0
  504. data/templates/default/module/html/header.erb +5 -0
  505. data/templates/default/module/html/inherited_attributes.erb +14 -0
  506. data/templates/default/module/html/inherited_constants.erb +8 -0
  507. data/templates/default/module/html/inherited_methods.erb +19 -0
  508. data/templates/default/module/html/item_summary.erb +40 -0
  509. data/templates/default/module/html/method_details_list.erb +9 -0
  510. data/templates/default/module/html/method_summary.erb +14 -0
  511. data/templates/default/module/html/methodmissing.erb +12 -0
  512. data/templates/default/module/html/pre_docstring.erb +1 -0
  513. data/templates/default/module/setup.rb +164 -0
  514. data/templates/default/module/text/children.erb +10 -0
  515. data/templates/default/module/text/class_meths_list.erb +8 -0
  516. data/templates/default/module/text/extends.erb +8 -0
  517. data/templates/default/module/text/header.erb +7 -0
  518. data/templates/default/module/text/includes.erb +8 -0
  519. data/templates/default/module/text/instance_meths_list.erb +8 -0
  520. data/templates/default/module/text/setup.rb +12 -0
  521. data/templates/default/onefile/html/files.erb +5 -0
  522. data/templates/default/onefile/html/headers.erb +6 -0
  523. data/templates/default/onefile/html/layout.erb +17 -0
  524. data/templates/default/onefile/html/readme.erb +3 -0
  525. data/templates/default/onefile/html/setup.rb +61 -0
  526. data/templates/default/root/dot/child.erb +3 -0
  527. data/templates/default/root/dot/setup.rb +5 -0
  528. data/templates/default/root/html/setup.rb +1 -0
  529. data/templates/default/tags/html/example.erb +11 -0
  530. data/templates/default/tags/html/index.erb +3 -0
  531. data/templates/default/tags/html/option.erb +24 -0
  532. data/templates/default/tags/html/overload.erb +14 -0
  533. data/templates/default/tags/html/see.erb +8 -0
  534. data/templates/default/tags/html/tag.erb +20 -0
  535. data/templates/default/tags/setup.rb +55 -0
  536. data/templates/default/tags/text/example.erb +12 -0
  537. data/templates/default/tags/text/index.erb +1 -0
  538. data/templates/default/tags/text/option.erb +20 -0
  539. data/templates/default/tags/text/overload.erb +19 -0
  540. data/templates/default/tags/text/see.erb +11 -0
  541. data/templates/default/tags/text/tag.erb +13 -0
  542. data/templates/guide/class/html/setup.rb +1 -0
  543. data/templates/guide/docstring/html/setup.rb +1 -0
  544. data/templates/guide/fulldoc/html/css/style.css +108 -0
  545. data/templates/guide/fulldoc/html/js/app.js +33 -0
  546. data/templates/guide/fulldoc/html/setup.rb +73 -0
  547. data/templates/guide/layout/html/layout.erb +81 -0
  548. data/templates/guide/layout/html/setup.rb +28 -0
  549. data/templates/guide/method/html/header.erb +18 -0
  550. data/templates/guide/method/html/setup.rb +21 -0
  551. data/templates/guide/module/html/header.erb +7 -0
  552. data/templates/guide/module/html/method_list.erb +5 -0
  553. data/templates/guide/module/html/setup.rb +26 -0
  554. data/templates/guide/onefile/html/files.erb +4 -0
  555. data/templates/guide/onefile/html/setup.rb +5 -0
  556. data/templates/guide/onefile/html/toc.erb +3 -0
  557. data/templates/guide/tags/html/setup.rb +8 -0
  558. metadata +689 -0
@@ -0,0 +1,43 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe YARD::CLI::CommandParser do
4
+ describe '#run' do
5
+ before do
6
+ @cmd = CLI::CommandParser.new
7
+ end
8
+
9
+ it "should show help if --help is provided" do
10
+ command = mock(:command)
11
+ command.should_receive(:run).with('--help')
12
+ CLI::CommandParser.commands[:foo] = command
13
+ @cmd.class.default_command = :foo
14
+ @cmd.run *%w( foo --help )
15
+ end
16
+
17
+ it "should use default command if first argument is a switch" do
18
+ command = mock(:command)
19
+ command.should_receive(:run).with('--a', 'b', 'c')
20
+ CLI::CommandParser.commands[:foo] = command
21
+ @cmd.class.default_command = :foo
22
+ @cmd.run *%w( --a b c )
23
+ end
24
+
25
+ it "should use default command if no arguments are provided" do
26
+ command = mock(:command)
27
+ command.should_receive(:run)
28
+ CLI::CommandParser.commands[:foo] = command
29
+ @cmd.class.default_command = :foo
30
+ @cmd.run
31
+ end
32
+
33
+ it "should list commands if command is not found" do
34
+ @cmd.should_receive(:list_commands)
35
+ @cmd.run *%w( unknown_command --args )
36
+ end
37
+
38
+ it "should list commands if --help is provided as sole argument" do
39
+ @cmd.should_receive(:list_commands)
40
+ @cmd.run *%w( --help )
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,36 @@
1
+ require File.dirname(__FILE__) + "/../spec_helper"
2
+ require 'optparse'
3
+
4
+ describe YARD::CLI::Command do
5
+ describe '#parse_options' do
6
+ before do
7
+ @options = OptionParser.new
8
+ @saw_foo = false
9
+ @options.on('--foo') { @saw_foo = true }
10
+ end
11
+
12
+ def parse(*args)
13
+ CLI::Command.new.send(:parse_options, @options, args)
14
+ args
15
+ end
16
+
17
+ it "should skip unrecognized options but continue to next option" do
18
+ log.should_receive(:warn).with(/Unrecognized.*--list/)
19
+ log.should_receive(:warn).with(/Unrecognized.*--list2/)
20
+ parse('--list', '--list2', '--foo')
21
+ @saw_foo.should be_true
22
+ end
23
+
24
+ it "should skip unrecognized options and any extra non-option arg that follows" do
25
+ log.should_receive(:warn).with(/Unrecognized.*--list/)
26
+ parse('--list', 'foo', '--foo')
27
+ @saw_foo.should be_true
28
+ end
29
+
30
+ it "should stop retrying to parse at non-switch argument" do
31
+ log.should_receive(:warn).with(/Unrecognized.*--list/)
32
+ args = parse('--list', 'foo', 'foo', 'foo')
33
+ args.should == %w(foo foo)
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,92 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ require 'yaml'
4
+
5
+ describe YARD::CLI::Config do
6
+ before do
7
+ @config = YARD::CLI::Config.new
8
+ YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
9
+ YARD::Config.stub!(:save)
10
+ end
11
+
12
+ def run(*args)
13
+ @config.run(*args)
14
+ end
15
+
16
+ describe 'Listing configuration' do
17
+ it "should accept --list" do
18
+ opts = YARD::Config.options
19
+ YAML.should_receive(:dump).twice.and_return("--- foo\nbar\nbaz")
20
+ log.should_receive(:puts).twice.with("bar\nbaz")
21
+ run
22
+ run('--list')
23
+ YARD::Config.options.should == opts
24
+ end
25
+ end
26
+
27
+ describe 'Viewing an item' do
28
+ it "should view item if no value is given" do
29
+ YARD::Config.options[:foo] = 'bar'
30
+ log.should_receive(:puts).with('"bar"')
31
+ run 'foo'
32
+ YARD::Config.options[:foo].should == 'bar'
33
+ end
34
+ end
35
+
36
+ describe 'Modifying an item' do
37
+ it "should accept --reset to set value" do
38
+ YARD::Config.options[:load_plugins] = 'foo'
39
+ run('--reset', 'load_plugins')
40
+ YARD::Config.options[:load_plugins].should == false
41
+ end
42
+
43
+ it "should accept --as-list to force single item as list" do
44
+ run('--as-list', 'foo', 'bar')
45
+ YARD::Config.options[:foo].should == ['bar']
46
+ end
47
+
48
+ it "should accept --append to append values to existing key" do
49
+ YARD::Config.options[:foo] = ['bar']
50
+ run('--append', 'foo', 'baz', 'quux')
51
+ YARD::Config.options[:foo].should == ['bar', 'baz', 'quux']
52
+ run('-a', 'foo', 'last')
53
+ YARD::Config.options[:foo].should == ['bar', 'baz', 'quux', 'last']
54
+ end
55
+
56
+ it "should turn key into list if --append is used on single item" do
57
+ YARD::Config.options[:foo] = 'bar'
58
+ run('-a', 'foo', 'baz')
59
+ YARD::Config.options[:foo].should == ['bar', 'baz']
60
+ end
61
+
62
+ it "should modify item if value is given" do
63
+ run('foo', 'xxx')
64
+ YARD::Config.options[:foo].should == 'xxx'
65
+ end
66
+
67
+ it "should turn list of values into array of values" do
68
+ run('foo', 'a', 'b', '1', 'true', 'false')
69
+ YARD::Config.options[:foo].should == ['a', 'b', 1, true, false]
70
+ end
71
+
72
+ it "should turn number into numeric Ruby type" do
73
+ run('foo', '1')
74
+ YARD::Config.options[:foo].should == 1
75
+ end
76
+
77
+ it "should turn true into TrueClass" do
78
+ run('foo', 'true')
79
+ YARD::Config.options[:foo].should == true
80
+ end
81
+
82
+ it "should turn false into FalseClass" do
83
+ run('foo', 'false')
84
+ YARD::Config.options[:foo].should == false
85
+ end
86
+
87
+ it "should save on modification" do
88
+ YARD::Config.should_receive(:save)
89
+ run('foo', 'true')
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,260 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+ require 'stringio'
3
+ require 'open-uri'
4
+
5
+ describe YARD::CLI::Diff do
6
+ before do
7
+ CLI::Yardoc.stub!(:run)
8
+ CLI::Gems.stub!(:run)
9
+ @diff = CLI::Diff.new
10
+ end
11
+
12
+ describe 'Argument handling' do
13
+ it "should exit if there is only one gem name" do
14
+ @diff.should_receive(:exit)
15
+ log.should_receive(:puts).with(/Usage/)
16
+ @diff.run
17
+ end
18
+ end
19
+
20
+ describe 'Diffing' do
21
+ before do
22
+ @objects1 = nil
23
+ @objects2 = nil
24
+ end
25
+
26
+ def run(*args)
27
+ @all_call = -1
28
+ @data = StringIO.new
29
+ @objects1 ||= %w( C#fooey C#baz D.bar )
30
+ @objects2 ||= %w( A A::B A::B::C A.foo A#foo B C.foo C.bar C#baz )
31
+ @objects = [@objects1, @objects2]
32
+ @diff.should_receive(:load_gem_data).ordered.with('gem1') do
33
+ Registry.clear
34
+ YARD.parse_string <<-eof
35
+ class C
36
+ def fooey; end
37
+ def baz; FOO end
38
+ end
39
+ class D
40
+ def self.bar; end
41
+ end
42
+ eof
43
+ end
44
+ @diff.should_receive(:load_gem_data).ordered.with('gem2') do
45
+ Registry.clear
46
+ YARD.parse_string <<-eof
47
+ module A
48
+ module B
49
+ class C; end
50
+ end
51
+ def self.foo; end
52
+ def foo; end
53
+ end
54
+ class C
55
+ def self.foo; end
56
+ def self.bar; end
57
+ def baz; BAR end
58
+ end
59
+ eof
60
+ end
61
+ log.stub!(:print) {|data| @data << data }
62
+ log.stub!(:puts) {|*args| @data << args.join("\n"); @data << "\n" }
63
+ @diff.run(*(args + ['gem1', 'gem2']))
64
+ end
65
+
66
+ it "should show differences between objects" do
67
+ run
68
+ @data.string.should == <<-eof
69
+ Added objects:
70
+
71
+ A ((stdin):1) (...)
72
+ A::B::C ((stdin):3)
73
+ C.bar ((stdin):10)
74
+ C.foo ((stdin):9)
75
+
76
+ Modified objects:
77
+
78
+ C#baz ((stdin):3)
79
+
80
+ Removed objects:
81
+
82
+ C#fooey ((stdin):2)
83
+ D ((stdin):5) (...)
84
+
85
+ eof
86
+ end
87
+
88
+ it "should accept --compact" do
89
+ run('--compact')
90
+ @data.string.should == <<-eof
91
+ A A ((stdin):1) (...)
92
+ A A::B::C ((stdin):3)
93
+ A C.bar ((stdin):10)
94
+ A C.foo ((stdin):9)
95
+ M C#baz ((stdin):3)
96
+ D C#fooey ((stdin):2)
97
+ D D ((stdin):5) (...)
98
+ eof
99
+ end
100
+
101
+ it "should accept -a/--all" do
102
+ ['-a', '--all'].each do |opt|
103
+ run(opt)
104
+ @data.string.should == <<-eof
105
+ Added objects:
106
+
107
+ A ((stdin):1)
108
+ A#foo ((stdin):6)
109
+ A.foo ((stdin):5)
110
+ A::B ((stdin):2)
111
+ A::B::C ((stdin):3)
112
+ C.bar ((stdin):10)
113
+ C.foo ((stdin):9)
114
+
115
+ Modified objects:
116
+
117
+ C#baz ((stdin):3)
118
+
119
+ Removed objects:
120
+
121
+ C#fooey ((stdin):2)
122
+ D ((stdin):5)
123
+ D.bar ((stdin):6)
124
+
125
+ eof
126
+ end
127
+ end
128
+
129
+ it "should accept --compact and --all" do
130
+ run('--compact', '--all')
131
+ @data.string.should == <<-eof
132
+ A A ((stdin):1)
133
+ A A#foo ((stdin):6)
134
+ A A.foo ((stdin):5)
135
+ A A::B ((stdin):2)
136
+ A A::B::C ((stdin):3)
137
+ A C.bar ((stdin):10)
138
+ A C.foo ((stdin):9)
139
+ M C#baz ((stdin):3)
140
+ D C#fooey ((stdin):2)
141
+ D D ((stdin):5)
142
+ D D.bar ((stdin):6)
143
+ eof
144
+ end
145
+
146
+ it "should accept --no-modified" do
147
+ run('--compact', '--no-modified')
148
+ @data.string.should == <<-eof
149
+ A A ((stdin):1) (...)
150
+ A A::B::C ((stdin):3)
151
+ A C.bar ((stdin):10)
152
+ A C.foo ((stdin):9)
153
+ D C#fooey ((stdin):2)
154
+ D D ((stdin):5) (...)
155
+ eof
156
+ end
157
+
158
+ it "should accept --query" do
159
+ run('--compact', '--query', 'o.type == :method')
160
+ @data.string.should == <<-eof
161
+ A A#foo ((stdin):6)
162
+ A A.foo ((stdin):5)
163
+ A C.bar ((stdin):10)
164
+ A C.foo ((stdin):9)
165
+ M C#baz ((stdin):3)
166
+ D C#fooey ((stdin):2)
167
+ D D.bar ((stdin):6)
168
+ eof
169
+ end
170
+ end
171
+
172
+ describe 'File searching' do
173
+ before do
174
+ @diff.stub!(:generate_yardoc)
175
+ end
176
+
177
+ it "should search for gem/.yardoc" do
178
+ File.should_receive(:directory?).with('gem1/.yardoc').and_return(true)
179
+ File.should_receive(:directory?).with('gem2/.yardoc').and_return(true)
180
+ Registry.should_receive(:load_yardoc).with('gem1/.yardoc')
181
+ Registry.should_receive(:load_yardoc).with('gem2/.yardoc')
182
+ @diff.run('gem1', 'gem2')
183
+ end
184
+
185
+ it "should search for argument as yardoc" do
186
+ File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
187
+ File.should_receive(:directory?).with('gem2/.yardoc').and_return(false)
188
+ File.should_receive(:directory?).with('gem1').and_return(true)
189
+ File.should_receive(:directory?).with('gem2').and_return(true)
190
+ Registry.should_receive(:load_yardoc).with('gem1')
191
+ Registry.should_receive(:load_yardoc).with('gem2')
192
+ @diff.run('gem1', 'gem2')
193
+ end
194
+
195
+ it "should search for installed gem" do
196
+ File.should_receive(:directory?).with('gem1-1.0.0.gem/.yardoc').and_return(false)
197
+ File.should_receive(:directory?).with('gem2-1.0.0/.yardoc').and_return(false)
198
+ File.should_receive(:directory?).with('gem1-1.0.0.gem').and_return(false)
199
+ File.should_receive(:directory?).with('gem2-1.0.0').and_return(false)
200
+ gemmock = mock(:gemmock)
201
+ spec1 = mock(:spec)
202
+ spec2 = mock(:spec)
203
+ gemmock.should_receive(:find_name).at_least(1).times.and_return([spec1, spec2])
204
+ Gem.should_receive(:source_index).at_least(1).times.and_return(gemmock)
205
+ spec1.stub!(:full_name).and_return('gem1-1.0.0')
206
+ spec1.stub!(:name).and_return('gem1')
207
+ spec1.stub!(:version).and_return('1.0.0')
208
+ spec2.stub!(:full_name).and_return('gem2-1.0.0')
209
+ spec2.stub!(:name).and_return('gem2')
210
+ spec2.stub!(:version).and_return('1.0.0')
211
+ Registry.should_receive(:yardoc_file_for_gem).with('gem1', '= 1.0.0').and_return('/path/to/file')
212
+ Registry.should_receive(:yardoc_file_for_gem).with('gem2', '= 1.0.0').and_return(nil)
213
+ Registry.should_receive(:load_yardoc).with('/path/to/file')
214
+ CLI::Gems.should_receive(:run).with('gem2', '1.0.0').and_return(nil)
215
+ Dir.stub!(:chdir)
216
+ @diff.run('gem1-1.0.0.gem', 'gem2-1.0.0')
217
+ end
218
+
219
+ it "should search for .gem file" do
220
+ File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
221
+ File.should_receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
222
+ File.should_receive(:directory?).with('gem1').and_return(false)
223
+ File.should_receive(:directory?).with('gem2.gem').and_return(false)
224
+ File.should_receive(:directory?).any_number_of_times
225
+ File.should_receive(:exist?).with('gem1.gem').and_return(true)
226
+ File.should_receive(:exist?).with('gem2.gem').and_return(true)
227
+ File.should_receive(:exist?).any_number_of_times
228
+ File.should_receive(:open).with('gem1.gem', 'rb')
229
+ File.should_receive(:open).with('gem2.gem', 'rb')
230
+ FileUtils.stub(:mkdir_p)
231
+ Gem::Package.stub(:open)
232
+ FileUtils.stub(:rm_rf)
233
+ @diff.run('gem1', 'gem2.gem')
234
+ end
235
+
236
+ it "should search for .gem file on rubygems.org" do
237
+ File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
238
+ File.should_receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
239
+ File.should_receive(:directory?).with('gem1').and_return(false)
240
+ File.should_receive(:directory?).with('gem2.gem').and_return(false)
241
+ File.should_receive(:directory?).any_number_of_times
242
+ File.should_receive(:exist?).with('gem1.gem').and_return(false)
243
+ File.should_receive(:exist?).with('gem2.gem').and_return(false)
244
+ File.should_receive(:exist?).any_number_of_times
245
+ @diff.should_receive(:open).with('http://rubygems.org/downloads/gem1.gem')
246
+ @diff.should_receive(:open).with('http://rubygems.org/downloads/gem2.gem')
247
+ FileUtils.stub(:mkdir_p)
248
+ Gem::Package.stub(:open)
249
+ FileUtils.stub(:rm_rf)
250
+ @diff.run('gem1', 'gem2.gem')
251
+ end
252
+
253
+ it "should error if gem is not found" do
254
+ log.should_receive(:error).with("Cannot find gem gem1")
255
+ log.should_receive(:error).with("Cannot find gem gem2.gem")
256
+ @diff.stub!(:load_gem_data).and_return(false)
257
+ @diff.run('gem1', 'gem2.gem')
258
+ end
259
+ end
260
+ end
@@ -0,0 +1,30 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe YARD::CLI::Display do
4
+ before do
5
+ Registry.stub(:load)
6
+ @object = CodeObjects::ClassObject.new(:root, :Foo)
7
+ @object.docstring = 'Foo bar'
8
+ end
9
+
10
+ it "displays an object" do
11
+ YARD::CLI::Display.run('-f', 'text', 'Foo')
12
+ log.io.string.strip.should eq(@object.format.strip)
13
+ end
14
+
15
+ it "wraps output with -l (defaulting to layout)" do
16
+ YARD::CLI::Display.run('-l', '-f', 'html', 'Foo')
17
+ formatted_output = @object.format(:format => :html).strip
18
+ actual_output = log.io.string.strip
19
+ actual_output.should_not eq(formatted_output)
20
+ actual_output.should include(formatted_output)
21
+ end
22
+
23
+ it "wraps output with --layout onefile" do
24
+ YARD::CLI::Display.run('--layout', 'onefile', '-f', 'html', 'Foo')
25
+ formatted_output = @object.format(:format => :html).strip
26
+ actual_output = log.io.string.strip
27
+ actual_output.should_not eq(formatted_output)
28
+ actual_output.should include(formatted_output)
29
+ end
30
+ end
@@ -0,0 +1,81 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+ require 'ostruct'
3
+ require 'rubygems'
4
+
5
+ describe YARD::CLI::Gems do
6
+ before do
7
+ @rebuild = false
8
+ @gem1 = build_mock('gem1')
9
+ @gem2 = build_mock('gem2')
10
+ @gem3 = build_mock('gem3')
11
+ end
12
+
13
+ def build_mock(name, version = '1.0')
14
+ OpenStruct.new :name => name,
15
+ :version => version,
16
+ :full_gem_path => "/path/to/gems/#{name}-#{version}",
17
+ :yardoc_file => "/path/to/yardoc/#{name}-#{version}"
18
+ end
19
+
20
+ def build_specs(*specs)
21
+ specs.each do |themock|
22
+ Registry.should_receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}").and_return(themock.yardoc_file)
23
+ File.should_receive(:directory?).with(themock.yardoc_file).and_return(@rebuild)
24
+ File.should_receive(:directory?).with(themock.full_gem_path).and_return(true)
25
+ Registry.should_receive(:yardoc_file_for_gem).with(themock.name, "= #{themock.version}", true).and_return(themock.yardoc_file)
26
+ Dir.should_receive(:chdir).with(themock.full_gem_path)
27
+ end
28
+ Registry.should_receive(:clear).exactly(specs.size).times
29
+ CLI::Yardoc.should_receive(:run).exactly(specs.size).times
30
+ end
31
+
32
+ describe '#run' do
33
+ it "should build all gem indexes if no gem is specified" do
34
+ build_specs(@gem1, @gem2)
35
+ Gem.source_index.should_receive(:find_name).with('').and_return([@gem1, @gem2])
36
+ CLI::Gems.run
37
+ end
38
+
39
+ it "should allow gem to be specified" do
40
+ build_specs(@gem1)
41
+ Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 0').and_return([@gem1])
42
+ CLI::Gems.run(@gem1.name)
43
+ end
44
+
45
+ it "should allow multiple gems to be specified for building" do
46
+ build_specs(@gem1, @gem2)
47
+ Gem.source_index.should_receive(:find_name).with(@gem1.name, @gem1.version).and_return([@gem1])
48
+ Gem.source_index.should_receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
49
+ CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
50
+ end
51
+
52
+ it "should allow version to be specified with gem" do
53
+ build_specs(@gem1)
54
+ Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
55
+ CLI::Gems.run(@gem1.name, '>= 1.0')
56
+ end
57
+
58
+ it "should warn if one of the gems is not found, but it should process others" do
59
+ build_specs(@gem2)
60
+ Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
61
+ Gem.source_index.should_receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
62
+ log.should_receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
63
+ CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
64
+ end
65
+
66
+ it "should fail if specified gem(s) is/are not found" do
67
+ CLI::Yardoc.should_not_receive(:run)
68
+ Gem.source_index.should_receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
69
+ log.should_receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
70
+ log.should_receive(:error).with(/No specified gems could be found/)
71
+ CLI::Gems.run(@gem1.name, '>= 2.0')
72
+ end
73
+
74
+ it "should accept --rebuild" do
75
+ @rebuild = true
76
+ build_specs(@gem1)
77
+ Gem.source_index.should_receive(:find_name).with('').and_return([@gem1])
78
+ CLI::Gems.run('--rebuild')
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,17 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe YARD::CLI::Graph do
4
+ it "should serialize output" do
5
+ Registry.should_receive(:load).at_least(1).times
6
+ subject.stub(:yardopts) { [] }
7
+ subject.options.serializer.should_receive(:serialize).once
8
+ subject.run
9
+ end
10
+
11
+ it 'should read yardoc file from .yardopts' do
12
+ subject.stub(:yardopts) { %w(--db /path/to/db) }
13
+ subject.options.serializer.should_receive(:serialize).once
14
+ subject.run
15
+ Registry.yardoc_file.should == '/path/to/db'
16
+ end
17
+ end
@@ -0,0 +1,22 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe YARD::CLI::Help do
4
+ describe '#run' do
5
+ it "should accept 'help command'" do
6
+ CLI::Yardoc.should_receive(:run).with('--help')
7
+ CLI::Help.run('doc')
8
+ end
9
+
10
+ it "should accept no arguments (lists all commands)" do
11
+ CLI::CommandParser.should_receive(:run).with('--help')
12
+ CLI::Help.run
13
+ end
14
+
15
+ it "should show all commands if command isn't found" do
16
+ CLI::CommandParser.should_receive(:run).with('--help')
17
+ help = CLI::Help.new
18
+ log.should_receive(:puts).with(/not found/)
19
+ help.run('unknown')
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,111 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe YARD::CLI::I18n do
4
+ before do
5
+ @i18n = YARD::CLI::I18n.new
6
+ @i18n.use_document_file = false
7
+ @i18n.use_yardopts_file = false
8
+ output_path = File.expand_path(@i18n.options.serializer.basepath)
9
+ File.stub!(:open!).with(output_path, "wb")
10
+ YARD.stub!(:parse)
11
+ end
12
+
13
+ describe 'Defaults' do
14
+ before do
15
+ @i18n = YARD::CLI::I18n.new
16
+ @i18n.stub!(:yardopts).and_return([])
17
+ @i18n.stub!(:support_rdoc_document_file!).and_return([])
18
+ @i18n.parse_arguments
19
+ end
20
+
21
+ it "should read .yardopts by default" do
22
+ @i18n.use_yardopts_file.should == true
23
+ end
24
+
25
+ it "should use {lib,app}/**/*.rb and ext/**/*.c as default file glob" do
26
+ @i18n.files.should == ['{lib,app}/**/*.rb', 'ext/**/*.c']
27
+ end
28
+
29
+ it "should only show public visibility by default" do
30
+ @i18n.visibilities.should == [:public]
31
+ end
32
+ end
33
+
34
+ describe 'General options' do
35
+ def self.should_accept(*args, &block)
36
+ @counter ||= 0
37
+ @counter += 1
38
+ counter = @counter
39
+ args.each do |arg|
40
+ define_method("test_options_#{@counter}", &block)
41
+ it("should accept #{arg}") { send("test_options_#{counter}", arg) }
42
+ end
43
+ end
44
+
45
+ should_accept('--yardopts') do |arg|
46
+ @i18n = YARD::CLI::I18n.new
47
+ @i18n.use_document_file = false
48
+ @i18n.should_receive(:yardopts).at_least(1).times.and_return([])
49
+ @i18n.parse_arguments(arg)
50
+ @i18n.use_yardopts_file.should == true
51
+ @i18n.parse_arguments('--no-yardopts', arg)
52
+ @i18n.use_yardopts_file.should == true
53
+ end
54
+
55
+ should_accept('--yardopts with filename') do |arg|
56
+ @i18n = YARD::CLI::I18n.new
57
+ File.should_receive(:read_binary).with('.yardopts_i18n').and_return('')
58
+ @i18n.use_document_file = false
59
+ @i18n.parse_arguments('--yardopts', '.yardopts_i18n')
60
+ @i18n.use_yardopts_file.should == true
61
+ @i18n.options_file.should == '.yardopts_i18n'
62
+ end
63
+
64
+ should_accept('--no-yardopts') do |arg|
65
+ @i18n = YARD::CLI::I18n.new
66
+ @i18n.use_document_file = false
67
+ @i18n.should_not_receive(:yardopts)
68
+ @i18n.parse_arguments(arg)
69
+ @i18n.use_yardopts_file.should == false
70
+ @i18n.parse_arguments('--yardopts', arg)
71
+ @i18n.use_yardopts_file.should == false
72
+ end
73
+
74
+ should_accept('--exclude') do |arg|
75
+ YARD.should_receive(:parse).with(['a'], ['nota', 'b'])
76
+ @i18n.run(arg, 'nota', arg, 'b', 'a')
77
+ end
78
+ end
79
+
80
+ describe '.yardopts handling' do
81
+ before do
82
+ @i18n.use_yardopts_file = true
83
+ end
84
+
85
+ it "should search for and use yardopts file specified by #options_file" do
86
+ File.should_receive(:read_binary).with("test").and_return("-o \n\nMYPATH\nFILE1 FILE2")
87
+ @i18n.use_document_file = false
88
+ @i18n.options_file = "test"
89
+ File.should_receive(:open!).with(File.expand_path("MYPATH"), "wb")
90
+ @i18n.run
91
+ @i18n.files.should == ["FILE1", "FILE2"]
92
+ end
93
+ end
94
+
95
+ describe '#run' do
96
+ it "should parse_arguments if run() is called" do
97
+ @i18n.should_receive(:parse_arguments)
98
+ @i18n.run
99
+ end
100
+
101
+ it "should parse_arguments if run(arg1, arg2, ...) is called" do
102
+ @i18n.should_receive(:parse_arguments)
103
+ @i18n.run('--private', '-p', 'foo')
104
+ end
105
+
106
+ it "should not parse_arguments if run(nil) is called" do
107
+ @i18n.should_not_receive(:parse_arguments)
108
+ @i18n.run(nil)
109
+ end
110
+ end
111
+ end