rdoc 6.0.0.beta3 → 6.0.0.beta4

data/lib/rdoc/generator/json_index.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 require 'json'
 begin
   require 'zlib'
@@ -161,7 +161,7 @@ class RDoc::Generator::JsonIndex
   # Compress the search_index.js file using gzip
 
   def generate_gzipped
-    return unless defined?(Zlib)
+    return if @options.dry_run or not defined?(Zlib)
 
     debug_msg "Compressing generated JSON index"
     out_dir = @base_dir + @options.op_dir

data/lib/rdoc/generator/markup.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Handle common RDoc::Markup tasks for various CodeObjects
 #

data/lib/rdoc/generator/pot.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Generates a POT file.
 #

data/lib/rdoc/generator/pot/message_extractor.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Extracts message from RDoc::Store
 

data/lib/rdoc/generator/pot/po.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Generates a PO format text
 
@@ -29,8 +29,8 @@ class RDoc::Generator::POT::PO
   def to_s
     po = ''
     sort_entries.each do |entry|
-      po << "\n" unless po.empty?
-      po << entry.to_s
+      po += "\n" unless po.empty?
+      po += entry.to_s
     end
     po
   end

data/lib/rdoc/generator/pot/po_entry.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A PO entry in PO
 
@@ -40,11 +40,11 @@ class RDoc::Generator::POT::POEntry
 
   def to_s
     entry = ''
-    entry << format_translator_comment
-    entry << format_extracted_comment
-    entry << format_references
-    entry << format_flags
-    entry << <<-ENTRY
+    entry += format_translator_comment
+    entry += format_extracted_comment
+    entry += format_references
+    entry += format_flags
+    entry += <<-ENTRY
 msgid #{format_message(@msgid)}
 msgstr #{format_message(@msgstr)}
     ENTRY
@@ -75,9 +75,9 @@ msgstr #{format_message(@msgstr)}
 
     formatted_comment = ''
     comment.each_line do |line|
-      formatted_comment << "#{mark} #{line}"
+      formatted_comment += "#{mark} #{line}"
     end
-    formatted_comment << "\n" unless formatted_comment.end_with?("\n")
+    formatted_comment += "\n" unless formatted_comment.end_with?("\n")
     formatted_comment
   end
 
@@ -94,7 +94,7 @@ msgstr #{format_message(@msgstr)}
 
     formatted_references = ''
     @references.sort.each do |file, line|
-      formatted_references << "\#: #{file}:#{line}\n"
+      formatted_references += "\#: #{file}:#{line}\n"
     end
     formatted_references
   end
@@ -111,8 +111,8 @@ msgstr #{format_message(@msgstr)}
 
     formatted_message = '""'
     message.each_line do |line|
-      formatted_message << "\n"
-      formatted_message << "\"#{escape(line)}\""
+      formatted_message += "\n"
+      formatted_message += "\"#{escape(line)}\""
     end
     formatted_message
   end

data/lib/rdoc/generator/ri.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # Generates ri data files
 

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.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # This module provides i18n related features.
 

data/lib/rdoc/i18n/locale.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 ##
 # A message container for a locale.
 #

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/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.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]
@@ -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
@@ -494,27 +524,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 +763,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 +801,7 @@ HtmlBlockInTags = HtmlAnchor
                 | HtmlBlockThead
                 | HtmlBlockTr
                 | HtmlBlockScript
+                | HtmlBlockHead
 
 HtmlBlock = < ( HtmlBlockInTags | HtmlComment | HtmlBlockSelfClosing | HtmlUnclosed) >
             @BlankLine+
@@ -871,6 +905,7 @@ Inline  = Str
         | @Space
         | Strong
         | Emph
+        | Strike
         | Image
         | Link
         | NoteReference
@@ -896,7 +931,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 +951,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 +1004,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 +1100,7 @@ Eof =           !.
 Nonspacechar =  !@Spacechar !@Newline .
 Sp =            @Spacechar*
 Spnl =          @Sp (@Newline @Sp)?
-SpecialChar =   /[*_`&\[\]()<!#\\'"]/ | @ExtendedSpecialChar
+SpecialChar =   /[~*_`&\[\]()<!#\\'"]/ | @ExtendedSpecialChar
 NormalChar =    !( @SpecialChar | @Spacechar | @Newline ) .
 Digit = [0-9]
 
@@ -1077,7 +1109,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 +1168,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

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
 
 ##