rdoc 5.0.0 → 6.3.1

data/lib/rdoc/generator/template/json_index/js/searcher.js

@@ -51,20 +51,20 @@ Searcher.prototype = new function() {
 
   /*  ----- Utilities ------  */
   function splitQuery(query) {
-    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+    return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
       return string.match(/\S/);
     });
   }
 
   function buildRegexps(queries) {
-    return jQuery.map(queries, function(query) {
+    return queries.map(function(query) {
       return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
     });
   }
 
   function buildHilighters(queries) {
-    return jQuery.map(queries, function(query) {
-      return jQuery.map(query.split(''), function(l, i) {
+    return queries.map(function(query) {
+      return query.split('').map(function(l, i) {
         return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
       }).join('');
     });
@@ -221,9 +221,9 @@ Searcher.prototype = new function() {
   }
 
   function triggerResults(results, isLast) {
-    jQuery.each(this.handlers, function(i, fn) {
+    this.handlers.forEach(function(fn) {
       fn.call(this, results, isLast)
-    })
+    });
   }
 }
 

data/lib/rdoc/generator.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # RDoc uses generators to turn parsed source code in the form of an
 # RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML

data/lib/rdoc/ghost_method.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # GhostMethod represents a method referenced only by a comment
 

data/lib/rdoc/i18n/locale.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A message container for a locale.
 #
@@ -92,7 +92,7 @@ class RDoc::I18n::Locale
   end
 
   ##
-  # Translates the +message+ into locale. If there is no tranlsation
+  # Translates the +message+ into locale. If there is no translation
   # messages for +message+ in locale, +message+ itself is returned.
 
   def translate(message)

data/lib/rdoc/i18n/text.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # An i18n supported text.
 #
@@ -46,9 +46,9 @@ class RDoc::I18n::Text
     parse do |part|
       case part[:type]
       when :paragraph
-        translated_text << locale.translate(part[:paragraph])
+        translated_text += locale.translate(part[:paragraph])
       when :empty_line
-        translated_text << part[:line]
+        translated_text += part[:line]
       else
         raise "should not reach here: unexpected type: #{type}"
       end
@@ -69,14 +69,14 @@ class RDoc::I18n::Text
         if paragraph.empty?
           emit_empty_line_event(line, line_no, &block)
         else
-          paragraph << line
+          paragraph += line
           emit_paragraph_event(paragraph, paragraph_start_line, line_no,
                                &block)
           paragraph = ''
         end
       else
         paragraph_start_line = line_no if paragraph.empty?
-        paragraph << line
+        paragraph += line
       end
     end
 

data/lib/rdoc/i18n.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
-# This module provides i18n realated features.
+# This module provides i18n related features.
 
 module RDoc::I18n
 
   autoload :Locale, 'rdoc/i18n/locale'
-  autoload :Text,   'rdoc/i18n/text'
+  require_relative 'i18n/text'
 
 end

data/lib/rdoc/include.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A Module included in a class with \#include
 #

data/lib/rdoc/known_classes.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 module RDoc
 
   ##

data/lib/rdoc/markdown/entities.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # HTML entity name map for RDoc::Markdown
 

data/lib/rdoc/markdown/literals.kpeg

@@ -2,6 +2,7 @@
 
 %% header {
 # coding: UTF-8
+# frozen_string_literal: true
 # :markup: markdown
 
 ##

data/lib/rdoc/markdown/literals.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
-# frozen_string_literal: false
+# frozen_string_literal: true
 # :markup: markdown
 
 ##
@@ -183,14 +183,26 @@ class RDoc::Markdown::Literals
       return nil
     end
 
-    def get_byte
-      if @pos >= @string_size
-        return nil
+    if "".respond_to? :ord
+      def get_byte
+        if @pos >= @string_size
+          return nil
+        end
+
+        s = @string[@pos].ord
+        @pos += 1
+        s
       end
+    else
+      def get_byte
+        if @pos >= @string_size
+          return nil
+        end
 
-      s = @string[@pos].ord
-      @pos += 1
-      s
+        s = @string[@pos]
+        @pos += 1
+        s
+      end
     end
 
     def parse(rule=nil)

data/lib/rdoc/markdown.kpeg

@@ -2,6 +2,7 @@
 
 %% header {
 # coding: UTF-8
+# frozen_string_literal: true
 # :markup: markdown
 
 ##
@@ -84,6 +85,18 @@
 # :   A little insect that is known
 # to enjoy picnics
 #
+# ### Strike
+#
+# Example:
+#
+# ```
+# This is ~~striked~~.
+# ```
+#
+# Produces:
+#
+# This is ~~striked~~.
+#
 # ### Github
 #
 # The #github extension enables a partial set of [Github Flavored Markdown]
@@ -163,7 +176,7 @@
 # The port to kpeg was performed by Eric Hodel and Evan Phoenix
 #
 # [dingus]: http://daringfireball.net/projects/markdown/dingus
-# [GFM]: http://github.github.com/github-flavored-markdown/
+# [GFM]: https://github.github.com/gfm/
 # [pegmarkdown]: https://github.com/jgm/peg-markdown
 # [PHPE]: http://michelf.com/projects/php-markdown/extra/#def-list
 # [syntax]: http://daringfireball.net/projects/markdown/syntax
@@ -193,6 +206,7 @@
     :github,
     :html,
     :notes,
+    :strike,
   ]
 
   # :section: Extensions
@@ -243,6 +257,11 @@
 
   extension :notes
 
+  ##
+  # Enables the strike extension
+
+  extension :strike
+
   # :section:
 
   ##
@@ -331,7 +350,7 @@
   # with the linking `text` (usually whitespace).
 
   def link_to content, label = content, text = nil
-    raise 'enable notes extension' if
+    raise ParseError, 'enable notes extension' if
       content.start_with? '^' and label.equal? content
 
     if ref = @references[label] then
@@ -466,6 +485,17 @@
       "<b>#{text}</b>"
     end
   end
+
+  ##
+  # Wraps `text` in strike markup for rdoc inline formatting
+
+  def strike text
+    if text =~ /\A[a-z\d.\/-]+\z/i then
+      "~#{text}~"
+    else
+      "<s>#{text}</s>"
+    end
+  end
 }
 
 root = Doc
@@ -476,6 +506,7 @@ Block =     @BlankLine*
             ( BlockQuote
             | Verbatim
             | CodeFence
+            | Table
             | Note
             | Reference
             | HorizontalRule
@@ -494,27 +525,27 @@ Para =      @NonindentSpace Inlines:a @BlankLine+
 Plain =     Inlines:a
             { paragraph a }
 
-AtxInline = !@Newline !(@Sp? /#*/ @Sp @Newline) Inline
+AtxInline = !@Newline !(@Sp /#*/ @Sp @Newline) Inline
 
 AtxStart =  < /\#{1,6}/ >
             { text.length }
 
-AtxHeading = AtxStart:s @Sp? AtxInline+:a (@Sp? /#*/ @Sp)?  @Newline
+AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
             { RDoc::Markup::Heading.new(s, a.join) }
 
 SetextHeading = SetextHeading1 | SetextHeading2
 
-SetextBottom1 = /={3,}/ @Newline
+SetextBottom1 = /={1,}/ @Newline
 
-SetextBottom2 = /-{3,}/ @Newline
+SetextBottom2 = /-{1,}/ @Newline
 
 SetextHeading1 =  &(@RawLine SetextBottom1)
-                  @StartList:a ( !@Endline Inline:b { a << b } )+ @Sp? @Newline
+                  @StartList:a ( !@Endline Inline:b { a << b } )+ @Sp @Newline
                   SetextBottom1
                   { RDoc::Markup::Heading.new(1, a.join) }
 
 SetextHeading2 =  &(@RawLine SetextBottom2)
-                  @StartList:a ( !@Endline Inline:b { a << b })+ @Sp? @Newline
+                  @StartList:a ( !@Endline Inline:b { a << b })+ @Sp @Newline
                   SetextBottom2
                   { RDoc::Markup::Heading.new(2, a.join) }
 
@@ -733,6 +764,9 @@ HtmlBlockOpenScript = "<" Spnl ("script" | "SCRIPT") Spnl HtmlAttribute* ">"
 HtmlBlockCloseScript = "<" Spnl "/" ("script" | "SCRIPT") Spnl ">"
 HtmlBlockScript = HtmlBlockOpenScript (!HtmlBlockCloseScript .)* HtmlBlockCloseScript
 
+HtmlBlockOpenHead = "<" Spnl ("head" | "HEAD") Spnl HtmlAttribute* ">"
+HtmlBlockCloseHead = "<" Spnl "/" ("head" | "HEAD") Spnl ">"
+HtmlBlockHead = HtmlBlockOpenHead (!HtmlBlockCloseHead .)* HtmlBlockCloseHead
 
 HtmlBlockInTags = HtmlAnchor
                 | HtmlBlockAddress
@@ -768,6 +802,7 @@ HtmlBlockInTags = HtmlAnchor
                 | HtmlBlockThead
                 | HtmlBlockTr
                 | HtmlBlockScript
+                | HtmlBlockHead
 
 HtmlBlock = < ( HtmlBlockInTags | HtmlComment | HtmlBlockSelfClosing | HtmlUnclosed) >
             @BlankLine+
@@ -862,7 +897,8 @@ StyleBlock =    < InStyleTags >
                   end }
 
 Inlines  =  ( !@Endline Inline:i { i }
-            | @Endline:c &Inline { c } )+:chunks @Endline?
+            | @Endline:c !( &{ github? } Ticks3 /[^`\n]*$/ )
+	      &Inline { c } )+:chunks @Endline?
             { chunks }
 
 Inline  = Str
@@ -871,6 +907,7 @@ Inline  = Str
         | @Space
         | Strong
         | Emph
+        | Strike
         | Image
         | Link
         | NoteReference
@@ -896,7 +933,7 @@ Entity =    ( HexEntity | DecEntity | CharEntity ):a { a }
 Endline =   @LineBreak | @TerminalEndline | @NormalEndline
 
 NormalEndline =   @Sp @Newline !@BlankLine !">" !AtxStart
-                  !(Line /={3,}|-{3,}=/ @Newline)
+                  !(Line /={1,}|-{1,}/ @Newline)
                   { "\n" }
 
 TerminalEndline = @Sp @Newline @Eof
@@ -916,46 +953,44 @@ UlLine   = < /_{4,}/ > { text } |
 
 Emph =      EmphStar | EmphUl
 
-OneStarOpen  =  !StarLine "*" !@Spacechar !@Newline
-OneStarClose =  !@Spacechar !@Newline Inline:a "*"
-                { a }
+Whitespace = @Spacechar | @Newline
 
-EmphStar =  OneStarOpen
+EmphStar =  "*" !@Whitespace
             @StartList:a
-            ( !OneStarClose Inline:l { a << l } )*
-            OneStarClose:l { a << l }
+            ( !"*" Inline:b { a << b }
+            | StrongStar:b  { a << b }
+            )+
+            "*"
             { emphasis a.join }
 
-OneUlOpen  =  !UlLine "_" !@Spacechar !@Newline
-OneUlClose =  !@Spacechar !@Newline Inline:a "_" # !Alphanumeric # TODO check
-              { a }
-
-EmphUl =    OneUlOpen
+EmphUl =    "_" !@Whitespace
             @StartList:a
-            ( !OneUlClose Inline:l { a << l } )*
-            OneUlClose:l { a << l }
+            ( !"_" Inline:b { a << b }
+            | StrongUl:b  { a << b }
+            )+
+            "_"
             { emphasis a.join }
 
 Strong = StrongStar | StrongUl
 
-TwoStarOpen =   !StarLine "**" !@Spacechar !@Newline
-TwoStarClose =  !@Spacechar !@Newline Inline:a "**" { a }
-
-StrongStar =    TwoStarOpen
+StrongStar =    "**" !@Whitespace
                 @StartList:a
-                ( !TwoStarClose Inline:l { a << l } )*
-                TwoStarClose:l { a << l }
+                ( !"**" Inline:b { a << b } )+
+                "**"
                 { strong a.join }
 
-TwoUlOpen =     !UlLine "__" !@Spacechar !@Newline
-TwoUlClose =    !@Spacechar !@Newline Inline:a "__" # !Alphanumeric # TODO check
-                { a }
+StrongUl   =    "__" !@Whitespace
+                @StartList:a
+                ( !"__" Inline:b { a << b } )+
+                "__"
+                { strong a.join }
 
-StrongUl =  TwoUlOpen
-            @StartList:a
-            ( !TwoUlClose Inline:i { a << i } )*
-            TwoUlClose:l { a << l }
-            { strong a.join }
+Strike = &{ strike? }
+         "~~" !@Whitespace
+         @StartList:a
+         ( !"~~" Inline:b { a << b } )+
+         "~~"
+         { strike a.join }
 
 # TODO alt text support
 Image = "!" ( ExplicitLink | ReferenceLink ):a
@@ -971,14 +1006,13 @@ ReferenceLinkDouble = Label:content < Spnl > !"[]" Label:label
 ReferenceLinkSingle = Label:content < (Spnl "[]")? >
                       { link_to content, content, text }
 
-ExplicitLink =  Label:l Spnl "(" @Sp Source:s Spnl Title @Sp ")"
+ExplicitLink =  Label:l "(" @Sp Source:s Spnl Title @Sp ")"
                 { "{#{l}}[#{s}]" }
 
 Source  = ( "<" < SourceContents > ">" | < SourceContents > )
           { text }
 
 SourceContents = ( ( !"(" !")" !">" Nonspacechar )+ | "(" SourceContents ")")*
-                 | ""
 
 Title = ( TitleSingle | TitleDouble | "" ):a
         { a }
@@ -1068,7 +1102,7 @@ Eof =           !.
 Nonspacechar =  !@Spacechar !@Newline .
 Sp =            @Spacechar*
 Spnl =          @Sp (@Newline @Sp)?
-SpecialChar =   /[*_`&\[\]()<!#\\'"]/ | @ExtendedSpecialChar
+SpecialChar =   /[~*_`&\[\]()<!#\\'"]/ | @ExtendedSpecialChar
 NormalChar =    !( @SpecialChar | @Spacechar | @Newline ) .
 Digit = [0-9]
 
@@ -1077,7 +1111,6 @@ Alphanumeric      = %literals.Alphanumeric
 AlphanumericAscii = %literals.AlphanumericAscii
 BOM               = %literals.BOM
 Newline           = %literals.Newline
-NonAlphanumeric   = %literals.NonAlphanumeric
 Spacechar         = %literals.Spacechar
 
 HexEntity  = /&#x/i < /[0-9a-fA-F]+/ > ";"
@@ -1137,8 +1170,7 @@ InlineNote = &{ notes? }
              @StartList:a
              ( !"]" Inline:l { a << l } )+
              "]"
-             {
-               ref = [:inline, @note_order.length]
+             { ref = [:inline, @note_order.length]
                @footnotes[ref] = paragraph a
 
                note_for ref
@@ -1161,10 +1193,26 @@ CodeFence = &{ github? }
               @Newline
             )+ > Ticks3 @Sp @Newline*
             { verbatim = RDoc::Markup::Verbatim.new text
-              verbatim.format = format.intern if format
+              verbatim.format = format.intern if format.instance_of?(String)
               verbatim
             }
 
+Table = &{ github? }
+        TableRow:header TableLine:line TableRow+:body
+        { table = RDoc::Markup::Table.new(header, line, body) }
+
+TableRow = TableItem+:row "|" @Newline
+           { row }
+TableItem = "|" < (!"|" !@Newline .)+ >
+            { text.strip }
+
+TableLine = TableColumn+:line "|" @Newline
+            { line }
+TableColumn = "|" < ( "-"+ ":"? | ":" "-"* ) >
+              { text.start_with?(":") ? :left :
+                text.end_with?(":") ? :right : nil
+              }
+
 DefinitionList = &{ definition_lists? }
                  ( DefinitionListItem+:list )
                  { RDoc::Markup::List.new :NOTE, *list.flatten }