rdoc 6.17.0 → 8.1.0

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 (169) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +193 -0
  3. data/LEGAL.rdoc +6 -0
  4. data/LICENSE.rdoc +4 -0
  5. data/README.md +132 -8
  6. data/RI.md +75 -75
  7. data/doc/markup_reference/markdown.md +659 -0
  8. data/doc/markup_reference/rdoc.rdoc +1169 -0
  9. data/exe/rdoc +2 -2
  10. data/lib/rdoc/code_object/alias.rb +70 -74
  11. data/lib/rdoc/code_object/any_method.rb +308 -293
  12. data/lib/rdoc/code_object/attr.rb +150 -142
  13. data/lib/rdoc/code_object/class_module.rb +802 -715
  14. data/lib/rdoc/code_object/constant.rb +181 -144
  15. data/lib/rdoc/code_object/context/section.rb +140 -130
  16. data/lib/rdoc/code_object/context.rb +925 -941
  17. data/lib/rdoc/code_object/extend.rb +7 -5
  18. data/lib/rdoc/code_object/include.rb +7 -5
  19. data/lib/rdoc/code_object/method_attr.rb +328 -315
  20. data/lib/rdoc/code_object/mixin.rb +97 -92
  21. data/lib/rdoc/code_object/normal_class.rb +77 -78
  22. data/lib/rdoc/code_object/normal_module.rb +61 -59
  23. data/lib/rdoc/code_object/require.rb +23 -39
  24. data/lib/rdoc/code_object/single_class.rb +21 -19
  25. data/lib/rdoc/code_object/top_level.rb +215 -202
  26. data/lib/rdoc/code_object.rb +305 -305
  27. data/lib/rdoc/comment.rb +274 -337
  28. data/lib/rdoc/cross_reference.rb +195 -206
  29. data/lib/rdoc/encoding.rb +105 -103
  30. data/lib/rdoc/erb_partial.rb +13 -11
  31. data/lib/rdoc/erbio.rb +29 -27
  32. data/lib/rdoc/generator/aliki.rb +196 -30
  33. data/lib/rdoc/generator/darkfish.rb +647 -629
  34. data/lib/rdoc/generator/json_index.rb +233 -229
  35. data/lib/rdoc/generator/markup.rb +165 -122
  36. data/lib/rdoc/generator/pot/message_extractor.rb +57 -51
  37. data/lib/rdoc/generator/pot/po.rb +52 -51
  38. data/lib/rdoc/generator/pot/po_entry.rb +138 -132
  39. data/lib/rdoc/generator/pot.rb +85 -81
  40. data/lib/rdoc/generator/ri.rb +23 -19
  41. data/lib/rdoc/generator/template/aliki/DESIGN.md +538 -0
  42. data/lib/rdoc/generator/template/aliki/_aside_toc.rhtml +1 -1
  43. data/lib/rdoc/generator/template/aliki/_footer.rhtml +2 -2
  44. data/lib/rdoc/generator/template/aliki/_head.rhtml +15 -10
  45. data/lib/rdoc/generator/template/aliki/_header.rhtml +29 -44
  46. data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +8 -6
  47. data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +8 -6
  48. data/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml +1 -1
  49. data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +3 -3
  50. data/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +3 -3
  51. data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +1 -1
  52. data/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml +1 -1
  53. data/lib/rdoc/generator/template/aliki/class.rhtml +71 -61
  54. data/lib/rdoc/generator/template/aliki/css/rdoc.css +796 -323
  55. data/lib/rdoc/generator/template/aliki/index.rhtml +1 -1
  56. data/lib/rdoc/generator/template/aliki/js/aliki.js +119 -113
  57. data/lib/rdoc/generator/template/aliki/js/bash_highlighter.js +167 -0
  58. data/lib/rdoc/generator/template/aliki/js/c_highlighter.js +1 -1
  59. data/lib/rdoc/generator/template/aliki/js/{search.js → search_controller.js} +16 -7
  60. data/lib/rdoc/generator/template/aliki/js/search_navigation.js +105 -0
  61. data/lib/rdoc/generator/template/aliki/js/search_ranker.js +239 -0
  62. data/lib/rdoc/generator/template/aliki/page.rhtml +1 -1
  63. data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +1 -1
  64. data/lib/rdoc/generator/template/aliki/servlet_root.rhtml +2 -2
  65. data/lib/rdoc/generator/template/darkfish/_footer.rhtml +1 -1
  66. data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +8 -6
  67. data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +8 -6
  68. data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +1 -1
  69. data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +2 -2
  70. data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +1 -1
  71. data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +5 -5
  72. data/lib/rdoc/generator/template/darkfish/class.rhtml +29 -32
  73. data/lib/rdoc/generator/template/darkfish/css/rdoc.css +19 -1
  74. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +3 -3
  75. data/lib/rdoc/generator.rb +48 -46
  76. data/lib/rdoc/i18n/locale.rb +99 -95
  77. data/lib/rdoc/i18n/text.rb +109 -105
  78. data/lib/rdoc/i18n.rb +7 -5
  79. data/lib/rdoc/markdown/byte_runtime.rb +80 -0
  80. data/lib/rdoc/markdown.kpeg +52 -33
  81. data/lib/rdoc/markdown.rb +365 -177
  82. data/lib/rdoc/markup/blank_line.rb +25 -23
  83. data/lib/rdoc/markup/block_quote.rb +12 -8
  84. data/lib/rdoc/markup/document.rb +127 -123
  85. data/lib/rdoc/markup/element.rb +21 -0
  86. data/lib/rdoc/markup/formatter.rb +220 -203
  87. data/lib/rdoc/markup/hard_break.rb +30 -27
  88. data/lib/rdoc/markup/heading.rb +163 -77
  89. data/lib/rdoc/markup/include.rb +33 -29
  90. data/lib/rdoc/markup/indented_paragraph.rb +37 -33
  91. data/lib/rdoc/markup/inline_parser.rb +316 -0
  92. data/lib/rdoc/markup/list.rb +80 -88
  93. data/lib/rdoc/markup/list_item.rb +73 -85
  94. data/lib/rdoc/markup/paragraph.rb +23 -19
  95. data/lib/rdoc/markup/parser.rb +501 -497
  96. data/lib/rdoc/markup/pre_process.rb +284 -305
  97. data/lib/rdoc/markup/raw.rb +52 -55
  98. data/lib/rdoc/markup/rule.rb +16 -12
  99. data/lib/rdoc/markup/table.rb +48 -40
  100. data/lib/rdoc/markup/to_ansi.rb +143 -92
  101. data/lib/rdoc/markup/to_bs.rb +86 -102
  102. data/lib/rdoc/markup/to_html.rb +608 -506
  103. data/lib/rdoc/markup/to_html_crossref.rb +219 -210
  104. data/lib/rdoc/markup/to_html_snippet.rb +210 -205
  105. data/lib/rdoc/markup/to_joined_paragraph.rb +40 -41
  106. data/lib/rdoc/markup/to_label.rb +64 -51
  107. data/lib/rdoc/markup/to_markdown.rb +212 -184
  108. data/lib/rdoc/markup/to_rdoc.rb +341 -277
  109. data/lib/rdoc/markup/to_table_of_contents.rb +66 -62
  110. data/lib/rdoc/markup/to_test.rb +62 -50
  111. data/lib/rdoc/markup/to_tt_only.rb +83 -92
  112. data/lib/rdoc/markup/verbatim.rb +62 -58
  113. data/lib/rdoc/markup.rb +196 -215
  114. data/lib/rdoc/options.rb +1063 -1076
  115. data/lib/rdoc/parser/c.rb +1039 -1036
  116. data/lib/rdoc/parser/changelog.rb +320 -287
  117. data/lib/rdoc/parser/markdown.rb +17 -13
  118. data/lib/rdoc/parser/rbs.rb +279 -0
  119. data/lib/rdoc/parser/rd.rb +17 -13
  120. data/lib/rdoc/parser/ruby.rb +1231 -2222
  121. data/lib/rdoc/parser/ruby_colorizer.rb +303 -0
  122. data/lib/rdoc/parser/simple.rb +31 -27
  123. data/lib/rdoc/parser/text.rb +12 -8
  124. data/lib/rdoc/parser.rb +230 -221
  125. data/lib/rdoc/rbs_helper.rb +186 -0
  126. data/lib/rdoc/rd/inline.rb +57 -53
  127. data/lib/rdoc/rd.rb +90 -88
  128. data/lib/rdoc/rdoc.rb +547 -366
  129. data/lib/rdoc/ri/driver.rb +1141 -1130
  130. data/lib/rdoc/ri/formatter.rb +7 -3
  131. data/lib/rdoc/ri/paths.rb +140 -136
  132. data/lib/rdoc/ri/servlet.rb +456 -0
  133. data/lib/rdoc/ri/store.rb +4 -2
  134. data/lib/rdoc/ri/task.rb +55 -51
  135. data/lib/rdoc/ri.rb +14 -11
  136. data/lib/rdoc/rubygems_hook.rb +194 -192
  137. data/lib/rdoc/server.rb +462 -0
  138. data/lib/rdoc/stats/normal.rb +46 -42
  139. data/lib/rdoc/stats/quiet.rb +39 -35
  140. data/lib/rdoc/stats/verbose.rb +35 -31
  141. data/lib/rdoc/stats.rb +363 -338
  142. data/lib/rdoc/store.rb +919 -725
  143. data/lib/rdoc/task.rb +260 -255
  144. data/lib/rdoc/text.rb +164 -240
  145. data/lib/rdoc/token_stream.rb +88 -106
  146. data/lib/rdoc/tom_doc.rb +203 -201
  147. data/lib/rdoc/version.rb +1 -1
  148. data/lib/rdoc.rb +35 -7
  149. data/lib/rubygems_plugin.rb +2 -11
  150. data/rdoc-logo.svg +43 -0
  151. data/rdoc.gemspec +9 -7
  152. metadata +46 -32
  153. data/CONTRIBUTING.rdoc +0 -219
  154. data/ExampleMarkdown.md +0 -39
  155. data/ExampleRDoc.rdoc +0 -210
  156. data/lib/rdoc/code_object/anon_class.rb +0 -10
  157. data/lib/rdoc/code_object/ghost_method.rb +0 -6
  158. data/lib/rdoc/code_object/meta_method.rb +0 -6
  159. data/lib/rdoc/markdown/literals.kpeg +0 -21
  160. data/lib/rdoc/markdown/literals.rb +0 -454
  161. data/lib/rdoc/markup/attr_changer.rb +0 -22
  162. data/lib/rdoc/markup/attr_span.rb +0 -35
  163. data/lib/rdoc/markup/attribute_manager.rb +0 -405
  164. data/lib/rdoc/markup/attributes.rb +0 -70
  165. data/lib/rdoc/markup/regexp_handling.rb +0 -40
  166. data/lib/rdoc/parser/prism_ruby.rb +0 -1100
  167. data/lib/rdoc/parser/ripper_state_lex.rb +0 -302
  168. data/lib/rdoc/parser/ruby_tools.rb +0 -163
  169. data/lib/rdoc/servlet.rb +0 -452
data/exe/rdoc CHANGED
@@ -25,11 +25,11 @@ rescue Errno::ENOSPC
25
25
  rescue SystemExit
26
26
  raise
27
27
  rescue Exception => e
28
- if $DEBUG_RDOC then
28
+ if $DEBUG_RDOC
29
29
  $stderr.puts e.message
30
30
  $stderr.puts "#{e.backtrace.join "\n\t"}"
31
31
  $stderr.puts
32
- elsif Interrupt === e then
32
+ elsif Interrupt === e
33
33
  $stderr.puts
34
34
  $stderr.puts 'Interrupted'
35
35
  else
@@ -1,104 +1,100 @@
1
1
  # frozen_string_literal: true
2
- ##
3
- # Represent an alias, which is an old_name/new_name pair associated with a
4
- # particular context
5
- #--
6
- # TODO implement Alias as a proxy to a method/attribute, inheriting from
7
- # MethodAttr
8
-
9
- class RDoc::Alias < RDoc::CodeObject
10
-
2
+ module RDoc
11
3
  ##
12
- # Aliased method's name
4
+ # Represent an alias, which is an old_name/new_name pair associated with a
5
+ # particular context
6
+ #--
7
+ # TODO implement Alias as a proxy to a method/attribute, inheriting from
8
+ # MethodAttr
13
9
 
14
- attr_reader :new_name
10
+ class Alias < CodeObject
15
11
 
16
- alias name new_name
12
+ ##
13
+ # Aliased method's name
17
14
 
18
- ##
19
- # Aliasee method's name
15
+ attr_reader :new_name
20
16
 
21
- attr_reader :old_name
17
+ alias name new_name
22
18
 
23
- ##
24
- # Is this an alias declared in a singleton context?
19
+ ##
20
+ # Aliasee method's name
25
21
 
26
- attr_reader :singleton
22
+ attr_reader :old_name
27
23
 
28
- ##
29
- # Source file token stream
24
+ ##
25
+ # Is this an alias declared in a singleton context?
30
26
 
31
- attr_reader :text
27
+ attr_reader :singleton
32
28
 
33
- ##
34
- # Creates a new Alias with a token stream of +text+ that aliases +old_name+
35
- # to +new_name+, has +comment+ and is a +singleton+ context.
29
+ ##
30
+ # Creates a new Alias that aliases +old_name+
31
+ # to +new_name+, has +comment+ and is a +singleton+ context.
36
32
 
37
- def initialize(text, old_name, new_name, comment, singleton: false)
38
- super()
33
+ def initialize(old_name, new_name, comment, singleton: false)
34
+ super()
39
35
 
40
- @text = text
41
- @singleton = singleton
42
- @old_name = old_name
43
- @new_name = new_name
44
- self.comment = comment
45
- end
36
+ @singleton = singleton
37
+ @old_name = old_name
38
+ @new_name = new_name
39
+ self.comment = comment
40
+ end
46
41
 
47
- ##
48
- # Order by #singleton then #new_name
42
+ ##
43
+ # Order by #singleton then #new_name
49
44
 
50
- def <=>(other)
51
- [@singleton ? 0 : 1, new_name] <=> [other.singleton ? 0 : 1, other.new_name]
52
- end
45
+ def <=>(other)
46
+ [@singleton ? 0 : 1, new_name] <=> [other.singleton ? 0 : 1, other.new_name]
47
+ end
53
48
 
54
- ##
55
- # HTML fragment reference for this alias
49
+ ##
50
+ # HTML fragment reference for this alias
56
51
 
57
- def aref
58
- type = singleton ? 'c' : 'i'
59
- "#alias-#{type}-#{html_name}"
60
- end
52
+ def aref
53
+ type = singleton ? 'c' : 'i'
54
+ "#alias-#{type}-#{html_name}"
55
+ end
61
56
 
62
- ##
63
- # HTML id-friendly version of +#new_name+.
57
+ ##
58
+ # HTML id-friendly version of +#new_name+.
64
59
 
65
- def html_name
66
- CGI.escape(@new_name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
67
- end
60
+ def html_name
61
+ CGI.escape(@new_name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
62
+ end
68
63
 
69
- def inspect # :nodoc:
70
- parent_name = parent ? parent.name : '(unknown)'
71
- "#<%s:0x%x %s.alias_method %s, %s>" % [
72
- self.class, object_id,
73
- parent_name, @old_name, @new_name,
74
- ]
75
- end
64
+ def inspect # :nodoc:
65
+ parent_name = parent ? parent.name : '(unknown)'
66
+ "#<%s:0x%x %s.alias_method %s, %s>" % [
67
+ self.class, object_id,
68
+ parent_name, @old_name, @new_name,
69
+ ]
70
+ end
76
71
 
77
- ##
78
- # '::' for the alias of a singleton method/attribute, '#' for instance-level.
72
+ ##
73
+ # '::' for the alias of a singleton method/attribute, '#' for instance-level.
79
74
 
80
- def name_prefix
81
- singleton ? '::' : '#'
82
- end
75
+ def name_prefix
76
+ singleton ? '::' : '#'
77
+ end
83
78
 
84
- ##
85
- # Old name with prefix '::' or '#'.
79
+ ##
80
+ # Old name with prefix '::' or '#'.
86
81
 
87
- def pretty_old_name
88
- "#{singleton ? '::' : '#'}#{@old_name}"
89
- end
82
+ def pretty_old_name
83
+ "#{singleton ? '::' : '#'}#{@old_name}"
84
+ end
90
85
 
91
- ##
92
- # New name with prefix '::' or '#'.
86
+ ##
87
+ # New name with prefix '::' or '#'.
93
88
 
94
- def pretty_new_name
95
- "#{singleton ? '::' : '#'}#{@new_name}"
96
- end
89
+ def pretty_new_name
90
+ "#{singleton ? '::' : '#'}#{@new_name}"
91
+ end
97
92
 
98
- alias pretty_name pretty_new_name
93
+ alias pretty_name pretty_new_name
99
94
 
100
- def to_s # :nodoc:
101
- "alias: #{self.new_name} -> #{self.pretty_old_name} in: #{parent}"
102
- end
95
+ def to_s # :nodoc:
96
+ "alias: #{self.new_name} -> #{self.pretty_old_name} in: #{parent}"
97
+ end
103
98
 
99
+ end
104
100
  end