Skip to content

Added Null and IsNull to eventually replace Empty #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2025
Merged

Added Null and IsNull to eventually replace Empty #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Pathy.ApiVerificationTests/ApprovedApi/pathy.net47.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ namespace Pathy
public bool FileExists { get; }
public bool IsDirectory { get; }
public bool IsFile { get; }
public bool IsNull { get; }
public bool IsRooted { get; }
public string Name { get; }
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 Null { get; }
public static Pathy.ChainablePath Temp { get; }
public Pathy.ChainablePath FindParentWithFileMatching(params string[] wildcards) { }
public bool HasExtension(string extension) { }
Expand Down
2 changes: 2 additions & 0 deletions Pathy.ApiVerificationTests/ApprovedApi/pathy.net8.0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ namespace Pathy
public bool FileExists { get; }
public bool IsDirectory { get; }
public bool IsFile { get; }
public bool IsNull { get; }
public bool IsRooted { get; }
public string Name { get; }
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 Null { get; }
public static Pathy.ChainablePath Temp { get; }
public Pathy.ChainablePath AsRelativeTo(Pathy.ChainablePath basePath) { }
public Pathy.ChainablePath FindParentWithFileMatching(params string[] wildcards) { }
Expand Down
2 changes: 2 additions & 0 deletions Pathy.ApiVerificationTests/ApprovedApi/pathy.netstandard2.0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ namespace Pathy
public bool FileExists { get; }
public bool IsDirectory { get; }
public bool IsFile { get; }
public bool IsNull { get; }
public bool IsRooted { get; }
public string Name { get; }
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 Null { get; }
public static Pathy.ChainablePath Temp { get; }
public Pathy.ChainablePath FindParentWithFileMatching(params string[] wildcards) { }
public bool HasExtension(string extension) { }
Expand Down
2 changes: 2 additions & 0 deletions Pathy.ApiVerificationTests/ApprovedApi/pathy.netstandard2.1.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ namespace Pathy
public bool FileExists { get; }
public bool IsDirectory { get; }
public bool IsFile { get; }
public bool IsNull { get; }
public bool IsRooted { get; }
public string Name { get; }
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 Null { get; }
public static Pathy.ChainablePath Temp { get; }
public Pathy.ChainablePath AsRelativeTo(Pathy.ChainablePath basePath) { }
public Pathy.ChainablePath FindParentWithFileMatching(params string[] wildcards) { }
Expand Down
4 changes: 2 additions & 2 deletions Pathy.Specs/ChainablePathSpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ public void Empty_path_returned_when_no_match_found()
var result = childDir.FindParentWithFileMatching("*.sln");

// Assert
result.Should().Be(ChainablePath.Empty);
result.Should().Be(ChainablePath.Null);
}

[Fact]
Expand Down Expand Up @@ -765,7 +765,7 @@ public void Returns_empty_for_non_existing_string_paths()
var result = ChainablePath.FindFirst(nonExistingFile1.ToString(), nonExistingFile2.ToString());

// Assert
result.Should().Be(ChainablePath.Empty);
result.IsNull.Should().BeTrue();
}

[Fact]
Expand Down
13 changes: 13 additions & 0 deletions Pathy/ChainablePath.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ private ChainablePath(string path)
/// </summary>
public static ChainablePath Empty { get; } = new(string.Empty);

/// <summary>
/// Represents a <see cref="ChainablePath"/> not pointing to any file or directory.
/// </summary>
/// <remarks>
/// Implements the Null Pattern and should be used as a replacement of <see cref="Empty"/>
/// </remarks>
public static ChainablePath Null { get; } = new(string.Empty);

/// <summary>
/// Gets a default, empty <see cref="ChainablePath"/> instance.
/// </summary>
Expand Down Expand Up @@ -221,6 +229,11 @@ private static string NormalizeSlashes(string path)
return From(leftPath.ToString() + additionalPath);
}

/// <summary>
/// Gets a value indicating whether the current <see cref="ChainablePath"/> instance is equal to <see cref="ChainablePath.Null"/>.
/// </summary>
public bool IsNull => Equals(Null);

/// <summary>
/// Gets the name of the file or directory represented by the current path, without the parent directory.
/// </summary>
Expand Down
Loading