Nullable properties returning ChainablePath now return ChainablePath.Empty

dennisdoomen · dennisdoomen · commit ae7c4cd93971 · 2025-05-13T08:45:15.000+02:00
diff --git a/Pathy.ApiVerificationTests/ApprovedApi/pathy.net47.verified.txt b/Pathy.ApiVerificationTests/ApprovedApi/pathy.net47.verified.txt
@@ -3,7 +3,7 @@ namespace Pathy
 {
     public readonly struct ChainablePath : System.IEquatable<Pathy.ChainablePath>
     {
-        public Pathy.ChainablePath? Directory { get; }
+        public Pathy.ChainablePath Directory { get; }
         public bool DirectoryExists { get; }
         public string DirectoryName { get; }
         public bool Exists { get; }
@@ -16,6 +16,7 @@ namespace Pathy
         public Pathy.ChainablePath Parent { get; }
         public Pathy.ChainablePath Root { get; }
         public static Pathy.ChainablePath Current { get; }
+        public static Pathy.ChainablePath Empty { get; }
         public static Pathy.ChainablePath New { get; }
         public static Pathy.ChainablePath Temp { get; }
         public System.IO.DirectoryInfo ToDirectoryInfo() { }
@@ -38,4 +39,4 @@ namespace Pathy
     {
         public static Pathy.ChainablePath ToPath(this string path) { }
     }
-}
+}
diff --git a/Pathy.ApiVerificationTests/ApprovedApi/pathy.net8.0.verified.txt b/Pathy.ApiVerificationTests/ApprovedApi/pathy.net8.0.verified.txt
@@ -3,7 +3,7 @@ namespace Pathy
 {
     public readonly struct ChainablePath : System.IEquatable<Pathy.ChainablePath>
     {
-        public Pathy.ChainablePath? Directory { get; }
+        public Pathy.ChainablePath Directory { get; }
         public bool DirectoryExists { get; }
         public string DirectoryName { get; }
         public bool Exists { get; }
@@ -16,6 +16,7 @@ namespace Pathy
         public Pathy.ChainablePath Parent { get; }
         public Pathy.ChainablePath Root { get; }
         public static Pathy.ChainablePath Current { get; }
+        public static Pathy.ChainablePath Empty { get; }
         public static Pathy.ChainablePath New { get; }
         public static Pathy.ChainablePath Temp { get; }
         public Pathy.ChainablePath AsRelativeTo(Pathy.ChainablePath basePath) { }
@@ -39,4 +40,4 @@ namespace Pathy
     {
         public static Pathy.ChainablePath ToPath(this string path) { }
     }
-}
+}
diff --git a/Pathy.ApiVerificationTests/ApprovedApi/pathy.netstandard2.0.verified.txt b/Pathy.ApiVerificationTests/ApprovedApi/pathy.netstandard2.0.verified.txt
@@ -3,7 +3,7 @@ namespace Pathy
 {
     public readonly struct ChainablePath : System.IEquatable<Pathy.ChainablePath>
     {
-        public Pathy.ChainablePath? Directory { get; }
+        public Pathy.ChainablePath Directory { get; }
         public bool DirectoryExists { get; }
         public string DirectoryName { get; }
         public bool Exists { get; }
@@ -16,6 +16,7 @@ namespace Pathy
         public Pathy.ChainablePath Parent { get; }
         public Pathy.ChainablePath Root { get; }
         public static Pathy.ChainablePath Current { get; }
+        public static Pathy.ChainablePath Empty { get; }
         public static Pathy.ChainablePath New { get; }
         public static Pathy.ChainablePath Temp { get; }
         public System.IO.DirectoryInfo ToDirectoryInfo() { }
@@ -38,4 +39,4 @@ namespace Pathy
     {
         public static Pathy.ChainablePath ToPath(this string path) { }
     }
-}
+}
diff --git a/Pathy.ApiVerificationTests/ApprovedApi/pathy.netstandard2.1.verified.txt b/Pathy.ApiVerificationTests/ApprovedApi/pathy.netstandard2.1.verified.txt
@@ -3,7 +3,7 @@ namespace Pathy
 {
     public readonly struct ChainablePath : System.IEquatable<Pathy.ChainablePath>
     {
-        public Pathy.ChainablePath? Directory { get; }
+        public Pathy.ChainablePath Directory { get; }
         public bool DirectoryExists { get; }
         public string DirectoryName { get; }
         public bool Exists { get; }
@@ -16,6 +16,7 @@ namespace Pathy
         public Pathy.ChainablePath Parent { get; }
         public Pathy.ChainablePath Root { get; }
         public static Pathy.ChainablePath Current { get; }
+        public static Pathy.ChainablePath Empty { get; }
         public static Pathy.ChainablePath New { get; }
         public static Pathy.ChainablePath Temp { get; }
         public Pathy.ChainablePath AsRelativeTo(Pathy.ChainablePath basePath) { }
@@ -39,4 +40,4 @@ namespace Pathy
     {
         public static Pathy.ChainablePath ToPath(this string path) { }
     }
-}
+}
diff --git a/Pathy.Specs/ChainablePathSpecs.cs b/Pathy.Specs/ChainablePathSpecs.cs
@@ -13,7 +13,7 @@ public class ChainablePathSpecs
 
     public ChainablePathSpecs()
     {
-        testFolder =  ChainablePath.Temp / nameof(ChainablePathSpecs);
+        testFolder =  ChainablePath.Temp / nameof(ChainablePathSpecs) / Environment.Version.ToString();
         testFolder.DeleteFileOrDirectory();
         testFolder.CreateDirectoryRecursively();
     }
@@ -310,7 +310,8 @@ public void The_root_does_not_have_a_parent_directory()
         var path = ChainablePath.From("C://");
 
         // Assert
-        path.Directory.Should().BeNull();
+        path.Directory.Should().Be(ChainablePath.Empty);
+        path.Directory.ToString().Should().BeEmpty();
     }
 
     [Fact]
diff --git a/Pathy/ChainablePath.cs b/Pathy/ChainablePath.cs
@@ -17,13 +17,18 @@ public readonly record struct ChainablePath
 internal readonly record struct ChainablePath
 #endif
 {
-    private readonly string path;
+    private readonly string path = string.Empty;
 
     private ChainablePath(string path)
     {
         this.path = path;
     }
 
+    /// <summary>
+    /// Represents an empty <see cref="ChainablePath"/> instance.
+    /// </summary>
+    public static ChainablePath Empty { get; } = new(string.Empty);
+
     /// <summary>
     /// Gets a default, empty <see cref="ChainablePath"/> instance.
     /// </summary>
@@ -158,39 +163,39 @@ private static string NormalizeSlashes(string path)
     /// <summary>
     /// If the current path represents a file, gets the directory of that file.
     /// Or, if the current path represents a directory, gets the parent directory.
-    /// Returns <c>null</c> if the path represents the root of a file system.
+    /// Returns <see cref="Empty"/> if the path represents the root of a file system.
     /// </summary>
-    public ChainablePath? Directory
+    public ChainablePath Directory
     {
         get
         {
             string directory = DirectoryName;
-            if (directory is not null)
+            if (directory.Length > 0)
             {
                 return From(directory);
             }
 
-            return null;
+            return Empty;
         }
     }
 
     /// <summary>
     /// If the current path represents a file, gets the directory of that file.
     /// Or, if the current path represents a directory, gets the parent directory.
-    /// Returns <c>null</c> if the path represents the root of a file system.
+    /// Returns <see cref="Empty"/> if the path represents the root of a file system.
     /// </summary>
     public ChainablePath Parent => From(DirectoryName);
 
     /// <summary>
     /// If the current path represents a file, gets the directory of that file.
     /// Or, if the current path represents a directory, gets the parent directory.
-    /// Returns <c>null</c> if the path represents the root of a file system.
+    /// Returns an empty string if the path represents the root of a file system.
     /// </summary>
     public string DirectoryName
     {
         get
         {
-            return Path.GetDirectoryName(path.TrimEnd(Path.DirectorySeparatorChar));
+            return Path.GetDirectoryName(path.TrimEnd(Path.DirectorySeparatorChar)) ?? "";
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ namespace Pathy`
`3`	`3`	`{`
`4`	`4`	`public readonly struct ChainablePath : System.IEquatable<Pathy.ChainablePath>`
`5`	`5`	`{`
`6`		`- public Pathy.ChainablePath? Directory { get; }`
	`6`	`+ public Pathy.ChainablePath Directory { get; }`
`7`	`7`	`public bool DirectoryExists { get; }`
`8`	`8`	`public string DirectoryName { get; }`
`9`	`9`	`public bool Exists { get; }`
`@@ -16,6 +16,7 @@ namespace Pathy`
`16`	`16`	`public Pathy.ChainablePath Parent { get; }`
`17`	`17`	`public Pathy.ChainablePath Root { get; }`
`18`	`18`	`public static Pathy.ChainablePath Current { get; }`
	`19`	`+ public static Pathy.ChainablePath Empty { get; }`
`19`	`20`	`public static Pathy.ChainablePath New { get; }`
`20`	`21`	`public static Pathy.ChainablePath Temp { get; }`
`21`	`22`	`public System.IO.DirectoryInfo ToDirectoryInfo() { }`
`@@ -38,4 +39,4 @@ namespace Pathy`
`38`	`39`	`{`
`39`	`40`	`public static Pathy.ChainablePath ToPath(this string path) { }`
`40`	`41`	`}`
`41`		`-}`
	`42`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class ChainablePathSpecs`
`13`	`13`
`14`	`14`	`public ChainablePathSpecs()`
`15`	`15`	`{`
`16`		`- testFolder = ChainablePath.Temp / nameof(ChainablePathSpecs);`
	`16`	`+ testFolder = ChainablePath.Temp / nameof(ChainablePathSpecs) / Environment.Version.ToString();`
`17`	`17`	`testFolder.DeleteFileOrDirectory();`
`18`	`18`	`testFolder.CreateDirectoryRecursively();`
`19`	`19`	`}`
`@@ -310,7 +310,8 @@ public void The_root_does_not_have_a_parent_directory()`
`310`	`310`	`var path = ChainablePath.From("C://");`
`311`	`311`
`312`	`312`	`// Assert`
`313`		`- path.Directory.Should().BeNull();`
	`313`	`+ path.Directory.Should().Be(ChainablePath.Empty);`
	`314`	`+ path.Directory.ToString().Should().BeEmpty();`
`314`	`315`	`}`
`315`	`316`
`316`	`317`	`[Fact]`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,18 @@ public readonly record struct ChainablePath`
`17`	`17`	`internal readonly record struct ChainablePath`
`18`	`18`	`#endif`
`19`	`19`	`{`
`20`		`- private readonly string path;`
	`20`	`+ private readonly string path = string.Empty;`
`21`	`21`
`22`	`22`	`private ChainablePath(string path)`
`23`	`23`	`{`
`24`	`24`	`this.path = path;`
`25`	`25`	`}`
`26`	`26`
	`27`	`+ /// <summary>`
	`28`	`+ /// Represents an empty <see cref="ChainablePath"/> instance.`
	`29`	`+ /// </summary>`
	`30`	`+ public static ChainablePath Empty { get; } = new(string.Empty);`
	`31`	`+`
`27`	`32`	`/// <summary>`
`28`	`33`	`/// Gets a default, empty <see cref="ChainablePath"/> instance.`
`29`	`34`	`/// </summary>`
`@@ -158,39 +163,39 @@ private static string NormalizeSlashes(string path)`
`158`	`163`	`/// <summary>`
`159`	`164`	`/// If the current path represents a file, gets the directory of that file.`
`160`	`165`	`/// Or, if the current path represents a directory, gets the parent directory.`
`161`		`- /// Returns <c>null</c> if the path represents the root of a file system.`
	`166`	`+ /// Returns <see cref="Empty"/> if the path represents the root of a file system.`
`162`	`167`	`/// </summary>`
`163`		`- public ChainablePath? Directory`
	`168`	`+ public ChainablePath Directory`
`164`	`169`	`{`
`165`	`170`	`get`
`166`	`171`	`{`
`167`	`172`	`string directory = DirectoryName;`
`168`		`- if (directory is not null)`
	`173`	`+ if (directory.Length > 0)`
`169`	`174`	`{`
`170`	`175`	`return From(directory);`
`171`	`176`	`}`
`172`	`177`
`173`		`- return null;`
	`178`	`+ return Empty;`
`174`	`179`	`}`
`175`	`180`	`}`
`176`	`181`
`177`	`182`	`/// <summary>`
`178`	`183`	`/// If the current path represents a file, gets the directory of that file.`
`179`	`184`	`/// Or, if the current path represents a directory, gets the parent directory.`
`180`		`- /// Returns <c>null</c> if the path represents the root of a file system.`
	`185`	`+ /// Returns <see cref="Empty"/> if the path represents the root of a file system.`
`181`	`186`	`/// </summary>`
`182`	`187`	`public ChainablePath Parent => From(DirectoryName);`
`183`	`188`
`184`	`189`	`/// <summary>`
`185`	`190`	`/// If the current path represents a file, gets the directory of that file.`
`186`	`191`	`/// Or, if the current path represents a directory, gets the parent directory.`
`187`		`- /// Returns <c>null</c> if the path represents the root of a file system.`
	`192`	`+ /// Returns an empty string if the path represents the root of a file system.`
`188`	`193`	`/// </summary>`
`189`	`194`	`public string DirectoryName`
`190`	`195`	`{`
`191`	`196`	`get`
`192`	`197`	`{`
`193`		`- return Path.GetDirectoryName(path.TrimEnd(Path.DirectorySeparatorChar));`
	`198`	`+ return Path.GetDirectoryName(path.TrimEnd(Path.DirectorySeparatorChar)) ?? "";`
`194`	`199`	`}`
`195`	`200`	`}`
`196`	`201`