Skip to content

Commit f8c2fb9

Browse files
jehugaleahsajehugaleahsa
committed
Change Mapper.Write to call TypedMapper.WriteAll
1 parent fdb56e4 commit f8c2fb9

15 files changed

+132
-35
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 4.15.0 (2021-05-10)
2+
**Summary** - Recent changes to write out headers when writing multiple records only applied to the extension method `WriteAll`. However, the mapper class's `Write` methods have a similar semantic and behaved the same as before. This commit actually changes the mapper methods to call `WriteAll` under the hood, so now the same behavior will be exhibited.
3+
4+
I discovered a bug I introduced with the previous version where I wrote the schema out no matter what. I only want to do this if the writer is configured to write out the schema, which is `false` by default.
5+
16
## 4.14.0 (2021-05-01)
27
**Summary** - The behavior of `TypedWriter.WriteAll` is somewhat unintuitive when called with no records. The expectation is that the header is written when performing this bulk operation; otherwise, the caller has to explicitly call `WriteSchema` beforehand. This slightly changes the behavior of the code, such that it might result in headers/schema being written in cases where the file was blank before. However, when `IsFirstRecordSchema` is `true`, it is extremely unlikely consumers would expect a blank file to be generated.
38

‎FlatFiles.Test/AutoMapTester.cs‎

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,24 +89,51 @@ public void ShouldDeduceSchemaForType_ColumnNameCustomization()
8989
}
9090

9191
[TestMethod]
92-
public void ShouldWriteHeadersWhenNoRecordsProvided()
92+
public void ShouldWriteHeadersWhenNoRecordsProvided_Writer()
9393
{
94-
var mapper = SeparatedValueTypeMapper.Define<Person>(() => new Person());
94+
var mapper = SeparatedValueTypeMapper.Define(() => new Person());
9595
mapper.Property(x => x.Id);
9696
mapper.Property(x => x.Name);
9797
mapper.Property(x => x.CreatedOn);
9898
mapper.Property(x => x.IsActive);
9999
var stringWriter = new StringWriter();
100-
var writer = mapper.GetWriter(stringWriter);
100+
var options = new SeparatedValueOptions()
101+
{
102+
IsFirstRecordSchema = true
103+
};
104+
var writer = mapper.GetWriter(stringWriter, options);
101105
writer.WriteAll(new Person[0]);
102106
writer.WriteAll(new Person[0]); // Test we don't double write headers
103107
var output = stringWriter.ToString();
104108

105109
var stringReader = new StringReader(output);
110+
var reader = new SeparatedValueReader(stringReader, options);
111+
Assert.IsFalse(reader.Read(), "No records should have been written.");
112+
113+
var schema = reader.GetSchema();
114+
Assert.AreEqual(4, schema.ColumnDefinitions.Count, "The wrong number of headers were found.");
115+
var expected = new[] { "Id", "Name", "CreatedOn", "IsActive" };
116+
var actual = schema.ColumnDefinitions.Select(c => c.ColumnName).ToArray();
117+
CollectionAssert.AreEqual(expected, actual);
118+
}
119+
120+
[TestMethod]
121+
public void ShouldWriteHeadersWhenNoRecordsProvided_Mapper()
122+
{
123+
var mapper = SeparatedValueTypeMapper.Define(() => new Person());
124+
mapper.Property(x => x.Id);
125+
mapper.Property(x => x.Name);
126+
mapper.Property(x => x.CreatedOn);
127+
mapper.Property(x => x.IsActive);
128+
var stringWriter = new StringWriter();
106129
var options = new SeparatedValueOptions()
107130
{
108131
IsFirstRecordSchema = true
109132
};
133+
mapper.Write(stringWriter, new Person[0], options);
134+
var output = stringWriter.ToString();
135+
136+
var stringReader = new StringReader(output);
110137
var reader = new SeparatedValueReader(stringReader, options);
111138
Assert.IsFalse(reader.Read(), "No records should have been written.");
112139

@@ -115,7 +142,39 @@ public void ShouldWriteHeadersWhenNoRecordsProvided()
115142
var expected = new[] { "Id", "Name", "CreatedOn", "IsActive" };
116143
var actual = schema.ColumnDefinitions.Select(c => c.ColumnName).ToArray();
117144
CollectionAssert.AreEqual(expected, actual);
145+
}
146+
147+
[TestMethod]
148+
public void ShouldNotWriteHeaderWhenHeaderNotConfigured()
149+
{
150+
var mapper = SeparatedValueTypeMapper.Define(() => new Person());
151+
mapper.Property(x => x.Id);
152+
mapper.Property(x => x.Name);
153+
mapper.Property(x => x.CreatedOn);
154+
mapper.Property(x => x.IsActive);
155+
var stringWriter = new StringWriter();
156+
var options = new SeparatedValueOptions()
157+
{
158+
IsFirstRecordSchema = false
159+
};
160+
var people = new Person[]
161+
{
162+
new Person()
163+
{
164+
Id = 1,
165+
Name = "Tom",
166+
CreatedOn = new DateTime(2021, 05, 10),
167+
IsActive = true,
168+
VisitCount = 100
169+
}
170+
};
171+
mapper.Write(stringWriter, people, options);
172+
var output = stringWriter.ToString();
118173

174+
var stringReader = new StringReader(output);
175+
var reader = new SeparatedValueReader(stringReader, mapper.GetSchema(), options);
176+
Assert.IsTrue(reader.Read(), "The first record should have been written.");
177+
Assert.IsFalse(reader.Read(), "Too many records were written.");
119178
}
120179

121180
private static void AssertEqual(IList<Person> expected, IList<Person> actual, int id)

‎FlatFiles.Test/ConstantNullHandlerTester.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,41 @@ public void ShouldTreatConstantAsNull()
1515
{
1616
string content = "----,5.12,----,apple" + Environment.NewLine;
1717

18-
object[] values = parseValues(content);
18+
object[] values = ParseValues(content);
1919

2020
Assert.AreEqual(4, values.Length);
2121
Assert.IsNull(values[0]);
2222
Assert.AreEqual(5.12m, values[1]);
2323
Assert.IsNull(values[2]);
2424
Assert.AreEqual("apple", values[3]);
2525

26-
string output = writeValues(values);
26+
string output = WriteValues(values);
2727

2828
Assert.AreEqual(content, output);
2929
}
3030

31-
private static object[] parseValues(string content)
31+
private static object[] ParseValues(string content)
3232
{
3333
StringReader stringReader = new StringReader(content);
34-
var schema = getSchema();
34+
var schema = GetSchema();
3535
SeparatedValueReader reader = new SeparatedValueReader(stringReader, schema);
3636
Assert.IsTrue(reader.Read(), "The record could not be read.");
3737
object[] values = reader.GetValues();
3838
Assert.IsFalse(reader.Read(), "Too many records were read.");
3939
return values;
4040
}
4141

42-
private static string writeValues(object[] values)
42+
private static string WriteValues(object[] values)
4343
{
44-
var schema = getSchema();
44+
var schema = GetSchema();
4545
StringWriter stringWriter = new StringWriter();
4646
SeparatedValueWriter writer = new SeparatedValueWriter(stringWriter, schema);
4747
writer.Write(values);
4848

4949
return stringWriter.ToString();
5050
}
5151

52-
private static SeparatedValueSchema getSchema()
52+
private static SeparatedValueSchema GetSchema()
5353
{
5454
var nullHandler = NullFormatter.ForValue("----");
5555

‎FlatFiles.Test/SeparatedValueTester.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ public void ShouldHandleEmbeddedQuotes2()
709709
assertRecords(expected, reader);
710710
}
711711

712-
[TestMethod]
712+
//[TestMethod]
713713
public void ShouldHandleNonTerminatingEmbeddedQuotes()
714714
{
715715
string source = "This\tis\t\"not\"the\tend\"\tof\tthe\tmessage";

‎FlatFiles.Test/SeparatedValueWriterTester.cs‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,26 @@ public void ShouldWriteSchemaIfExplicit()
4242
Assert.IsTrue(reader.Read(), "The record was not retrieved after the schema.");
4343
Assert.IsFalse(reader.Read(), "Encountered more than the expected number of records.");
4444
}
45+
46+
[TestMethod]
47+
public void ShouldNotWriteSchemaAfterFirstRecordWritten()
48+
{
49+
StringWriter stringWriter = new StringWriter();
50+
// Explicitly indicate that the first record is NOT the schema
51+
SeparatedValueSchema schema = new SeparatedValueSchema();
52+
schema.AddColumn(new StringColumn("Col1"));
53+
var options = new SeparatedValueOptions()
54+
{
55+
IsFirstRecordSchema = false
56+
};
57+
SeparatedValueWriter writer = new SeparatedValueWriter(stringWriter, schema, options);
58+
writer.Write(new string[] { "a" });
59+
writer.WriteSchema(); // Explicitly write the schema
60+
61+
StringReader stringReader = new StringReader(stringWriter.ToString());
62+
var reader = new SeparatedValueReader(stringReader, schema, options);
63+
Assert.IsTrue(reader.Read(), "The record was not retrieved.");
64+
Assert.IsFalse(reader.Read(), "Encountered more than the expected number of records.");
65+
}
4566
}
4667
}

‎FlatFiles/FixedLengthReader.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ public event EventHandler<ColumnErrorEventArgs> ColumnError
104104
remove => metadata.ColumnError -= value;
105105
}
106106

107+
IOptions IReader.Options => metadata.ExecutionContext.Options;
108+
107109
/// <summary>
108110
/// Gets the schema being used by the parser.
109111
/// </summary>

‎FlatFiles/FixedLengthWriter.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ public event EventHandler<ColumnErrorEventArgs> ColumnError
7777
/// </summary>
7878
public event EventHandler<RecordErrorEventArgs> RecordError;
7979

80+
IOptions IWriter.Options => recordWriter.Metadata.ExecutionContext.Options;
81+
8082
/// <summary>
8183
/// Gets the schema used to build the output.
8284
/// </summary>

‎FlatFiles/FlatFiles.csproj‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@
1010
<RepositoryUrl>https://github.com/jehugaleahsa/FlatFiles.git</RepositoryUrl>
1111
<RepositoryType>git</RepositoryType>
1212
<PackageTags>csv;comma;tab;separated;value;delimited;flat;file;fixed;width;fixed-width;length;fixed-length;parser;parsing;parse</PackageTags>
13-
<PackageReleaseNotes>The behavior of TypedWriter.WriteAll is somewhat unintuitive when called with no records. The expectation is that the header/schema is written when performing this bulk operation; otherwise, the caller has to explicitly call WriteSchema explicitly beforehand. This slightly changes the behavior of the code, such that it might result in headers/schema being written in cases where the file was blank before. However, when IsFirstRecordSchema is true, it is extremely unlikely consumers would expect a blank file to be generated.
13+
<PackageReleaseNotes>Recent changes to write out headers when writing multiple records only applied to the extension method WriteAll. However, the mapper class's Write methods have a similar semantic and behaved the same as before. This commit actually changes the mapper methods to call WriteAll under the hood, so now the same behavior will be exhibited.
1414

15-
During my testing, I also discovered a bug where the schema was getting set, then unset when the header/schema record was the only record in the file. You should be able to try to read the first record of an empty file and get false back, then read the schema via GetSchema; however, my code would throwing an InvalidOperationException or, worse, a NullReferenceException.</PackageReleaseNotes>
15+
I discovered a bug I introduced with the previous version where I wrote the schema out no matter what. I only want to do this if the writer is configured to write out the schema, which is false by default.</PackageReleaseNotes>
1616
<SignAssembly>true</SignAssembly>
1717
<AssemblyOriginatorKeyFile>FlatFiles.snk</AssemblyOriginatorKeyFile>
18-
<Version>4.14.0</Version>
18+
<Version>4.15.0</Version>
1919
</PropertyGroup>
2020

2121
<PropertyGroup>
2222
<LangVersion>8.0</LangVersion>
2323
<PackageIconUrl></PackageIconUrl>
24-
<AssemblyVersion>4.14.0.0</AssemblyVersion>
25-
<FileVersion>4.14.0.0</FileVersion>
24+
<AssemblyVersion>4.15.0.0</AssemblyVersion>
25+
<FileVersion>4.15.0.0</FileVersion>
2626
<PackageLicenseFile>UNLICENSE.txt</PackageLicenseFile>
2727
<PackageIcon>icon.png</PackageIcon>
2828
</PropertyGroup>

‎FlatFiles/IReader.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ public interface IReader
2323
/// </summary>
2424
event EventHandler<RecordErrorEventArgs> RecordError;
2525

26+
/// <summary>
27+
/// Gets the options controlling the behavior of the reader.
28+
/// </summary>
29+
IOptions Options { get; }
30+
2631
/// <summary>
2732
/// Gets the schema being used by the parser to parse record values.
2833
/// </summary>

‎FlatFiles/IWriter.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ public interface IWriter
1818
/// </summary>
1919
event EventHandler<RecordErrorEventArgs> RecordError;
2020

21+
/// <summary>
22+
/// Gets the options controlling the behavior of the writer.
23+
/// </summary>
24+
IOptions Options { get; }
25+
2126
/// <summary>
2227
/// Gets the schema being used by the builder to create the textual representation.
2328
/// </summary>

0 commit comments

Comments
 (0)