Added WrapLineLayoutRendererWrapper #1400
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| // | ||
| // Copyright (c) 2004-2016 Jaroslaw Kowalski <jaak@jkowalski.net>, Kim Christensen, Julian Verdurmen | ||
| // | ||
| // All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions | ||
| // are met: | ||
| // | ||
| // * Redistributions of source code must retain the above copyright notice, | ||
| // this list of conditions and the following disclaimer. | ||
| // | ||
| // * Redistributions in binary form must reproduce the above copyright notice, | ||
| // this list of conditions and the following disclaimer in the documentation | ||
| // and/or other materials provided with the distribution. | ||
| // | ||
| // * Neither the name of Jaroslaw Kowalski nor the names of its | ||
| // contributors may be used to endorse or promote products derived from this | ||
| // software without specific prior written permission. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| // THE POSSIBILITY OF SUCH DAMAGE. | ||
| // | ||
|
|
||
| namespace NLog.LayoutRenderers.Wrappers | ||
| { | ||
| using System; | ||
| using System.ComponentModel; | ||
| using System.Text; | ||
|
|
||
| using NLog.Config; | ||
|
|
||
| /// <summary> | ||
| /// Replaces newline characters from the result of another layout renderer with spaces. | ||
| /// </summary> | ||
| [LayoutRenderer("wrapline")] | ||
| [AmbientProperty("WrapLine")] | ||
| [ThreadAgnostic] | ||
| public sealed class WrapLineLayoutRendererWrapper : WrapperLayoutRendererBase | ||
| { | ||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="WrapLineLayoutRendererWrapper" /> class. | ||
| /// </summary> | ||
| public WrapLineLayoutRendererWrapper() | ||
| { | ||
| WrapLine = 80; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the line length for wrapping. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Only positive values are allowed | ||
| /// </remarks> | ||
| /// <docgen category='Transformation Options' order='10' /> | ||
| [DefaultValue(80)] | ||
| public int WrapLine { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Post-processes the rendered message. | ||
| /// </summary> | ||
| /// <param name="text">The text to be post-processed.</param> | ||
| /// <returns>Post-processed text.</returns> | ||
| protected override string Transform(string text) | ||
| { | ||
| var chunkLength = WrapLine; | ||
| var textLength = text.Length; | ||
|
|
||
| var sb = new StringBuilder(textLength); | ||
|
There was a problem hiding this comment. building a stringbuilder isn't always needed There was a problem hiding this comment. indeed. replaced by a string |
||
|
|
||
| // based on : http://stackoverflow.com/questions/36788754/how-can-i-limit-the-length-of-a-line-in-nlog/36789394 | ||
| // and : http://stackoverflow.com/questions/1450774/splitting-a-string-into-chunks-of-a-certain-size/8944374#8944374 | ||
| for (int pos = 0; pos < text.Length; pos += chunkLength) | ||
| { | ||
| if (chunkLength + pos > textLength) | ||
| chunkLength = textLength - pos; | ||
|
|
||
| sb.Append(text.Substring(pos, chunkLength) + Environment.NewLine); | ||
| } | ||
|
|
||
| sb.Remove(sb.Length - Environment.NewLine.Length, Environment.NewLine.Length); | ||
|
There was a problem hiding this comment. this could be done better. We already checking thing is the |
||
|
|
||
| return sb.ToString(); | ||
| } | ||
| } | ||
| } | ||
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
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
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| // | ||
| // Copyright (c) 2004-2016 Jaroslaw Kowalski <jaak@jkowalski.net>, Kim Christensen, Julian Verdurmen | ||
| // | ||
| // All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions | ||
| // are met: | ||
| // | ||
| // * Redistributions of source code must retain the above copyright notice, | ||
| // this list of conditions and the following disclaimer. | ||
| // | ||
| // * Redistributions in binary form must reproduce the above copyright notice, | ||
| // this list of conditions and the following disclaimer in the documentation | ||
| // and/or other materials provided with the distribution. | ||
| // | ||
| // * Neither the name of Jaroslaw Kowalski nor the names of its | ||
| // contributors may be used to endorse or promote products derived from this | ||
| // software without specific prior written permission. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| // THE POSSIBILITY OF SUCH DAMAGE. | ||
| // | ||
|
|
||
| namespace NLog.UnitTests.LayoutRenderers.Wrappers | ||
| { | ||
| using NLog; | ||
| using NLog.Layouts; | ||
| using NLog.Targets; | ||
| using Xunit; | ||
|
|
||
| public class WrapLineTests : NLogTestBase | ||
| { | ||
| [Fact] | ||
| public void WrapLineAtPositionInsideTextTest() | ||
|
There was a problem hiding this comment. Nice tests, but we need wrapline=0 and wrapline=-1 (negative) tests IMO There was a problem hiding this comment. Tests added. I did not find a simple way (other than providing InternalLogger with a StringWriter then test on it (cf InternalLogger). For the moment asserted on output == "" |
||
| { | ||
| MappedDiagnosticsContext.Clear(); | ||
|
There was a problem hiding this comment. I saw it in a lot of other tests. I was thinking it is required. Works without it as well. There was a problem hiding this comment. OK please remove them. Less is more. :) |
||
|
|
||
| SimpleLayout l = "${message:wrapline=3}"; | ||
|
|
||
| var le = LogEventInfo.Create(LogLevel.Info, "logger", "foobar"); | ||
|
|
||
| Assert.Equal("foo" + System.Environment.NewLine + "bar", l.Render(le)); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void WrapLineMultipleTimesTest() | ||
| { | ||
| MappedDiagnosticsContext.Clear(); | ||
|
|
||
| SimpleLayout l = "${message:wrapline=3}"; | ||
|
|
||
| var le = LogEventInfo.Create(LogLevel.Info, "logger", "foobarbaz"); | ||
|
|
||
| Assert.Equal("foo" + System.Environment.NewLine + "bar" + System.Environment.NewLine + "baz", l.Render(le)); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void WrapLineAtPositionAtExactTextLengthTest() | ||
| { | ||
| MappedDiagnosticsContext.Clear(); | ||
|
|
||
| SimpleLayout l = "${message:wrapline=6}"; | ||
|
|
||
| var le = LogEventInfo.Create(LogLevel.Info, "logger", "foobar"); | ||
|
|
||
| Assert.Equal("foobar", l.Render(le)); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void WrapLineAtPositionSmallerThanTextLengthTest() | ||
| { | ||
| MappedDiagnosticsContext.Clear(); | ||
|
|
||
| SimpleLayout l = "${message:wrapline=7}"; | ||
|
|
||
| var le = LogEventInfo.Create(LogLevel.Info, "logger", "foobar"); | ||
|
|
||
| Assert.Equal("foobar", l.Render(le)); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void WrapLineFromConfig() | ||
| { | ||
| MappedDiagnosticsContext.Clear(); | ||
|
|
||
| var configuration = CreateConfigurationFromString(@" | ||
| <nlog throwExceptions='true'> | ||
| <targets> | ||
| <target name='d1' type='Debug' layout='${message:wrapline=3}' /> | ||
| </targets> | ||
| <rules> | ||
| <logger name=""*"" minlevel=""Trace"" writeTo=""d1"" /> | ||
| </rules> | ||
| </nlog>"); | ||
|
|
||
| var d1 = configuration.FindTargetByName("d1") as DebugTarget; | ||
| Assert.NotNull(d1); | ||
| var layout = d1.Layout as SimpleLayout; | ||
| Assert.NotNull(layout); | ||
|
|
||
| var result = layout.Render(new LogEventInfo(LogLevel.Info, "Test", "foobar")); | ||
| Assert.Equal("foo" + System.Environment.NewLine + "bar", result); | ||
| } | ||
| } | ||
| } | ||
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
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we have to check if
WrapLine > 0There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, threw ArgumentException