Merge pull request #626 from willson556/bugfix/extra-newline

Fix #361 - Extra Windows newline in folded scalar.
aaubry · Aug 6, 2021 · 35013cd · 35013cd
2 parents 5f91b4f + ce5c00a
commit 35013cd
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 3 deletions.
diff --git a/YamlDotNet.Test/Core/EmitterTests.cs b/YamlDotNet.Test/Core/EmitterTests.cs
@@ -360,6 +360,7 @@ public void EmptyStringsAreQuoted()
 
         [Theory]
         [InlineData("b-carriage-return,b-line-feed\r\nlll", "b-carriage-return,b-line-feed\nlll")]
+        [InlineData("b-carriage-return,b-line-feed\r\n\r\nlll", "b-carriage-return,b-line-feed\n\nlll")]
         [InlineData("b-carriage-return\rlll", "b-carriage-return\nlll")]
         [InlineData("b-line-feed\nlll", "b-line-feed\nlll")]
         [InlineData("b-next-line\x85lll", "b-next-line\nlll")]
@@ -379,6 +380,28 @@ public void NewLinesAreNotDuplicatedWhenEmitted(string input, string expected)
                 StreamEnd);
         }
 
+        [Theory]
+        [InlineData("b-carriage-return,b-line-feed\r\nlll", "b-carriage-return,b-line-feed\nlll")]
+        [InlineData("b-carriage-return,b-line-feed\r\n\r\nlll", "b-carriage-return,b-line-feed\n\nlll")]
+        [InlineData("b-carriage-return\rlll", "b-carriage-return\nlll")]
+        [InlineData("b-line-feed\nlll", "b-line-feed\nlll")]
+        [InlineData("b-next-line\x85lll", "b-next-line\nlll")]
+        [InlineData("b-line-separator\x2028lll", "b-line-separator\x2028lll")]
+        [InlineData("b-paragraph-separator\x2029lll", "b-paragraph-separator\x2029lll")]
+        public void NewLinesAreNotDuplicatedWhenEmittedInFoldedScalar(string input, string expected)
+        {
+            var yaml = EmittedTextFrom(StreamOf(DocumentWith(
+                                                             FoldedScalar(input)
+                                                            )));
+
+            AssertSequenceOfEventsFrom(Yaml.ParserForText(yaml),
+                                       StreamStart,
+                                       DocumentStart(Implicit),
+                                       FoldedScalar(expected),
+                                       DocumentEnd(Implicit),
+                                       StreamEnd);
+        }
+
         [Theory]
         [InlineData("'.'test")]
         [InlineData("'")]

diff --git a/YamlDotNet.Test/Serialization/SerializationTests.cs b/YamlDotNet.Test/Serialization/SerializationTests.cs
@@ -2001,7 +2001,7 @@ public void ShouldIndentSequences()
 
             Assert.Equal(expected.NormalizeNewLines(), yaml.NormalizeNewLines().TrimNewLines());
         }
-       
+
         [Fact]
         public void ExampleFromSpecificationIsHandledCorrectlyWithLateDefine()
         {
@@ -2128,6 +2128,23 @@ public void DeserializeCycleWithAnchorsWithDepth(int? depth)
             Assert.Same(obj, iterator);
         }
 
+        [Fact]
+        public void RoundtripWindowsNewlines()
+        {
+            var text = "Line1\r\nLine2\r\nLine3\r\n\r\nLine4";
+
+            var sut = new SerializerBuilder().Build();
+            var dut = new DeserializerBuilder().Build();
+
+            using var writer = new StringWriter { NewLine = Environment.NewLine };
+            sut.Serialize(writer, new StringContainer { Text = text });
+            var serialized = writer.ToString();
+
+            using var reader = new StringReader(serialized);
+            var roundtrippedText = dut.Deserialize<StringContainer>(reader).Text.NormalizeNewLines();
+            Assert.Equal(text, roundtrippedText);
+        }
+
         [TypeConverter(typeof(DoublyConvertedTypeConverter))]
         public class DoublyConverted
         {
@@ -2175,6 +2192,11 @@ public class NonSerializable
             public string Text { get; set; }
         }
 
+        public class StringContainer
+        {
+            public string Text { get; set; }
+        }
+
         public class NonSerializableTypeConverter : IYamlTypeConverter
         {
             public bool Accepts(Type type)

diff --git a/YamlDotNet/Core/Emitter.cs b/YamlDotNet/Core/Emitter.cs
@@ -176,7 +176,7 @@ public void Emit(ParsingEvent @event)
 
         /// <summary>
         /// Check if we need to accumulate more events before emitting.
-        /// 
+        ///
         /// We accumulate extra
         ///  - 1 event for DOCUMENT-START
         ///  - 2 events for SEQUENCE-START
@@ -1256,7 +1256,12 @@ private void WriteFoldedScalar(string value)
                 var character = value[i];
                 if (IsBreak(character, out var breakCharacter))
                 {
-                    if (!previousBreak && !leadingSpaces && character == '\n')
+                    if (character == '\r' && (i + 1) < value.Length && value[i + 1] == '\n')
+                    {
+                        continue;
+                    }
+
+                    if (!previousBreak && !leadingSpaces && breakCharacter == '\n')
                     {
                         var k = 0;
                         while (i + k < value.Length && IsBreak(value[i + k], out _))
@@ -1268,6 +1273,7 @@ private void WriteFoldedScalar(string value)
                             WriteBreak();
                         }
                     }
+
                     WriteBreak(breakCharacter);
                     isIndentation = true;
                     previousBreak = true;