Merge pull request #21 from akesseler/xml-format

Support of XML message format.

code/hlp/Plexdata.LogWriter.help.shfbproj

@@ -44,7 +44,7 @@
     <IndentHtml>False</IndentHtml>
     <BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
     <HelpTitle>Plexdata Logging Writer</HelpTitle>
-    <HelpFileVersion>1.0.5.1</HelpFileVersion>
+    <HelpFileVersion>1.0.5.2</HelpFileVersion>
     <NamingMethod>Guid</NamingMethod>
     <ContentPlacement>AboveNamespaces</ContentPlacement>
     <RootNamespaceContainer>True</RootNamespaceContainer>

code/hlp/Plexdata.LogWriter.wiki.shfbproj

@@ -44,7 +44,7 @@
     <IndentHtml>False</IndentHtml>
     <BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
     <HelpTitle>Plexdata Logging Writer</HelpTitle>
-    <HelpFileVersion>1.0.5.1</HelpFileVersion>
+    <HelpFileVersion>1.0.5.2</HelpFileVersion>
     <NamingMethod>Guid</NamingMethod>
     <ContentPlacement>AboveNamespaces</ContentPlacement>
     <RootNamespaceContainer>True</RootNamespaceContainer>

code/src/HISTORY.md

@@ -1,5 +1,15 @@
 
 
+**1.0.5.2**
+- Support of a simple XML message format.
+- Correction of some typos.
+- Tests adjusted as well as new tests added.
+- Testing application enriched by new feature and others.
+- Source code and online documentation updated.
+- Version number increased.
+- Wiki and release update on _GitHub_.
+- All affected packages released on `nuget.org`.
+
 **1.0.5.1**
 - Introduction of e-mail logger.
   - Mail logger project added.

code/src/Plexdata.LogWriter.Abstraction.Tests/Internals/Factories/LoggerFactoryTests.cs

@@ -81,6 +81,7 @@ public void LoggerFactory_CreateLogEventFormatterForDefaultType_FormatterTypeIsD
         [TestCase(LogType.Raw, typeof(RawFormatter))]
         [TestCase(LogType.Csv, typeof(CsvFormatter))]
         [TestCase(LogType.Json, typeof(JsonFormatter))]
+        [TestCase(LogType.Xml, typeof(XmlFormatter))]
         public void LoggerFactory_CreateLogEventFormatterForSpecialType_FormatterTypeAsExpected(LogType type, Type expected)
         {
             this.settings.LogType = type;

code/src/Plexdata.LogWriter.Abstraction.Tests/Internals/Formatters/CsvFormatterTests.cs

@@ -81,6 +81,7 @@ public void Setup()
         [Test]
         [TestCase(LogType.Raw)]
         [TestCase(LogType.Json)]
+        [TestCase(LogType.Xml)]
         public void CsvFormatter_WrongLogType_ThrowsNotSupportedException(LogType logType)
         {
             this.settings.SetupGet(x => x.LogType).Returns(logType);

code/src/Plexdata.LogWriter.Abstraction.Tests/Internals/Formatters/JsonFormatterTests.cs

@@ -81,6 +81,7 @@ public void Setup()
         [Test]
         [TestCase(LogType.Csv)]
         [TestCase(LogType.Raw)]
+        [TestCase(LogType.Xml)]
         public void JsonFormatter_WrongLogType_ThrowsNotSupportedException(LogType logType)
         {
             this.settings.SetupGet(x => x.LogType).Returns(logType);

code/src/Plexdata.LogWriter.Abstraction.Tests/Internals/Formatters/RawFormatterTests.cs

@@ -81,6 +81,7 @@ public void Setup()
         [Test]
         [TestCase(LogType.Csv)]
         [TestCase(LogType.Json)]
+        [TestCase(LogType.Xml)]
         public void RawFormatter_WrongLogType_ThrowsNotSupportedException(LogType logType)
         {
             this.settings.SetupGet(x => x.LogType).Returns(logType);

code/src/Plexdata.LogWriter.Abstraction.Tests/Plexdata.LogWriter.Abstraction.Tests.csproj

@@ -68,6 +68,7 @@
     <Compile Include="Internals\Formatters\FormatterBaseTests.cs" />
     <Compile Include="Internals\Formatters\JsonFormatterTests.cs" />
     <Compile Include="Internals\Formatters\RawFormatterTests.cs" />
+    <Compile Include="Internals\Formatters\XmlFormatterTests.cs" />
     <Compile Include="Internals\Settings\LoggerSettingsBaseTests.cs" />
     <Compile Include="Internals\Settings\LoggerSettingsEmptyTests.cs" />
     <Compile Include="Internals\Settings\LoggerSettingsJsonTests.cs" />

code/src/Plexdata.LogWriter.Abstraction.Tests/Properties/AssemblyInfo.cs

@@ -55,5 +55,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.5.1")]
-[assembly: AssemblyFileVersion("1.0.5.1")]
+[assembly: AssemblyVersion("1.0.5.2")]
+[assembly: AssemblyFileVersion("1.0.5.2")]

code/src/Plexdata.LogWriter.Abstraction/Definitions/LogType.cs

@@ -28,8 +28,8 @@ namespace Plexdata.LogWriter.Definitions
     /// This enumeration defines all currently supported logging types.
     /// </summary>
     /// <remarks>
-    /// For the moment a raw-text logger, a CSV logger as well as a JSON 
-    /// logger type are supported.
+    /// For the moment a raw-text logger, a CSV logger, a JSON as well 
+    /// as an XML logger are the supported types.
     /// </remarks>
     public enum LogType
     {
@@ -52,6 +52,12 @@ public enum LogType
         /// </summary>
         Json,
 
+        /// <summary>
+        /// Use XML output format. The output is formatted in Extensible 
+        /// Markup Language format.
+        /// </summary>
+        Xml,
+
         /// <summary>
         /// Use default output format, which is set to <see cref="Raw"/> 
         /// format.

code/src/Plexdata.LogWriter.Abstraction/Internals/Factories/LoggerFactory.cs

@@ -81,6 +81,8 @@ public ILogEventFormatter CreateLogEventFormatter(ILoggerSettings settings)
                     return new JsonFormatter(settings);
                 case LogType.Csv:
                     return new CsvFormatter(settings);
+                case LogType.Xml:
+                    return new XmlFormatter(settings);
                 default:
                     return new RawFormatter(settings);
             }

code/src/Plexdata.LogWriter.Abstraction/Internals/Formatters/CsvFormatter.cs

@@ -139,7 +139,7 @@ protected override String ToValue(String value, Char split)
 
         /// <inheritdoc />
         /// <remarks>
-        /// This method takes the value and check if it includes at least one double 
+        /// This method takes the value and checks if it includes at least one double 
         /// quote character or one carriage return character or one line feed character 
         /// or one of the provided split character. If this the case then the whole 
         /// value is surrounded by double quotes. Additionally, each of the double 
@@ -197,7 +197,7 @@ protected override String ToOutput(String label, String value, Char split)
         /// The string builder to be used.
         /// </param>
         /// <param name="key">
-        /// The key stamp to be used.
+        /// The key to be used.
         /// </param>
         /// <param name="split">
         /// The split character to be appended.

code/src/Plexdata.LogWriter.Abstraction/Internals/Formatters/JsonFormatter.cs

@@ -151,7 +151,7 @@ protected override String ToValue(String value, Char split)
         /// <inheritdoc />
         /// <remarks>
         /// <para>
-        /// This method takes the value and check if it includes at least one the 
+        /// This method takes the value and checks if it includes at least one the 
         /// characters backslash, double quote, carriage return, line feed, form 
         /// feed, backspace or tab. If this is the case then each of those control 
         /// characters is escaped by a backslash. Additionally, each result string 
@@ -231,7 +231,7 @@ protected override String ToOutput(String label, String value, Char split)
         /// The value label to be used.
         /// </param>
         /// <param name="key">
-        /// The key stamp to be used.
+        /// The key to be used.
         /// </param>
         /// <param name="split">
         /// The split character to be appended.
@@ -399,7 +399,7 @@ private void AddMessage(StringBuilder builder, String label, String message, Cha
         /// </summary>
         /// <remarks>
         /// <para>
-        /// The details are always added and cannot be disabled, but might be empty.
+        /// The details are always added and cannot be disabled, but might be <c>empty</c>.
         /// </para>
         /// <para>
         /// If a value list is available, then each of them is put into a string with