Ignore inline notes before note ordering

Inline notes can be parsed while Markdown references are being collected, before footnote ordering has been initialized. Treat that early pass as a no-op so malformed reference labels do not crash the parser.

Author: skatkov

lib/rdoc/markdown.kpeg

@@ -437,8 +437,6 @@
   def parse markdown
     @references          = {}
     @unlinked_references = {}
-    @footnotes           = nil
-    @note_order          = nil
 
     markdown += "\n\n"
 
@@ -1236,12 +1234,12 @@ InlineNote = &{ notes? }
              @StartList:a
              ( !"]" Inline:l { a << l } )+
              "]"
-             { raise ParseError, 'invalid inline note' unless @note_order
+             { if @note_order
+                 ref = [:inline, @note_order.length]
+                 @footnotes[ref] = paragraph a
 
-               ref = [:inline, @note_order.length]
-               @footnotes[ref] = paragraph a
-
-               note_for ref
+                 note_for ref
+               end
              }
 
 Notes = ( Note | SkipBlock )*

lib/rdoc/markdown.rb

@@ -822,8 +822,6 @@ def paragraph parts
   def parse markdown
     @references          = {}
     @unlinked_references = {}
-    @footnotes           = nil
-    @note_order          = nil
 
     markdown += "\n\n"
 
@@ -15478,7 +15476,7 @@ def _Note
     return _tmp
   end
 
-  # InlineNote = &{ notes? } "^[" @StartList:a (!"]" Inline:l { a << l })+ "]" { raise ParseError, 'invalid inline note' unless @note_order                 ref = [:inline, @note_order.length]                @footnotes[ref] = paragraph a                 note_for ref              }
+  # InlineNote = &{ notes? } "^[" @StartList:a (!"]" Inline:l { a << l })+ "]" { if @note_order                  ref = [:inline, @note_order.length]                  @footnotes[ref] = paragraph a                   note_for ref                end              }
   def _InlineNote
 
     _save = self.pos
@@ -15569,12 +15567,12 @@ def _InlineNote
         self.pos = _save
         break
       end
-      @result = begin;  raise ParseError, 'invalid inline note' unless @note_order
+      @result = begin;  if @note_order
+                 ref = [:inline, @note_order.length]
+                 @footnotes[ref] = paragraph a
 
-               ref = [:inline, @note_order.length]
-               @footnotes[ref] = paragraph a
-
-               note_for ref
+                 note_for ref
+               end
              ; end
       _tmp = true
       unless _tmp
@@ -16845,7 +16843,7 @@ def _DefinitionListDefinition
   Rules[:_NoteReference] = rule_info("NoteReference", "&{ notes? } RawNoteReference:ref { note_for ref }")
   Rules[:_RawNoteReference] = rule_info("RawNoteReference", "\"[^\" < (!@Newline !\"]\" .)+ > \"]\" { text }")
   Rules[:_Note] = rule_info("Note", "&{ notes? } @NonindentSpace RawNoteReference:ref \":\" @Sp @StartList:a RawNoteBlock:i { a.concat i } (&Indent RawNoteBlock:i { a.concat i })* { @footnotes[ref] = paragraph a                    nil                 }")
-  Rules[:_InlineNote] = rule_info("InlineNote", "&{ notes? } \"^[\" @StartList:a (!\"]\" Inline:l { a << l })+ \"]\" { raise ParseError, 'invalid inline note' unless @note_order                 ref = [:inline, @note_order.length]                @footnotes[ref] = paragraph a                 note_for ref              }")
+  Rules[:_InlineNote] = rule_info("InlineNote", "&{ notes? } \"^[\" @StartList:a (!\"]\" Inline:l { a << l })+ \"]\" { if @note_order                  ref = [:inline, @note_order.length]                  @footnotes[ref] = paragraph a                   note_for ref                end              }")
   Rules[:_Notes] = rule_info("Notes", "(Note | SkipBlock)*")
   Rules[:_RawNoteBlock] = rule_info("RawNoteBlock", "@StartList:a (!@BlankLine !RawNoteReference OptionallyIndentedLine:l { a << l })+ < @BlankLine* > { a << text } { a }")
   Rules[:_CodeFence] = rule_info("CodeFence", "&{ github? } Ticks3 (@Sp StrChunk:format)? @Sp @Newline? < ((!\"`\" Nonspacechar)+ | !Ticks3 /`+/ | Spacechar | @Newline)+ > Ticks3 @Sp @Newline* { verbatim = RDoc::Markup::Verbatim.new text               verbatim.format = format.intern if format.instance_of?(String)               verbatim             }")

test/rdoc/rdoc_markdown_test.rb

@@ -1002,16 +1002,10 @@ def test_parse_note_inline
     assert_equal expected, doc
   end
 
-  def test_parse_note_inline_in_reference_label_after_reuse
+  def test_parse_note_inline_in_reference_label
     @parser.notes = true
 
-    parse "Some text. ^[With a footnote]"
-
-    error = assert_raise RDoc::Markdown::ParseError do
-      parse "[foo ^[note]]: /url\n"
-    end
-
-    assert_equal 'invalid inline note', error.message
+    assert_kind_of RDoc::Markup::Document, parse("[foo ^[note]]: /url\n")
   end
 
   def test_parse_note_no_notes