Merge pull request #110 from MrDave1999/fix/issue_109

Fixed problem with inline comment being removed when used in multi-line values

Author: DevD4v3

src/Parser/EnvParser.HelperMethods.cs

@@ -37,15 +37,27 @@ private bool IsComment(string line)
         /// Removes the inline comment.
         /// </summary>
         /// <param name="line">The line with the inline comment to remove.</param>
+        /// <param name="comment">Contains the removed comment or null if there is no comment.</param>
         /// <exception cref="ArgumentNullException"><c>line</c> is <c>null</c>.</exception>
         /// <returns>A string without the inline comment.</returns>
-        private string RemoveInlineComment(string line)
+        private string RemoveInlineComment(string line, out string comment)
         {
             _ = line ?? throw new ArgumentNullException(nameof(line));
             var separator = $" {_configuration.CommentChar}";
-            return line.Split(new[] { separator }, MaxCount, StringSplitOptions.None)[0];
+            var substrings = line.Split(new[] { separator }, MaxCount, StringSplitOptions.None);
+            comment = substrings.Length == 1 ? null : substrings[1];
+            return substrings[0];
         }
 
+        /// <summary>
+        /// Concatenates the comment with the value.
+        /// </summary>
+        /// <param name="value">The value of a key.</param>
+        /// <param name="comment">The comment to concatenate with the value.</param>
+        /// <returns>A string with the concatenated comment.</returns>
+        private string ConcatCommentWithValue(string value, string comment)
+            => comment is null ? value : $"{value} {_configuration.CommentChar}{comment}";
+
         /// <summary>
         /// Removes all leading and trailing white-space characters from the current key.
         /// </summary>
@@ -283,5 +295,13 @@ private string GetValuesMultilines(string[] lines, ref int index, string value)
             ));
             return null;
         }
+
+        /// <summary>
+        /// Converts an empty string to a whitespace.
+        /// </summary>
+        /// <param name="value">The value to convert.</param>
+        /// <returns>A string with the converted value.</returns>
+        private string ConvertStringEmptyToWhitespace(string value)
+            => string.IsNullOrEmpty(value) ? " " : value;
     }
 }

src/Parser/EnvParser.cs

@@ -75,7 +75,7 @@ public IEnvironmentVariablesProvider Parse(string dataSource, out EnvValidationR
                 if (IsComment(line))
                     continue;
 
-                line = RemoveInlineComment(line);
+                line = RemoveInlineComment(line, out var removedComment);
                 if (HasNoKeyValuePair(line))
                 {
                     ValidationResult.Add(errorMsg: FormatParserExceptionMessage(
@@ -95,16 +95,17 @@ public IEnvironmentVariablesProvider Parse(string dataSource, out EnvValidationR
 
                 key   = RemovePrefixBeforeKey(key, ExportPrefix);
                 key   = TrimKey(key);
-                value = TrimValue(value);
-                if(IsQuoted(value))
+                if (IsQuoted(value))
                     value = RemoveQuotes(value);
                 else if (IsMultiline(value))
                 {
-                    value = GetValuesMultilines(lines, ref i, value);
+                    value = GetValuesMultilines(lines, ref i, ConcatCommentWithValue(value, removedComment));
                     if (value is null)
                         continue;
                 }
-                value = string.IsNullOrEmpty(value) ? " " : value;
+                else
+                    value = TrimValue(value);
+                value = ConvertStringEmptyToWhitespace(value);
 
                 var retrievedValue = EnvVarsProvider[key];
                 if (retrievedValue is null)

tests/Parser/.env.multi-lines

@@ -3,7 +3,7 @@ MULTI_LINE=line
 #
 # Double-Quoted
 #
-MULTI_DOUBLE_QUOTED_1="first ${MULTI_LINE} #a
+MULTI_DOUBLE_QUOTED_1="first ${MULTI_LINE} #a 
 second ${MULTI_LINE} #b
 third ${MULTI_LINE} #c
 four ${MULTI_LINE} #d" 
@@ -24,7 +24,7 @@ MULTI_DOUBLE_QUOTED_5="
 #
 # Single-Quoted
 #
-MULTI_SINGLE_QUOTED_1='first ${MULTI_LINE} #a
+MULTI_SINGLE_QUOTED_1='first ${MULTI_LINE} #a 
 second ${MULTI_LINE} #b
 third ${MULTI_LINE} #c
 four ${MULTI_LINE} #d' 

tests/Parser/EnvParserTests.Multilines.cs

@@ -10,7 +10,7 @@ public void Parse_WhenValuesAreOnMultiLines_ShouldGetValuesSeparatedByNewLine()
         parser.Parse(File.ReadAllText(".env.multi-lines"));
 
         Assert.AreEqual(
-            expected: "first line\nsecond line #b\nthird line #c\nfour line #d", 
+            expected: "first line #a \nsecond line #b\nthird line #c\nfour line #d", 
             actual: GetEnvironmentVariable("MULTI_DOUBLE_QUOTED_1")
         );
         Assert.AreEqual(
@@ -21,7 +21,7 @@ public void Parse_WhenValuesAreOnMultiLines_ShouldGetValuesSeparatedByNewLine()
         Assert.AreEqual(expected: "\n", actual: GetEnvironmentVariable("MULTI_DOUBLE_QUOTED_4"));
         Assert.AreEqual(expected: "  \n", actual: GetEnvironmentVariable("MULTI_DOUBLE_QUOTED_5"));
         Assert.AreEqual(
-            expected: "first line\nsecond line #b\nthird line #c\nfour line #d", 
+            expected: "first line #a \nsecond line #b\nthird line #c\nfour line #d", 
             actual: GetEnvironmentVariable("MULTI_SINGLE_QUOTED_1")
         );
         Assert.AreEqual(