gitlab-rdoc 6.3.2

data/lib/rdoc/markup/to_ansi.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+##
+# Outputs RDoc markup with vibrant ANSI color!
+
+class RDoc::Markup::ToAnsi < RDoc::Markup::ToRdoc
+
+  ##
+  # Creates a new ToAnsi visitor that is ready to output vibrant ANSI color!
+
+  def initialize markup = nil
+    super
+
+    @headings.clear
+    @headings[1] = ["\e[1;32m", "\e[m"] # bold
+    @headings[2] = ["\e[4;32m", "\e[m"] # underline
+    @headings[3] = ["\e[32m",   "\e[m"] # just green
+  end
+
+  ##
+  # Maps attributes to ANSI sequences
+
+  def init_tags
+    add_tag :BOLD, "\e[1m", "\e[m"
+    add_tag :TT,   "\e[7m", "\e[m"
+    add_tag :EM,   "\e[4m", "\e[m"
+  end
+
+  ##
+  # Overrides indent width to ensure output lines up correctly.
+
+  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" unless res.length == 1
+              2
+            else
+              bullet = @list_index.last.to_s
+              @list_index[-1] = @list_index.last.succ
+              bullet.length + 2
+            end
+
+    @indent -= width
+  end
+
+  ##
+  # Adds coloring to note and label list items
+
+  def accept_list_item_start list_item
+    bullet = case @list_type.last
+             when :BULLET then
+               '*'
+             when :NOTE, :LABEL then
+               labels = Array(list_item.label).map do |label|
+                 attributes(label).strip
+               end.join "\n"
+
+               labels << ":\n" unless labels.empty?
+
+               labels
+             else
+               @list_index.last.to_s + '.'
+             end
+
+    case @list_type.last
+    when :NOTE, :LABEL then
+      @indent += 2
+      @prefix = bullet + (' ' * @indent)
+    else
+      @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
+
+      width = bullet.gsub(/\e\[[\d;]*m/, '').length + 1
+
+      @indent += width
+    end
+  end
+
+  ##
+  # Starts accepting with a reset screen
+
+  def start_accepting
+    super
+
+    @res = ["\e[0m"]
+  end
+
+end
+

data/lib/rdoc/markup/to_bs.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+##
+# Outputs RDoc markup with hot backspace action!  You will probably need a
+# pager to use this output format.
+#
+# This formatter won't work on 1.8.6 because it lacks String#chars.
+
+class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
+
+  ##
+  # Returns a new ToBs that is ready for hot backspace action!
+
+  def initialize markup = nil
+    super
+
+    @in_b  = false
+    @in_em = false
+  end
+
+  ##
+  # Sets a flag that is picked up by #annotate to do the right thing in
+  # #convert_string
+
+  def init_tags
+    add_tag :BOLD, '+b', '-b'
+    add_tag :EM,   '+_', '-_'
+    add_tag :TT,   ''  , ''   # we need in_tt information maintained
+  end
+
+  ##
+  # Makes heading text bold.
+
+  def accept_heading heading
+    use_prefix or @res << ' ' * @indent
+    @res << @headings[heading.level][0]
+    @in_b = true
+    @res << attributes(heading.text)
+    @in_b = false
+    @res << @headings[heading.level][1]
+    @res << "\n"
+  end
+
+  ##
+  # Turns on or off regexp handling for +convert_string+
+
+  def annotate tag
+    case tag
+    when '+b' then @in_b = true
+    when '-b' then @in_b = false
+    when '+_' then @in_em = true
+    when '-_' then @in_em = false
+    end
+    ''
+  end
+
+  ##
+  # Calls convert_string on the result of convert_regexp_handling
+
+  def convert_regexp_handling target
+    convert_string super
+  end
+
+  ##
+  # Adds bold or underline mixed with backspaces
+
+  def convert_string string
+    return string unless @in_b or @in_em
+    chars = if @in_b then
+              string.chars.map do |char| "#{char}\b#{char}" end
+            elsif @in_em then
+              string.chars.map do |char| "_\b#{char}" end
+            end
+
+    chars.join
+  end
+
+end

data/lib/rdoc/markup/to_html.rb

@@ -0,0 +1,444 @@
+# frozen_string_literal: true
+require 'cgi'
+
+##
+# Outputs RDoc markup as HTML.
+
+class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
+
+  include RDoc::Text
+
+  # :section: Utilities
+
+  ##
+  # Maps RDoc::Markup::Parser::LIST_TOKENS types to HTML tags
+
+  LIST_TYPE_TO_HTML = {
+    :BULLET => ['<ul>',                                      '</ul>'],
+    :LABEL  => ['<dl class="rdoc-list label-list">',         '</dl>'],
+    :LALPHA => ['<ol style="list-style-type: lower-alpha">', '</ol>'],
+    :NOTE   => ['<dl class="rdoc-list note-list">',          '</dl>'],
+    :NUMBER => ['<ol>',                                      '</ol>'],
+    :UALPHA => ['<ol style="list-style-type: upper-alpha">', '</ol>'],
+  }
+
+  attr_reader :res # :nodoc:
+  attr_reader :in_list_entry # :nodoc:
+  attr_reader :list # :nodoc:
+
+  ##
+  # The RDoc::CodeObject HTML is being generated for.  This is used to
+  # generate namespaced URI fragments
+
+  attr_accessor :code_object
+
+  ##
+  # Path to this document for relative links
+
+  attr_accessor :from_path
+
+  # :section:
+
+  ##
+  # Creates a new formatter that will output HTML
+
+  def initialize options, markup = nil
+    super
+
+    @code_object = nil
+    @from_path = ''
+    @in_list_entry = nil
+    @list = nil
+    @th = nil
+    @hard_break = "<br>\n"
+
+    init_regexp_handlings
+
+    init_tags
+  end
+
+  # :section: Regexp Handling
+  #
+  # These methods are used by regexp handling markup added by RDoc::Markup#add_regexp_handling.
+
+  ##
+  # Adds regexp handlings.
+
+  def init_regexp_handlings
+    # external links
+    @markup.add_regexp_handling(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)\S+\w/,
+                                :HYPERLINK)
+    init_link_notation_regexp_handlings
+  end
+
+  ##
+  # Adds regexp handlings about link notations.
+
+  def init_link_notation_regexp_handlings
+    add_regexp_handling_RDOCLINK
+    add_regexp_handling_TIDYLINK
+  end
+
+  def handle_RDOCLINK url # :nodoc:
+    case url
+    when /^rdoc-ref:/
+      $'
+    when /^rdoc-label:/
+      text = $'
+
+      text = case text
+             when /\Alabel-/    then $'
+             when /\Afootmark-/ then $'
+             when /\Afoottext-/ then $'
+             else                    text
+             end
+
+      gen_url url, text
+    when /^rdoc-image:/
+      "<img src=\"#{$'}\">"
+    else
+      url =~ /\Ardoc-[a-z]+:/
+
+      $'
+    end
+  end
+
+  ##
+  # +target+ is a <code><br></code>
+
+  def handle_regexp_HARD_BREAK target
+    '<br>'
+  end
+
+  ##
+  # +target+ is a potential link.  The following schemes are handled:
+  #
+  # <tt>mailto:</tt>::
+  #   Inserted as-is.
+  # <tt>http:</tt>::
+  #   Links are checked to see if they reference an image. If so, that image
+  #   gets inserted using an <tt><img></tt> tag. Otherwise a conventional
+  #   <tt><a href></tt> is used.
+  # <tt>link:</tt>::
+  #   Reference to a local file relative to the output directory.
+
+  def handle_regexp_HYPERLINK(target)
+    url = target.text
+
+    gen_url url, url
+  end
+
+  ##
+  # +target+ is an rdoc-schemed link that will be converted into a hyperlink.
+  #
+  # For the +rdoc-ref+ scheme the named reference will be returned without
+  # creating a link.
+  #
+  # For the +rdoc-label+ scheme the footnote and label prefixes are stripped
+  # when creating a link.  All other contents will be linked verbatim.
+
+  def handle_regexp_RDOCLINK target
+    handle_RDOCLINK target.text
+  end
+
+  ##
+  # This +target+ is a link where the label is different from the URL
+  # <tt>label[url]</tt> or <tt>{long label}[url]</tt>
+
+  def handle_regexp_TIDYLINK(target)
+    text = target.text
+
+    return text unless
+      text =~ /^\{(.*)\}\[(.*?)\]$/ or text =~ /^(\S+)\[(.*?)\]$/
+
+    label = $1
+    url   = $2
+
+    label = handle_RDOCLINK label if /^rdoc-image:/ =~ label
+
+    gen_url url, label
+  end
+
+  # :section: Visitor
+  #
+  # These methods implement the HTML visitor.
+
+  ##
+  # Prepares the visitor for HTML generation
+
+  def start_accepting
+    @res = []
+    @in_list_entry = []
+    @list = []
+  end
+
+  ##
+  # Returns the generated output
+
+  def end_accepting
+    @res.join
+  end
+
+  ##
+  # Adds +block_quote+ to the output
+
+  def accept_block_quote block_quote
+    @res << "\n<blockquote>"
+
+    block_quote.parts.each do |part|
+      part.accept self
+    end
+
+    @res << "</blockquote>\n"
+  end
+
+  ##
+  # Adds +paragraph+ to the output
+
+  def accept_paragraph paragraph
+    @res << "\n<p>"
+    text = paragraph.text @hard_break
+    text = text.gsub(/\r?\n/, ' ')
+    @res << to_html(text)
+    @res << "</p>\n"
+  end
+
+  ##
+  # Adds +verbatim+ to the output
+
+  def accept_verbatim verbatim
+    text = verbatim.text.rstrip
+
+    klass = nil
+
+    content = if verbatim.ruby? or parseable? text then
+                begin
+                  tokens = RDoc::Parser::RipperStateLex.parse text
+                  klass  = ' class="ruby"'
+
+                  result = RDoc::TokenStream.to_html tokens
+                  result = result + "\n" unless "\n" == result[-1]
+                  result
+                rescue
+                  CGI.escapeHTML text
+                end
+              else
+                CGI.escapeHTML text
+              end
+
+    if @options.pipe then
+      @res << "\n<pre><code>#{CGI.escapeHTML text}\n</code></pre>\n"
+    else
+      @res << "\n<pre#{klass}>#{content}</pre>\n"
+    end
+  end
+
+  ##
+  # Adds +rule+ to the output
+
+  def accept_rule rule
+    @res << "<hr>\n"
+  end
+
+  ##
+  # Prepares the visitor for consuming +list+
+
+  def accept_list_start(list)
+    @list << list.type
+    @res << html_list_name(list.type, true)
+    @in_list_entry.push false
+  end
+
+  ##
+  # Finishes consumption of +list+
+
+  def accept_list_end(list)
+    @list.pop
+    if tag = @in_list_entry.pop
+      @res << tag
+    end
+    @res << html_list_name(list.type, false) << "\n"
+  end
+
+  ##
+  # Prepares the visitor for consuming +list_item+
+
+  def accept_list_item_start(list_item)
+    if tag = @in_list_entry.last
+      @res << tag
+    end
+
+    @res << list_item_start(list_item, @list.last)
+  end
+
+  ##
+  # Finishes consumption of +list_item+
+
+  def accept_list_item_end(list_item)
+    @in_list_entry[-1] = list_end_for(@list.last)
+  end
+
+  ##
+  # Adds +blank_line+ to the output
+
+  def accept_blank_line(blank_line)
+    # @res << annotate("<p />") << "\n"
+  end
+
+  ##
+  # Adds +heading+ to the output.  The headings greater than 6 are trimmed to
+  # level 6.
+
+  def accept_heading heading
+    level = [6, heading.level].min
+
+    label = heading.label @code_object
+
+    @res << if @options.output_decoration
+              "\n<h#{level} id=\"#{label}\">"
+            else
+              "\n<h#{level}>"
+            end
+    @res << to_html(heading.text)
+    unless @options.pipe then
+      @res << "<span><a href=\"##{label}\">&para;</a>"
+      @res << " <a href=\"#top\">&uarr;</a></span>"
+    end
+    @res << "</h#{level}>\n"
+  end
+
+  ##
+  # Adds +raw+ to the output
+
+  def accept_raw raw
+    @res << raw.parts.join("\n")
+  end
+
+  ##
+  # Adds +table+ to the output
+
+  def accept_table header, body, aligns
+    @res << "\n<table role=\"table\">\n<thead>\n<tr>\n"
+    header.zip(aligns) do |text, align|
+      @res << '<th'
+      @res << ' align="' << align << '"' if align
+      @res << '>' << CGI.escapeHTML(text) << "</th>\n"
+    end
+    @res << "</tr>\n</thead>\n<tbody>\n"
+    body.each do |row|
+      @res << "<tr>\n"
+      row.zip(aligns) do |text, align|
+        @res << '<td'
+        @res << ' align="' << align << '"' if align
+        @res << '>' << CGI.escapeHTML(text) << "</td>\n"
+      end
+      @res << "</tr>\n"
+    end
+    @res << "</tbody>\n</table>\n"
+  end
+
+  # :section: Utilities
+
+  ##
+  # CGI-escapes +text+
+
+  def convert_string(text)
+    CGI.escapeHTML text
+  end
+
+  ##
+  # Generate a link to +url+ with content +text+.  Handles the special cases
+  # for img: and link: described under handle_regexp_HYPERLINK
+
+  def gen_url url, text
+    scheme, url, id = parse_url url
+
+    if %w[http https link].include?(scheme) and
+       url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
+      "<img src=\"#{url}\" />"
+    else
+      if scheme != 'link' and /\.(?:rb|rdoc|md)\z/i =~ url
+        url = url.sub(%r%\A([./]*)(.*)\z%) { "#$1#{$2.tr('.', '_')}.html" }
+      end
+
+      text = text.sub %r%^#{scheme}:/*%i, ''
+      text = text.sub %r%^[*\^](\d+)$%,   '\1'
+
+      link = "<a#{id} href=\"#{url}\">#{text}</a>"
+
+      link = "<sup>#{link}</sup>" if /"foot/ =~ id
+
+      link
+    end
+  end
+
+  ##
+  # Determines the HTML list element for +list_type+ and +open_tag+
+
+  def html_list_name(list_type, open_tag)
+    tags = LIST_TYPE_TO_HTML[list_type]
+    raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless tags
+    tags[open_tag ? 0 : 1]
+  end
+
+  ##
+  # Maps attributes to HTML tags
+
+  def init_tags
+    add_tag :BOLD, "<strong>", "</strong>"
+    add_tag :TT,   "<code>",   "</code>"
+    add_tag :EM,   "<em>",     "</em>"
+  end
+
+  ##
+  # Returns the HTML tag for +list_type+, possible using a label from
+  # +list_item+
+
+  def list_item_start(list_item, list_type)
+    case list_type
+    when :BULLET, :LALPHA, :NUMBER, :UALPHA then
+      "<li>"
+    when :LABEL, :NOTE then
+      Array(list_item.label).map do |label|
+        "<dt>#{to_html label}\n"
+      end.join << "<dd>"
+    else
+      raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
+    end
+  end
+
+  ##
+  # Returns the HTML end-tag for +list_type+
+
+  def list_end_for(list_type)
+    case list_type
+    when :BULLET, :LALPHA, :NUMBER, :UALPHA then
+      "</li>"
+    when :LABEL, :NOTE then
+      "</dd>"
+    else
+      raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
+    end
+  end
+
+  ##
+  # Returns true if text is valid ruby syntax
+
+  def parseable? text
+    verbose, $VERBOSE = $VERBOSE, nil
+    eval("BEGIN {return true}\n#{text}")
+  rescue SyntaxError
+    false
+  ensure
+    $VERBOSE = verbose
+  end
+
+  ##
+  # Converts +item+ to HTML using RDoc::Text#to_html
+
+  def to_html item
+    super convert_flow @am.flow item
+  end
+
+end
+