Skip to content

Commit ced82dc

Browse files
BenjaminMichaelisBenjaminMichaelis
committed
fix: Handle file-scoped namespaces (#111)
and some general namespace suffix's and formatting
1 parent 95a36fa commit ced82dc

File tree

3 files changed

+220
-43
lines changed

3 files changed

+220
-43
lines changed

‎ListingManager.Tests/ListingInformationTests.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,4 +231,16 @@ public void GetNewFileName_FileName_ReturnCorrectNewFileName(string expected, st
231231

232232
Assert.Equal(expected, new ListingInformation(writtenFile.FullName, isTest).GetNewFileName());
233233
}
234+
235+
[Theory]
236+
[InlineData("namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06;", 0, true, false)]
237+
[InlineData("namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06 ;", 1, true, false)]
238+
[InlineData("namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06{ ", 0, false, true)]
239+
[InlineData("namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06 { ", 1, false, true)]
240+
[InlineData("namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06 { ", 2, false, true)]
241+
public void GetNumberOfWhitespaceCharactersInTheSuffixOfNamespace_Namespace_ReturnCorrectNumberOfWhitespaceCharacters(string @namespace, int expected, bool isNamespaceFileScoped, bool isNamespaceCurlyBraced)
242+
{
243+
Assert.Equal(expected, ListingInformation.GetNumberOfWhitespaceCharactersInTheSuffixOfNamespace(@namespace, isNamespaceFileScoped, isNamespaceCurlyBraced));
244+
}
245+
234246
}

‎ListingManager.Tests/ListingManagerTests.cs‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,149 @@ public void UpdateChapterListingNumbers_GitStorageManager_ListingsWithinListMiss
234234
}
235235
#endregion GitStorageManager
236236
#region UsingOSStorageManager
237+
[Fact]
238+
public void UpdateChapterListingNumbers_OSStorageManager_FileScopedNamespacesUpdated()
239+
{
240+
ICollection<string> filesToMake = new List<string>
241+
{
242+
Path.Join("Chapter42","Listing42.06.cs"),
243+
};
244+
245+
ICollection<string> expectedFiles = new List<string>
246+
{
247+
Path.Join("Chapter42","Listing42.01.cs")
248+
};
249+
250+
IEnumerable<string> toWrite = new List<string>
251+
{
252+
"namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06;",
253+
" using System;",
254+
" using System.Reflection;",
255+
" public class Program { }",
256+
};
257+
258+
IEnumerable<string> expectedToWrite = new List<string>
259+
{
260+
"namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter42.Listing42_01;",
261+
" using System;",
262+
" using System.Reflection;",
263+
" public class Program { }",
264+
};
265+
DirectoryInfo tempDir = CreateTempDirectory();
266+
DirectoryInfo chapterDir = CreateTempDirectory(tempDir, name: "Chapter42");
267+
CreateTempDirectory(tempDir, name: "Chapter42.Tests");
268+
WriteFiles(tempDir, filesToMake, toWrite);
269+
expectedFiles = ConvertFileNamesToFullPath(expectedFiles, tempDir).ToList();
270+
271+
ListingManager listingManager = new(tempDir, new OSStorageManager());
272+
listingManager.UpdateChapterListingNumbers(chapterDir);
273+
274+
List<string> files = FileManager.GetAllFilesAtPath(tempDir.FullName, true)
275+
.Where(x => Path.GetExtension(x) == ".cs").OrderBy(x => x).ToList();
276+
277+
// Assert
278+
string expectedFile = Assert.Single(files);
279+
Assert.Equivalent(expectedFiles, files);
280+
281+
Assert.Equal(string.Join(Environment.NewLine, expectedToWrite) + Environment.NewLine, File.ReadAllText(expectedFile));
282+
}
283+
284+
[Fact]
285+
public void UpdateChapterListingNumbers_OSStorageManager_FileScopedNamespaceWithSpacesUpdated()
286+
{
287+
ICollection<string> filesToMake = new List<string>
288+
{
289+
Path.Join("Chapter42","Listing42.06.cs"),
290+
};
291+
292+
ICollection<string> expectedFiles = new List<string>
293+
{
294+
Path.Join("Chapter42","Listing42.01.cs")
295+
};
296+
297+
IEnumerable<string> toWrite = new List<string>
298+
{
299+
"namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06 ;",
300+
" using System;",
301+
" using System.Reflection;",
302+
" public class Program { }",
303+
};
304+
305+
IEnumerable<string> expectedToWrite = new List<string>
306+
{
307+
"namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter42.Listing42_01 ;",
308+
" using System;",
309+
" using System.Reflection;",
310+
" public class Program { }",
311+
};
312+
DirectoryInfo tempDir = CreateTempDirectory();
313+
DirectoryInfo chapterDir = CreateTempDirectory(tempDir, name: "Chapter42");
314+
CreateTempDirectory(tempDir, name: "Chapter42.Tests");
315+
WriteFiles(tempDir, filesToMake, toWrite);
316+
expectedFiles = ConvertFileNamesToFullPath(expectedFiles, tempDir).ToList();
317+
318+
ListingManager listingManager = new(tempDir, new OSStorageManager());
319+
listingManager.UpdateChapterListingNumbers(chapterDir);
320+
321+
List<string> files = FileManager.GetAllFilesAtPath(tempDir.FullName, true)
322+
.Where(x => Path.GetExtension(x) == ".cs").OrderBy(x => x).ToList();
323+
324+
// Assert
325+
string expectedFile = Assert.Single(files);
326+
Assert.Equivalent(expectedFiles, files);
327+
328+
Assert.Equal(string.Join(Environment.NewLine, expectedToWrite) + Environment.NewLine, File.ReadAllText(expectedFile));
329+
}
330+
331+
[Fact]
332+
public void UpdateChapterListingNumbers_OSStorageManager_NamespacesWithCurlyBraceOnSameLineUpdated()
333+
{
334+
ICollection<string> filesToMake = new List<string>
335+
{
336+
Path.Join("Chapter42","Listing42.06.cs"),
337+
};
338+
339+
ICollection<string> expectedFiles = new List<string>
340+
{
341+
Path.Join("Chapter42","Listing42.01.cs")
342+
};
343+
344+
IEnumerable<string> toWrite = new List<string>
345+
{
346+
"namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter18.Listing18_06 {",
347+
" using System;",
348+
" using System.Reflection;",
349+
" public class Program { }",
350+
"}"
351+
};
352+
353+
IEnumerable<string> expectedToWrite = new List<string>
354+
{
355+
"namespace AddisonWesley.Michaelis.EssentialCSharp.Chapter42.Listing42_01 {",
356+
" using System;",
357+
" using System.Reflection;",
358+
" public class Program { }",
359+
"}",
360+
};
361+
DirectoryInfo tempDir = CreateTempDirectory();
362+
DirectoryInfo chapterDir = CreateTempDirectory(tempDir, name: "Chapter42");
363+
CreateTempDirectory(tempDir, name: "Chapter42.Tests");
364+
WriteFiles(tempDir, filesToMake, toWrite);
365+
expectedFiles = ConvertFileNamesToFullPath(expectedFiles, tempDir).ToList();
366+
367+
ListingManager listingManager = new(tempDir, new OSStorageManager());
368+
listingManager.UpdateChapterListingNumbers(chapterDir);
369+
370+
List<string> files = FileManager.GetAllFilesAtPath(tempDir.FullName, true)
371+
.Where(x => Path.GetExtension(x) == ".cs").OrderBy(x => x).ToList();
372+
373+
// Assert
374+
string expectedFile = Assert.Single(files);
375+
Assert.Equivalent(expectedFiles, files);
376+
377+
Assert.Equal(string.Join(Environment.NewLine, expectedToWrite) + Environment.NewLine, File.ReadAllText(expectedFile));
378+
}
379+
237380
[Fact]
238381
public void UpdateChapterListingNumbers_ListingsWithinListMissing_ListingsRenumbered()
239382
{

‎ListingManager/ListingInformation.cs‎

Lines changed: 65 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -119,57 +119,79 @@ public string GetNewNamespace()
119119
+ $".Chapter{paddedChapterNumber}"
120120
+ $".Listing{paddedChapterNumber}_"
121121
+ paddedListingNumber + (IsTest ? ".Tests" : string.Empty);
122-
}
123-
122+
}
123+
124124
public bool UpdateNamespaceInFileContents()
125-
{
126-
return UpdateNamespaceInFileContents(GetNewNamespace());
125+
{
126+
return UpdateNamespaceInFileContents(GetNewNamespace());
127127
}
128128

129129
public bool UpdateNamespaceInFileContents(string newNamespace)
130-
{
131-
bool updated = false;
132-
for (int i = 0; i < FileContents.Count; i++)
133-
{
134-
if (FileContents[i].TrimStart().StartsWith("namespace"))
135-
{
136-
FileContents[i] = $"namespace {newNamespace}";
137-
updated = true;
138-
FileContentsChanged = true;
139-
}
140-
}
141-
return updated;
142-
}
143-
130+
{
131+
bool updated = false;
132+
for (int i = 0; i < FileContents.Count; i++)
133+
{
134+
if (FileContents[i].TrimStart().StartsWith("namespace"))
135+
{
136+
bool isNamespaceFileScoped = FileContents[i].TrimEnd().EndsWith(';');
137+
bool isNamespaceCurlyBraced = FileContents[i].TrimEnd().EndsWith('{');
138+
if (isNamespaceFileScoped && isNamespaceCurlyBraced) throw new InvalidOperationException("Namespace is detected to be both file scoped and curly braced scoped.");
139+
int numberOfWhitespaceCharacters = GetNumberOfWhitespaceCharactersInTheSuffixOfNamespace(FileContents[i], isNamespaceFileScoped, isNamespaceCurlyBraced);
140+
FileContents[i] = $"namespace {newNamespace}";
141+
// add the whitespace characters back in
142+
FileContents[i] += new string(' ', numberOfWhitespaceCharacters);
143+
// append the closing curly brace if the namespace was curly braced and a ; if it was file scoped
144+
if (isNamespaceFileScoped) FileContents[i] += ";";
145+
else if (isNamespaceCurlyBraced) FileContents[i] += "{";
146+
updated = true;
147+
FileContentsChanged = true;
148+
}
149+
}
150+
return updated;
151+
}
152+
153+
public static int GetNumberOfWhitespaceCharactersInTheSuffixOfNamespace(string @namespace, bool isNamespaceFileScoped, bool isNamespaceCurlyBraced)
154+
{
155+
int indexOfNamespaceEnd = @namespace.TrimEnd().LastIndexOfAny([';', '{']);
156+
// get the number of whitespace characters between the last non-whitespace character and the index indexOfNamespaceEnd
157+
int numberOfWhitespaceCharacters = 0;
158+
if (indexOfNamespaceEnd > 0 && (isNamespaceCurlyBraced || isNamespaceFileScoped))
159+
{
160+
numberOfWhitespaceCharacters = indexOfNamespaceEnd - @namespace[..(indexOfNamespaceEnd)].TrimEnd().Length;
161+
}
162+
163+
return numberOfWhitespaceCharacters;
164+
}
165+
144166
public void UpdateReferencesInFileAndTest(List<ListingInformation> listingData)
145167
{
146168
for (int i = 0; i < FileContents.Count; i++)
147169
{
148170
if (ListingReference().IsMatch(FileContents[i]))
149-
{
150-
if (FileContents[i].TrimStart().StartsWith("namespace"))
151-
{
152-
continue;
153-
}
154-
MatchCollection matches = ListingReference().Matches(FileContents[i]);
155-
for (int j = 0; j < matches.Count; j++)
156-
{
157-
int chapterNumber = int.Parse(matches[j].Groups[1].Value);
158-
string chapterListingDeliminator = matches[j].Groups[2].Value;
171+
{
172+
if (FileContents[i].TrimStart().StartsWith("namespace"))
173+
{
174+
continue;
175+
}
176+
MatchCollection matches = ListingReference().Matches(FileContents[i]);
177+
for (int j = 0; j < matches.Count; j++)
178+
{
179+
int chapterNumber = int.Parse(matches[j].Groups[1].Value);
180+
string chapterListingDeliminator = matches[j].Groups[2].Value;
159181
int listingNumber = int.Parse(matches[j].Groups[3].Value);
160-
ListingInformation? referencedListingInformation = listingData.FirstOrDefault(item => item.OriginalChapterNumber == chapterNumber && item.OriginalListingNumber == listingNumber);
161-
if (referencedListingInformation is not null)
162-
{
163-
string replacementListingReference = matches[j].Groups[0].Value.Replace($"{chapterNumber:D2}{matches[j].Groups[2].Value}{listingNumber:D2}", $"{referencedListingInformation.NewChapterNumber:D2}{matches[j].Groups[2].Value}{referencedListingInformation.NewListingNumber:D2}");
182+
ListingInformation? referencedListingInformation = listingData.FirstOrDefault(item => item.OriginalChapterNumber == chapterNumber && item.OriginalListingNumber == listingNumber);
183+
if (referencedListingInformation is not null)
184+
{
185+
string replacementListingReference = matches[j].Groups[0].Value.Replace($"{chapterNumber:D2}{matches[j].Groups[2].Value}{listingNumber:D2}", $"{referencedListingInformation.NewChapterNumber:D2}{matches[j].Groups[2].Value}{referencedListingInformation.NewListingNumber:D2}");
164186
FileContents[i] = FileContents[i].Replace(matches[j].Groups[0].Value, replacementListingReference);
165-
}
166-
}
187+
}
188+
}
167189
FileContentsChanged = true;
168190
}
169191
}
170-
if (AssociatedTest is ListingInformation listingTest)
171-
{
172-
listingTest.UpdateReferencesInFileAndTest(listingData);
192+
if (AssociatedTest is ListingInformation listingTest)
193+
{
194+
listingTest.UpdateReferencesInFileAndTest(listingData);
173195
}
174196
}
175197

@@ -183,13 +205,13 @@ public string GetNewFileName()
183205
paddedChapterNumber,
184206
paddedListingNumber,
185207
string.IsNullOrWhiteSpace(Caption) ? "" : $".{Caption}");
186-
}
187-
188-
// Match any approved files regex: regexr.com/7lfi2
208+
}
209+
210+
// Match any approved files regex: regexr.com/7lfi2
189211
[GeneratedRegex("Listing(\\d{2}).(\\d{2})([A-Za-z]*)(\\.{1}(.*))*(\\.(\\w+))$")]
190212
private static partial Regex ExtractListingNameFromAnyApprovedFileTypes();
191213
[GeneratedRegex(@"\d{1}[A-Za-z]")]
192-
private static partial Regex SingleDigitListingWithSuffix();
193-
[GeneratedRegex("Listing(\\d{2})([_.])(\\d{2})")]
194-
private static partial Regex ListingReference();
214+
private static partial Regex SingleDigitListingWithSuffix();
215+
[GeneratedRegex("Listing(\\d{2})([_.])(\\d{2})")]
216+
private static partial Regex ListingReference();
195217
}

0 commit comments

Comments
 (0)