10044806963

Committed 22 Jul 2024 04:35PM UTC coverage: 83.747% (+0.6%) from 83.112%

Build # 10044806963

Build Type

push

github

Committed by

JaCraig

Commit Message

fix: Adding YAML support

Run Details

1206 of 1518 branches covered (79.45%)

Branch coverage included in aggregate %.

44 of 47 new or added lines in 3 files covered. (93.62%)

1 existing line in 1 file now uncovered.

1561 of 1786 relevant lines covered (87.4%)

7197.82 hits per line

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

91.67

/Archivist/Formats/YAML/YAMLReader.cs

﻿using Archivist.BaseClasses;
using Archivist.DataTypes;
using Archivist.ExtensionMethods;
using Archivist.Interfaces;
using System;
using System.Dynamic;
using System.IO;
using System.Threading.Tasks;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;

namespace Archivist.Formats.YAML
{
    /// <summary>
    /// Represents a reader for YAML files.
    /// </summary>
    public class YAMLReader : ReaderBaseClass
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="YAMLReader"/> class.
        /// </summary>
        public YAMLReader()
        {
            Deserializer = new DeserializerBuilder().WithNamingConvention(CamelCaseNamingConvention.Instance).Build();
        }

        /// <summary>
        /// Gets the header information for the YAML format.
        /// </summary>
        public override byte[] HeaderInfo => Array.Empty<byte>();

        /// <summary>
        /// The deserializer to use when deserializing YAML.
        /// </summary>
        private IDeserializer Deserializer { get; }

        /// <summary>
        /// Determines if the reader can read the specified stream.
        /// </summary>
        /// <param name="stream">The stream to read.</param>
        /// <returns><c>true</c> if the reader can read the stream; otherwise, <c>false</c>.</returns>
        public override bool InternalCanRead(Stream? stream)
        {
            if (stream is null)
                return false;
            try
            {
                var Value = stream.ReadAll();
                if (string.IsNullOrEmpty(Value))
                    return false;
                ExpandoObject? TestObject = Deserializer.Deserialize<ExpandoObject>(Value);
                _ = stream.Seek(0, SeekOrigin.Begin);
                return true;
            }
            catch
            {
                return false;
            }
        }

        /// <summary>
        /// Reads a YAML file asynchronously from the specified stream.
        /// </summary>
        /// <param name="stream">The stream to read the YAML file from.</param>
        /// <returns>The parsed YAML file.</returns>
        public override async Task<IGenericFile?> ReadAsync(Stream? stream)
        {
            if (stream?.CanRead != true)
                return new StructuredObject();
            var StreamData = await stream.ReadAllAsync().ConfigureAwait(false);
            if (string.IsNullOrEmpty(StreamData))
                return new StructuredObject();
            ExpandoObject? Data = Deserializer.Deserialize<ExpandoObject>(StreamData);
            return new StructuredObject(Data ?? new ExpandoObject());
        }
    }
}

1	using Archivist.BaseClasses;
2	using Archivist.DataTypes;
3	using Archivist.ExtensionMethods;
4	using Archivist.Interfaces;
5	using System;
6	using System.Dynamic;
7	using System.IO;
8	using System.Threading.Tasks;
9	using YamlDotNet.Serialization;
10	using YamlDotNet.Serialization.NamingConventions;
11
12	namespace Archivist.Formats.YAML
13	{
14	/// <summary>
15	/// Represents a reader for YAML files.
16	/// </summary>
17	public class YAMLReader : ReaderBaseClass
18	{
19	/// <summary>
20	/// Initializes a new instance of the <see cref="YAMLReader"/> class.
21	/// </summary>
22	public YAMLReader()	40✔
23	{
24	Deserializer = new DeserializerBuilder().WithNamingConvention(CamelCaseNamingConvention.Instance).Build();	40✔
25	}	40✔
26
27	/// <summary>
28	/// Gets the header information for the YAML format.
29	/// </summary>
30	public override byte[] HeaderInfo => Array.Empty<byte>();	3✔
31
32	/// <summary>
33	/// The deserializer to use when deserializing YAML.
34	/// </summary>
35	private IDeserializer Deserializer { get; }	6✔
36
37	/// <summary>
38	/// Determines if the reader can read the specified stream.
39	/// </summary>
40	/// <param name="stream">The stream to read.</param>
41	/// <returns><c>true</c> if the reader can read the stream; otherwise, <c>false</c>.</returns>
42	public override bool InternalCanRead(Stream? stream)
43	{
44	if (stream is null)	5✔
45	return false;	1✔
46	try
47	{
48	var Value = stream.ReadAll();	4✔
49	if (string.IsNullOrEmpty(Value))	4✔
50	return false;	1✔
51	ExpandoObject? TestObject = Deserializer.Deserialize<ExpandoObject>(Value);	3✔
52	_ = stream.Seek(0, SeekOrigin.Begin);	3✔
53	return true;	3✔
54	}
NEW 55	catch	×
56	{
NEW 57	return false;	×
58	}
59	}	4✔
60
61	/// <summary>
62	/// Reads a YAML file asynchronously from the specified stream.
63	/// </summary>
64	/// <param name="stream">The stream to read the YAML file from.</param>
65	/// <returns>The parsed YAML file.</returns>
66	public override async Task<IGenericFile?> ReadAsync(Stream? stream)
67	{
68	if (stream?.CanRead != true)	6✔
69	return new StructuredObject();	2✔
70	var StreamData = await stream.ReadAllAsync().ConfigureAwait(false);	4✔
71	if (string.IsNullOrEmpty(StreamData))	4✔
72	return new StructuredObject();	1✔
73	ExpandoObject? Data = Deserializer.Deserialize<ExpandoObject>(StreamData);	3✔
74	return new StructuredObject(Data ?? new ExpandoObject());	3!
75	}	6✔
76	}
77	}

JaCraig / Archivist / 10044806963

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