rdoc 6.0.0.beta3 → 6.0.0.beta4

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

Potentially problematic release.


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

Files changed (121) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.travis.yml +1 -1
  4. data/Rakefile +5 -2
  5. data/lib/rdoc.rb +2 -3
  6. data/lib/rdoc/alias.rb +1 -1
  7. data/lib/rdoc/anon_class.rb +1 -1
  8. data/lib/rdoc/any_method.rb +7 -7
  9. data/lib/rdoc/attr.rb +1 -1
  10. data/lib/rdoc/class_module.rb +4 -2
  11. data/lib/rdoc/code_object.rb +2 -2
  12. data/lib/rdoc/code_objects.rb +1 -1
  13. data/lib/rdoc/comment.rb +20 -10
  14. data/lib/rdoc/constant.rb +1 -1
  15. data/lib/rdoc/context.rb +3 -3
  16. data/lib/rdoc/context/section.rb +2 -2
  17. data/lib/rdoc/cross_reference.rb +1 -1
  18. data/lib/rdoc/encoding.rb +40 -18
  19. data/lib/rdoc/erb_partial.rb +1 -1
  20. data/lib/rdoc/erbio.rb +1 -1
  21. data/lib/rdoc/extend.rb +1 -1
  22. data/lib/rdoc/generator.rb +1 -1
  23. data/lib/rdoc/generator/darkfish.rb +48 -21
  24. data/lib/rdoc/generator/json_index.rb +2 -2
  25. data/lib/rdoc/generator/markup.rb +1 -1
  26. data/lib/rdoc/generator/pot.rb +1 -1
  27. data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
  28. data/lib/rdoc/generator/pot/po.rb +3 -3
  29. data/lib/rdoc/generator/pot/po_entry.rb +11 -11
  30. data/lib/rdoc/generator/ri.rb +1 -1
  31. data/lib/rdoc/ghost_method.rb +1 -1
  32. data/lib/rdoc/i18n.rb +1 -1
  33. data/lib/rdoc/i18n/locale.rb +1 -1
  34. data/lib/rdoc/i18n/text.rb +5 -5
  35. data/lib/rdoc/include.rb +1 -1
  36. data/lib/rdoc/known_classes.rb +1 -1
  37. data/lib/rdoc/markdown.kpeg +71 -41
  38. data/lib/rdoc/markdown/entities.rb +1 -1
  39. data/lib/rdoc/markdown/literals.kpeg +1 -0
  40. data/lib/rdoc/markdown/literals.rb +18 -7
  41. data/lib/rdoc/markup.rb +1 -1
  42. data/lib/rdoc/markup/attr_changer.rb +1 -1
  43. data/lib/rdoc/markup/attr_span.rb +1 -1
  44. data/lib/rdoc/markup/attribute_manager.rb +2 -2
  45. data/lib/rdoc/markup/attributes.rb +1 -1
  46. data/lib/rdoc/markup/blank_line.rb +1 -1
  47. data/lib/rdoc/markup/block_quote.rb +1 -1
  48. data/lib/rdoc/markup/document.rb +1 -1
  49. data/lib/rdoc/markup/formatter.rb +1 -1
  50. data/lib/rdoc/markup/formatter_test_case.rb +1 -1
  51. data/lib/rdoc/markup/hard_break.rb +1 -1
  52. data/lib/rdoc/markup/heading.rb +1 -1
  53. data/lib/rdoc/markup/include.rb +1 -1
  54. data/lib/rdoc/markup/indented_paragraph.rb +1 -1
  55. data/lib/rdoc/markup/inline.rb +1 -1
  56. data/lib/rdoc/markup/list.rb +1 -1
  57. data/lib/rdoc/markup/list_item.rb +1 -1
  58. data/lib/rdoc/markup/paragraph.rb +1 -1
  59. data/lib/rdoc/markup/parser.rb +3 -3
  60. data/lib/rdoc/markup/pre_process.rb +9 -5
  61. data/lib/rdoc/markup/raw.rb +1 -1
  62. data/lib/rdoc/markup/rule.rb +1 -1
  63. data/lib/rdoc/markup/special.rb +1 -1
  64. data/lib/rdoc/markup/text_formatter_test_case.rb +1 -1
  65. data/lib/rdoc/markup/to_ansi.rb +1 -1
  66. data/lib/rdoc/markup/to_bs.rb +1 -1
  67. data/lib/rdoc/markup/to_html.rb +1 -1
  68. data/lib/rdoc/markup/to_html_crossref.rb +1 -1
  69. data/lib/rdoc/markup/to_html_snippet.rb +1 -1
  70. data/lib/rdoc/markup/to_joined_paragraph.rb +6 -32
  71. data/lib/rdoc/markup/to_label.rb +1 -1
  72. data/lib/rdoc/markup/to_markdown.rb +1 -1
  73. data/lib/rdoc/markup/to_rdoc.rb +1 -1
  74. data/lib/rdoc/markup/to_table_of_contents.rb +1 -1
  75. data/lib/rdoc/markup/to_test.rb +1 -1
  76. data/lib/rdoc/markup/to_tt_only.rb +1 -1
  77. data/lib/rdoc/markup/verbatim.rb +1 -1
  78. data/lib/rdoc/meta_method.rb +1 -1
  79. data/lib/rdoc/method_attr.rb +2 -2
  80. data/lib/rdoc/mixin.rb +1 -1
  81. data/lib/rdoc/normal_class.rb +3 -3
  82. data/lib/rdoc/normal_module.rb +1 -1
  83. data/lib/rdoc/options.rb +6 -6
  84. data/lib/rdoc/parser.rb +1 -1
  85. data/lib/rdoc/parser/c.rb +6 -6
  86. data/lib/rdoc/parser/changelog.rb +5 -5
  87. data/lib/rdoc/parser/markdown.rb +1 -1
  88. data/lib/rdoc/parser/rd.rb +1 -1
  89. data/lib/rdoc/parser/ripper_state_lex.rb +26 -8
  90. data/lib/rdoc/parser/ruby.rb +36 -42
  91. data/lib/rdoc/parser/ruby_tools.rb +2 -3
  92. data/lib/rdoc/parser/simple.rb +3 -3
  93. data/lib/rdoc/parser/text.rb +1 -1
  94. data/lib/rdoc/rd.rb +1 -1
  95. data/lib/rdoc/rd/block_parser.ry +2 -2
  96. data/lib/rdoc/rd/inline.rb +5 -5
  97. data/lib/rdoc/rd/inline_parser.ry +1 -1
  98. data/lib/rdoc/rdoc.rb +12 -7
  99. data/lib/rdoc/require.rb +1 -1
  100. data/lib/rdoc/ri.rb +1 -1
  101. data/lib/rdoc/ri/driver.rb +1 -1
  102. data/lib/rdoc/ri/formatter.rb +1 -1
  103. data/lib/rdoc/ri/paths.rb +1 -1
  104. data/lib/rdoc/ri/store.rb +1 -1
  105. data/lib/rdoc/ri/task.rb +1 -1
  106. data/lib/rdoc/rubygems_hook.rb +1 -1
  107. data/lib/rdoc/servlet.rb +2 -2
  108. data/lib/rdoc/single_class.rb +1 -1
  109. data/lib/rdoc/stats.rb +1 -1
  110. data/lib/rdoc/stats/normal.rb +2 -2
  111. data/lib/rdoc/stats/quiet.rb +1 -1
  112. data/lib/rdoc/stats/verbose.rb +1 -1
  113. data/lib/rdoc/store.rb +1 -1
  114. data/lib/rdoc/task.rb +1 -1
  115. data/lib/rdoc/test_case.rb +3 -4
  116. data/lib/rdoc/text.rb +7 -7
  117. data/lib/rdoc/token_stream.rb +15 -7
  118. data/lib/rdoc/tom_doc.rb +2 -2
  119. data/lib/rdoc/top_level.rb +1 -1
  120. data/rdoc.gemspec +3 -3
  121. metadata +3 -3
@@ -1,5 +1,4 @@
1
1
  # coding: UTF-8
2
- # frozen_string_literal: false
3
2
  # :markup: markdown
4
3
 
5
4
  ##
@@ -183,14 +182,26 @@ class RDoc::Markdown::Literals
183
182
  return nil
184
183
  end
185
184
 
186
- def get_byte
187
- if @pos >= @string_size
188
- return nil
185
+ if "".respond_to? :ord
186
+ def get_byte
187
+ if @pos >= @string_size
188
+ return nil
189
+ end
190
+
191
+ s = @string[@pos].ord
192
+ @pos += 1
193
+ s
189
194
  end
195
+ else
196
+ def get_byte
197
+ if @pos >= @string_size
198
+ return nil
199
+ end
190
200
 
191
- s = @string[@pos].ord
192
- @pos += 1
193
- s
201
+ s = @string[@pos]
202
+ @pos += 1
203
+ s
204
+ end
194
205
  end
195
206
 
196
207
  def parse(rule=nil)
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # RDoc::Markup parses plain text documents and attempts to decompose them into
4
4
  # their constituent parts. Some of these parts are high-level: paragraphs,
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  class RDoc::Markup
3
3
 
4
4
  AttrChanger = Struct.new :turn_on, :turn_off # :nodoc:
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # An array of attributes which parallels the characters in a string.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Manages changes of attributes in a block of text
4
4
 
@@ -246,7 +246,7 @@ class RDoc::Markup::AttributeManager
246
246
  # Processes +str+ converting attributes, HTML and specials
247
247
 
248
248
  def flow str
249
- @str = str
249
+ @str = str.dup
250
250
 
251
251
  mask_protected_sequences
252
252
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # We manage a set of attributes. Each attribute has a symbol name and a bit
4
4
  # value.
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # An empty line. This class is a singleton.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A quoted section which contains markup items.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A Document containing lists, headings, paragraphs, etc.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Base class for RDoc markup formatters
4
4
  #
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  require 'minitest/unit'
3
3
 
4
4
  ##
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A hard-break in the middle of a paragraph.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A heading with a level (1-6) and text
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A file included at generation time. Objects of this class are created by
4
4
  # RDoc::RD for an extension-less include.
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # An Indented Paragraph of text
4
4
 
@@ -1,2 +1,2 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  warn "requiring rdoc/markup/inline is deprecated and will be removed in RDoc 4." if $-w
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A List is a homogeneous set of ListItems.
4
4
  #
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # An item within a List that contains paragraphs, headings, etc.
4
4
  #
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A Paragraph of text
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  require 'strscan'
3
3
 
4
4
  ##
@@ -249,7 +249,7 @@ class RDoc::Markup::Parser
249
249
 
250
250
  min_indent = nil
251
251
  generate_leading_spaces = true
252
- line = ''
252
+ line = ''.dup
253
253
 
254
254
  until @tokens.empty? do
255
255
  type, data, column, = get
@@ -257,7 +257,7 @@ class RDoc::Markup::Parser
257
257
  if type == :NEWLINE then
258
258
  line << data
259
259
  verbatim << line
260
- line = ''
260
+ line = ''.dup
261
261
  generate_leading_spaces = true
262
262
  next
263
263
  end
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Handle common directives that can occur in a block of text:
4
4
  #
@@ -105,7 +105,7 @@ class RDoc::Markup::PreProcess
105
105
  # regexp helper (square brackets for optional)
106
106
  # $1 $2 $3 $4 $5
107
107
  # [prefix][\]:directive:[spaces][param]newline
108
- text.gsub!(/^([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):(\w+):([ \t]*)(.+)?(\r?\n|$)/) do
108
+ text = text.gsub(/^([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):(\w+):([ \t]*)(.+)?(\r?\n|$)/) do
109
109
  # skip something like ':toto::'
110
110
  next $& if $4.empty? and $5 and $5[0, 1] == ':'
111
111
 
@@ -123,7 +123,11 @@ class RDoc::Markup::PreProcess
123
123
  handle_directive $1, $3, $5, code_object, text.encoding, &block
124
124
  end
125
125
 
126
- comment = text unless comment
126
+ if comment then
127
+ comment.text = text
128
+ else
129
+ comment = text
130
+ end
127
131
 
128
132
  self.class.post_processors.each do |handler|
129
133
  handler.call comment, code_object
@@ -150,7 +154,7 @@ class RDoc::Markup::PreProcess
150
154
 
151
155
  case directive
152
156
  when 'arg', 'args' then
153
- return "#{prefix}:#{directive}: #{param}\n" unless code_object
157
+ return "#{prefix}:#{directive}: #{param}\n" unless code_object && code_object.kind_of?(RDoc::AnyMethod)
154
158
 
155
159
  code_object.params = param
156
160
 
@@ -212,7 +216,7 @@ class RDoc::Markup::PreProcess
212
216
  when 'yield', 'yields' then
213
217
  return blankline unless code_object
214
218
  # remove parameter &block
215
- code_object.params.sub!(/,?\s*&\w+/, '') if code_object.params
219
+ code_object.params = code_object.params.sub(/,?\s*&\w+/, '') if code_object.params
216
220
 
217
221
  code_object.block_params = param
218
222
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A section of text that is added to the output document as-is
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A horizontal rule with a weight
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Hold details of a special sequence
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Test case for creating new plain-text RDoc::Markup formatters. See also
4
4
  # RDoc::Markup::FormatterTestCase
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Outputs RDoc markup with vibrant ANSI color!
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Outputs RDoc markup with hot backspace action! You will probably need a
4
4
  # pager to use this output format.
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  require 'cgi'
3
3
 
4
4
  ##
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Subclass of the RDoc::Markup::ToHtml class that supports looking up method
4
4
  # names, classes, etc to create links. RDoc::CrossReference is used to
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Outputs RDoc markup as paragraphs with inline markup only.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Joins the parts of an RDoc::Markup::Paragraph into a single String.
4
4
  #
@@ -23,37 +23,11 @@ class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
23
23
  # Converts the parts of +paragraph+ to a single entry.
24
24
 
25
25
  def accept_paragraph paragraph
26
- parts = []
27
- string = false
28
-
29
- paragraph.parts.each do |part|
30
- if String === part then
31
- if string then
32
- string << part
33
- else
34
- parts << part
35
- string = part
36
- end
37
- else
38
- parts << part
39
- string = false
40
- end
41
- end
42
-
43
- parts = parts.map do |part|
44
- if String === part then
45
- part.rstrip
46
- else
47
- part
48
- end
49
- end
50
-
51
- # TODO use Enumerable#chunk when Ruby 1.8 support is dropped
52
- #parts = paragraph.parts.chunk do |part|
53
- # String === part
54
- #end.map do |string, chunk|
55
- # string ? chunk.join.rstrip : chunk
56
- #end.flatten
26
+ parts = paragraph.parts.chunk do |part|
27
+ String === part
28
+ end.map do |string, chunk|
29
+ string ? chunk.join.rstrip : chunk
30
+ end.flatten
57
31
 
58
32
  paragraph.parts.replace parts
59
33
  end
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  require 'cgi'
3
3
 
4
4
  ##
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  # :markup: markdown
3
3
 
4
4
  ##
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Outputs RDoc markup as RDoc markup! (mostly)
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Extracts just the RDoc::Markup::Heading elements from a
4
4
  # RDoc::Markup::Document to help build a table of contents
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # This Markup outputter is used for testing purposes.
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Extracts sections of text enclosed in plus, tt or code. Used to discover
4
4
  # undocumented parameters.
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A section of verbatim text
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # MetaMethod represents a meta-programmed method
4
4
 
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # Abstract class representing either a method or an attribute.
4
4
 
@@ -188,7 +188,7 @@ class RDoc::MethodAttr < RDoc::CodeObject
188
188
  next if String === ancestor
189
189
  next if parent == ancestor
190
190
 
191
- other = ancestor.find_method_named('#' << name) ||
191
+ other = ancestor.find_method_named('#' + name) ||
192
192
  ancestor.find_attribute_named(name)
193
193
 
194
194
  return other if other
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A Mixin adds features from a module into another context. RDoc::Include and
4
4
  # RDoc::Extend are both mixins.
@@ -1,4 +1,4 @@
1
- # frozen_string_literal: false
1
+ # frozen_string_literal: true
2
2
  ##
3
3
  # A normal class, neither singleton nor anonymous
4
4
 
@@ -47,9 +47,9 @@ class RDoc::NormalClass < RDoc::ClassModule
47
47
  def to_s # :nodoc:
48
48
  display = "#{self.class.name} #{self.full_name}"
49
49
  if superclass
50
- display << ' < ' << (superclass.is_a?(String) ? superclass : superclass.full_name)
50
+ display += ' < ' + (superclass.is_a?(String) ? superclass : superclass.full_name)
51
51
  end
52
- display << ' -> ' << is_alias_for.to_s if is_alias_for
52
+ display += ' -> ' + is_alias_for.to_s if is_alias_for
53
53
  display
54
54
  end
55
55