9238576416

Committed 25 May 2024 10:17PM UTC coverage: 83.817% (+28.8%) from 54.978%

Build # 9238576416

Build Type

push

github

Committed by

JaCraig

Commit Message

fix: More test fixes

Updated the `FixedLengthFile` class in the `Archivist.DataTypes` namespace to include a line separator. Added two constructors, one default initializing the line separator to "\r\n", and another allowing the line separator to be specified. Also added a `LineSeparator` property to get the line separator used in the fixed-length file.

The `GetContent` method now uses the `LineSeparator` property instead of `Environment.NewLine` when joining the records.

Updated the `FixedLengthFile` instances in the `GetContent_ShouldReturnRecordsAsString` and `ToString_ShouldReturnRecordsAsString` test methods in the `FixedLengthFileTests` class to use the new constructor that accepts a line separator.

Improved readability of the `FixedLengthFile` class by updating comments for the comparison and equality operators and methods to span multiple lines.

Run Details

230 of 296 branches covered (77.7%)

Branch coverage included in aggregate %.

7 of 7 new or added lines in 1 file covered. (100.0%)

22 existing lines in 3 files now uncovered.

376 of 427 relevant lines covered (88.06%)

3061.44 hits per line

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

27.78

/Archivist/BaseClasses/FileBaseClass.cs

﻿using Archivist.Interfaces;
using System.Collections.Generic;

namespace Archivist.BaseClasses
{
    /// <summary>
    /// Base class for file types in the Archivist library.
    /// </summary>
    /// <typeparam name="TFileType">The specific file type derived from this base class.</typeparam>
    public abstract class FileBaseClass<TFileType> : IGenericFile
        where TFileType : FileBaseClass<TFileType>
    {
        /// <summary>
        /// Gets or sets the metadata associated with the file.
        /// </summary>
        public Dictionary<string, string> Metadata { get; } = new Dictionary<string, string>();

        /// <summary>
        /// Gets or sets the title of the file.
        /// </summary>
        public string? Title { get; set; }

        /// <summary>
        /// Determines if the two file objects are not equal.
        /// </summary>
        /// <param name="value1">The first file object.</param>
        /// <param name="value2">The second file object.</param>
        /// <returns>True if the file objects are not equal, false otherwise.</returns>
        public static bool operator !=(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
        {
            return !(value1 == value2);
        }

        /// <summary>
        /// Determines if the first file object is less than the second file object.
        /// </summary>
        /// <param name="value1">The first file object.</param>
        /// <param name="value2">The second file object.</param>
        /// <returns>True if the first file object is less than the second file object, false otherwise.</returns>
        public static bool operator <(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
        {
            if (value1 is null)
                return value2 is not null;
            return value1.CompareTo(value2) < 0;
        }

        /// <summary>
        /// Determines if the first file object is less than or equal to the second file object.
        /// </summary>
        /// <param name="value1">The first file object.</param>
        /// <param name="value2">The second file object.</param>
        /// <returns>True if the first file object is less than or equal to the second file object, false otherwise.</returns>
        public static bool operator <=(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
        {
            return (value1?.CompareTo(value2) ?? 0) <= 0;
        }

        /// <summary>
        /// Determines if the two file objects are equal.
        /// </summary>
        /// <param name="value1">The first file object.</param>
        /// <param name="value2">The second file object.</param>
        /// <returns>True if the file objects are equal, false otherwise.</returns>
        public static bool operator ==(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
        {
            return value1?.Equals(value2) ?? value2 is null;
        }

        /// <summary>
        /// Determines if the first file object is greater than the second file object.
        /// </summary>
        /// <param name="value1">The first file object.</param>
        /// <param name="value2">The second file object.</param>
        /// <returns>True if the first file object is greater than the second file object, false otherwise.</returns>
        public static bool operator >(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
        {
            return value1 is not null
                && (value2 is null
                    || value1.CompareTo(value2) > 0);
        }

        /// <summary>
        /// Determines if the first file object is greater than or equal to the second file object.
        /// </summary>
        /// <param name="value1">The first file object.</param>
        /// <param name="value2">The second file object.</param>
        /// <returns>True if the first file object is greater than or equal to the second file object, false otherwise.</returns>
        public static bool operator >=(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
        {
            return (value1 is null) ? value2 is null : value1.CompareTo(value2) >= 0;
        }

        /// <summary>
        /// Compares the file object to another object.
        /// </summary>
        /// <param name="obj">The object to compare to.</param>
        /// <returns>0 if the objects are equal, -1 if this is smaller, 1 if it is larger.</returns>
        public int CompareTo(object? obj) => obj is TFileType FormatFileType ? CompareTo(FormatFileType) : -1;

        /// <summary>
        /// Compares the file object to another file object.
        /// </summary>
        /// <param name="other">The file object to compare to.</param>
        /// <returns>0 if the file objects are equal, -1 if this is smaller, 1 if it is larger.</returns>
        public abstract int CompareTo(TFileType? other);

        /// <summary>
        /// Determines if the file object is equal to another file object.
        /// </summary>
        /// <param name="other">The file object to compare to.</param>
        /// <returns>True if the file objects are equal, false otherwise.</returns>
        public abstract bool Equals(TFileType? other);

        /// <summary>
        /// Determines if the file object is equal to another object.
        /// </summary>
        /// <param name="obj">The object to compare to.</param>
        /// <returns>True if the file objects are equal, false otherwise.</returns>
        public override bool Equals(object? obj) => (obj is TFileType TempItem) && Equals(TempItem);

        /// <summary>
        /// Gets the content of the file.
        /// </summary>
        /// <returns>The content of the file.</returns>
        public abstract string? GetContent();

        /// <summary>
        /// Gets the hash code for the file object.
        /// </summary>
        /// <returns>The hash code for the file object.</returns>
        public override int GetHashCode() => GetContent()?.GetHashCode() ?? 0;

        /// <summary>
        /// Converts the file object to a string.
        /// </summary>
        /// <returns>The content of the file object.</returns>
        public override string ToString() => GetContent() ?? "";
    }
}

1	using Archivist.Interfaces;
2	using System.Collections.Generic;
3
4	namespace Archivist.BaseClasses
5	{
6	/// <summary>
7	/// Base class for file types in the Archivist library.
8	/// </summary>
9	/// <typeparam name="TFileType">The specific file type derived from this base class.</typeparam>
10	public abstract class FileBaseClass<TFileType> : IGenericFile
11	where TFileType : FileBaseClass<TFileType>
12	{
13	/// <summary>
14	/// Gets or sets the metadata associated with the file.
15	/// </summary>
16	public Dictionary<string, string> Metadata { get; } = new Dictionary<string, string>();	257,645✔
17
18	/// <summary>
19	/// Gets or sets the title of the file.
20	/// </summary>
21	public string? Title { get; set; }	171,674✔
22
23	/// <summary>
24	/// Determines if the two file objects are not equal.
25	/// </summary>
26	/// <param name="value1">The first file object.</param>
27	/// <param name="value2">The second file object.</param>
28	/// <returns>True if the file objects are not equal, false otherwise.</returns>
29	public static bool operator !=(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
30	{
UNCOV 31	return !(value1 == value2);	×
32	}
33
34	/// <summary>
35	/// Determines if the first file object is less than the second file object.
36	/// </summary>
37	/// <param name="value1">The first file object.</param>
38	/// <param name="value2">The second file object.</param>
39	/// <returns>True if the first file object is less than the second file object, false otherwise.</returns>
40	public static bool operator <(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
41	{
UNCOV 42	if (value1 is null)	×
UNCOV 43	return value2 is not null;	×
UNCOV 44	return value1.CompareTo(value2) < 0;	×
45	}
46
47	/// <summary>
48	/// Determines if the first file object is less than or equal to the second file object.
49	/// </summary>
50	/// <param name="value1">The first file object.</param>
51	/// <param name="value2">The second file object.</param>
52	/// <returns>True if the first file object is less than or equal to the second file object, false otherwise.</returns>
53	public static bool operator <=(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
54	{
UNCOV 55	return (value1?.CompareTo(value2) ?? 0) <= 0;	×
56	}
57
58	/// <summary>
59	/// Determines if the two file objects are equal.
60	/// </summary>
61	/// <param name="value1">The first file object.</param>
62	/// <param name="value2">The second file object.</param>
63	/// <returns>True if the file objects are equal, false otherwise.</returns>
64	public static bool operator ==(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
65	{
UNCOV 66	return value1?.Equals(value2) ?? value2 is null;	×
67	}
68
69	/// <summary>
70	/// Determines if the first file object is greater than the second file object.
71	/// </summary>
72	/// <param name="value1">The first file object.</param>
73	/// <param name="value2">The second file object.</param>
74	/// <returns>True if the first file object is greater than the second file object, false otherwise.</returns>
75	public static bool operator >(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
76	{
UNCOV 77	return value1 is not null	×
UNCOV 78	&& (value2 is null	×
UNCOV 79	\|\| value1.CompareTo(value2) > 0);	×
80	}
81
82	/// <summary>
83	/// Determines if the first file object is greater than or equal to the second file object.
84	/// </summary>
85	/// <param name="value1">The first file object.</param>
86	/// <param name="value2">The second file object.</param>
87	/// <returns>True if the first file object is greater than or equal to the second file object, false otherwise.</returns>
88	public static bool operator >=(FileBaseClass<TFileType>? value1, FileBaseClass<TFileType>? value2)
89	{
UNCOV 90	return (value1 is null) ? value2 is null : value1.CompareTo(value2) >= 0;	×
91	}
92
93	/// <summary>
94	/// Compares the file object to another object.
95	/// </summary>
96	/// <param name="obj">The object to compare to.</param>
97	/// <returns>0 if the objects are equal, -1 if this is smaller, 1 if it is larger.</returns>
98	public int CompareTo(object? obj) => obj is TFileType FormatFileType ? CompareTo(FormatFileType) : -1;	3!
99
100	/// <summary>
101	/// Compares the file object to another file object.
102	/// </summary>
103	/// <param name="other">The file object to compare to.</param>
104	/// <returns>0 if the file objects are equal, -1 if this is smaller, 1 if it is larger.</returns>
105	public abstract int CompareTo(TFileType? other);
106
107	/// <summary>
108	/// Determines if the file object is equal to another file object.
109	/// </summary>
110	/// <param name="other">The file object to compare to.</param>
111	/// <returns>True if the file objects are equal, false otherwise.</returns>
112	public abstract bool Equals(TFileType? other);
113
114	/// <summary>
115	/// Determines if the file object is equal to another object.
116	/// </summary>
117	/// <param name="obj">The object to compare to.</param>
118	/// <returns>True if the file objects are equal, false otherwise.</returns>
119	public override bool Equals(object? obj) => (obj is TFileType TempItem) && Equals(TempItem);	1!
120
121	/// <summary>
122	/// Gets the content of the file.
123	/// </summary>
124	/// <returns>The content of the file.</returns>
125	public abstract string? GetContent();
126
127	/// <summary>
128	/// Gets the hash code for the file object.
129	/// </summary>
130	/// <returns>The hash code for the file object.</returns>
131	public override int GetHashCode() => GetContent()?.GetHashCode() ?? 0;	1!
132
133	/// <summary>
134	/// Converts the file object to a string.
135	/// </summary>
136	/// <returns>The content of the file object.</returns>
137	public override string ToString() => GetContent() ?? "";	2!
138	}
139	}

JaCraig / Archivist / 9238576416

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