rdoc 6.3.4.1 → 8.0.0

data/lib/rdoc/markup/to_markdown.rb

@@ -9,7 +9,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Creates a new formatter that will output Markdown format text
 
-  def initialize markup = nil
+  def initialize
     super
 
     @headings[1] = ['# ',      '']
@@ -20,46 +20,29 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
     @headings[6] = ['###### ', '']
 
     add_regexp_handling_RDOCLINK
-    add_regexp_handling_TIDYLINK
 
     @hard_break = "  \n"
   end
 
-  ##
-  # Maps attributes to HTML sequences
-
-  def init_tags
-    add_tag :BOLD, '**', '**'
-    add_tag :EM,   '*',  '*'
-    add_tag :TT,   '`',  '`'
-  end
-
-  ##
-  # Adds a newline to the output
-
-  def handle_regexp_HARD_BREAK target
-    "  \n"
-  end
-
   ##
   # Finishes consumption of `list`
 
-  def accept_list_end list
-    @res << "\n"
-
+  def accept_list_end(list)
     super
   end
 
   ##
   # Finishes consumption of `list_item`
 
-  def accept_list_item_end list_item
+  def accept_list_item_end(list_item)
     width = case @list_type.last
             when :BULLET then
               4
             when :NOTE, :LABEL then
               use_prefix
 
+              @res << "\n"
+
               4
             else
               @list_index[-1] = @list_index.last.succ
@@ -72,7 +55,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Prepares the visitor for consuming `list_item`
 
-  def accept_list_item_start list_item
+  def accept_list_item_start(list_item)
     type = @list_type.last
 
     case type
@@ -81,11 +64,11 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
         attributes(label).strip
       end.join "\n"
 
-      bullets << "\n:"
+      bullets << "\n" unless bullets.empty?
 
       @prefix = ' ' * @indent
       @indent += 4
-      @prefix << bullets + (' ' * (@indent - 1))
+      @prefix << bullets << ":" << (' ' * (@indent - 1))
     else
       bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.'
       @prefix = (' ' * @indent) + bullet.ljust(4)
@@ -94,10 +77,69 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
     end
   end
 
+  def add_tag(tag, simple_tag, content)
+    if content.match?(/\A[\w\s]+\z/)
+      emit_inline("#{simple_tag}#{content}#{simple_tag}")
+    else
+      emit_inline("<#{tag}>#{content}</#{tag}>")
+    end
+  end
+
+  def handle_tag(nodes, simple_tag, tag)
+    if nodes.size == 1 && String === nodes[0]
+      content = apply_regexp_handling(nodes[0]).map do |text, converted|
+        converted ? text : convert_string(text)
+      end.join
+      add_tag(tag, simple_tag, content)
+    else
+      emit_inline("<#{tag}>")
+      traverse_inline_nodes(nodes)
+      emit_inline("</#{tag}>")
+    end
+  end
+
+  def handle_TIDYLINK(label_part, url)
+    if url =~ /^rdoc-label:foot/ then
+      emit_inline(handle_rdoc_link(url))
+    else
+      emit_inline('[')
+      traverse_inline_nodes(label_part)
+      emit_inline("](#{url})")
+    end
+  end
+
+  def handle_BOLD(nodes)
+    handle_tag(nodes, '**', 'strong')
+  end
+
+  def handle_EM(nodes)
+    handle_tag(nodes, '*', 'em')
+  end
+
+  def handle_BOLD_WORD(word)
+    add_tag('strong', '**', convert_string(word))
+  end
+
+  def handle_EM_WORD(word)
+    add_tag('em', '*', convert_string(word))
+  end
+
+  def handle_TT(text)
+    add_tag('code', '`', convert_string(text))
+  end
+
+  def handle_STRIKE(nodes)
+    handle_tag(nodes, '~~', 's')
+  end
+
+  def handle_HARD_BREAK
+    emit_inline("  \n")
+  end
+
   ##
   # Prepares the visitor for consuming `list`
 
-  def accept_list_start list
+  def accept_list_start(list)
     case list.type
     when :BULLET, :LABEL, :NOTE then
       @list_index << nil
@@ -114,7 +156,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Adds `rule` to the output
 
-  def accept_rule rule
+  def accept_rule(rule)
     use_prefix or @res << ' ' * @indent
     @res << '-' * 3
     @res << "\n"
@@ -123,7 +165,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Outputs `verbatim` indented 4 columns
 
-  def accept_verbatim verbatim
+  def accept_verbatim(verbatim)
     indent = ' ' * (@indent + 4)
 
     verbatim.parts.each do |part|
@@ -137,7 +179,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Creates a Markdown-style URL from +url+ with +text+.
 
-  def gen_url url, text
+  def gen_url(url, text)
     scheme, url, = parse_url url
 
     "[#{text.sub(%r{^#{scheme}:/*}i, '')}](#{url})"
@@ -146,7 +188,7 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
   ##
   # Handles <tt>rdoc-</tt> type links for footnotes.
 
-  def handle_rdoc_link url
+  def handle_rdoc_link(url)
     case url
     when /^rdoc-ref:/ then
       $'
@@ -163,30 +205,11 @@ class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
     end
   end
 
-  ##
-  # Converts the RDoc markup tidylink into a Markdown.style link.
-
-  def handle_regexp_TIDYLINK target
-    text = target.text
-
-    return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
-
-    label = $1
-    url   = $2
-
-    if url =~ /^rdoc-label:foot/ then
-      handle_rdoc_link url
-    else
-      gen_url url, label
-    end
-  end
-
   ##
   # Converts the rdoc-...: links into a Markdown.style links.
 
-  def handle_regexp_RDOCLINK target
-    handle_rdoc_link target.text
+  def handle_regexp_RDOCLINK(text)
+    handle_rdoc_link text
   end
 
 end
-

data/lib/rdoc/markup/to_rdoc.rb

@@ -3,6 +3,16 @@
 # Outputs RDoc markup as RDoc markup! (mostly)
 
 class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
+  DEFAULT_HEADINGS = {
+      1 => ['= ',      ''],
+      2 => ['== ',     ''],
+      3 => ['=== ',    ''],
+      4 => ['==== ',   ''],
+      5 => ['===== ',  ''],
+      6 => ['====== ', '']
+  }
+  DEFAULT_HEADINGS.default = []
+  DEFAULT_HEADINGS.freeze
 
   ##
   # Current indent amount for output in characters
@@ -42,46 +52,27 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Creates a new formatter that will output (mostly) \RDoc markup
 
-  def initialize markup = nil
-    super nil, markup
+  def initialize
+    super
 
     @markup.add_regexp_handling(/\\\S/, :SUPPRESSED_CROSSREF)
     @width = 78
-    init_tags
-
-    @headings = {}
-    @headings.default = []
-
-    @headings[1] = ['= ',      '']
-    @headings[2] = ['== ',     '']
-    @headings[3] = ['=== ',    '']
-    @headings[4] = ['==== ',   '']
-    @headings[5] = ['===== ',  '']
-    @headings[6] = ['====== ', '']
 
+    @headings = DEFAULT_HEADINGS.dup
     @hard_break = "\n"
   end
 
-  ##
-  # Maps attributes to HTML sequences
-
-  def init_tags
-    add_tag :BOLD, "<b>", "</b>"
-    add_tag :TT,   "<tt>", "</tt>"
-    add_tag :EM,   "<em>", "</em>"
-  end
-
   ##
   # Adds +blank_line+ to the output
 
-  def accept_blank_line blank_line
+  def accept_blank_line(blank_line)
     @res << "\n"
   end
 
   ##
   # Adds +paragraph+ to the output
 
-  def accept_block_quote block_quote
+  def accept_block_quote(block_quote)
     @indent += 2
 
     block_quote.parts.each do |part|
@@ -96,7 +87,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Adds +heading+ to the output
 
-  def accept_heading heading
+  def accept_heading(heading)
     use_prefix or @res << ' ' * @indent
     @res << @headings[heading.level][0]
     @res << attributes(heading.text)
@@ -107,7 +98,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Finishes consumption of +list+
 
-  def accept_list_end list
+  def accept_list_end(list)
     @list_index.pop
     @list_type.pop
     @list_width.pop
@@ -116,7 +107,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Finishes consumption of +list_item+
 
-  def accept_list_item_end list_item
+  def accept_list_item_end(list_item)
     width = case @list_type.last
             when :BULLET then
               2
@@ -140,16 +131,24 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Prepares the visitor for consuming +list_item+
 
-  def accept_list_item_start list_item
+  def accept_list_item_start(list_item)
     type = @list_type.last
 
     case type
     when :NOTE, :LABEL then
-      bullets = Array(list_item.label).map do |label|
+      stripped_labels = Array(list_item.label).map do |label|
         attributes(label).strip
-      end.join "\n"
+      end
 
-      bullets << ":\n" unless bullets.empty?
+      bullets = case type
+      when :NOTE
+        stripped_labels.map { |b| "#{b}::" }
+      when :LABEL
+        stripped_labels.map { |b| "[#{b}]" }
+      end
+
+      bullets = bullets.join("\n")
+      bullets << "\n" unless stripped_labels.empty?
 
       @prefix = ' ' * @indent
       @indent += 2
@@ -165,7 +164,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Prepares the visitor for consuming +list+
 
-  def accept_list_start list
+  def accept_list_start(list)
     case list.type
     when :BULLET then
       @list_index << nil
@@ -192,7 +191,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Adds +paragraph+ to the output
 
-  def accept_paragraph paragraph
+  def accept_paragraph(paragraph)
     text = paragraph.text @hard_break
     wrap attributes text
   end
@@ -200,7 +199,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Adds +paragraph+ to the output
 
-  def accept_indented_paragraph paragraph
+  def accept_indented_paragraph(paragraph)
     @indent += paragraph.indent
     text = paragraph.text @hard_break
     wrap attributes text
@@ -210,14 +209,14 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Adds +raw+ to the output
 
-  def accept_raw raw
+  def accept_raw(raw)
     @res << raw.parts.join("\n")
   end
 
   ##
   # Adds +rule+ to the output
 
-  def accept_rule rule
+  def accept_rule(rule)
     use_prefix or @res << ' ' * @indent
     @res << '-' * (@width - @indent)
     @res << "\n"
@@ -226,7 +225,7 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Outputs +verbatim+ indented 2 columns
 
-  def accept_verbatim verbatim
+  def accept_verbatim(verbatim)
     indent = ' ' * (@indent + 2)
 
     verbatim.parts.each do |part|
@@ -240,13 +239,15 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Adds +table+ to the output
 
-  def accept_table header, body, aligns
-    widths = header.zip(body) do |h, b|
-      [h.size, b.size].max
+  def accept_table(header, body, aligns)
+    header = header.map { |h| attributes h }
+    body = body.map { |row| row.map { |t| attributes t } }
+    widths = header.zip(*body).map do |cols|
+      cols.compact.map { |col| calculate_text_width(col) }.max
     end
     aligns = aligns.map do |a|
       case a
-      when nil
+      when nil, :center
         :center
       when :left
         :ljust
@@ -254,23 +255,108 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
         :rjust
       end
     end
-    @res << header.zip(widths, aligns) do |h, w, a|
-      h.__send__(a, w)
+    @res << header.zip(widths, aligns).map do |h, w, a|
+      extra_width = h.size - calculate_text_width(h)
+      h.__send__(a, w + extra_width)
     end.join("|").rstrip << "\n"
     @res << widths.map {|w| "-" * w }.join("|") << "\n"
     body.each do |row|
-      @res << row.zip(widths, aligns) do |t, w, a|
-        t.__send__(a, w)
+      @res << widths.zip(aligns).each_with_index.map do |(w, a), i|
+        t = row[i] || ""
+        extra_width = t.size - calculate_text_width(t)
+        t.__send__(a, w + extra_width)
       end.join("|").rstrip << "\n"
     end
   end
 
+  def calculate_text_width(text)
+    text.size
+  end
+
+  def handle_PLAIN_TEXT(text)
+    add_text(text)
+  end
+
+  def handle_REGEXP_HANDLING_TEXT(text)
+    add_text(text)
+  end
+
+  def handle_BOLD(target)
+    on(:BOLD)
+    super
+    off(:BOLD)
+  end
+
+  def handle_EM(target)
+    on(:EM)
+    super
+    off(:EM)
+  end
+
+  def handle_BOLD_WORD(word)
+    on(:BOLD)
+    super
+    off(:BOLD)
+  end
+
+  def handle_EM_WORD(word)
+    on(:EM)
+    super
+    off(:EM)
+  end
+
+  def handle_TT(code)
+    on(:TT)
+    super
+    off(:TT)
+  end
+
+  def handle_STRIKE(target)
+    on(:STRIKE)
+    super
+    off(:STRIKE)
+  end
+
+  def handle_HARD_BREAK
+    add_text("\n")
+  end
+
+  def handle_TIDYLINK(label_part, url)
+    super
+    add_text("( #{url} )")
+  end
+
+  def handle_inline(text, initial_attributes = [])
+    @attributes = Hash.new(0)
+    initial_attributes.each { |attr| on(attr) }
+    out = @inline_output = +''
+    super(text)
+    @inline_output = nil
+    out
+  end
+
+  def on(attr)
+    @attributes[attr] += 1
+  end
+
+  def off(attr)
+    @attributes[attr] -= 1
+    @attributes.delete(attr) if @attributes[attr] == 0
+  end
+
+  def add_text(text)
+    emit_inline(text)
+  end
+
+  def emit_inline(text)
+    @inline_output << text
+  end
+
   ##
-  # Applies attribute-specific markup to +text+ using RDoc::AttributeManager
+  # Applies attribute-specific markup to +text+ using RDoc::Markup::InlineParser
 
-  def attributes text
-    flow = @am.flow text.dup
-    convert_flow flow
+  def attributes(text)
+    handle_inline(text)
   end
 
   ##
@@ -283,17 +369,8 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Removes preceding \\ from the suppressed crossref +target+
 
-  def handle_regexp_SUPPRESSED_CROSSREF target
-    text = target.text
-    text = text.sub('\\', '') unless in_tt?
-    text
-  end
-
-  ##
-  # Adds a newline to the output
-
-  def handle_regexp_HARD_BREAK target
-    "\n"
+  def handle_regexp_SUPPRESSED_CROSSREF(text)
+    text.sub('\\', '')
   end
 
   ##
@@ -323,40 +400,22 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   ##
   # Wraps +text+ to #width
 
-  def wrap text
+  def wrap(text)
     return unless text && !text.empty?
 
     text_len = @width - @indent
 
     text_len = 20 if text_len < 20
 
-    re = /^(.{0,#{text_len}})[ \n]/
     next_prefix = ' ' * @indent
 
     prefix = @prefix || next_prefix
     @prefix = nil
 
-    @res << prefix
-
-    while text.length > text_len
-      if text =~ re then
-        @res << $1
-        text.slice!(0, $&.length)
-      else
-        @res << text.slice!(0, text_len)
-      end
-
-      @res << "\n" << next_prefix
-    end
-
-    if text.empty? then
-      @res.pop
-      @res.pop
-    else
-      @res << text
-      @res << "\n"
+    text.scan(/\G(?:([^ \n]{#{text_len}})(?=[^ \n])|(.{1,#{text_len}})(?:[ \n]|\z))/) do
+      @res << prefix << ($1 || $2) << "\n"
+      prefix = next_prefix
     end
   end
 
 end
-

data/lib/rdoc/markup/to_table_of_contents.rb

@@ -25,7 +25,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   attr_accessor :omit_headings_below
 
   def initialize # :nodoc:
-    super nil
+    super
 
     @omit_headings_below = nil
   end
@@ -33,7 +33,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   ##
   # Adds +document+ to the output, using its heading cutoff if present
 
-  def accept_document document
+  def accept_document(document)
     @omit_headings_below = document.omit_headings_below
 
     super
@@ -42,7 +42,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   ##
   # Adds +heading+ to the table of contents
 
-  def accept_heading heading
+  def accept_heading(heading)
     @res << heading unless suppressed? heading
   end
 
@@ -64,7 +64,7 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   ##
   # Returns true if +heading+ is below the display threshold
 
-  def suppressed? heading
+  def suppressed?(heading)
     return false unless @omit_headings_below
 
     heading.level > @omit_headings_below
@@ -86,4 +86,3 @@ class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
   # :startdoc:
 
 end
-

data/lib/rdoc/markup/to_test.rb

@@ -18,11 +18,19 @@ class RDoc::Markup::ToTest < RDoc::Markup::Formatter
     @res
   end
 
+  def handle_PLAIN_TEXT(text)
+    @res << text
+  end
+
+  def handle_REGEXP_HANDLING_TEXT(text)
+    @res << text
+  end
+
   def accept_paragraph(paragraph)
-    @res << convert_flow(@am.flow(paragraph.text))
+    handle_inline(paragraph.text)
   end
 
-  def accept_raw raw
+  def accept_raw(raw)
     @res << raw.parts.join
   end
 
@@ -67,4 +75,3 @@ class RDoc::Markup::ToTest < RDoc::Markup::Formatter
   # :startdoc:
 
 end
-