kinetic_sdk 5.0.18 → 5.0.20

Sign up to get free protection for your applications and to get access to all the features.
Files changed (667) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -1
  3. data/README.md +1 -1
  4. data/gems/{mime-types-3.1/Code-of-Conduct.rdoc → mime-types-3.4.1/Code-of-Conduct.md} +29 -30
  5. data/gems/mime-types-3.4.1/Contributing.md +132 -0
  6. data/gems/mime-types-3.4.1/History.md +269 -0
  7. data/gems/{mime-types-3.1/Licence.rdoc → mime-types-3.4.1/Licence.md} +3 -3
  8. data/gems/{mime-types-3.1 → mime-types-3.4.1}/Manifest.txt +4 -4
  9. data/gems/{mime-types-3.1 → mime-types-3.4.1}/README.rdoc +6 -14
  10. data/gems/mime-types-3.4.1/Rakefile +270 -0
  11. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/type/columnar.rb +6 -4
  12. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/type.rb +162 -101
  13. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/_columnar.rb +22 -20
  14. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/cache.rb +13 -11
  15. data/gems/mime-types-3.4.1/lib/mime/types/columnar.rb +3 -0
  16. data/gems/mime-types-3.4.1/lib/mime/types/container.rb +96 -0
  17. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/deprecations.rb +17 -13
  18. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/full.rb +4 -2
  19. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/loader.rb +29 -18
  20. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/logger.rb +5 -5
  21. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/registry.rb +14 -5
  22. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types.rb +26 -21
  23. data/gems/mime-types-3.4.1/lib/mime-types.rb +3 -0
  24. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/bad-fixtures/malformed +0 -0
  25. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/fixture/json.json +0 -0
  26. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/fixture/old-data +0 -0
  27. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/fixture/yaml.yaml +0 -0
  28. data/gems/mime-types-3.4.1/test/minitest_helper.rb +11 -0
  29. data/gems/mime-types-3.4.1/test/test_mime_type.rb +621 -0
  30. data/gems/mime-types-3.4.1/test/test_mime_types.rb +169 -0
  31. data/gems/mime-types-3.4.1/test/test_mime_types_cache.rb +118 -0
  32. data/gems/mime-types-3.4.1/test/test_mime_types_class.rb +159 -0
  33. data/gems/mime-types-3.4.1/test/test_mime_types_lazy.rb +49 -0
  34. data/gems/mime-types-3.4.1/test/test_mime_types_loader.rb +32 -0
  35. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/Code-of-Conduct.md +22 -22
  36. data/gems/mime-types-data-3.2022.0105/Contributing.md +241 -0
  37. data/gems/mime-types-data-3.2022.0105/History.md +502 -0
  38. data/gems/{websocket-driver-0.6.5-java/LICENSE.md → mime-types-data-3.2022.0105/Licence.md} +7 -5
  39. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/Manifest.txt +16 -0
  40. data/gems/mime-types-data-3.2022.0105/README.md +73 -0
  41. data/gems/mime-types-data-3.2022.0105/Rakefile +155 -0
  42. data/gems/mime-types-data-3.2022.0105/data/content_type_mime.db +878 -0
  43. data/gems/mime-types-data-3.2022.0105/data/ext_mime.db +1198 -0
  44. data/gems/mime-types-data-3.2022.0105/data/mime-types.json +1 -0
  45. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.content_type.column +432 -13
  46. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.docs.column +419 -0
  47. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.encoding.column +419 -0
  48. data/gems/mime-types-data-3.2022.0105/data/mime.flags.column +2383 -0
  49. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.friendly.column +419 -0
  50. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.pext.column +419 -0
  51. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.use_instead.column +420 -1
  52. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.xrefs.column +567 -148
  53. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/lib/mime/types/data.rb +2 -2
  54. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/lib/mime-types-data.rb +1 -1
  55. data/gems/mime-types-data-3.2022.0105/types/application.yaml +17299 -0
  56. data/gems/mime-types-data-3.2022.0105/types/audio.yaml +1716 -0
  57. data/gems/mime-types-data-3.2022.0105/types/chemical.yaml +71 -0
  58. data/gems/mime-types-data-3.2022.0105/types/conference.yaml +9 -0
  59. data/gems/mime-types-data-3.2022.0105/types/drawing.yaml +15 -0
  60. data/gems/mime-types-data-3.2022.0105/types/font.yaml +65 -0
  61. data/gems/mime-types-data-3.2022.0105/types/image.yaml +1252 -0
  62. data/gems/mime-types-data-3.2022.0105/types/message.yaml +205 -0
  63. data/gems/mime-types-data-3.2022.0105/types/model.yaml +390 -0
  64. data/gems/mime-types-data-3.2022.0105/types/multipart.yaml +179 -0
  65. data/gems/mime-types-data-3.2022.0105/types/provisional-standard-types.yaml +145 -0
  66. data/gems/mime-types-data-3.2022.0105/types/text.yaml +1166 -0
  67. data/gems/mime-types-data-3.2022.0105/types/video.yaml +1121 -0
  68. data/gems/mime-types-data-3.2022.0105/types/world.yaml +8 -0
  69. data/gems/rake-13.0.1/CONTRIBUTING.rdoc +43 -0
  70. data/gems/rake-13.0.1/Gemfile +10 -0
  71. data/gems/rake-13.0.1/History.rdoc +2368 -0
  72. data/gems/{parallel-1.12.1/MIT-LICENSE.txt → rake-13.0.1/MIT-LICENSE} +2 -1
  73. data/gems/rake-13.0.1/README.rdoc +155 -0
  74. data/gems/rake-13.0.1/Rakefile +41 -0
  75. data/gems/rake-13.0.1/bin/bundle +105 -0
  76. data/gems/rake-13.0.1/bin/console +7 -0
  77. data/gems/rake-13.0.1/bin/rake +29 -0
  78. data/gems/rake-13.0.1/bin/rdoc +29 -0
  79. data/gems/rake-13.0.1/bin/rubocop +29 -0
  80. data/gems/rake-13.0.1/bin/setup +6 -0
  81. data/gems/rake-13.0.1/doc/command_line_usage.rdoc +158 -0
  82. data/gems/rake-13.0.1/doc/example/Rakefile1 +38 -0
  83. data/gems/rake-13.0.1/doc/example/Rakefile2 +35 -0
  84. data/gems/rake-13.0.1/doc/example/a.c +6 -0
  85. data/gems/rake-13.0.1/doc/example/b.c +6 -0
  86. data/gems/rake-13.0.1/doc/example/main.c +11 -0
  87. data/gems/rake-13.0.1/doc/glossary.rdoc +42 -0
  88. data/gems/rake-13.0.1/doc/jamis.rb +592 -0
  89. data/gems/rake-13.0.1/doc/proto_rake.rdoc +127 -0
  90. data/gems/rake-13.0.1/doc/rake.1 +156 -0
  91. data/gems/rake-13.0.1/doc/rakefile.rdoc +622 -0
  92. data/gems/rake-13.0.1/doc/rational.rdoc +151 -0
  93. data/gems/rake-13.0.1/exe/rake +27 -0
  94. data/gems/rake-13.0.1/lib/rake/application.rb +824 -0
  95. data/gems/rake-13.0.1/lib/rake/backtrace.rb +24 -0
  96. data/gems/rake-13.0.1/lib/rake/clean.rb +78 -0
  97. data/gems/rake-13.0.1/lib/rake/cloneable.rb +17 -0
  98. data/gems/rake-13.0.1/lib/rake/cpu_counter.rb +107 -0
  99. data/gems/rake-13.0.1/lib/rake/default_loader.rb +15 -0
  100. data/gems/rake-13.0.1/lib/rake/dsl_definition.rb +195 -0
  101. data/gems/rake-13.0.1/lib/rake/early_time.rb +22 -0
  102. data/gems/rake-13.0.1/lib/rake/ext/core.rb +26 -0
  103. data/gems/rake-13.0.1/lib/rake/ext/string.rb +176 -0
  104. data/gems/rake-13.0.1/lib/rake/file_creation_task.rb +25 -0
  105. data/gems/rake-13.0.1/lib/rake/file_list.rb +435 -0
  106. data/gems/rake-13.0.1/lib/rake/file_task.rb +54 -0
  107. data/gems/rake-13.0.1/lib/rake/file_utils.rb +134 -0
  108. data/gems/rake-13.0.1/lib/rake/file_utils_ext.rb +134 -0
  109. data/gems/rake-13.0.1/lib/rake/invocation_chain.rb +57 -0
  110. data/gems/rake-13.0.1/lib/rake/invocation_exception_mixin.rb +17 -0
  111. data/gems/rake-13.0.1/lib/rake/late_time.rb +18 -0
  112. data/gems/rake-13.0.1/lib/rake/linked_list.rb +112 -0
  113. data/gems/rake-13.0.1/lib/rake/loaders/makefile.rb +54 -0
  114. data/gems/rake-13.0.1/lib/rake/multi_task.rb +14 -0
  115. data/gems/rake-13.0.1/lib/rake/name_space.rb +38 -0
  116. data/gems/rake-13.0.1/lib/rake/packagetask.rb +222 -0
  117. data/gems/rake-13.0.1/lib/rake/phony.rb +16 -0
  118. data/gems/rake-13.0.1/lib/rake/private_reader.rb +21 -0
  119. data/gems/rake-13.0.1/lib/rake/promise.rb +100 -0
  120. data/gems/rake-13.0.1/lib/rake/pseudo_status.rb +30 -0
  121. data/gems/rake-13.0.1/lib/rake/rake_module.rb +67 -0
  122. data/gems/rake-13.0.1/lib/rake/rake_test_loader.rb +27 -0
  123. data/gems/rake-13.0.1/lib/rake/rule_recursion_overflow_error.rb +20 -0
  124. data/gems/rake-13.0.1/lib/rake/scope.rb +43 -0
  125. data/gems/rake-13.0.1/lib/rake/task.rb +434 -0
  126. data/gems/rake-13.0.1/lib/rake/task_argument_error.rb +8 -0
  127. data/gems/rake-13.0.1/lib/rake/task_arguments.rb +109 -0
  128. data/gems/rake-13.0.1/lib/rake/task_manager.rb +331 -0
  129. data/gems/rake-13.0.1/lib/rake/tasklib.rb +12 -0
  130. data/gems/rake-13.0.1/lib/rake/testtask.rb +224 -0
  131. data/gems/rake-13.0.1/lib/rake/thread_history_display.rb +49 -0
  132. data/gems/rake-13.0.1/lib/rake/thread_pool.rb +163 -0
  133. data/gems/rake-13.0.1/lib/rake/trace_output.rb +23 -0
  134. data/gems/rake-13.0.1/lib/rake/version.rb +10 -0
  135. data/gems/rake-13.0.1/lib/rake/win32.rb +51 -0
  136. data/gems/rake-13.0.1/lib/rake.rb +71 -0
  137. data/gems/rake-13.0.1/rake.gemspec +43 -0
  138. data/gems/yard-0.9.25/CHANGELOG.md +804 -0
  139. data/gems/yard-0.9.25/CODE_OF_CONDUCT.md +15 -0
  140. data/gems/yard-0.9.25/CONTRIBUTING.md +140 -0
  141. data/gems/yard-0.9.25/Dockerfile.samus +28 -0
  142. data/gems/yard-0.9.25/Gemfile +32 -0
  143. data/gems/yard-0.9.25/LEGAL +66 -0
  144. data/gems/yard-0.9.25/LICENSE +22 -0
  145. data/gems/yard-0.9.25/README.md +325 -0
  146. data/gems/yard-0.9.25/Rakefile +39 -0
  147. data/gems/yard-0.9.25/SECURITY.md +26 -0
  148. data/gems/yard-0.9.25/benchmarks/builtins_vs_eval.rb +24 -0
  149. data/gems/yard-0.9.25/benchmarks/concat_vs_join.rb +13 -0
  150. data/gems/yard-0.9.25/benchmarks/erb_vs_erubis.rb +54 -0
  151. data/gems/yard-0.9.25/benchmarks/format_args.rb +47 -0
  152. data/gems/yard-0.9.25/benchmarks/generation.rb +38 -0
  153. data/gems/yard-0.9.25/benchmarks/marshal_vs_dbm.rb +64 -0
  154. data/gems/yard-0.9.25/benchmarks/parsing.rb +46 -0
  155. data/gems/yard-0.9.25/benchmarks/pathname_vs_string.rb +51 -0
  156. data/gems/yard-0.9.25/benchmarks/rdoc_vs_yardoc.rb +11 -0
  157. data/gems/yard-0.9.25/benchmarks/registry_store_types.rb +49 -0
  158. data/gems/yard-0.9.25/benchmarks/ri_vs_yri.rb +19 -0
  159. data/gems/yard-0.9.25/benchmarks/ripper_parser.rb +13 -0
  160. data/gems/yard-0.9.25/benchmarks/splat_vs_flatten.rb +13 -0
  161. data/gems/yard-0.9.25/benchmarks/template_erb.rb +23 -0
  162. data/gems/yard-0.9.25/benchmarks/template_format.rb +7 -0
  163. data/gems/yard-0.9.25/benchmarks/template_profile.rb +18 -0
  164. data/gems/yard-0.9.25/benchmarks/yri_cache.rb +20 -0
  165. data/gems/yard-0.9.25/bin/yard +13 -0
  166. data/gems/yard-0.9.25/bin/yardoc +13 -0
  167. data/gems/yard-0.9.25/bin/yri +13 -0
  168. data/gems/yard-0.9.25/docs/CodeObjects.md +115 -0
  169. data/gems/yard-0.9.25/docs/GettingStarted.md +679 -0
  170. data/gems/yard-0.9.25/docs/Handlers.md +152 -0
  171. data/gems/yard-0.9.25/docs/Overview.md +61 -0
  172. data/gems/yard-0.9.25/docs/Parser.md +191 -0
  173. data/gems/yard-0.9.25/docs/Tags.md +283 -0
  174. data/gems/yard-0.9.25/docs/TagsArch.md +123 -0
  175. data/gems/yard-0.9.25/docs/Templates.md +496 -0
  176. data/gems/yard-0.9.25/docs/WhatsNew.md +1245 -0
  177. data/gems/yard-0.9.25/docs/images/code-objects-class-diagram.png +0 -0
  178. data/gems/yard-0.9.25/docs/images/handlers-class-diagram.png +0 -0
  179. data/gems/yard-0.9.25/docs/images/overview-class-diagram.png +0 -0
  180. data/gems/yard-0.9.25/docs/images/parser-class-diagram.png +0 -0
  181. data/gems/yard-0.9.25/docs/images/tags-class-diagram.png +0 -0
  182. data/gems/yard-0.9.25/docs/templates/default/fulldoc/html/full_list_tag.erb +9 -0
  183. data/gems/yard-0.9.25/docs/templates/default/fulldoc/html/setup.rb +6 -0
  184. data/gems/yard-0.9.25/docs/templates/default/layout/html/setup.rb +9 -0
  185. data/gems/yard-0.9.25/docs/templates/default/layout/html/tag_list.erb +11 -0
  186. data/gems/yard-0.9.25/docs/templates/default/yard_tags/html/list.erb +18 -0
  187. data/gems/yard-0.9.25/docs/templates/default/yard_tags/html/setup.rb +26 -0
  188. data/gems/yard-0.9.25/docs/templates/plugin.rb +70 -0
  189. data/gems/yard-0.9.25/lib/rubygems_plugin.rb +9 -0
  190. data/gems/yard-0.9.25/lib/yard/autoload.rb +308 -0
  191. data/gems/yard-0.9.25/lib/yard/cli/command.rb +85 -0
  192. data/gems/yard-0.9.25/lib/yard/cli/command_parser.rb +93 -0
  193. data/gems/yard-0.9.25/lib/yard/cli/config.rb +198 -0
  194. data/gems/yard-0.9.25/lib/yard/cli/diff.rb +273 -0
  195. data/gems/yard-0.9.25/lib/yard/cli/display.rb +69 -0
  196. data/gems/yard-0.9.25/lib/yard/cli/gems.rb +84 -0
  197. data/gems/yard-0.9.25/lib/yard/cli/graph.rb +125 -0
  198. data/gems/yard-0.9.25/lib/yard/cli/help.rb +20 -0
  199. data/gems/yard-0.9.25/lib/yard/cli/i18n.rb +70 -0
  200. data/gems/yard-0.9.25/lib/yard/cli/list.rb +23 -0
  201. data/gems/yard-0.9.25/lib/yard/cli/markup_types.rb +32 -0
  202. data/gems/yard-0.9.25/lib/yard/cli/server.rb +266 -0
  203. data/gems/yard-0.9.25/lib/yard/cli/stats.rb +231 -0
  204. data/gems/yard-0.9.25/lib/yard/cli/yardoc.rb +789 -0
  205. data/gems/yard-0.9.25/lib/yard/cli/yardopts_command.rb +110 -0
  206. data/gems/yard-0.9.25/lib/yard/cli/yri.rb +215 -0
  207. data/gems/yard-0.9.25/lib/yard/code_objects/base.rb +622 -0
  208. data/gems/yard-0.9.25/lib/yard/code_objects/class_object.rb +146 -0
  209. data/gems/yard-0.9.25/lib/yard/code_objects/class_variable_object.rb +11 -0
  210. data/gems/yard-0.9.25/lib/yard/code_objects/constant_object.rb +16 -0
  211. data/gems/yard-0.9.25/lib/yard/code_objects/extended_method_object.rb +24 -0
  212. data/gems/yard-0.9.25/lib/yard/code_objects/extra_file_object.rb +134 -0
  213. data/gems/yard-0.9.25/lib/yard/code_objects/macro_object.rb +172 -0
  214. data/gems/yard-0.9.25/lib/yard/code_objects/method_object.rb +196 -0
  215. data/gems/yard-0.9.25/lib/yard/code_objects/module_object.rb +21 -0
  216. data/gems/yard-0.9.25/lib/yard/code_objects/namespace_mapper.rb +141 -0
  217. data/gems/yard-0.9.25/lib/yard/code_objects/namespace_object.rb +200 -0
  218. data/gems/yard-0.9.25/lib/yard/code_objects/proxy.rb +245 -0
  219. data/gems/yard-0.9.25/lib/yard/code_objects/root_object.rb +19 -0
  220. data/gems/yard-0.9.25/lib/yard/config.rb +270 -0
  221. data/gems/yard-0.9.25/lib/yard/core_ext/array.rb +16 -0
  222. data/gems/yard-0.9.25/lib/yard/core_ext/file.rb +69 -0
  223. data/gems/yard-0.9.25/lib/yard/core_ext/hash.rb +16 -0
  224. data/gems/yard-0.9.25/lib/yard/core_ext/insertion.rb +63 -0
  225. data/gems/yard-0.9.25/lib/yard/core_ext/module.rb +11 -0
  226. data/gems/yard-0.9.25/lib/yard/core_ext/string.rb +68 -0
  227. data/gems/yard-0.9.25/lib/yard/core_ext/symbol_hash.rb +75 -0
  228. data/gems/yard-0.9.25/lib/yard/docstring.rb +386 -0
  229. data/gems/yard-0.9.25/lib/yard/docstring_parser.rb +345 -0
  230. data/gems/yard-0.9.25/lib/yard/gem_index.rb +29 -0
  231. data/gems/yard-0.9.25/lib/yard/globals.rb +22 -0
  232. data/gems/yard-0.9.25/lib/yard/handlers/base.rb +595 -0
  233. data/gems/yard-0.9.25/lib/yard/handlers/c/alias_handler.rb +16 -0
  234. data/gems/yard-0.9.25/lib/yard/handlers/c/attribute_handler.rb +13 -0
  235. data/gems/yard-0.9.25/lib/yard/handlers/c/base.rb +164 -0
  236. data/gems/yard-0.9.25/lib/yard/handlers/c/class_handler.rb +27 -0
  237. data/gems/yard-0.9.25/lib/yard/handlers/c/constant_handler.rb +13 -0
  238. data/gems/yard-0.9.25/lib/yard/handlers/c/handler_methods.rb +212 -0
  239. data/gems/yard-0.9.25/lib/yard/handlers/c/init_handler.rb +20 -0
  240. data/gems/yard-0.9.25/lib/yard/handlers/c/method_handler.rb +45 -0
  241. data/gems/yard-0.9.25/lib/yard/handlers/c/mixin_handler.rb +21 -0
  242. data/gems/yard-0.9.25/lib/yard/handlers/c/module_handler.rb +17 -0
  243. data/gems/yard-0.9.25/lib/yard/handlers/c/override_comment_handler.rb +31 -0
  244. data/gems/yard-0.9.25/lib/yard/handlers/c/path_handler.rb +11 -0
  245. data/gems/yard-0.9.25/lib/yard/handlers/c/struct_handler.rb +13 -0
  246. data/gems/yard-0.9.25/lib/yard/handlers/c/symbol_handler.rb +8 -0
  247. data/gems/yard-0.9.25/lib/yard/handlers/common/method_handler.rb +19 -0
  248. data/gems/yard-0.9.25/lib/yard/handlers/processor.rb +200 -0
  249. data/gems/yard-0.9.25/lib/yard/handlers/ruby/alias_handler.rb +45 -0
  250. data/gems/yard-0.9.25/lib/yard/handlers/ruby/attribute_handler.rb +87 -0
  251. data/gems/yard-0.9.25/lib/yard/handlers/ruby/base.rb +165 -0
  252. data/gems/yard-0.9.25/lib/yard/handlers/ruby/class_condition_handler.rb +92 -0
  253. data/gems/yard-0.9.25/lib/yard/handlers/ruby/class_handler.rb +119 -0
  254. data/gems/yard-0.9.25/lib/yard/handlers/ruby/class_variable_handler.rb +17 -0
  255. data/gems/yard-0.9.25/lib/yard/handlers/ruby/comment_handler.rb +10 -0
  256. data/gems/yard-0.9.25/lib/yard/handlers/ruby/constant_handler.rb +55 -0
  257. data/gems/yard-0.9.25/lib/yard/handlers/ruby/decorator_handler_methods.rb +123 -0
  258. data/gems/yard-0.9.25/lib/yard/handlers/ruby/dsl_handler.rb +15 -0
  259. data/gems/yard-0.9.25/lib/yard/handlers/ruby/dsl_handler_methods.rb +96 -0
  260. data/gems/yard-0.9.25/lib/yard/handlers/ruby/exception_handler.rb +27 -0
  261. data/gems/yard-0.9.25/lib/yard/handlers/ruby/extend_handler.rb +22 -0
  262. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/alias_handler.rb +37 -0
  263. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/attribute_handler.rb +65 -0
  264. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/base.rb +245 -0
  265. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -0
  266. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_handler.rb +113 -0
  267. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +15 -0
  268. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/comment_handler.rb +10 -0
  269. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/constant_handler.rb +29 -0
  270. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/dsl_handler.rb +17 -0
  271. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/exception_handler.rb +13 -0
  272. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/extend_handler.rb +21 -0
  273. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/method_handler.rb +90 -0
  274. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -0
  275. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/module_function_handler.rb +19 -0
  276. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/module_handler.rb +12 -0
  277. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +22 -0
  278. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +22 -0
  279. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/visibility_handler.rb +17 -0
  280. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/yield_handler.rb +29 -0
  281. data/gems/yard-0.9.25/lib/yard/handlers/ruby/method_condition_handler.rb +9 -0
  282. data/gems/yard-0.9.25/lib/yard/handlers/ruby/method_handler.rb +104 -0
  283. data/gems/yard-0.9.25/lib/yard/handlers/ruby/mixin_handler.rb +49 -0
  284. data/gems/yard-0.9.25/lib/yard/handlers/ruby/module_function_handler.rb +27 -0
  285. data/gems/yard-0.9.25/lib/yard/handlers/ruby/module_handler.rb +12 -0
  286. data/gems/yard-0.9.25/lib/yard/handlers/ruby/private_class_method_handler.rb +14 -0
  287. data/gems/yard-0.9.25/lib/yard/handlers/ruby/private_constant_handler.rb +43 -0
  288. data/gems/yard-0.9.25/lib/yard/handlers/ruby/public_class_method_handler.rb +14 -0
  289. data/gems/yard-0.9.25/lib/yard/handlers/ruby/struct_handler_methods.rb +143 -0
  290. data/gems/yard-0.9.25/lib/yard/handlers/ruby/visibility_handler.rb +22 -0
  291. data/gems/yard-0.9.25/lib/yard/handlers/ruby/yield_handler.rb +31 -0
  292. data/gems/yard-0.9.25/lib/yard/i18n/locale.rb +67 -0
  293. data/gems/yard-0.9.25/lib/yard/i18n/message.rb +57 -0
  294. data/gems/yard-0.9.25/lib/yard/i18n/messages.rb +56 -0
  295. data/gems/yard-0.9.25/lib/yard/i18n/po_parser.rb +61 -0
  296. data/gems/yard-0.9.25/lib/yard/i18n/pot_generator.rb +290 -0
  297. data/gems/yard-0.9.25/lib/yard/i18n/text.rb +173 -0
  298. data/gems/yard-0.9.25/lib/yard/logging.rb +205 -0
  299. data/gems/yard-0.9.25/lib/yard/options.rb +217 -0
  300. data/gems/yard-0.9.25/lib/yard/parser/base.rb +57 -0
  301. data/gems/yard-0.9.25/lib/yard/parser/c/c_parser.rb +235 -0
  302. data/gems/yard-0.9.25/lib/yard/parser/c/comment_parser.rb +134 -0
  303. data/gems/yard-0.9.25/lib/yard/parser/c/statement.rb +66 -0
  304. data/gems/yard-0.9.25/lib/yard/parser/ruby/ast_node.rb +551 -0
  305. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/irb/slex.rb +276 -0
  306. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/ruby_lex.rb +1345 -0
  307. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/ruby_parser.rb +32 -0
  308. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/statement.rb +68 -0
  309. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/statement_list.rb +394 -0
  310. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/token_list.rb +74 -0
  311. data/gems/yard-0.9.25/lib/yard/parser/ruby/ruby_parser.rb +701 -0
  312. data/gems/yard-0.9.25/lib/yard/parser/ruby/token_resolver.rb +158 -0
  313. data/gems/yard-0.9.25/lib/yard/parser/source_parser.rb +526 -0
  314. data/gems/yard-0.9.25/lib/yard/rake/yardoc_task.rb +81 -0
  315. data/gems/yard-0.9.25/lib/yard/registry.rb +439 -0
  316. data/gems/yard-0.9.25/lib/yard/registry_resolver.rb +217 -0
  317. data/gems/yard-0.9.25/lib/yard/registry_store.rb +342 -0
  318. data/gems/yard-0.9.25/lib/yard/rubygems/backports/LICENSE.txt +57 -0
  319. data/gems/yard-0.9.25/lib/yard/rubygems/backports/MIT.txt +20 -0
  320. data/gems/yard-0.9.25/lib/yard/rubygems/backports/gem.rb +10 -0
  321. data/gems/yard-0.9.25/lib/yard/rubygems/backports/source_index.rb +365 -0
  322. data/gems/yard-0.9.25/lib/yard/rubygems/backports.rb +10 -0
  323. data/gems/yard-0.9.25/lib/yard/rubygems/doc_manager.rb +90 -0
  324. data/gems/yard-0.9.25/lib/yard/rubygems/hook.rb +197 -0
  325. data/gems/yard-0.9.25/lib/yard/rubygems/specification.rb +50 -0
  326. data/gems/yard-0.9.25/lib/yard/serializers/base.rb +83 -0
  327. data/gems/yard-0.9.25/lib/yard/serializers/file_system_serializer.rb +123 -0
  328. data/gems/yard-0.9.25/lib/yard/serializers/process_serializer.rb +24 -0
  329. data/gems/yard-0.9.25/lib/yard/serializers/stdout_serializer.rb +34 -0
  330. data/gems/yard-0.9.25/lib/yard/serializers/yardoc_serializer.rb +152 -0
  331. data/gems/yard-0.9.25/lib/yard/server/adapter.rb +100 -0
  332. data/gems/yard-0.9.25/lib/yard/server/commands/base.rb +209 -0
  333. data/gems/yard-0.9.25/lib/yard/server/commands/display_file_command.rb +29 -0
  334. data/gems/yard-0.9.25/lib/yard/server/commands/display_object_command.rb +65 -0
  335. data/gems/yard-0.9.25/lib/yard/server/commands/frames_command.rb +16 -0
  336. data/gems/yard-0.9.25/lib/yard/server/commands/library_command.rb +187 -0
  337. data/gems/yard-0.9.25/lib/yard/server/commands/library_index_command.rb +28 -0
  338. data/gems/yard-0.9.25/lib/yard/server/commands/list_command.rb +25 -0
  339. data/gems/yard-0.9.25/lib/yard/server/commands/root_request_command.rb +15 -0
  340. data/gems/yard-0.9.25/lib/yard/server/commands/search_command.rb +79 -0
  341. data/gems/yard-0.9.25/lib/yard/server/commands/static_file_command.rb +23 -0
  342. data/gems/yard-0.9.25/lib/yard/server/commands/static_file_helpers.rb +61 -0
  343. data/gems/yard-0.9.25/lib/yard/server/doc_server_helper.rb +91 -0
  344. data/gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb +39 -0
  345. data/gems/yard-0.9.25/lib/yard/server/library_version.rb +277 -0
  346. data/gems/yard-0.9.25/lib/yard/server/rack_adapter.rb +89 -0
  347. data/gems/yard-0.9.25/lib/yard/server/router.rb +187 -0
  348. data/gems/yard-0.9.25/lib/yard/server/static_caching.rb +46 -0
  349. data/gems/yard-0.9.25/lib/yard/server/templates/default/fulldoc/html/css/custom.css +127 -0
  350. data/gems/yard-0.9.25/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
  351. data/gems/yard-0.9.25/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +12 -0
  352. data/gems/yard-0.9.25/lib/yard/server/templates/default/layout/html/breadcrumb.erb +37 -0
  353. data/gems/yard-0.9.25/lib/yard/server/templates/default/layout/html/script_setup.erb +7 -0
  354. data/gems/yard-0.9.25/lib/yard/server/templates/default/layout/html/setup.rb +8 -0
  355. data/gems/yard-0.9.25/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -0
  356. data/gems/yard-0.9.25/lib/yard/server/templates/default/method_details/html/setup.rb +5 -0
  357. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/headers.erb +8 -0
  358. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +14 -0
  359. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/listing.erb +13 -0
  360. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/setup.rb +6 -0
  361. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -0
  362. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/processing/html/processing.erb +52 -0
  363. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/processing/html/setup.rb +4 -0
  364. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/search/html/search.erb +18 -0
  365. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/search/html/setup.rb +9 -0
  366. data/gems/yard-0.9.25/lib/yard/server/webrick_adapter.rb +45 -0
  367. data/gems/yard-0.9.25/lib/yard/server.rb +13 -0
  368. data/gems/yard-0.9.25/lib/yard/tags/default_factory.rb +191 -0
  369. data/gems/yard-0.9.25/lib/yard/tags/default_tag.rb +13 -0
  370. data/gems/yard-0.9.25/lib/yard/tags/directives.rb +616 -0
  371. data/gems/yard-0.9.25/lib/yard/tags/library.rb +633 -0
  372. data/gems/yard-0.9.25/lib/yard/tags/option_tag.rb +13 -0
  373. data/gems/yard-0.9.25/lib/yard/tags/overload_tag.rb +71 -0
  374. data/gems/yard-0.9.25/lib/yard/tags/ref_tag.rb +8 -0
  375. data/gems/yard-0.9.25/lib/yard/tags/ref_tag_list.rb +28 -0
  376. data/gems/yard-0.9.25/lib/yard/tags/tag.rb +71 -0
  377. data/gems/yard-0.9.25/lib/yard/tags/tag_format_error.rb +7 -0
  378. data/gems/yard-0.9.25/lib/yard/tags/types_explainer.rb +162 -0
  379. data/gems/yard-0.9.25/lib/yard/templates/engine.rb +186 -0
  380. data/gems/yard-0.9.25/lib/yard/templates/erb_cache.rb +23 -0
  381. data/gems/yard-0.9.25/lib/yard/templates/helpers/base_helper.rb +215 -0
  382. data/gems/yard-0.9.25/lib/yard/templates/helpers/filter_helper.rb +27 -0
  383. data/gems/yard-0.9.25/lib/yard/templates/helpers/html_helper.rb +670 -0
  384. data/gems/yard-0.9.25/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +78 -0
  385. data/gems/yard-0.9.25/lib/yard/templates/helpers/markup/rdoc_markdown.rb +23 -0
  386. data/gems/yard-0.9.25/lib/yard/templates/helpers/markup/rdoc_markup.rb +110 -0
  387. data/gems/yard-0.9.25/lib/yard/templates/helpers/markup_helper.rb +172 -0
  388. data/gems/yard-0.9.25/lib/yard/templates/helpers/method_helper.rb +75 -0
  389. data/gems/yard-0.9.25/lib/yard/templates/helpers/module_helper.rb +21 -0
  390. data/gems/yard-0.9.25/lib/yard/templates/helpers/text_helper.rb +112 -0
  391. data/gems/yard-0.9.25/lib/yard/templates/helpers/uml_helper.rb +47 -0
  392. data/gems/yard-0.9.25/lib/yard/templates/section.rb +105 -0
  393. data/gems/yard-0.9.25/lib/yard/templates/template.rb +418 -0
  394. data/gems/yard-0.9.25/lib/yard/templates/template_options.rb +92 -0
  395. data/gems/yard-0.9.25/lib/yard/verifier.rb +151 -0
  396. data/gems/yard-0.9.25/lib/yard/version.rb +6 -0
  397. data/gems/yard-0.9.25/lib/yard.rb +69 -0
  398. data/gems/yard-0.9.25/po/ja.po +31108 -0
  399. data/gems/yard-0.9.25/samus.json +80 -0
  400. data/gems/yard-0.9.25/tasks/update_error_map.rake +53 -0
  401. data/gems/yard-0.9.25/templates/default/class/dot/setup.rb +7 -0
  402. data/gems/yard-0.9.25/templates/default/class/dot/superklass.erb +3 -0
  403. data/gems/yard-0.9.25/templates/default/class/html/constructor_details.erb +8 -0
  404. data/gems/yard-0.9.25/templates/default/class/html/setup.rb +2 -0
  405. data/gems/yard-0.9.25/templates/default/class/html/subclasses.erb +4 -0
  406. data/gems/yard-0.9.25/templates/default/class/setup.rb +36 -0
  407. data/gems/yard-0.9.25/templates/default/class/text/setup.rb +12 -0
  408. data/gems/yard-0.9.25/templates/default/class/text/subclasses.erb +5 -0
  409. data/gems/yard-0.9.25/templates/default/constant/text/header.erb +11 -0
  410. data/gems/yard-0.9.25/templates/default/constant/text/setup.rb +4 -0
  411. data/gems/yard-0.9.25/templates/default/docstring/html/abstract.erb +4 -0
  412. data/gems/yard-0.9.25/templates/default/docstring/html/deprecated.erb +1 -0
  413. data/gems/yard-0.9.25/templates/default/docstring/html/index.erb +5 -0
  414. data/gems/yard-0.9.25/templates/default/docstring/html/note.erb +6 -0
  415. data/gems/yard-0.9.25/templates/default/docstring/html/private.erb +4 -0
  416. data/gems/yard-0.9.25/templates/default/docstring/html/returns_void.erb +1 -0
  417. data/gems/yard-0.9.25/templates/default/docstring/html/text.erb +1 -0
  418. data/gems/yard-0.9.25/templates/default/docstring/html/todo.erb +6 -0
  419. data/gems/yard-0.9.25/templates/default/docstring/setup.rb +52 -0
  420. data/gems/yard-0.9.25/templates/default/docstring/text/abstract.erb +2 -0
  421. data/gems/yard-0.9.25/templates/default/docstring/text/deprecated.erb +2 -0
  422. data/gems/yard-0.9.25/templates/default/docstring/text/index.erb +2 -0
  423. data/gems/yard-0.9.25/templates/default/docstring/text/note.erb +4 -0
  424. data/gems/yard-0.9.25/templates/default/docstring/text/private.erb +2 -0
  425. data/gems/yard-0.9.25/templates/default/docstring/text/returns_void.erb +1 -0
  426. data/gems/yard-0.9.25/templates/default/docstring/text/text.erb +1 -0
  427. data/gems/yard-0.9.25/templates/default/docstring/text/todo.erb +4 -0
  428. data/gems/yard-0.9.25/templates/default/fulldoc/html/css/common.css +1 -0
  429. data/gems/yard-0.9.25/templates/default/fulldoc/html/css/full_list.css +58 -0
  430. data/gems/yard-0.9.25/templates/default/fulldoc/html/css/style.css +496 -0
  431. data/gems/yard-0.9.25/templates/default/fulldoc/html/frames.erb +17 -0
  432. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list.erb +37 -0
  433. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list_class.erb +2 -0
  434. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list_file.erb +7 -0
  435. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list_method.erb +10 -0
  436. data/gems/yard-0.9.25/templates/default/fulldoc/html/js/app.js +314 -0
  437. data/gems/yard-0.9.25/templates/default/fulldoc/html/js/full_list.js +216 -0
  438. data/gems/yard-0.9.25/templates/default/fulldoc/html/js/jquery.js +4 -0
  439. data/gems/yard-0.9.25/templates/default/fulldoc/html/setup.rb +241 -0
  440. data/gems/yard-0.9.25/templates/default/layout/dot/header.erb +6 -0
  441. data/gems/yard-0.9.25/templates/default/layout/dot/setup.rb +15 -0
  442. data/gems/yard-0.9.25/templates/default/layout/html/breadcrumb.erb +11 -0
  443. data/gems/yard-0.9.25/templates/default/layout/html/files.erb +11 -0
  444. data/gems/yard-0.9.25/templates/default/layout/html/footer.erb +5 -0
  445. data/gems/yard-0.9.25/templates/default/layout/html/headers.erb +15 -0
  446. data/gems/yard-0.9.25/templates/default/layout/html/index.erb +2 -0
  447. data/gems/yard-0.9.25/templates/default/layout/html/layout.erb +24 -0
  448. data/gems/yard-0.9.25/templates/default/layout/html/listing.erb +4 -0
  449. data/gems/yard-0.9.25/templates/default/layout/html/objects.erb +32 -0
  450. data/gems/yard-0.9.25/templates/default/layout/html/script_setup.erb +4 -0
  451. data/gems/yard-0.9.25/templates/default/layout/html/search.erb +13 -0
  452. data/gems/yard-0.9.25/templates/default/layout/html/setup.rb +89 -0
  453. data/gems/yard-0.9.25/templates/default/method/html/header.erb +17 -0
  454. data/gems/yard-0.9.25/templates/default/method/setup.rb +4 -0
  455. data/gems/yard-0.9.25/templates/default/method/text/header.erb +1 -0
  456. data/gems/yard-0.9.25/templates/default/method_details/html/header.erb +3 -0
  457. data/gems/yard-0.9.25/templates/default/method_details/html/method_signature.erb +25 -0
  458. data/gems/yard-0.9.25/templates/default/method_details/html/source.erb +10 -0
  459. data/gems/yard-0.9.25/templates/default/method_details/setup.rb +11 -0
  460. data/gems/yard-0.9.25/templates/default/method_details/text/header.erb +10 -0
  461. data/gems/yard-0.9.25/templates/default/method_details/text/method_signature.erb +12 -0
  462. data/gems/yard-0.9.25/templates/default/method_details/text/setup.rb +11 -0
  463. data/gems/yard-0.9.25/templates/default/module/dot/child.erb +1 -0
  464. data/gems/yard-0.9.25/templates/default/module/dot/dependencies.erb +3 -0
  465. data/gems/yard-0.9.25/templates/default/module/dot/header.erb +6 -0
  466. data/gems/yard-0.9.25/templates/default/module/dot/info.erb +14 -0
  467. data/gems/yard-0.9.25/templates/default/module/dot/setup.rb +15 -0
  468. data/gems/yard-0.9.25/templates/default/module/html/attribute_details.erb +10 -0
  469. data/gems/yard-0.9.25/templates/default/module/html/attribute_summary.erb +8 -0
  470. data/gems/yard-0.9.25/templates/default/module/html/box_info.erb +43 -0
  471. data/gems/yard-0.9.25/templates/default/module/html/children.erb +8 -0
  472. data/gems/yard-0.9.25/templates/default/module/html/constant_summary.erb +17 -0
  473. data/gems/yard-0.9.25/templates/default/module/html/defines.erb +3 -0
  474. data/gems/yard-0.9.25/templates/default/module/html/header.erb +5 -0
  475. data/gems/yard-0.9.25/templates/default/module/html/inherited_attributes.erb +14 -0
  476. data/gems/yard-0.9.25/templates/default/module/html/inherited_constants.erb +8 -0
  477. data/gems/yard-0.9.25/templates/default/module/html/inherited_methods.erb +19 -0
  478. data/gems/yard-0.9.25/templates/default/module/html/item_summary.erb +40 -0
  479. data/gems/yard-0.9.25/templates/default/module/html/method_details_list.erb +9 -0
  480. data/gems/yard-0.9.25/templates/default/module/html/method_summary.erb +14 -0
  481. data/gems/yard-0.9.25/templates/default/module/html/methodmissing.erb +12 -0
  482. data/gems/yard-0.9.25/templates/default/module/html/pre_docstring.erb +1 -0
  483. data/gems/yard-0.9.25/templates/default/module/setup.rb +167 -0
  484. data/gems/yard-0.9.25/templates/default/module/text/children.erb +10 -0
  485. data/gems/yard-0.9.25/templates/default/module/text/class_meths_list.erb +8 -0
  486. data/gems/yard-0.9.25/templates/default/module/text/extends.erb +8 -0
  487. data/gems/yard-0.9.25/templates/default/module/text/header.erb +7 -0
  488. data/gems/yard-0.9.25/templates/default/module/text/includes.erb +8 -0
  489. data/gems/yard-0.9.25/templates/default/module/text/instance_meths_list.erb +8 -0
  490. data/gems/yard-0.9.25/templates/default/module/text/setup.rb +13 -0
  491. data/gems/yard-0.9.25/templates/default/onefile/html/files.erb +5 -0
  492. data/gems/yard-0.9.25/templates/default/onefile/html/headers.erb +6 -0
  493. data/gems/yard-0.9.25/templates/default/onefile/html/layout.erb +17 -0
  494. data/gems/yard-0.9.25/templates/default/onefile/html/readme.erb +3 -0
  495. data/gems/yard-0.9.25/templates/default/onefile/html/setup.rb +62 -0
  496. data/gems/yard-0.9.25/templates/default/root/dot/child.erb +3 -0
  497. data/gems/yard-0.9.25/templates/default/root/dot/setup.rb +6 -0
  498. data/gems/yard-0.9.25/templates/default/root/html/setup.rb +2 -0
  499. data/gems/yard-0.9.25/templates/default/tags/html/example.erb +11 -0
  500. data/gems/yard-0.9.25/templates/default/tags/html/index.erb +3 -0
  501. data/gems/yard-0.9.25/templates/default/tags/html/option.erb +24 -0
  502. data/gems/yard-0.9.25/templates/default/tags/html/overload.erb +14 -0
  503. data/gems/yard-0.9.25/templates/default/tags/html/see.erb +8 -0
  504. data/gems/yard-0.9.25/templates/default/tags/html/tag.erb +20 -0
  505. data/gems/yard-0.9.25/templates/default/tags/setup.rb +57 -0
  506. data/gems/yard-0.9.25/templates/default/tags/text/example.erb +12 -0
  507. data/gems/yard-0.9.25/templates/default/tags/text/index.erb +1 -0
  508. data/gems/yard-0.9.25/templates/default/tags/text/option.erb +20 -0
  509. data/gems/yard-0.9.25/templates/default/tags/text/overload.erb +19 -0
  510. data/gems/yard-0.9.25/templates/default/tags/text/see.erb +11 -0
  511. data/gems/yard-0.9.25/templates/default/tags/text/tag.erb +13 -0
  512. data/gems/yard-0.9.25/templates/guide/class/html/setup.rb +2 -0
  513. data/gems/yard-0.9.25/templates/guide/docstring/html/setup.rb +2 -0
  514. data/gems/yard-0.9.25/templates/guide/fulldoc/html/css/style.css +108 -0
  515. data/gems/yard-0.9.25/templates/guide/fulldoc/html/js/app.js +33 -0
  516. data/gems/yard-0.9.25/templates/guide/fulldoc/html/setup.rb +74 -0
  517. data/gems/yard-0.9.25/templates/guide/layout/html/layout.erb +81 -0
  518. data/gems/yard-0.9.25/templates/guide/layout/html/setup.rb +25 -0
  519. data/gems/yard-0.9.25/templates/guide/method/html/header.erb +18 -0
  520. data/gems/yard-0.9.25/templates/guide/method/html/setup.rb +22 -0
  521. data/gems/yard-0.9.25/templates/guide/module/html/header.erb +7 -0
  522. data/gems/yard-0.9.25/templates/guide/module/html/method_list.erb +5 -0
  523. data/gems/yard-0.9.25/templates/guide/module/html/setup.rb +27 -0
  524. data/gems/yard-0.9.25/templates/guide/onefile/html/files.erb +4 -0
  525. data/gems/yard-0.9.25/templates/guide/onefile/html/setup.rb +6 -0
  526. data/gems/yard-0.9.25/templates/guide/onefile/html/toc.erb +3 -0
  527. data/gems/yard-0.9.25/templates/guide/tags/html/setup.rb +9 -0
  528. data/gems/yard-0.9.25/yard.gemspec +24 -0
  529. data/kinetic_sdk.gemspec +3 -7
  530. data/lib/kinetic_sdk/core/lib/form.rb +55 -0
  531. data/lib/kinetic_sdk/core/lib/kapp.rb +52 -0
  532. data/lib/kinetic_sdk/core/lib/space.rb +51 -0
  533. data/lib/kinetic_sdk/task/lib/export.rb +22 -2
  534. data/lib/kinetic_sdk/task/lib/trees.rb +11 -0
  535. data/lib/kinetic_sdk/version.rb +1 -1
  536. data/lib/kinetic_sdk.rb +2 -22
  537. metadata +551 -229
  538. data/gems/kontena-websocket-client-0.1.1/Gemfile +0 -4
  539. data/gems/kontena-websocket-client-0.1.1/LICENSE +0 -190
  540. data/gems/kontena-websocket-client-0.1.1/README.md +0 -138
  541. data/gems/kontena-websocket-client-0.1.1/Rakefile +0 -6
  542. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark-client.rb +0 -45
  543. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark-em.rb +0 -66
  544. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark.rb +0 -161
  545. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark.sh +0 -17
  546. data/gems/kontena-websocket-client-0.1.1/benchmark/websocket-echo-server.go +0 -207
  547. data/gems/kontena-websocket-client-0.1.1/examples/websocket-echo-client.rb +0 -80
  548. data/gems/kontena-websocket-client-0.1.1/kontena-websocket-client.gemspec +0 -24
  549. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client/connection.rb +0 -119
  550. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client/version.rb +0 -13
  551. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client.rb +0 -848
  552. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/error.rb +0 -81
  553. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/logging.rb +0 -55
  554. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/openssl_patch.rb +0 -10
  555. data/gems/kontena-websocket-client-0.1.1/lib/kontena-websocket-client.rb +0 -15
  556. data/gems/mime-types-3.1/Contributing.rdoc +0 -130
  557. data/gems/mime-types-3.1/History.rdoc +0 -658
  558. data/gems/mime-types-3.1/Rakefile +0 -254
  559. data/gems/mime-types-3.1/lib/mime/types/columnar.rb +0 -1
  560. data/gems/mime-types-3.1/lib/mime/types/container.rb +0 -30
  561. data/gems/mime-types-3.1/lib/mime-types.rb +0 -1
  562. data/gems/mime-types-3.1/test/minitest_helper.rb +0 -13
  563. data/gems/mime-types-3.1/test/test_mime_type.rb +0 -603
  564. data/gems/mime-types-3.1/test/test_mime_types.rb +0 -161
  565. data/gems/mime-types-3.1/test/test_mime_types_cache.rb +0 -109
  566. data/gems/mime-types-3.1/test/test_mime_types_class.rb +0 -155
  567. data/gems/mime-types-3.1/test/test_mime_types_lazy.rb +0 -43
  568. data/gems/mime-types-3.1/test/test_mime_types_loader.rb +0 -32
  569. data/gems/mime-types-data-3.2016.0521/Contributing.md +0 -157
  570. data/gems/mime-types-data-3.2016.0521/History.md +0 -351
  571. data/gems/mime-types-data-3.2016.0521/Licence.md +0 -25
  572. data/gems/mime-types-data-3.2016.0521/README.md +0 -61
  573. data/gems/mime-types-data-3.2016.0521/Rakefile +0 -80
  574. data/gems/mime-types-data-3.2016.0521/data/mime-types.json +0 -1
  575. data/gems/mime-types-data-3.2016.0521/data/mime.flags.column +0 -1964
  576. data/gems/parallel-1.12.1/lib/parallel/processor_count.rb +0 -93
  577. data/gems/parallel-1.12.1/lib/parallel/version.rb +0 -3
  578. data/gems/parallel-1.12.1/lib/parallel.rb +0 -500
  579. data/gems/ruby-progressbar-1.9.0/LICENSE.txt +0 -19
  580. data/gems/ruby-progressbar-1.9.0/README.md +0 -38
  581. data/gems/ruby-progressbar-1.9.0/Rakefile +0 -2
  582. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/base.rb +0 -183
  583. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/calculators/length.rb +0 -99
  584. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/calculators/running_average.rb +0 -9
  585. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/bar.rb +0 -96
  586. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/percentage.rb +0 -29
  587. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/rate.rb +0 -43
  588. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/time.rb +0 -107
  589. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/title.rb +0 -13
  590. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components.rb +0 -5
  591. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/errors/invalid_progress_error.rb +0 -4
  592. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format/formatter.rb +0 -27
  593. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format/molecule.rb +0 -59
  594. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format/string.rb +0 -36
  595. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format.rb +0 -3
  596. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/output.rb +0 -68
  597. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/outputs/non_tty.rb +0 -47
  598. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/outputs/null.rb +0 -33
  599. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/outputs/tty.rb +0 -32
  600. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/progress.rb +0 -118
  601. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/refinements/enumerator.rb +0 -25
  602. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/refinements.rb +0 -1
  603. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/throttle.rb +0 -25
  604. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/time.rb +0 -30
  605. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/timer.rb +0 -72
  606. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/version.rb +0 -3
  607. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar.rb +0 -18
  608. data/gems/websocket-driver-0.6.5/CHANGELOG.md +0 -123
  609. data/gems/websocket-driver-0.6.5/LICENSE.md +0 -22
  610. data/gems/websocket-driver-0.6.5/README.md +0 -369
  611. data/gems/websocket-driver-0.6.5/examples/tcp_server.rb +0 -28
  612. data/gems/websocket-driver-0.6.5/ext/websocket-driver/Makefile +0 -264
  613. data/gems/websocket-driver-0.6.5/ext/websocket-driver/WebsocketMaskService.java +0 -55
  614. data/gems/websocket-driver-0.6.5/ext/websocket-driver/extconf.rb +0 -4
  615. data/gems/websocket-driver-0.6.5/ext/websocket-driver/websocket_mask.bundle +0 -0
  616. data/gems/websocket-driver-0.6.5/ext/websocket-driver/websocket_mask.c +0 -41
  617. data/gems/websocket-driver-0.6.5/ext/websocket-driver/websocket_mask.o +0 -0
  618. data/gems/websocket-driver-0.6.5/lib/websocket/driver/client.rb +0 -140
  619. data/gems/websocket-driver-0.6.5/lib/websocket/driver/draft75.rb +0 -102
  620. data/gems/websocket-driver-0.6.5/lib/websocket/driver/draft76.rb +0 -96
  621. data/gems/websocket-driver-0.6.5/lib/websocket/driver/event_emitter.rb +0 -54
  622. data/gems/websocket-driver-0.6.5/lib/websocket/driver/headers.rb +0 -45
  623. data/gems/websocket-driver-0.6.5/lib/websocket/driver/hybi/frame.rb +0 -20
  624. data/gems/websocket-driver-0.6.5/lib/websocket/driver/hybi/message.rb +0 -31
  625. data/gems/websocket-driver-0.6.5/lib/websocket/driver/hybi.rb +0 -406
  626. data/gems/websocket-driver-0.6.5/lib/websocket/driver/proxy.rb +0 -68
  627. data/gems/websocket-driver-0.6.5/lib/websocket/driver/server.rb +0 -80
  628. data/gems/websocket-driver-0.6.5/lib/websocket/driver/stream_reader.rb +0 -55
  629. data/gems/websocket-driver-0.6.5/lib/websocket/driver.rb +0 -199
  630. data/gems/websocket-driver-0.6.5/lib/websocket/http/headers.rb +0 -112
  631. data/gems/websocket-driver-0.6.5/lib/websocket/http/request.rb +0 -45
  632. data/gems/websocket-driver-0.6.5/lib/websocket/http/response.rb +0 -29
  633. data/gems/websocket-driver-0.6.5/lib/websocket/http.rb +0 -15
  634. data/gems/websocket-driver-0.6.5/lib/websocket/mask.rb +0 -14
  635. data/gems/websocket-driver-0.6.5/lib/websocket/websocket_mask.rb +0 -2
  636. data/gems/websocket-driver-0.6.5/lib/websocket_mask.bundle +0 -0
  637. data/gems/websocket-driver-0.6.5-java/CHANGELOG.md +0 -123
  638. data/gems/websocket-driver-0.6.5-java/README.md +0 -369
  639. data/gems/websocket-driver-0.6.5-java/examples/tcp_server.rb +0 -28
  640. data/gems/websocket-driver-0.6.5-java/ext/websocket-driver/WebsocketMaskService.java +0 -55
  641. data/gems/websocket-driver-0.6.5-java/ext/websocket-driver/extconf.rb +0 -4
  642. data/gems/websocket-driver-0.6.5-java/ext/websocket-driver/websocket_mask.c +0 -41
  643. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/client.rb +0 -140
  644. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/draft75.rb +0 -102
  645. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/draft76.rb +0 -96
  646. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/event_emitter.rb +0 -54
  647. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/headers.rb +0 -45
  648. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/hybi/frame.rb +0 -20
  649. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/hybi/message.rb +0 -31
  650. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/hybi.rb +0 -406
  651. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/proxy.rb +0 -68
  652. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/server.rb +0 -80
  653. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/stream_reader.rb +0 -55
  654. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver.rb +0 -199
  655. data/gems/websocket-driver-0.6.5-java/lib/websocket/http/headers.rb +0 -112
  656. data/gems/websocket-driver-0.6.5-java/lib/websocket/http/request.rb +0 -45
  657. data/gems/websocket-driver-0.6.5-java/lib/websocket/http/response.rb +0 -29
  658. data/gems/websocket-driver-0.6.5-java/lib/websocket/http.rb +0 -15
  659. data/gems/websocket-driver-0.6.5-java/lib/websocket/mask.rb +0 -14
  660. data/gems/websocket-driver-0.6.5-java/lib/websocket/websocket_mask.rb +0 -2
  661. data/gems/websocket-driver-0.6.5-java/lib/websocket_mask.jar +0 -0
  662. data/gems/websocket-extensions-0.1.3/CHANGELOG.md +0 -15
  663. data/gems/websocket-extensions-0.1.3/LICENSE.md +0 -20
  664. data/gems/websocket-extensions-0.1.3/README.md +0 -313
  665. data/gems/websocket-extensions-0.1.3/lib/websocket/extensions/parser.rb +0 -111
  666. data/gems/websocket-extensions-0.1.3/lib/websocket/extensions.rb +0 -181
  667. data/lib/kinetic_sdk/discussions/lib/websockets.rb +0 -96
@@ -0,0 +1,496 @@
1
+ # @title Templates Architecture
2
+
3
+ # Templates Architecture
4
+
5
+ Templates are the main component in the output rendering process of YARD,
6
+ which is invoked when conventional HTML/text output needs to be rendered
7
+ for a set of code objects.
8
+
9
+ ## Design Goals
10
+
11
+ The general design attempts to be as abstracted from actual content and templates
12
+ as possible. Unlike RDoc which uses one file to describe the entire template,
13
+ YARD splits up the rendering of code objects into small components, allowing
14
+ template modification for smaller subsets of a full template without having to
15
+ duplicate the entire template itself. This is necessary because of YARD's support
16
+ for plugins. YARD is designed for extensibility by external plugins, and because
17
+ of this, no one plugin can be responsible for the entire template because no
18
+ one plugin knows about the other plugins being used. For instance, if an RSpec
19
+ plugin was added to support and document specifications in class templates,
20
+ this information would need to be transparently added to the template to work
21
+ in conjunction with any other plugin that performed similar template modifications.
22
+ The design goals can be summarized as follows:
23
+
24
+ 1. Output should be able to be rendered for any arbitrary format with little
25
+ modification to YARD's source code. The addition of extra templates should
26
+ be sufficient.
27
+ 2. The output rendered for an object should independently rendered data
28
+ from arbitrary sources. These independent components are called "sections".
29
+ 3. Sections should be able to be inserted into any object without affecting
30
+ any existing sections in the document. This allows for easy modification
31
+ of templates by plugins.
32
+
33
+ ## Templates
34
+
35
+ Template modules are the objects used to orchestrate the design goals listed
36
+ above. Specifically, they organize the sections and render the template contents
37
+ depending on the format.
38
+
39
+ ## Engine
40
+
41
+ The Engine class orchestrates the creation and rendering of Template modules and
42
+ handles serialization or specific rendering scenarios (like HTML). To create
43
+ a template, use the {YARD::Templates::Engine.template template} method. The two most
44
+ common methods used to initiate output are the {YARD::Templates::Engine.render render}
45
+ and {YARD::Templates::Engine.generate generate} methods which generate and
46
+ optionally serialize output to a file. The latter, `#generate`, is used
47
+ specially to generate HTML documentation and copy over assets that may be
48
+ needed. For instance, an object may be rendered with:
49
+
50
+ YARD::Templates::Engine.render(:object => myobject)
51
+
52
+ A set of objects may be rendered into HTML documentation by using:
53
+
54
+ # all_objects is an array of module and class objects
55
+ # options includes a :serializer key to copy output to the file system
56
+ YARD::Templates::Engine.generate(all_objects, options)
57
+
58
+ Note that these methods should not be called directly. The {YARD::CodeObjects::Base}
59
+ class has a {YARD::CodeObjects::Base#format #format} helper method to render an
60
+ object. For instance, the above render example is equivalent to the simple
61
+ call `myobject.format`. The `generate` method is a special kind of render
62
+ and is called from the {YARD::CLI::Yardoc} command line utility.
63
+
64
+ ## Template Options
65
+
66
+ A template keeps state when it is rendering output. This state is kept in
67
+ an options hash which is initially passed to it during instantiation. Some
68
+ default options set the template style (`:template`), the output format (`:format`),
69
+ and the serializer to use (`:serializer`). This options hash is modifiable
70
+ from all methods seen above. For example, initializing a template to output as
71
+ HTML instead of text can be done as follows:
72
+
73
+ myobject.format(:format => :html)
74
+
75
+ ## Serializer
76
+
77
+ This class abstracts the logic involved in deciding how to serialize data to
78
+ the expected endpoint. For instance, there is both a {YARD::Serializers::StdoutSerializer StdoutSerializer}
79
+ and {YARD::Serializers::FileSystemSerializer FileSystemSerializer} class for
80
+ outputting to console or to a file respectively. When endpoints with locations
81
+ are used (like files or URLs), the serializer implements the {YARD::Serializers::Base#serialized_path #serialized_path}
82
+ method. This allows the translation from a code object to its path at the endpoint,
83
+ which enables inter-document linking.
84
+
85
+ Rendered objects are automatically serialized using the object if present,
86
+ otherwise the rendered object is returned as a string to its parent. Nested
87
+ Templates automatically set the serializer to nil so that they return
88
+ as a String to their parent.
89
+
90
+ ## Creating a Template
91
+
92
+ Templates are represented by a directory inside the {YARD::Templates::Engine.template_paths}
93
+ on disk. A standard template directory looks like the following tree:
94
+
95
+ (Assuming templates/ is a template path)
96
+ templates
97
+ `-- default
98
+ |-- class
99
+ | |-- dot
100
+ | | |-- setup.rb
101
+ | | `-- superklass.erb
102
+ | |-- html
103
+ | | |-- constructor_details.erb
104
+ | | |-- setup.rb
105
+ | | `-- subclasses.erb
106
+ | |-- setup.rb
107
+ | `-- text
108
+ | |-- setup.rb
109
+ | `-- subclasses.erb
110
+ |-- docstring
111
+ | |-- html
112
+ | | |-- abstract.erb
113
+ | | |-- deprecated.erb
114
+ | | |-- index.erb
115
+ | | `-- text.erb
116
+ | |-- setup.rb
117
+ | `-- text
118
+ | |-- abstract.erb
119
+ | |-- deprecated.erb
120
+ | |-- index.erb
121
+ | `-- text.erb
122
+
123
+ The path `default` refers to the template style (:template key in options hash)
124
+ and the directories at the next level (such as `class`) refer to template
125
+ `:type` (options hash key) for a template. The next directory refers to the
126
+ output format being used defined by the `:format` template option.
127
+
128
+ As we saw in the above example, the format option can be set to `:html`, which
129
+ would use the `html/` directory instead of `text/`. Finally, the individual .erb
130
+ files are the sections that make up the template.
131
+
132
+ Note that the subdirectory `html/` is also its own "template" that inherits
133
+ from the parent directory. We will see more on this later.
134
+
135
+ ## setup.rb
136
+
137
+ Every template should have at least one `setup.rb` file that defines the
138
+ {YARD::Templates::Template#init #init} method to set the
139
+ {YARD::Templates::Template#sections #sections} used by the template. If
140
+ a setup.rb is not defined in the template itself, there should be a template
141
+ that is inherited (via parent directory or explicitly) that sets the sections
142
+ on a newly created template.
143
+
144
+ A standard setup.rb file looks like:
145
+
146
+ def init
147
+ sections :section1, :section2, :section3
148
+ end
149
+
150
+ ## Sections
151
+
152
+ Sections are smaller components that correlate to template
153
+ fragments. Practically speaking, a section can either be a template fragment
154
+ (a conventional .erb file or other supported templating language), a method
155
+ (which returns a String) or another {YARD::Templates::Template} (which in turn has its own
156
+ list of sections).
157
+
158
+ ## Nested Sections
159
+
160
+ Sections often require the ability to encapsulate a set of sub-sections in markup
161
+ (HTML, for instance). Rather than use heavier Template subclass objects, a more
162
+ lightweight solution is to nest a set of sub-sections as a list that follows
163
+ a section, for example:
164
+
165
+ def init
166
+ sections :header, [:section_a, :section_b]
167
+ end
168
+
169
+ The above example nests `section_a` and `section_b` within the `header` section.
170
+ Practically speaking, these sections can be placed in the result by `yield`ing
171
+ to them. A sample header.erb template might contain:
172
+
173
+ <h2>Header</h2>
174
+ <div id="contents">
175
+ <%= yieldall %>
176
+ </div>
177
+
178
+ This template code would place the output of `section_a` and `section_b` within
179
+ the above div element. Using `yieldall`, we can also change the object that is being
180
+ rendered. For example, we may want to yield the first method of the class.
181
+ We can do this like so:
182
+
183
+ <h2>First method</h2>
184
+ <%= yieldall :object => object.meths.first %>
185
+
186
+ This would run the nested sections for the method object instead of the class.
187
+
188
+ Note that `yieldall` yields to all subsections, whereas `yield` will yield
189
+ to each individually (in order) until there are no more left to yield to.
190
+ In the vast majority of cases, you'd want to use `yieldall`, since `yield`
191
+ makes it hard for users to override your template.
192
+
193
+ ## Inheriting Templates
194
+
195
+ Parent directory templates are automatically inherited (or mixed in, to be
196
+ more accurate) by the current template. This means that the 'default/class/html'
197
+ template automatically inherits from 'default/class'. This also means that anything
198
+ defined in 'default/class/setup.rb' can be overridden by 'default/class/html/setup.rb'.
199
+
200
+ Since the Template module is a module, and not a class, they can be mixed in
201
+ explicitly (via include/extend) from other templates, which allows templates
202
+ to share erb files or helper logic. The 'default/class' template explicitly
203
+ mixes in the 'default/module' template, since it uses much of the same sections.
204
+ This is done with the helper {YARD::Templates::Template::ClassMethods#T T} method, which
205
+ is simply a shorthand for {YARD::Templates::Engine.template Engine.template}.
206
+ It can then override (using standard inheritance) the sections from the module
207
+ template and insert sections pertaining to classes. This is one of the design
208
+ goals described above.
209
+
210
+ For instance, the first line in `default/class/html/setup.rb` is:
211
+
212
+ include T('default/module/html')
213
+
214
+ This includes the 'default/module/html', which means it also includes 'default/module'
215
+ by extension. This allows class to make use of any of module's erb files.
216
+
217
+ ## Inserting and Traversing Sections
218
+
219
+ The ability to insert sections was mentioned above. The class template, for
220
+ instance, will modify the #init method to insert class specific sections:
221
+
222
+ def init
223
+ super
224
+ sections.place(:subclasses).before(:children)
225
+ sections.delete(:children)
226
+ sections.place([:constructor_details, [T('method_details')]]).before(:methodmissing)
227
+ end
228
+
229
+ Observe how sections has been modified after the super method was called (the
230
+ super method would have been defined in `default/module/setup.rb`). The
231
+ `sections` object is of the {YARD::Templates::Section} class and allows sections to be inserted
232
+ before or after another section using {Array#place} by it's given name rather
233
+ than index. This allows the overriding of templates in a way that does not
234
+ depend on where the section is located (since it may have been overridden by
235
+ another module).
236
+
237
+ You can also use `sections[:name]` to find the first child section named `:name`.
238
+ For instance, with the following sections declaration:
239
+
240
+ sections :a, [:b, :c, [:d]]
241
+
242
+ You can get to the :d section with:
243
+
244
+ sections[:a][:c][:d]
245
+
246
+ You can use this to insert a section inside a nested set without using indexed
247
+ access. The following command would result in `[:a, [:b, :c, [:d, :e]]]`:
248
+
249
+ sections[:a][:c].place(:e).after(:d)
250
+
251
+ There are also two methods, {Insertion#before_any} and {Insertion#after_any},
252
+ which allow you to insert sections before or after the first matching section name
253
+ recursively. The above example could simply be rewritten as:
254
+
255
+ sections.place(:e).after_any(:d)
256
+
257
+ ## Overriding Templates by Registering a Template Path
258
+
259
+ Inheriting templates explicitly is useful when creating a customized template
260
+ that wants to take advantage of code re-use. However, most users who want
261
+ to customize YARD templates will want to override existing behaviour without
262
+ creating a template from scratch.
263
+
264
+ YARD solves this problem by allowing other template paths to be registered.
265
+ Because template modules are represented by a relative path such as 'default/class',
266
+ they can be found within any of the registered template paths. A new template
267
+ path is registered as:
268
+
269
+ YARD::Templates::Engine.register_template_path '/path/to/mytemplates'
270
+
271
+ At this point, any time the 'default/class' template is loaded, the template
272
+ will first be looked for inside the newly registered template path. If found,
273
+ it will be used as the template module, with the modules from the other
274
+ template paths implicitly mixed in.
275
+
276
+ Therefore, by using the same directory structure as a builtin YARD template,
277
+ a user can customize or override individual templates as if the old ones were
278
+ inherited. A real world example would further modify the 'default/class' template
279
+ seen above by creating such a path in our '/path/to/mytemplates' custom template
280
+ path:
281
+
282
+ /path/to/mytemplates/:
283
+ |-- class
284
+ | |-- html
285
+ | | |-- customsection.erb
286
+ | |-- setup.rb
287
+
288
+ The `setup.rb` file would look like:
289
+
290
+ def init
291
+ super
292
+ sections.push :customsection
293
+ end
294
+
295
+ Now, when a class object is formatted as HTML, our customsection.erb will be
296
+ appended to the rendered data.
297
+
298
+
299
+ ### Overriding Stylesheets and Javascripts
300
+
301
+ Template authors can override existing stylesheets and javascripts by creating
302
+ a file with the same name as existing files within the `fulldoc` template. The
303
+ documentation output will utilize the new replacement file.
304
+
305
+ YARD's `fulldoc` template defines three stylesheets:
306
+
307
+ /yard/templates/default/:
308
+ |-- fulldoc
309
+ | |-- html
310
+ | | |-- css
311
+ | | | |-- common.css
312
+ | | | |-- full_list.css
313
+ | | | |-- style.css
314
+
315
+ The `style.css` is the primary stylesheet for the HTML output.
316
+
317
+ The `full_list.css` is an additional stylesheet loaded specifically for the
318
+ search field menus (i.e. class list, method list, and file list).
319
+
320
+ The `common.css` is an empty css file that an template author can easily override
321
+ to provide custom styles for their plugin. However, if a user installs multiple
322
+ plugins that utilize this same file to deliver styles, it is possible that they
323
+ will be overridden.
324
+
325
+ YARD's `fulldoc` template defines three javascript files:
326
+
327
+ /yard/templates/default/:
328
+ |-- fulldoc
329
+ | |-- html
330
+ | | |-- js
331
+ | | | |-- app.js
332
+ | | | |-- full_list.js
333
+ | | | |-- jquery.js
334
+
335
+ The `app.js` is the primary javascript file for the HTML output.
336
+
337
+ The `full_list.js` defines additional javascript loaded specifically for the
338
+ search field menus (i.e. class list, method list, and file list).
339
+
340
+ The `jquery.js` is copy of the jquery javascript library.
341
+
342
+ ### Adding a Custom Stylesheet or Javascript
343
+
344
+ To load additional stylesheets and javascripts with every page (except the search
345
+ field menus) generated from the base `layout` template:
346
+
347
+ 1. Define your own custom stylesheet and/or javascript file
348
+ (default/ is the default template name inside of the /template root directory):
349
+
350
+ /template/default/:
351
+ |-- fulldoc
352
+ | |-- html
353
+ | | |-- css
354
+ | | | |-- custom.css
355
+ | | |-- js
356
+ | | | |-- custom.js
357
+
358
+ 2. Create a `setup.rb` in the `layout` template directory and override the methods
359
+ `stylesheets` and `javascripts`. The path to the template would be:
360
+
361
+ /template/default/:
362
+ |-- layout
363
+ | |-- html
364
+ | | |-- setup.rb
365
+
366
+ And the code would look like:
367
+
368
+ def stylesheets
369
+ # Load the existing stylesheets while appending the custom one
370
+ super + %w(css/custom.css)
371
+ end
372
+
373
+ def javascripts
374
+ # Load the existing javascripts while appending the custom one
375
+ super + %w(js/custom.js)
376
+ end
377
+
378
+
379
+ To load additional stylesheets and javascripts for the search menus loaded from
380
+ the `fulldoc` template:
381
+
382
+ 1. Define your own custom stylesheet and/or javascript file.
383
+
384
+ /path/to/mytemplates/:
385
+ |-- fulldoc
386
+ | |-- html
387
+ | | |-- css
388
+ | | | |-- custom_full_menu.css
389
+ | | |-- js
390
+ | | | |-- custom_full_menu.js
391
+
392
+
393
+ 3. Override the methods `stylesheets_full_list` and `javascripts_full_list`
394
+ in the `setup.rb` file inside fulldoc/html.
395
+
396
+ def stylesheets_full_list
397
+ # Load the existing stylesheets while appending the custom one
398
+ super + %w(css/custom.css)
399
+ end
400
+
401
+ def javascripts_full_list
402
+ # Load the existing javascripts while appending the custom one
403
+ super + %w(js/custom.js)
404
+ end
405
+
406
+ ### Overriding Search Menus
407
+
408
+ By default YARD's `fulldoc` template generates three search fields:
409
+
410
+ * Class List
411
+ * Method List
412
+ * File List
413
+
414
+ Their contents are rendered in methods within the `fulldoc` template:
415
+
416
+ * `generate_class_list`
417
+ * `generate_method_list`
418
+ * `generate_file_list`
419
+
420
+ To override these lists you will need to:
421
+
422
+ 1. Create a `setup.rb` in the `fulldoc` template directory and override the
423
+ particular method.
424
+
425
+ /path/to/mytemplates/:
426
+ |-- fulldoc
427
+ | |-- html
428
+ | | |-- setup.rb
429
+
430
+ def generate_method_list
431
+ @items = prune_method_listing(Registry.all(:method), false)
432
+ @items = @items.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
433
+
434
+ # Here we changed the functionality to reverse the order of displayed methods
435
+ @items = @items.sort_by {|m| m.name.to_s }.reverse
436
+ @list_title = "Method List"
437
+ @list_type = "methods"
438
+ asset('method_list.html', erb(:full_list))
439
+ end
440
+
441
+ ### Adding Additional Search Menus
442
+
443
+ By default YARD's `fulldoc` template generates three search fields:
444
+
445
+ * Class List
446
+ * Method List
447
+ * File List
448
+
449
+ These are defined in the `layout` template method `menu_lists` and pulled into
450
+ the `fulldoc` template through a similarly named method.
451
+
452
+ To load an additional menu item:
453
+
454
+
455
+ 1. Create a `setup.rb` in the `layout` template directory and override the methods
456
+ `menu_lists`. The `type` informs the search field the name of the file.
457
+ The `title` is the name that appears above the section when viewed in frames.
458
+ The `search_title` is the name that appears in the search field tab on the page.
459
+
460
+
461
+ /path/to/mytemplates/:
462
+ |-- layout
463
+ | |-- html
464
+ | | |-- setup.rb
465
+
466
+ def menu_lists
467
+ # Load the existing menus
468
+ super + [ { :type => 'feature', :title => 'Features', :search_title => 'Feature List' } ]
469
+ end
470
+
471
+ 2. Create a `setup.rb` in the `fulldoc` template directory and create a method
472
+ to generate a menu for the specified `type`.
473
+ The method `generate_assets` will look for a function with a signature prefixed
474
+ with `generate`, the type value specified, and the suffix `list`. Within that
475
+ method you can configure and load the specific objects you wish to display.
476
+
477
+ /path/to/mytemplates/:
478
+ |-- fulldoc
479
+ | |-- html
480
+ | | |-- setup.rb
481
+
482
+ def generate_feature_list
483
+
484
+ # load all the features from the Registry
485
+ @items = Registry.all(:feature)
486
+ @list_title = "Feature List"
487
+ @list_type = "feature"
488
+
489
+ # optional: the specified stylesheet class
490
+ # when not specified it will default to the value of @list_type
491
+ @list_class = "class"
492
+
493
+ # Generate the full list html file with named feature_list.html
494
+ # @note this file must be match the name of the type
495
+ asset('feature_list.html', erb(:full_list))
496
+ end