yard 0.9.27 → 0.9.29

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

Potentially problematic release.


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

Files changed (223) hide show
  1. checksums.yaml +4 -4
  2. data/LEGAL +29 -1
  3. data/LICENSE +1 -1
  4. data/lib/yard/autoload.rb +2 -1
  5. data/lib/yard/cli/command.rb +1 -1
  6. data/lib/yard/cli/stats.rb +2 -1
  7. data/lib/yard/cli/yardoc.rb +3 -2
  8. data/lib/yard/code_objects/base.rb +4 -1
  9. data/lib/yard/config.rb +5 -1
  10. data/lib/yard/docstring_parser.rb +1 -1
  11. data/lib/yard/handlers/ruby/attribute_handler.rb +1 -1
  12. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +1 -1
  13. data/lib/yard/handlers/ruby/method_handler.rb +1 -1
  14. data/lib/yard/handlers/ruby/mixin_handler.rb +13 -6
  15. data/lib/yard/i18n/locale.rb +1 -1
  16. data/lib/yard/i18n/message.rb +2 -2
  17. data/lib/yard/i18n/messages.rb +1 -1
  18. data/lib/yard/i18n/pot_generator.rb +1 -1
  19. data/lib/yard/options.rb +1 -1
  20. data/lib/yard/parser/ruby/ast_node.rb +7 -0
  21. data/lib/yard/parser/ruby/ruby_parser.rb +8 -2
  22. data/lib/yard/registry_resolver.rb +2 -1
  23. data/lib/yard/server/commands/base.rb +1 -1
  24. data/lib/yard/server/http_utils.rb +512 -0
  25. data/lib/yard/server/rack_adapter.rb +24 -12
  26. data/lib/yard/tags/tag.rb +2 -2
  27. data/lib/yard/tags/types_explainer.rb +1 -1
  28. data/lib/yard/templates/helpers/html_helper.rb +1 -1
  29. data/lib/yard/templates/helpers/method_helper.rb +3 -1
  30. data/lib/yard/templates/template.rb +3 -1
  31. data/lib/yard/version.rb +1 -1
  32. data/lib/yard.rb +3 -0
  33. metadata +5 -208
  34. data/.dockerignore +0 -2
  35. data/.gitattributes +0 -4
  36. data/.github/FUNDING.yml +0 -3
  37. data/.github/ISSUE_TEMPLATE.md +0 -33
  38. data/.github/PULL_REQUEST_TEMPLATE.md +0 -12
  39. data/.github/workflows/ci.yml +0 -30
  40. data/.github/workflows/gem.yml +0 -19
  41. data/.gitignore +0 -14
  42. data/.rspec +0 -2
  43. data/.rubocop.yml +0 -112
  44. data/.yardopts +0 -26
  45. data/.yardopts_guide +0 -19
  46. data/.yardopts_i18n +0 -23
  47. data/CHANGELOG.md +0 -827
  48. data/CODE_OF_CONDUCT.md +0 -15
  49. data/CONTRIBUTING.md +0 -140
  50. data/Dockerfile.samus +0 -28
  51. data/Gemfile +0 -34
  52. data/Rakefile +0 -36
  53. data/SECURITY.md +0 -26
  54. data/benchmarks/builtins_vs_eval.rb +0 -24
  55. data/benchmarks/concat_vs_join.rb +0 -13
  56. data/benchmarks/erb_vs_erubis.rb +0 -54
  57. data/benchmarks/format_args.rb +0 -47
  58. data/benchmarks/generation.rb +0 -38
  59. data/benchmarks/marshal_vs_dbm.rb +0 -64
  60. data/benchmarks/parsing.rb +0 -46
  61. data/benchmarks/pathname_vs_string.rb +0 -51
  62. data/benchmarks/rdoc_vs_yardoc.rb +0 -11
  63. data/benchmarks/registry_store_types.rb +0 -49
  64. data/benchmarks/ri_vs_yri.rb +0 -19
  65. data/benchmarks/ripper_parser.rb +0 -13
  66. data/benchmarks/splat_vs_flatten.rb +0 -13
  67. data/benchmarks/template_erb.rb +0 -23
  68. data/benchmarks/template_format.rb +0 -7
  69. data/benchmarks/template_profile.rb +0 -18
  70. data/benchmarks/yri_cache.rb +0 -20
  71. data/docs/CodeObjects.md +0 -115
  72. data/docs/GettingStarted.md +0 -679
  73. data/docs/Handlers.md +0 -152
  74. data/docs/Overview.md +0 -61
  75. data/docs/Parser.md +0 -191
  76. data/docs/Tags.md +0 -283
  77. data/docs/TagsArch.md +0 -123
  78. data/docs/Templates.md +0 -496
  79. data/docs/WhatsNew.md +0 -1245
  80. data/docs/images/code-objects-class-diagram.png +0 -0
  81. data/docs/images/handlers-class-diagram.png +0 -0
  82. data/docs/images/overview-class-diagram.png +0 -0
  83. data/docs/images/parser-class-diagram.png +0 -0
  84. data/docs/images/tags-class-diagram.png +0 -0
  85. data/docs/templates/default/fulldoc/html/full_list_tag.erb +0 -9
  86. data/docs/templates/default/fulldoc/html/setup.rb +0 -6
  87. data/docs/templates/default/layout/html/setup.rb +0 -9
  88. data/docs/templates/default/layout/html/tag_list.erb +0 -11
  89. data/docs/templates/default/yard_tags/html/list.erb +0 -18
  90. data/docs/templates/default/yard_tags/html/setup.rb +0 -26
  91. data/docs/templates/plugin.rb +0 -70
  92. data/po/ja.po +0 -31108
  93. data/samus.json +0 -49
  94. data/tasks/prepare_tag.rake +0 -45
  95. data/tasks/update_error_map.rake +0 -53
  96. data/templates/default/class/dot/setup.rb +0 -7
  97. data/templates/default/class/dot/superklass.erb +0 -3
  98. data/templates/default/class/html/constructor_details.erb +0 -8
  99. data/templates/default/class/html/setup.rb +0 -2
  100. data/templates/default/class/html/subclasses.erb +0 -4
  101. data/templates/default/class/setup.rb +0 -36
  102. data/templates/default/class/text/setup.rb +0 -12
  103. data/templates/default/class/text/subclasses.erb +0 -5
  104. data/templates/default/constant/text/header.erb +0 -11
  105. data/templates/default/constant/text/setup.rb +0 -4
  106. data/templates/default/docstring/html/abstract.erb +0 -4
  107. data/templates/default/docstring/html/deprecated.erb +0 -1
  108. data/templates/default/docstring/html/index.erb +0 -5
  109. data/templates/default/docstring/html/note.erb +0 -6
  110. data/templates/default/docstring/html/private.erb +0 -4
  111. data/templates/default/docstring/html/returns_void.erb +0 -1
  112. data/templates/default/docstring/html/text.erb +0 -1
  113. data/templates/default/docstring/html/todo.erb +0 -6
  114. data/templates/default/docstring/setup.rb +0 -52
  115. data/templates/default/docstring/text/abstract.erb +0 -2
  116. data/templates/default/docstring/text/deprecated.erb +0 -2
  117. data/templates/default/docstring/text/index.erb +0 -2
  118. data/templates/default/docstring/text/note.erb +0 -4
  119. data/templates/default/docstring/text/private.erb +0 -2
  120. data/templates/default/docstring/text/returns_void.erb +0 -1
  121. data/templates/default/docstring/text/text.erb +0 -1
  122. data/templates/default/docstring/text/todo.erb +0 -4
  123. data/templates/default/fulldoc/html/css/common.css +0 -1
  124. data/templates/default/fulldoc/html/css/full_list.css +0 -58
  125. data/templates/default/fulldoc/html/css/style.css +0 -497
  126. data/templates/default/fulldoc/html/frames.erb +0 -17
  127. data/templates/default/fulldoc/html/full_list.erb +0 -37
  128. data/templates/default/fulldoc/html/full_list_class.erb +0 -2
  129. data/templates/default/fulldoc/html/full_list_file.erb +0 -7
  130. data/templates/default/fulldoc/html/full_list_method.erb +0 -10
  131. data/templates/default/fulldoc/html/js/app.js +0 -314
  132. data/templates/default/fulldoc/html/js/full_list.js +0 -216
  133. data/templates/default/fulldoc/html/js/jquery.js +0 -4
  134. data/templates/default/fulldoc/html/setup.rb +0 -241
  135. data/templates/default/layout/dot/header.erb +0 -6
  136. data/templates/default/layout/dot/setup.rb +0 -15
  137. data/templates/default/layout/html/breadcrumb.erb +0 -11
  138. data/templates/default/layout/html/files.erb +0 -11
  139. data/templates/default/layout/html/footer.erb +0 -5
  140. data/templates/default/layout/html/headers.erb +0 -15
  141. data/templates/default/layout/html/index.erb +0 -2
  142. data/templates/default/layout/html/layout.erb +0 -24
  143. data/templates/default/layout/html/listing.erb +0 -4
  144. data/templates/default/layout/html/objects.erb +0 -32
  145. data/templates/default/layout/html/script_setup.erb +0 -4
  146. data/templates/default/layout/html/search.erb +0 -13
  147. data/templates/default/layout/html/setup.rb +0 -89
  148. data/templates/default/method/html/header.erb +0 -17
  149. data/templates/default/method/setup.rb +0 -4
  150. data/templates/default/method/text/header.erb +0 -1
  151. data/templates/default/method_details/html/header.erb +0 -3
  152. data/templates/default/method_details/html/method_signature.erb +0 -25
  153. data/templates/default/method_details/html/source.erb +0 -10
  154. data/templates/default/method_details/setup.rb +0 -11
  155. data/templates/default/method_details/text/header.erb +0 -10
  156. data/templates/default/method_details/text/method_signature.erb +0 -12
  157. data/templates/default/method_details/text/setup.rb +0 -11
  158. data/templates/default/module/dot/child.erb +0 -1
  159. data/templates/default/module/dot/dependencies.erb +0 -3
  160. data/templates/default/module/dot/header.erb +0 -6
  161. data/templates/default/module/dot/info.erb +0 -14
  162. data/templates/default/module/dot/setup.rb +0 -15
  163. data/templates/default/module/html/attribute_details.erb +0 -10
  164. data/templates/default/module/html/attribute_summary.erb +0 -8
  165. data/templates/default/module/html/box_info.erb +0 -43
  166. data/templates/default/module/html/children.erb +0 -8
  167. data/templates/default/module/html/constant_summary.erb +0 -17
  168. data/templates/default/module/html/defines.erb +0 -3
  169. data/templates/default/module/html/header.erb +0 -5
  170. data/templates/default/module/html/inherited_attributes.erb +0 -14
  171. data/templates/default/module/html/inherited_constants.erb +0 -8
  172. data/templates/default/module/html/inherited_methods.erb +0 -19
  173. data/templates/default/module/html/item_summary.erb +0 -40
  174. data/templates/default/module/html/method_details_list.erb +0 -9
  175. data/templates/default/module/html/method_summary.erb +0 -14
  176. data/templates/default/module/html/methodmissing.erb +0 -12
  177. data/templates/default/module/html/pre_docstring.erb +0 -1
  178. data/templates/default/module/setup.rb +0 -167
  179. data/templates/default/module/text/children.erb +0 -10
  180. data/templates/default/module/text/class_meths_list.erb +0 -8
  181. data/templates/default/module/text/extends.erb +0 -8
  182. data/templates/default/module/text/header.erb +0 -7
  183. data/templates/default/module/text/includes.erb +0 -8
  184. data/templates/default/module/text/instance_meths_list.erb +0 -8
  185. data/templates/default/module/text/setup.rb +0 -13
  186. data/templates/default/onefile/html/files.erb +0 -5
  187. data/templates/default/onefile/html/headers.erb +0 -6
  188. data/templates/default/onefile/html/layout.erb +0 -17
  189. data/templates/default/onefile/html/readme.erb +0 -3
  190. data/templates/default/onefile/html/setup.rb +0 -62
  191. data/templates/default/root/dot/child.erb +0 -3
  192. data/templates/default/root/dot/setup.rb +0 -6
  193. data/templates/default/root/html/setup.rb +0 -2
  194. data/templates/default/tags/html/example.erb +0 -11
  195. data/templates/default/tags/html/index.erb +0 -3
  196. data/templates/default/tags/html/option.erb +0 -24
  197. data/templates/default/tags/html/overload.erb +0 -14
  198. data/templates/default/tags/html/see.erb +0 -8
  199. data/templates/default/tags/html/tag.erb +0 -20
  200. data/templates/default/tags/setup.rb +0 -57
  201. data/templates/default/tags/text/example.erb +0 -12
  202. data/templates/default/tags/text/index.erb +0 -1
  203. data/templates/default/tags/text/option.erb +0 -20
  204. data/templates/default/tags/text/overload.erb +0 -19
  205. data/templates/default/tags/text/see.erb +0 -11
  206. data/templates/default/tags/text/tag.erb +0 -13
  207. data/templates/guide/class/html/setup.rb +0 -2
  208. data/templates/guide/docstring/html/setup.rb +0 -2
  209. data/templates/guide/fulldoc/html/css/style.css +0 -108
  210. data/templates/guide/fulldoc/html/js/app.js +0 -33
  211. data/templates/guide/fulldoc/html/setup.rb +0 -74
  212. data/templates/guide/layout/html/layout.erb +0 -81
  213. data/templates/guide/layout/html/setup.rb +0 -25
  214. data/templates/guide/method/html/header.erb +0 -18
  215. data/templates/guide/method/html/setup.rb +0 -22
  216. data/templates/guide/module/html/header.erb +0 -7
  217. data/templates/guide/module/html/method_list.erb +0 -5
  218. data/templates/guide/module/html/setup.rb +0 -27
  219. data/templates/guide/onefile/html/files.erb +0 -4
  220. data/templates/guide/onefile/html/setup.rb +0 -6
  221. data/templates/guide/onefile/html/toc.erb +0 -3
  222. data/templates/guide/tags/html/setup.rb +0 -9
  223. data/yard.gemspec +0 -25
Binary file
Binary file
Binary file
Binary file
@@ -1,9 +0,0 @@
1
- <% even_odd = 'odd' %>
2
- <% collect_tags.each do |tag| %>
3
- <li class="<%= even_odd %> <%= tag.object.has_tag?(:deprecated) ? 'deprecated' : '' %>">
4
- <div class="item">
5
- <span class="object_link"><%= tag_link(tag) %></span>
6
- </div>
7
- </li>
8
- <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
9
- <% end %>
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
- def generate_tag_list
3
- @list_title = "Tag List"
4
- @list_type = "tag"
5
- asset('tag_list.html', erb(:full_list))
6
- end
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
- def init
3
- super
4
- sections.place(:tag_list).after_any(:files)
5
- end
6
-
7
- def menu_lists
8
- super + [{:type => 'tag', :title => 'Tags', :search_title => 'Tag List'}]
9
- end
@@ -1,11 +0,0 @@
1
- <h2>Tag Listing</h2>
2
- <p>The following are a brief list of tags that can be used in YARD formatted
3
- documentation. See <%= link_file "docs/Tags.md" %> for information on using tags.</p>
4
- <ul id="tags" class="index_inline_list">
5
- <% n = 1 %>
6
- <% collect_tags.each do |tag| %>
7
- <li class="r<%= n %>"><%= tag_link(tag) %></li>
8
- <% n = n == 2 ? 1 : 2 %>
9
- <% end %>
10
- </ul>
11
- <div class="clear"></div>
@@ -1,18 +0,0 @@
1
- <% [["Tag", all_tags], ["Directive", all_directives]].each do |(name, list)| %>
2
- <h2><%= name %> List</h2>
3
-
4
- <% list.each_with_index do |tag, i| %>
5
- <div class="method_details <%= i == 0 ? 'first' : '' %>">
6
- <h3 class="signature"
7
- id="<%= tag.name %>" toc-title="<%= tag_link_name(tag) %>">
8
- <%= tag_signature tag %>
9
- </h3>
10
- <% if name == "Directive" %>
11
- <%= yieldall :object => P("YARD::Tags::#{tag.text}") %>
12
- <% else %>
13
- <%= yieldall :object => tag.object %>
14
- <% end %>
15
- </div>
16
- <% end %>
17
-
18
- <% end%>
@@ -1,26 +0,0 @@
1
- # frozen_string_literal: true
2
- def init
3
- sections :list, [T('docstring')]
4
- end
5
-
6
- def tag_signature(tag)
7
- types = tag.types || []
8
- signature = "<strong>#{tag_link_name(tag)}</strong> "
9
- sig_tag = tag.object.tag('yard.signature')
10
- extra = sig_tag.text if sig_tag
11
- extra ||= case types.first
12
- when 'with_name'
13
- "name description"
14
- when 'with_types'
15
- "[Types] description"
16
- when 'with_types_and_name'
17
- "name [Types] description"
18
- when 'with_title_and_text'
19
- "title\ndescription"
20
- when 'with_types_and_title'
21
- "[Types] title\ndescription"
22
- else
23
- "description"
24
- end
25
- signature + h(extra).gsub(/\n/, "<br/>&nbsp;&nbsp;&nbsp;")
26
- end
@@ -1,70 +0,0 @@
1
- # frozen_string_literal: true
2
- include YARD
3
- include Templates
4
-
5
- module TagTemplateHelper
6
- def all_tags
7
- Registry.all(:method).map {|m| m.tag('yard.tag') }.compact
8
- end
9
-
10
- def all_directives
11
- Registry.all(:method).map {|m| m.tag('yard.directive') }.compact
12
- end
13
-
14
- def collect_tags
15
- (all_tags + all_directives).sort_by(&:name)
16
- end
17
-
18
- def tag_link(tag)
19
- link_file("docs/Tags.md", tag_link_name(tag), tag.name)
20
- end
21
-
22
- def tag_link_name(tag)
23
- prefix = tag.tag_name == 'yard.directive' ? '@!' : '@'
24
- h(prefix + tag.name)
25
- end
26
-
27
- # Wrap url_for and url_for_file to rewrite object when generating docs for
28
- # yard.tag/directive objects.
29
- %w(url_for url_for_file).each do |meth|
30
- self.class.send(:define_method, meth) do
31
- if object.is_a?(CodeObjects::Base) &&
32
- (object.tag('yard.tag') || object.tag('yard.directive') ||
33
- (object.type == :class && object.superclass.name == :Directive))
34
- obj = object
35
- self.object = Registry.root
36
- url = super
37
- self.object = obj
38
- url
39
- else
40
- super
41
- end
42
- end
43
- end
44
-
45
- def linkify(*args)
46
- if args.first.is_a?(String)
47
- case args.first
48
- when "yard:include_tags"
49
- return T('yard_tags').run(options)
50
- when /^tag:(\S+)/
51
- tag_name = $1
52
- suffix = "tag"
53
- if tag_name =~ /^!/
54
- tag_name = tag_name[1..-1]
55
- suffix = "directive"
56
- end
57
-
58
- obj = Registry.at("YARD::Tags::Library##{tag_name}_#{suffix}")
59
- return tag_link(obj.tag("yard.#{suffix}")) if obj
60
-
61
- log.warn "Cannot find tag: #{args.first}"
62
- return args.first
63
- end
64
- end
65
- super
66
- end
67
- end
68
-
69
- Template.extra_includes << TagTemplateHelper
70
- Engine.register_template_path(File.dirname(__FILE__))