Add support for detecting invalid XML that has unsupported content before root element #184
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kou
reviewed
Jul 22, 2024
| @@ -62,6 +43,28 @@ def test_xml_declaration_not_at_document_start | |||
| end | |||
| end | |||
|
|
|||
| def test_garbage_text | |||
There was a problem hiding this comment.
Could you improve test name? This is not a garbage text test now.
test_comment?
Comment on lines
47
to
51
| doc = parse(<<~XML) | ||
| <?x y | ||
| <!--?><?x -->?> | ||
| <r/> | ||
| XML |
There was a problem hiding this comment.
If you want to use <<~, could you indent content?
Suggested change
| doc = parse(<<~XML) | |
| <?x y | |
| <!--?><?x -->?> | |
| <r/> | |
| XML | |
| doc = parse(<<~XML) | |
| <?x y | |
| <!--?><?x -->?> | |
| <r/> | |
| XML |
BTW, I prefer <<- to <<~ for XML content because it's not a program code.
I think that indentation is needless for not a program code in program.
Comment on lines
52
to
53
| assert_equal(["x", "y\n<!--"], [ doc.children[0].target, doc.children[0].content]) | ||
| assert_equal(["x", "-->"], [ doc.children[1].target, doc.children[1].content]) |
There was a problem hiding this comment.
Could you unify these assertions to one assert for easy to debug?
Suggested change
| assert_equal(["x", "y\n<!--"], [ doc.children[0].target, doc.children[0].content]) | |
| assert_equal(["x", "-->"], [ doc.children[1].target, doc.children[1].content]) | |
| assert_equal([["x", "y\n<!--"], | |
| ["x", "-->"]], | |
| [[doc.children[0].target, doc.children[0].content], | |
| [doc.children[1].target, doc.children[1].content]]) |
There was a problem hiding this comment.
OK.
I see.
It looks good.
naitoh
force-pushed
the
fix_content_at_the_start_of_the_document
branch
from
1722700
to
0f7f84d
Compare
## Why? XML with content at the start of the document is invalid. https://www.w3.org/TR/2006/REC-xml11-20060816/#document ``` [1] document ::= ( prolog element Misc* ) - ( Char* RestrictedChar Char* ) ``` https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-prolog ``` [22] prolog ::= XMLDecl Misc* (doctypedecl Misc*)? ``` https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-XMLDecl ``` [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>' ``` https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-Misc ``` [27] Misc ::= Comment | PI | S ``` https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-PI ``` [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' ``` https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-PITarget ``` [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l')) ``` https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-doctypedecl ``` [28] doctypedecl ::= '<!DOCTYPE' S Name (S ExternalID)? S? ('[' intSubset ']' S?)? '>' ```
naitoh
force-pushed
the
fix_content_at_the_start_of_the_document
branch
from
0f7f84d
to
5ebd293
Compare
kou
changed the title
|
Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why?
XML with content at the start of the document is invalid.
https://www.w3.org/TR/2006/REC-xml11-20060816/#document
https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-prolog
https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-XMLDecl
https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-Misc
https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-PI
https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-PITarget
https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-doctypedecl
See: #164 (comment)