10017337279

Committed 20 Jul 2024 03:50AM UTC coverage: 83.39% (-0.3%) from 83.693%

Build # 10017337279

Build Type

push

github

Committed by

JaCraig

Commit Message

fix: Finishing XML format changes

This commit represents a major overhaul in the project's serialization and deserialization approach, transitioning from `System.Text.Json` to `Newtonsoft.Json` due to limitations with dynamic objects. Key changes include:

- Updated multiple files across the project, including test and format-specific classes, to use `Newtonsoft.Json` for JSON and XML handling.
- Modified serialization options in test classes (`JsonFormatTests.cs`, `JsonReaderTests.cs`, `JsonWriterTests.cs`, `XMLFormatTests.cs`, `XMLReaderTests.cs`) from `JsonSerializerOptions` to `JsonSerializerSettings`.
- Updated namespace and class references in test classes to avoid ambiguity.
- Added new test cases in `XMLFormatTests.cs` and `XMLReaderTests.cs` for enhanced coverage.
- Revised `StructuredObject.cs` methods for string conversion and content retrieval to utilize `Newtonsoft.Json` methods.
- Introduced a `ToByteArray` extension method in `InternalExtensionMethods.cs` for efficient string to byte array conversion.
- Overhauled core format classes (`JsonFormat.cs`, `JsonReader.cs`, `JsonWriter.cs`, `XMLFormat.cs`, `XMLReader.cs`, `XMLWriter.cs`) to adopt `Newtonsoft.Json` for all serialization and deserialization tasks.
- Added a `CleanUpReturnValue` method in `XMLReader.cs` for cleaner deserialized data.
- Updated `XMLWriter.cs` to convert structured objects to XML strings using an approach involving `Newtonsoft.Json`.

These changes leverage `Newtonsoft.Json`'s flexibility and features for improved JSON and XML processing capabilities.

Run Details

1187 of 1494 branches covered (79.45%)

Branch coverage included in aggregate %.

41 of 46 new or added lines in 6 files covered. (89.13%)

22 existing lines in 5 files now uncovered.

1509 of 1739 relevant lines covered (86.77%)

24709.24 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.75

/Archivist/Formats/Delimited/DelimitedWriter.cs

﻿using Archivist.BaseClasses;
using Archivist.DataTypes;
using Archivist.Interfaces;
using Archivist.Options;
using System.IO;
using System.Text;
using System.Threading.Tasks;

namespace Archivist.Formats.Delimited
{
    /// <summary>
    /// Delimited file writer
    /// </summary>
    /// <seealso cref="WriterBaseClass"/>
    public class DelimitedWriter : WriterBaseClass
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="DelimitedWriter"/> class.
        /// </summary>
        /// <param name="options">The options for the delimited writer.</param>
        public DelimitedWriter(DelimitedOptions options)
        {
            Options = options ?? DelimitedOptions.Default;
        }

        /// <summary>
        /// The options for the delimited writer.
        /// </summary>
        private DelimitedOptions Options { get; }

        /// <summary>
        /// Writes the content of the file to the specified stream asynchronously.
        /// </summary>
        /// <param name="file">The file to write.</param>
        /// <param name="stream">The stream to write to.</param>
        /// <returns>
        /// A task representing the asynchronous write operation. The task result is true if the
        /// write operation is successful; otherwise, false.
        /// </returns>
        public override async Task<bool> WriteAsync(IGenericFile? file, Stream? stream)
        {
            if (stream?.CanWrite != true || file is null)
                return false;
            var Builder = new StringBuilder();
            Table? FileTable = file.ToFileType<Table>();
            if (FileTable is not null)
            {
                _ = Builder.Append(CreateFromTable(FileTable, Options));
            }
            else
            {
                _ = Builder.Append(CreateFromFile(file, Options));
            }
            var ByteData = Encoding.UTF8.GetBytes(Builder.ToString());
            try
            {
                await stream.WriteAsync(ByteData).ConfigureAwait(false);
            }
            catch
            {
                return false;
            }
            return true;
        }

        /// <summary>
        /// Creates the file data from a file object.
        /// </summary>
        /// <param name="file">The file object.</param>
        /// <param name="options"></param>
        /// <returns>The file data as a string.</returns>
        private static string CreateFromFile(IGenericFile file, DelimitedOptions options) => options.Quote + file?.ToString()?.Replace(options.Quote ?? "", "") + options.Quote;

        /// <summary>
        /// Creates the file data from a table object.
        /// </summary>
        /// <param name="fileTable">The table object representing the file.</param>
        /// <param name="options">The options for the delimited writer.</param>
        /// <returns>The file data as a string.</returns>
        private static string CreateFromTable(Table fileTable, DelimitedOptions options)
        {
            if (!fileTable.Metadata.TryGetValue("Delimiter", out var Delimiter))
                Delimiter = options.DefaultSeparator;
            var Builder = new StringBuilder();
            var Seperator = "";
            if (fileTable.Columns.Count > 0)
            {
                foreach (var HeaderColumn in fileTable.Columns)
                {
                    var Header = HeaderColumn;
                    if (!string.IsNullOrEmpty(options.Quote) && !string.IsNullOrEmpty(Header))
                        Header = Header.Replace(options.Quote, "");
                    _ = Builder.Append(Seperator).Append(options.Quote).Append(Header ?? "").Append(options.Quote);
                    Seperator = Delimiter;
                }
                _ = Builder.AppendLine();
            }
            foreach (TableRow Row in fileTable)
            {
                Seperator = "";
                foreach (TableCell CurrentCell in Row)
                {
                    var Content = CurrentCell.Content;
                    if (!string.IsNullOrEmpty(options.Quote) && !string.IsNullOrEmpty(Content))
                        Content = Content.Replace(options.Quote, "");
                    _ = Builder.Append(Seperator).Append(options.Quote).Append(Content ?? "").Append(options.Quote);
                    Seperator = Delimiter;
                }
                _ = Builder.AppendLine();
            }
            return Builder.ToString();
        }
    }
}

1	using Archivist.BaseClasses;
2	using Archivist.DataTypes;
3	using Archivist.Interfaces;
4	using Archivist.Options;
5	using System.IO;
6	using System.Text;
7	using System.Threading.Tasks;
8
9	namespace Archivist.Formats.Delimited
10	{
11	/// <summary>
12	/// Delimited file writer
13	/// </summary>
14	/// <seealso cref="WriterBaseClass"/>
15	public class DelimitedWriter : WriterBaseClass
16	{
17	/// <summary>
18	/// Initializes a new instance of the <see cref="DelimitedWriter"/> class.
19	/// </summary>
20	/// <param name="options">The options for the delimited writer.</param>
21	public DelimitedWriter(DelimitedOptions options)	49✔
22	{
23	Options = options ?? DelimitedOptions.Default;	49!
24	}	49✔
25
26	/// <summary>
27	/// The options for the delimited writer.
28	/// </summary>
29	private DelimitedOptions Options { get; }	4✔
30
31	/// <summary>
32	/// Writes the content of the file to the specified stream asynchronously.
33	/// </summary>
34	/// <param name="file">The file to write.</param>
35	/// <param name="stream">The stream to write to.</param>
36	/// <returns>
37	/// A task representing the asynchronous write operation. The task result is true if the
38	/// write operation is successful; otherwise, false.
39	/// </returns>
40	public override async Task<bool> WriteAsync(IGenericFile? file, Stream? stream)
41	{
42	if (stream?.CanWrite != true \|\| file is null)	11✔
43	return false;	7✔
44	var Builder = new StringBuilder();	4✔
45	Table? FileTable = file.ToFileType<Table>();	4✔
46	if (FileTable is not null)	4!
47	{
48	_ = Builder.Append(CreateFromTable(FileTable, Options));	4✔
49	}
50	else
51	{
UNCOV 52	_ = Builder.Append(CreateFromFile(file, Options));	×
53	}
54	var ByteData = Encoding.UTF8.GetBytes(Builder.ToString());	4✔
55	try
56	{
57	await stream.WriteAsync(ByteData).ConfigureAwait(false);	4✔
58	}	4✔
UNCOV 59	catch	×
60	{
UNCOV 61	return false;	×
62	}
63	return true;	4✔
64	}	11✔
65
66	/// <summary>
67	/// Creates the file data from a file object.
68	/// </summary>
69	/// <param name="file">The file object.</param>
70	/// <param name="options"></param>
71	/// <returns>The file data as a string.</returns>
UNCOV 72	private static string CreateFromFile(IGenericFile file, DelimitedOptions options) => options.Quote + file?.ToString()?.Replace(options.Quote ?? "", "") + options.Quote;	×
73
74	/// <summary>
75	/// Creates the file data from a table object.
76	/// </summary>
77	/// <param name="fileTable">The table object representing the file.</param>
78	/// <param name="options">The options for the delimited writer.</param>
79	/// <returns>The file data as a string.</returns>
80	private static string CreateFromTable(Table fileTable, DelimitedOptions options)
81	{
82	if (!fileTable.Metadata.TryGetValue("Delimiter", out var Delimiter))	4!
83	Delimiter = options.DefaultSeparator;	×
84	var Builder = new StringBuilder();	4✔
85	var Seperator = "";	4✔
86	if (fileTable.Columns.Count > 0)	4✔
87	{
88	foreach (var HeaderColumn in fileTable.Columns)	4✔
89	{
90	var Header = HeaderColumn;	1✔
91	if (!string.IsNullOrEmpty(options.Quote) && !string.IsNullOrEmpty(Header))	1✔
92	Header = Header.Replace(options.Quote, "");	1✔
93	_ = Builder.Append(Seperator).Append(options.Quote).Append(Header ?? "").Append(options.Quote);	1!
94	Seperator = Delimiter;	1✔
95	}
96	_ = Builder.AppendLine();	1✔
97	}
98	foreach (TableRow Row in fileTable)	18✔
99	{
100	Seperator = "";	5✔
101	foreach (TableCell CurrentCell in Row)	20✔
102	{
103	var Content = CurrentCell.Content;	5✔
104	if (!string.IsNullOrEmpty(options.Quote) && !string.IsNullOrEmpty(Content))	5✔
105	Content = Content.Replace(options.Quote, "");	5✔
106	_ = Builder.Append(Seperator).Append(options.Quote).Append(Content ?? "").Append(options.Quote);	5!
107	Seperator = Delimiter;	5✔
108	}
109	_ = Builder.AppendLine();	5✔
110	}
111	return Builder.ToString();	4✔
112	}
113	}
114	}

JaCraig / Archivist / 10017337279

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous