rdoc 4.0.1 → 4.1.0.preview.3

data/lib/rdoc/markdown/literals_1_8.kpeg

@@ -6,7 +6,7 @@
 ##
 # Provides Literals appropriate for your ruby version.
 #--
-# This set of literals is for ruby 1.8 regular expressions.
+# This set of literals is for Ruby 1.8 regular expressions.
 }
 
 Alphanumeric      = /[0-9A-Za-z\200-\377]/

data/lib/rdoc/markdown/literals_1_8.rb

@@ -3,7 +3,7 @@
 ##
 # Provides Literals appropriate for your ruby version.
 #--
-# This set of literals is for ruby 1.8 regular expressions.
+# This set of literals is for Ruby 1.8 regular expressions.
 class RDoc::Markdown::Literals
   # :stopdoc:
 
@@ -19,8 +19,7 @@ class RDoc::Markdown::Literals
     # Prepares for parsing +str+.  If you define a custom initialize you must
     # call this method before #parse
     def setup_parser(str, debug=false)
-      @string = str
-      @pos = 0
+      set_string str, 0
       @memoizations = Hash.new { |h,k| h[k] = {} }
       @result = nil
       @failed_rule = nil
@@ -33,7 +32,6 @@ class RDoc::Markdown::Literals
     attr_reader :failing_rule_offset
     attr_accessor :result, :pos
 
-    
     def current_column(target=pos)
       if c = string.rindex("\n", target-1)
         return target - c - 1
@@ -67,6 +65,13 @@ class RDoc::Markdown::Literals
       @string[start..@pos-1]
     end
 
+    # Sets the string and current parsing position for the parser.
+    def set_string string, pos
+      @string = string
+      @string_size = string ? string.size : 0
+      @pos = pos
+    end
+
     def show_pos
       width = 10
       if @pos < width
@@ -173,19 +178,19 @@ class RDoc::Markdown::Literals
       return nil
     end
 
-    if "".respond_to? :getbyte
+    if "".respond_to? :ord
       def get_byte
-        if @pos >= @string.size
+        if @pos >= @string_size
           return nil
         end
 
-        s = @string.getbyte @pos
+        s = @string[@pos].ord
         @pos += 1
         s
       end
     else
       def get_byte
-        if @pos >= @string.size
+        if @pos >= @string_size
           return nil
         end
 
@@ -234,8 +239,7 @@ class RDoc::Markdown::Literals
       old_pos = @pos
       old_string = @string
 
-      @pos = other.pos
-      @string = other.string
+      set_string other.string, other.pos
 
       begin
         if val = __send__(rule, *args)
@@ -246,8 +250,7 @@ class RDoc::Markdown::Literals
         end
         val
       ensure
-        @pos = old_pos
-        @string = old_string
+        set_string old_string, old_pos
       end
     end
 

data/lib/rdoc/markdown/literals_1_9.kpeg

@@ -6,7 +6,7 @@
 
 ##
 #--
-# This set of literals is for ruby 1.9 regular expressions and gives full
+# This set of literals is for Ruby 1.9 regular expressions and gives full
 # unicode support.
 #
 # Unlike peg-markdown, this set of literals recognizes Unicode alphanumeric

data/lib/rdoc/markdown/literals_1_9.rb

@@ -3,7 +3,7 @@
 
 ##
 #--
-# This set of literals is for ruby 1.9 regular expressions and gives full
+# This set of literals is for Ruby 1.9 regular expressions and gives full
 # unicode support.
 #
 # Unlike peg-markdown, this set of literals recognizes Unicode alphanumeric
@@ -23,8 +23,7 @@ class RDoc::Markdown::Literals
     # Prepares for parsing +str+.  If you define a custom initialize you must
     # call this method before #parse
     def setup_parser(str, debug=false)
-      @string = str
-      @pos = 0
+      set_string str, 0
       @memoizations = Hash.new { |h,k| h[k] = {} }
       @result = nil
       @failed_rule = nil
@@ -37,7 +36,6 @@ class RDoc::Markdown::Literals
     attr_reader :failing_rule_offset
     attr_accessor :result, :pos
 
-    
     def current_column(target=pos)
       if c = string.rindex("\n", target-1)
         return target - c - 1
@@ -71,6 +69,13 @@ class RDoc::Markdown::Literals
       @string[start..@pos-1]
     end
 
+    # Sets the string and current parsing position for the parser.
+    def set_string string, pos
+      @string = string
+      @string_size = string ? string.size : 0
+      @pos = pos
+    end
+
     def show_pos
       width = 10
       if @pos < width
@@ -177,19 +182,19 @@ class RDoc::Markdown::Literals
       return nil
     end
 
-    if "".respond_to? :getbyte
+    if "".respond_to? :ord
       def get_byte
-        if @pos >= @string.size
+        if @pos >= @string_size
           return nil
         end
 
-        s = @string.getbyte @pos
+        s = @string[@pos].ord
         @pos += 1
         s
       end
     else
       def get_byte
-        if @pos >= @string.size
+        if @pos >= @string_size
           return nil
         end
 
@@ -238,8 +243,7 @@ class RDoc::Markdown::Literals
       old_pos = @pos
       old_string = @string
 
-      @pos = other.pos
-      @string = other.string
+      set_string other.string, other.pos
 
       begin
         if val = __send__(rule, *args)
@@ -250,8 +254,7 @@ class RDoc::Markdown::Literals
         end
         val
       ensure
-        @pos = old_pos
-        @string = old_string
+        set_string old_string, old_pos
       end
     end
 

data/lib/rdoc/markup.rb

@@ -127,7 +127,7 @@
 # left, so the amount of indentation of verbatim text is unimportant.
 #
 # For HTML output RDoc makes a small effort to determine if a verbatim section
-# contains ruby source code.  If so, the verbatim block will be marked up as
+# contains Ruby source code.  If so, the verbatim block will be marked up as
 # HTML.  Triggers include "def", "class", "module", "require", the "hash
 # rocket"# (=>) or a block call with a parameter.
 #
@@ -171,22 +171,13 @@
 # === Rules
 #
 # A line starting with three or more hyphens (at the current indent)
-# generates a horizontal rule.  The more hyphens, the thicker the rule
-# (within reason, and if supported by the output device).
-#
-# In the case of HTML output, three dashes generate a 1-pixel high rule,
-# four dashes result in 2 pixels, and so on. The actual height is limited
-# to 10 pixels:
+# generates a horizontal rule.
 #
 #   ---
-#   -----
-#   -----------------------------------------------------
 #
 # produces:
 #
 # ---
-# -----
-# -----------------------------------------------------
 #
 # === Simple Lists
 #
@@ -356,12 +347,18 @@
 # with <tt>+</tt> like <tt>RDoc::Markup@Escaping+Text+Markup</tt>.
 # Punctuation and other special characters must be escaped like CGI.escape.
 #
+# The <tt>@</tt> can also be used to link to sections.  If a section and a
+# heading share the same name the section is preferred for the link.
+#
 # Links can also be of the form <tt>label[url]</tt>, in which case +label+ is
 # used in the displayed text, and +url+ is used as the target.  If +label+
 # contains multiple words, put it in braces: <tt>{multi word label}[url]</tt>.
 # The +url+ may be an +http:+-type link or a cross-reference to a class,
 # module or method with a label.
 #
+# Links with the <code>rdoc-image:</code> scheme will create an image tag for
+# HTML output.  Only fully-qualified URLs are supported.
+#
 # Links with the <tt>rdoc-ref:</tt> scheme will link to the referenced class,
 # module, method, file, etc.  If the referenced item is does not exist
 # no link will be generated and <tt>rdoc-ref:</tt> will be removed from the
@@ -683,7 +680,7 @@
 #
 # [+:markup:+ _type_]
 #   Overrides the default markup type for this comment with the specified
-#   markup type.  For ruby files, if the first comment contains this directive
+#   markup type.  For Ruby files, if the first comment contains this directive
 #   it is applied automatically to all comments in the file.
 #
 #   Unless you are converting between markup formats you should use a
@@ -713,7 +710,7 @@
 #     def some_method
 #       # ...
 #
-#   See Markup@DEVELOPERS for instructions on adding a new markup format.
+#   See Markup@CONTRIBUTING for instructions on adding a new markup format.
 #
 # [+:include:+ _filename_]
 #   Include the contents of the named file at this point. This directive

data/lib/rdoc/markup/attribute_manager.rb

@@ -186,8 +186,9 @@ class RDoc::Markup::AttributeManager
     # protect __send__, __FILE__, etc.
     @str.gsub!(/__([a-z]+)__/i,
       "_#{PROTECT_ATTR}_#{PROTECT_ATTR}\\1_#{PROTECT_ATTR}_#{PROTECT_ATTR}")
-    @str.gsub!(/\\([#{Regexp.escape @protectable.join('')}])/,
-               "\\1#{PROTECT_ATTR}")
+    @str.gsub!(/(\A|[^\\])\\([#{Regexp.escape @protectable.join}])/m,
+               "\\1\\2#{PROTECT_ATTR}")
+    @str.gsub!(/\\(\\[#{Regexp.escape @protectable.join}])/m, "\\1")
   end
 
   ##

data/lib/rdoc/markup/formatter.rb

@@ -80,7 +80,7 @@ class RDoc::Markup::Formatter
   # Adds a special for links of the form rdoc-...:
 
   def add_special_RDOCLINK
-    @markup.add_special(/rdoc-[a-z]+:\S+/, :RDOCLINK)
+    @markup.add_special(/rdoc-[a-z]+:[^\s\]]+/, :RDOCLINK)
   end
 
   ##
@@ -88,7 +88,7 @@ class RDoc::Markup::Formatter
 
   def add_special_TIDYLINK
     @markup.add_special(/(?:
-                          \{.*?\} |   # multi-word label
+                          \{.*?\} |    # multi-word label
                           \b[^\s{}]+? # single-word label
                          )
 
@@ -239,7 +239,7 @@ class RDoc::Markup::Formatter
     else
       scheme = 'http'
       path   = url
-      url    = "http://#{url}"
+      url    = url
     end
 
     if scheme == 'link' then

data/lib/rdoc/markup/heading.rb

@@ -47,6 +47,19 @@ RDoc::Markup::Heading =
     "label-#{self.class.to_label.convert text.dup}"
   end
 
+  ##
+  # Creates a fully-qualified label which will include the label from
+  # +context+.  This helps keep ids unique in HTML.
+
+  def label context = nil
+    label = aref
+
+    label = [context.aref, label].compact.join '-' if
+      context and context.respond_to? :aref
+
+    label
+  end
+
   ##
   # HTML markup of the text of this label without the surrounding header
   # element.

data/lib/rdoc/markup/parser.rb

@@ -389,7 +389,7 @@ class RDoc::Markup::Parser
         skip :NEWLINE
       when :TEXT then
         unget
-        parent << build_paragraph(indent)
+        parse_text parent, indent
       when *LIST_TOKENS then
         unget
         parent << build_list(indent)
@@ -405,6 +405,13 @@ class RDoc::Markup::Parser
 
   end
 
+  ##
+  # Small hook that is overridden by RDoc::TomDoc
+
+  def parse_text parent, indent # :nodoc:
+    parent << build_paragraph(indent)
+  end
+
   ##
   # Returns the next token on the stream without modifying the stream
 
@@ -528,8 +535,8 @@ class RDoc::Markup::Parser
   end
 
   ##
-  # Calculates the column (by character) and line of the current token from
-  # +scanner+ based on +byte_offset+.
+  # Calculates the column (by character) and line of the current token based
+  # on +byte_offset+.
 
   def token_pos byte_offset
     offset = char_pos byte_offset

data/lib/rdoc/markup/pre_process.rb

@@ -151,7 +151,7 @@ class RDoc::Markup::PreProcess
 
     case directive
     when 'arg', 'args' then
-      return blankline unless code_object
+      return "#{prefix}:#{directive}: #{param}\n" unless code_object
 
       code_object.params = param
 

data/lib/rdoc/markup/to_html.rb

@@ -65,6 +65,30 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   #
   # These methods handle special markup added by RDoc::Markup#add_special.
 
+  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
+
   ##
   # +special+ is a <code><br></code>
 
@@ -100,27 +124,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   # when creating a link.  All other contents will be linked verbatim.
 
   def handle_special_RDOCLINK special
-    url = special.text
-
-    case url
-    when /\Ardoc-ref:/
-      $'
-    when /\Ardoc-label:/
-      text = $'
-
-      text = case text
-             when /\Alabel-/    then $'
-             when /\Afootmark-/ then "^#{$'}"
-             when /\Afoottext-/ then "*#{$'}"
-             else                    text
-             end
-
-      gen_url url, text
-    else
-      url =~ /\Ardoc-[a-z]+:/
-
-      $'
-    end
+    handle_RDOCLINK special.text
   end
 
   ##
@@ -130,10 +134,14 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   def handle_special_TIDYLINK(special)
     text = special.text
 
-    return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
+    return text unless
+      text =~ /^\{(.*)\}\[(.*?)\]$/ or text =~ /^(\S+)\[(.*?)\]$/
 
     label = $1
     url   = $2
+
+    label = handle_RDOCLINK label if /^rdoc-image:/ =~ label
+
     gen_url url, label
   end
 
@@ -212,10 +220,8 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   ##
   # Adds +rule+ to the output
 
-  def accept_rule(rule)
-    size = rule.weight
-    size = 10 if size > 10
-    @res << "<hr style=\"height: #{size}px\">\n"
+  def accept_rule rule
+    @res << "<hr>\n"
   end
 
   ##
@@ -270,11 +276,13 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
   def accept_heading heading
     level = [6, heading.level].min
 
-    label = heading.aref
-    label = [@code_object.aref, label].compact.join '-' if
-      @code_object and @code_object.respond_to? :aref
+    label = heading.label @code_object
 
-    @res << "\n<h#{level} id=\"#{label}\">"
+    @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>"
@@ -310,7 +318,14 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
        url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
       "<img src=\"#{url}\" />"
     else
-      "<a#{id} href=\"#{url}\">#{text.sub(%r{^#{scheme}:/*}i, '')}</a>"
+      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