Do not throw for returning single record methods in MinecraftJar, instead return NULL

tekgator · tekgator · commit 7b3521c2cb67 · 2023-06-07T21:24:44.000+10:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 
 
+## [1.4.6] - 2023-06-07
+
+### Changed
+- Do not throw for returning single record methods in MinecraftJar, instead return NULL
+
+
 ## [1.4.5] - 2023-06-04
 
 ### Fixed
diff --git a/MinecraftJars.Tests/ProjectTests.cs b/MinecraftJars.Tests/ProjectTests.cs
@@ -13,14 +13,15 @@ public class ProjectTests
     public void GetProviderByProject_Success(string providerName)
     {
         var provider = MinecraftJar.GetProvider(providerName);
+        Assert.That(provider, Is.Not.Null);
         
-        foreach (var project in provider.Projects)
+        foreach (var project in provider!.Projects)
         {
             var providerByProject = MinecraftJar.GetProvider(project);
             Assert.That(providerByProject, Is.SameAs(provider));
             
             TestContext.Progress.WriteLine("{0}: Provider for project {1} is {2}", 
-                nameof(GetProviderByProject_Success), providerByProject.Name, project.Name);
+                nameof(GetProviderByProject_Success), providerByProject!.Name, project.Name);
         }
     }
     
diff --git a/MinecraftJars.Tests/ProviderTests.cs b/MinecraftJars.Tests/ProviderTests.cs
@@ -48,7 +48,7 @@ public void GetProviderByName_Success()
     [TestCase("InvalidProviderName"), Order(5)]
     public void GetProviderByName_InvalidProvider(string name)
     {
-        Assert.Throws<InvalidOperationException>(() => MinecraftJar.GetProvider(name));
+        Assert.That(MinecraftJar.GetProvider(name), Is.Null);
         TestContext.Progress.WriteLine("{0}: Provider name {1} invalid", nameof(GetProviderByName_InvalidProvider), name);
     }
 }
diff --git a/MinecraftJars.Tests/VersionTests.cs b/MinecraftJars.Tests/VersionTests.cs
@@ -12,7 +12,7 @@ private static IEnumerable<string> Projects() =>
     [TestCaseSource(nameof(Projects)), Order(1)]
     public void GetProjectsByName_Success(string projectName)
     {
-        Assert.DoesNotThrow(() => MinecraftJar.GetProject(projectName));
+        Assert.That(MinecraftJar.GetProject(projectName), Is.Not.Null);
         TestContext.Progress.WriteLine("{0}: Project found by name {1}", 
             nameof(GetProjectsByName_Success), projectName);
     }     
diff --git a/MinecraftJars/IMinecraftJar.cs b/MinecraftJars/IMinecraftJar.cs
@@ -16,14 +16,14 @@ public interface IMinecraftJar
     IEnumerable<IMinecraftProvider> GetProviders(ProjectGroup projectGroup);
 
     /// <summary>
-    /// Return a specific provider
+    /// Return a specific provider, null if not found
     /// </summary>    
-    IMinecraftProvider GetProvider(string providerName);
+    IMinecraftProvider? GetProvider(string providerName);
 
     /// <summary>
-    /// Return the provider for the provided Project
+    /// Return the provider for the provided Project, null if not found
     /// </summary>    
-    IMinecraftProvider GetProvider(IMinecraftProject project);
+    IMinecraftProvider? GetProvider(IMinecraftProject project);
 
     /// <summary>
     /// Return a list of all projects (e.g. Vanilla, Spigot, etc.)
@@ -36,7 +36,7 @@ public interface IMinecraftJar
     IEnumerable<IMinecraftProject> GetProjects(ProjectGroup projectGroup);
 
     /// <summary>
-    /// Return project by it's name
+    /// Return project by it's name, null if not found
     /// </summary>       
-    IMinecraftProject GetProject(string projectName);
+    IMinecraftProject? GetProject(string projectName);
 }
diff --git a/MinecraftJars/MinecraftJar.cs b/MinecraftJars/MinecraftJar.cs
@@ -42,18 +42,18 @@ from project in provider.Projects
             select provider;
     }    
 
-    public IMinecraftProvider GetProvider(string providerName)
+    public IMinecraftProvider? GetProvider(string providerName)
     {
         return (from provider in GetProviders()
             where provider.Name.Equals(providerName)
-            select provider).Single();
+            select provider).SingleOrDefault();
     }
     
-    public IMinecraftProvider GetProvider(IMinecraftProject project)
+    public IMinecraftProvider? GetProvider(IMinecraftProject project)
     {
         return (from provider in GetProviders()
             where provider.Projects.Contains(project)
-            select provider).Single();
+            select provider).SingleOrDefault();
     }    
 
     public IEnumerable<IMinecraftProject> GetProjects()
@@ -71,11 +71,11 @@ from project in provider.Projects
             select project;
     }
 
-    public IMinecraftProject GetProject(string projectName)
+    public IMinecraftProject? GetProject(string projectName)
     {
         return (from provider in GetProviders()
             from project in provider.Projects
             where project.Name.Equals(projectName)
-            select project).Single();
+            select project).SingleOrDefault();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,14 +13,15 @@ public class ProjectTests`
`13`	`13`	`public void GetProviderByProject_Success(string providerName)`
`14`	`14`	`{`
`15`	`15`	`var provider = MinecraftJar.GetProvider(providerName);`
	`16`	`+ Assert.That(provider, Is.Not.Null);`
`16`	`17`
`17`		`- foreach (var project in provider.Projects)`
	`18`	`+ foreach (var project in provider!.Projects)`
`18`	`19`	`{`
`19`	`20`	`var providerByProject = MinecraftJar.GetProvider(project);`
`20`	`21`	`Assert.That(providerByProject, Is.SameAs(provider));`
`21`	`22`
`22`	`23`	`TestContext.Progress.WriteLine("{0}: Provider for project {1} is {2}",`
`23`		`- nameof(GetProviderByProject_Success), providerByProject.Name, project.Name);`
	`24`	`+ nameof(GetProviderByProject_Success), providerByProject!.Name, project.Name);`
`24`	`25`	`}`
`25`	`26`	`}`
`26`	`27`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public void GetProviderByName_Success()`
`48`	`48`	`[TestCase("InvalidProviderName"), Order(5)]`
`49`	`49`	`public void GetProviderByName_InvalidProvider(string name)`
`50`	`50`	`{`
`51`		`- Assert.Throws<InvalidOperationException>(() => MinecraftJar.GetProvider(name));`
	`51`	`+ Assert.That(MinecraftJar.GetProvider(name), Is.Null);`
`52`	`52`	`TestContext.Progress.WriteLine("{0}: Provider name {1} invalid", nameof(GetProviderByName_InvalidProvider), name);`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ private static IEnumerable<string> Projects() =>`
`12`	`12`	`[TestCaseSource(nameof(Projects)), Order(1)]`
`13`	`13`	`public void GetProjectsByName_Success(string projectName)`
`14`	`14`	`{`
`15`		`- Assert.DoesNotThrow(() => MinecraftJar.GetProject(projectName));`
	`15`	`+ Assert.That(MinecraftJar.GetProject(projectName), Is.Not.Null);`
`16`	`16`	`TestContext.Progress.WriteLine("{0}: Project found by name {1}",`
`17`	`17`	`nameof(GetProjectsByName_Success), projectName);`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,18 +42,18 @@ from project in provider.Projects`
`42`	`42`	`select provider;`
`43`	`43`	`}`
`44`	`44`
`45`		`- public IMinecraftProvider GetProvider(string providerName)`
	`45`	`+ public IMinecraftProvider? GetProvider(string providerName)`
`46`	`46`	`{`
`47`	`47`	`return (from provider in GetProviders()`
`48`	`48`	`where provider.Name.Equals(providerName)`
`49`		`- select provider).Single();`
	`49`	`+ select provider).SingleOrDefault();`
`50`	`50`	`}`
`51`	`51`
`52`		`- public IMinecraftProvider GetProvider(IMinecraftProject project)`
	`52`	`+ public IMinecraftProvider? GetProvider(IMinecraftProject project)`
`53`	`53`	`{`
`54`	`54`	`return (from provider in GetProviders()`
`55`	`55`	`where provider.Projects.Contains(project)`
`56`		`- select provider).Single();`
	`56`	`+ select provider).SingleOrDefault();`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`public IEnumerable<IMinecraftProject> GetProjects()`
`@@ -71,11 +71,11 @@ from project in provider.Projects`
`71`	`71`	`select project;`
`72`	`72`	`}`
`73`	`73`
`74`		`- public IMinecraftProject GetProject(string projectName)`
	`74`	`+ public IMinecraftProject? GetProject(string projectName)`
`75`	`75`	`{`
`76`	`76`	`return (from provider in GetProviders()`
`77`	`77`	`from project in provider.Projects`
`78`	`78`	`where project.Name.Equals(projectName)`
`79`		`- select project).Single();`
	`79`	`+ select project).SingleOrDefault();`
`80`	`80`	`}`
`81`	`81`	`}`