Stop adding extra new line after XML declaration with pretty format #164
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 10, 2024
lib/rexml/formatters/pretty.rb
Outdated
| @@ -111,7 +111,7 @@ def write_document( node, output ) | |||
| # itself, then we don't need a carriage return... which makes this | |||
| # logic more complex. | |||
| node.children.each { |child| | |||
| next if child == node.children[-1] and child.instance_of?(Text) | |||
| next if child == "\n" and child.instance_of?(Text) | |||
There was a problem hiding this comment.
Hmm. Does this work with the following XML?
<?xml version="1.0" encoding="UTF-8"?>
<message>Hello world!</message>It seems that we can ignore all top-level text nodes:
diff --git a/lib/rexml/formatters/pretty.rb b/lib/rexml/formatters/pretty.rb
index a1198b7..a838d83 100644
--- a/lib/rexml/formatters/pretty.rb
+++ b/lib/rexml/formatters/pretty.rb
@@ -111,7 +111,7 @@ module REXML
# itself, then we don't need a carriage return... which makes this
# logic more complex.
node.children.each { |child|
- next if child == node.children[-1] and child.instance_of?(Text)
+ next if child.instance_of?(Text)
unless child == node.children[0] or child.instance_of?(Text) or
(child == node.children[1] and !node.children[0].writethis)
output << "\n"There was a problem hiding this comment.
I think this is the right correction, too.
If next if child.instance_of?(Text), then the following XML works.
<?xml version="1.0" encoding="UTF-8"?>
<message>Hello world!</message>
There was a problem hiding this comment.
@naitoh Interestingly if you have top-level text nodes that are not an ?xml node, then you end up with the strange behavior below where it outputs a leading blank line.
XXX<message>Hello world!</message>d = REXML::Document.new("XXX<message>Hello world!</message>")
d.to_s
# => "XXX<message>Hello world!</message>"
d.write(out = '', 2)
out
# => "\n<message>\n Hello world!\n</message>"Note that I think this leading "XXX" is invalid XML anyway, but is parsed successfully with REXML (Nokogiri fails in STRICT mode with this). I wonder if you also need to fail on text nodes before the root node similar to how you did it in #161 for those after the root node?
There was a problem hiding this comment.
Let's open a new issue and discuss this on the new issue.
There was a problem hiding this comment.
I have created #184 which fixes the above.
## Why?
Fix REXML::Formatters::Pretty#write_document, which implicitly assumes that the XML file ends with a newline.
If the XML file does not end with a newline, a space is added to the end of the first line.
```
Failure: test_indent(REXMLTests::TestDocument::WriteTest::ArgumentsTest)
/Users/naitoh/ghq/github.com/naitoh/rexml/test/test_document.rb:270:in `test_indent'
267: output = ""
268: indent = 2
269: @document.write(output, indent)
=> 270: assert_equal(<<-EOX.chomp, output)
271: <?xml version='1.0' encoding='UTF-8'?>
272: <message>
273: Hello world!
<"<?xml version='1.0' encoding='UTF-8'?>\n" +
"<message>\n" +
" Hello world!\n" +
"</message>"> expected but was
<"<?xml version='1.0' encoding='UTF-8'?> \n" +
"<message>\n" +
" Hello world!\n" +
"</message>">
diff:
? <?xml version='1.0' encoding='UTF-8'?>
<message>
Hello world!
</message>
```
naitoh
force-pushed
the
fix_formatters_pretty
branch
from
df89ee2 to
01162bd
Compare
kou
changed the title
kou
changed the title
aduth
added a commit
to 18F/identity-idp
that referenced
this pull request
Jul 17, 2024
Likely a result of ruby/rexml#164
aduth
added a commit
to 18F/identity-idp
that referenced
this pull request
Jul 17, 2024
* Bump rexml to resolve security advisory changelog: Internal, Dependencies, Update dependencies to resolve security advisories * Add rexml as explicit dependency Since we use it in our code, it should be an explicit dependency See: https://github.com/18F/identity-idp/blob/ea8a6081961d6c373a870dd5fea31efce89fde7e/app/services/proofing/aamva/request/verification_request.rb#L60-L102 * Sync AAMVA fixture to expected output Likely a result of ruby/rexml#164
kou
pushed a commit
that referenced
this pull request
Jul 22, 2024
…fore root element (#184) ## 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?)? '>' ``` See: #164 (comment)
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.
If the XML file does not end with a newline, a space is added to the end of the first line.
This is happen because
REXML::Formatters::Pretty#write_documenthas a logic that depends on the last text node.We should ignore all top-level text nodes with pretty format.