gitlab-rdoc 6.3.2

data/lib/rdoc/markup/to_joined_paragraph.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+##
+# Joins the parts of an RDoc::Markup::Paragraph into a single String.
+#
+# This allows for easier maintenance and testing of Markdown support.
+#
+# This formatter only works on Paragraph instances.  Attempting to process
+# other markup syntax items will not work.
+
+class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
+
+  def initialize # :nodoc:
+    super nil
+  end
+
+  def start_accepting # :nodoc:
+  end
+
+  def end_accepting # :nodoc:
+  end
+
+  ##
+  # Converts the parts of +paragraph+ to a single entry.
+
+  def accept_paragraph paragraph
+    parts = paragraph.parts.chunk do |part|
+      String === part
+    end.map do |string, chunk|
+      string ? chunk.join.rstrip : chunk
+    end.flatten
+
+    paragraph.parts.replace parts
+  end
+
+  alias accept_block_quote     ignore
+  alias accept_heading         ignore
+  alias accept_list_end        ignore
+  alias accept_list_item_end   ignore
+  alias accept_list_item_start ignore
+  alias accept_list_start      ignore
+  alias accept_raw             ignore
+  alias accept_rule            ignore
+  alias accept_verbatim        ignore
+  alias accept_table           ignore
+
+end
+

data/lib/rdoc/markup/to_label.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require 'cgi'
+
+##
+# Creates HTML-safe labels suitable for use in id attributes.  Tidylinks are
+# converted to their link part and cross-reference links have the suppression
+# marks removed (\\SomeClass is converted to SomeClass).
+
+class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
+
+  attr_reader :res # :nodoc:
+
+  ##
+  # Creates a new formatter that will output HTML-safe labels
+
+  def initialize markup = nil
+    super nil, markup
+
+    @markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
+    @markup.add_regexp_handling(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)
+
+    add_tag :BOLD, '', ''
+    add_tag :TT,   '', ''
+    add_tag :EM,   '', ''
+
+    @res = []
+  end
+
+  ##
+  # Converts +text+ to an HTML-safe label
+
+  def convert text
+    label = convert_flow @am.flow text
+
+    CGI.escape(label).gsub('%', '-').sub(/^-/, '')
+  end
+
+  ##
+  # Converts the CROSSREF +target+ to plain text, removing the suppression
+  # marker, if any
+
+  def handle_regexp_CROSSREF target
+    text = target.text
+
+    text.sub(/^\\/, '')
+  end
+
+  ##
+  # Converts the TIDYLINK +target+ to just the text part
+
+  def handle_regexp_TIDYLINK target
+    text = target.text
+
+    return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
+
+    $1
+  end
+
+  alias accept_blank_line         ignore
+  alias accept_block_quote        ignore
+  alias accept_heading            ignore
+  alias accept_list_end           ignore
+  alias accept_list_item_end      ignore
+  alias accept_list_item_start    ignore
+  alias accept_list_start         ignore
+  alias accept_paragraph          ignore
+  alias accept_raw                ignore
+  alias accept_rule               ignore
+  alias accept_verbatim           ignore
+  alias end_accepting             ignore
+  alias handle_regexp_HARD_BREAK  ignore
+  alias start_accepting           ignore
+
+end
+

data/lib/rdoc/markup/to_markdown.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+# :markup: markdown
+
+##
+# Outputs parsed markup as Markdown
+
+class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
+
+  ##
+  # Creates a new formatter that will output Markdown format text
+
+  def initialize markup = nil
+    super
+
+    @headings[1] = ['# ',      '']
+    @headings[2] = ['## ',     '']
+    @headings[3] = ['### ',    '']
+    @headings[4] = ['#### ',   '']
+    @headings[5] = ['##### ',  '']
+    @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"
+
+    super
+  end
+
+  ##
+  # Finishes consumption of `list_item`
+
+  def accept_list_item_end list_item
+    width = case @list_type.last
+            when :BULLET then
+              4
+            when :NOTE, :LABEL then
+              use_prefix
+
+              4
+            else
+              @list_index[-1] = @list_index.last.succ
+              4
+            end
+
+    @indent -= width
+  end
+
+  ##
+  # Prepares the visitor for consuming `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|
+        attributes(label).strip
+      end.join "\n"
+
+      bullets << "\n:"
+
+      @prefix = ' ' * @indent
+      @indent += 4
+      @prefix << bullets + (' ' * (@indent - 1))
+    else
+      bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.'
+      @prefix = (' ' * @indent) + bullet.ljust(4)
+
+      @indent += 4
+    end
+  end
+
+  ##
+  # Prepares the visitor for consuming `list`
+
+  def accept_list_start list
+    case list.type
+    when :BULLET, :LABEL, :NOTE then
+      @list_index << nil
+    when :LALPHA, :NUMBER, :UALPHA then
+      @list_index << 1
+    else
+      raise RDoc::Error, "invalid list type #{list.type}"
+    end
+
+    @list_width << 4
+    @list_type << list.type
+  end
+
+  ##
+  # Adds `rule` to the output
+
+  def accept_rule rule
+    use_prefix or @res << ' ' * @indent
+    @res << '-' * 3
+    @res << "\n"
+  end
+
+  ##
+  # Outputs `verbatim` indented 4 columns
+
+  def accept_verbatim verbatim
+    indent = ' ' * (@indent + 4)
+
+    verbatim.parts.each do |part|
+      @res << indent unless part == "\n"
+      @res << part
+    end
+
+    @res << "\n"
+  end
+
+  ##
+  # Creates a Markdown-style URL from +url+ with +text+.
+
+  def gen_url url, text
+    scheme, url, = parse_url url
+
+    "[#{text.sub(%r{^#{scheme}:/*}i, '')}](#{url})"
+  end
+
+  ##
+  # Handles <tt>rdoc-</tt> type links for footnotes.
+
+  def handle_rdoc_link url
+    case url
+    when /^rdoc-ref:/ then
+      $'
+    when /^rdoc-label:footmark-(\d+)/ then
+      "[^#{$1}]:"
+    when /^rdoc-label:foottext-(\d+)/ then
+      "[^#{$1}]"
+    when /^rdoc-label:label-/ then
+      gen_url url, $'
+    when /^rdoc-image:/ then
+      "![](#{$'})"
+    when /^rdoc-[a-z]+:/ then
+      $'
+    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
+  end
+
+end
+

data/lib/rdoc/markup/to_rdoc.rb

@@ -0,0 +1,362 @@
+# frozen_string_literal: true
+##
+# Outputs RDoc markup as RDoc markup! (mostly)
+
+class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
+
+  ##
+  # Current indent amount for output in characters
+
+  attr_accessor :indent
+
+  ##
+  # Output width in characters
+
+  attr_accessor :width
+
+  ##
+  # Stack of current list indexes for alphabetic and numeric lists
+
+  attr_reader :list_index
+
+  ##
+  # Stack of list types
+
+  attr_reader :list_type
+
+  ##
+  # Stack of list widths for indentation
+
+  attr_reader :list_width
+
+  ##
+  # Prefix for the next list item.  See #use_prefix
+
+  attr_reader :prefix
+
+  ##
+  # Output accumulator
+
+  attr_reader :res
+
+  ##
+  # Creates a new formatter that will output (mostly) \RDoc markup
+
+  def initialize markup = nil
+    super nil, markup
+
+    @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] = ['====== ', '']
+
+    @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
+    @res << "\n"
+  end
+
+  ##
+  # Adds +paragraph+ to the output
+
+  def accept_block_quote block_quote
+    @indent += 2
+
+    block_quote.parts.each do |part|
+      @prefix = '> '
+
+      part.accept self
+    end
+
+    @indent -= 2
+  end
+
+  ##
+  # Adds +heading+ to the output
+
+  def accept_heading heading
+    use_prefix or @res << ' ' * @indent
+    @res << @headings[heading.level][0]
+    @res << attributes(heading.text)
+    @res << @headings[heading.level][1]
+    @res << "\n"
+  end
+
+  ##
+  # Finishes consumption of +list+
+
+  def accept_list_end list
+    @list_index.pop
+    @list_type.pop
+    @list_width.pop
+  end
+
+  ##
+  # Finishes consumption of +list_item+
+
+  def accept_list_item_end list_item
+    width = case @list_type.last
+            when :BULLET then
+              2
+            when :NOTE, :LABEL then
+              if @prefix then
+                @res << @prefix.strip
+                @prefix = nil
+              end
+
+              @res << "\n"
+              2
+            else
+              bullet = @list_index.last.to_s
+              @list_index[-1] = @list_index.last.succ
+              bullet.length + 2
+            end
+
+    @indent -= width
+  end
+
+  ##
+  # Prepares the visitor for consuming +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|
+        attributes(label).strip
+      end.join "\n"
+
+      bullets << ":\n" unless bullets.empty?
+
+      @prefix = ' ' * @indent
+      @indent += 2
+      @prefix << bullets + (' ' * @indent)
+    else
+      bullet = type == :BULLET ? '*' :  @list_index.last.to_s + '.'
+      @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
+      width = bullet.length + 1
+      @indent += width
+    end
+  end
+
+  ##
+  # Prepares the visitor for consuming +list+
+
+  def accept_list_start list
+    case list.type
+    when :BULLET then
+      @list_index << nil
+      @list_width << 1
+    when :LABEL, :NOTE then
+      @list_index << nil
+      @list_width << 2
+    when :LALPHA then
+      @list_index << 'a'
+      @list_width << list.items.length.to_s.length
+    when :NUMBER then
+      @list_index << 1
+      @list_width << list.items.length.to_s.length
+    when :UALPHA then
+      @list_index << 'A'
+      @list_width << list.items.length.to_s.length
+    else
+      raise RDoc::Error, "invalid list type #{list.type}"
+    end
+
+    @list_type << list.type
+  end
+
+  ##
+  # Adds +paragraph+ to the output
+
+  def accept_paragraph paragraph
+    text = paragraph.text @hard_break
+    wrap attributes text
+  end
+
+  ##
+  # Adds +paragraph+ to the output
+
+  def accept_indented_paragraph paragraph
+    @indent += paragraph.indent
+    text = paragraph.text @hard_break
+    wrap attributes text
+    @indent -= paragraph.indent
+  end
+
+  ##
+  # Adds +raw+ to the output
+
+  def accept_raw raw
+    @res << raw.parts.join("\n")
+  end
+
+  ##
+  # Adds +rule+ to the output
+
+  def accept_rule rule
+    use_prefix or @res << ' ' * @indent
+    @res << '-' * (@width - @indent)
+    @res << "\n"
+  end
+
+  ##
+  # Outputs +verbatim+ indented 2 columns
+
+  def accept_verbatim verbatim
+    indent = ' ' * (@indent + 2)
+
+    verbatim.parts.each do |part|
+      @res << indent unless part == "\n"
+      @res << part
+    end
+
+    @res << "\n"
+  end
+
+  ##
+  # Adds +table+ to the output
+
+  def accept_table header, body, aligns
+    widths = header.zip(body) do |h, b|
+      [h.size, b.size].max
+    end
+    aligns = aligns.map do |a|
+      case a
+      when nil
+        :center
+      when :left
+        :ljust
+      when :right
+        :rjust
+      end
+    end
+    @res << header.zip(widths, aligns) do |h, w, a|
+      h.__send__(a, w)
+    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)
+      end.join("|").rstrip << "\n"
+    end
+  end
+
+  ##
+  # Applies attribute-specific markup to +text+ using RDoc::AttributeManager
+
+  def attributes text
+    flow = @am.flow text.dup
+    convert_flow flow
+  end
+
+  ##
+  # Returns the generated output
+
+  def end_accepting
+    @res.join
+  end
+
+  ##
+  # 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"
+  end
+
+  ##
+  # Prepares the visitor for text generation
+
+  def start_accepting
+    @res = [""]
+    @indent = 0
+    @prefix = nil
+
+    @list_index = []
+    @list_type  = []
+    @list_width = []
+  end
+
+  ##
+  # Adds the stored #prefix to the output and clears it.  Lists generate a
+  # prefix for later consumption.
+
+  def use_prefix
+    prefix, @prefix = @prefix, nil
+    @res << prefix if prefix
+
+    prefix
+  end
+
+  ##
+  # Wraps +text+ to #width
+
+  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"
+    end
+  end
+
+end
+