Skip to content

Add advanced path operations #555

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
fgreinacher merged 5 commits into from
Feb 11, 2020
Merged

Add advanced path operations #555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5128fdc
Add IPath.IsPathFullyQualified
fgreinacher Feb 11, 2020
1dc0bc2
Add IPath.GetRelativePath
fgreinacher Feb 11, 2020
b87c5d0
Add back a .NET Framework target
fgreinacher Feb 11, 2020
aefba7c
Bump major to indicate API change
fgreinacher Feb 11, 2020
92f9103
Merge branch 'master' into feat/api-parity
fgreinacher Feb 11, 2020
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 Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
<Authors>Tatham Oddie &amp; friends</Authors>
<SignAssembly Condition="'$(Configuration)' == 'Release'">True</SignAssembly>
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)StrongName.snk</AssemblyOriginatorKeyFile>
<DefineConstants Condition="'$(TargetFramework)' == 'netcoreapp3.0' OR '$(TargetFramework)' == 'netstandard2.1'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS;FEATURE_ADVANCED_PATH_OPERATIONS</DefineConstants>

</PropertyGroup>
<ItemGroup>
<PackageReference Include="Nerdbank.GitVersioning" Version="3.0.50">
Expand Down
98 changes: 77 additions & 21 deletions System.IO.Abstractions.TestingHelpers.Tests/MockPathTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,13 @@ public static IEnumerable<string[]> GetFullPath_RelativePaths_Cases
{
get
{
yield return new [] { XFS.Path(@"c:\a"), "b", XFS.Path(@"c:\a\b") };
yield return new [] { XFS.Path(@"c:\a\b"), "c", XFS.Path(@"c:\a\b\c") };
yield return new [] { XFS.Path(@"c:\a\b"), XFS.Path(@"c\"), XFS.Path(@"c:\a\b\c\") };
yield return new [] { XFS.Path(@"c:\a\b"), XFS.Path(@"..\c"), XFS.Path(@"c:\a\c") };
yield return new [] { XFS.Path(@"c:\a\b\c"), XFS.Path(@"..\c\..\"), XFS.Path(@"c:\a\b\") };
yield return new [] { XFS.Path(@"c:\a\b\c"), XFS.Path(@"..\..\..\..\..\d"), XFS.Path(@"c:\d") };
yield return new [] { XFS.Path(@"c:\a\b\c"), XFS.Path(@"..\..\..\..\..\d\"), XFS.Path(@"c:\d\") };
yield return new[] { XFS.Path(@"c:\a"), "b", XFS.Path(@"c:\a\b") };
yield return new[] { XFS.Path(@"c:\a\b"), "c", XFS.Path(@"c:\a\b\c") };
yield return new[] { XFS.Path(@"c:\a\b"), XFS.Path(@"c\"), XFS.Path(@"c:\a\b\c\") };
yield return new[] { XFS.Path(@"c:\a\b"), XFS.Path(@"..\c"), XFS.Path(@"c:\a\c") };
yield return new[] { XFS.Path(@"c:\a\b\c"), XFS.Path(@"..\c\..\"), XFS.Path(@"c:\a\b\") };
yield return new[] { XFS.Path(@"c:\a\b\c"), XFS.Path(@"..\..\..\..\..\d"), XFS.Path(@"c:\d") };
yield return new[] { XFS.Path(@"c:\a\b\c"), XFS.Path(@"..\..\..\..\..\d\"), XFS.Path(@"c:\d\") };
}
}

Expand All @@ -172,11 +172,11 @@ public static IEnumerable<string[]> GetFullPath_RootedPathWithRelativeSegments_C
{
get
{
yield return new [] { XFS.Path(@"c:\a\b\..\c"), XFS.Path(@"c:\a\c") };
yield return new [] { XFS.Path(@"c:\a\b\.\.\..\.\c"), XFS.Path(@"c:\a\c") };
yield return new [] { XFS.Path(@"c:\a\b\.\c"), XFS.Path(@"c:\a\b\c") };
yield return new [] { XFS.Path(@"c:\a\b\.\.\.\.\c"), XFS.Path(@"c:\a\b\c") };
yield return new [] { XFS.Path(@"c:\a\..\..\c"), XFS.Path(@"c:\c") };
yield return new[] { XFS.Path(@"c:\a\b\..\c"), XFS.Path(@"c:\a\c") };
yield return new[] { XFS.Path(@"c:\a\b\.\.\..\.\c"), XFS.Path(@"c:\a\c") };
yield return new[] { XFS.Path(@"c:\a\b\.\c"), XFS.Path(@"c:\a\b\c") };
yield return new[] { XFS.Path(@"c:\a\b\.\.\.\.\c"), XFS.Path(@"c:\a\b\c") };
yield return new[] { XFS.Path(@"c:\a\..\..\c"), XFS.Path(@"c:\c") };
}
}

Expand All @@ -198,14 +198,14 @@ public static IEnumerable<string[]> GetFullPath_AbsolutePaths_Cases
{
get
{
yield return new [] { XFS.Path(@"c:\a"), XFS.Path(@"/b"), XFS.Path(@"c:\b") };
yield return new [] { XFS.Path(@"c:\a"), XFS.Path(@"/b\"), XFS.Path(@"c:\b\") };
yield return new [] { XFS.Path(@"c:\a"), XFS.Path(@"\b"), XFS.Path(@"c:\b") };
yield return new [] { XFS.Path(@"c:\a"), XFS.Path(@"\b\..\c"), XFS.Path(@"c:\c") };
yield return new [] { XFS.Path(@"z:\a"), XFS.Path(@"\b\..\c"), XFS.Path(@"z:\c") };
yield return new [] { XFS.Path(@"z:\a"), XFS.Path(@"\\computer\share\c"), XFS.Path(@"\\computer\share\c") };
yield return new [] { XFS.Path(@"z:\a"), XFS.Path(@"\\computer\share\c\..\d"), XFS.Path(@"\\computer\share\d") };
yield return new [] { XFS.Path(@"z:\a"), XFS.Path(@"\\computer\share\c\..\..\d"), XFS.Path(@"\\computer\share\d") };
yield return new[] { XFS.Path(@"c:\a"), XFS.Path(@"/b"), XFS.Path(@"c:\b") };
yield return new[] { XFS.Path(@"c:\a"), XFS.Path(@"/b\"), XFS.Path(@"c:\b\") };
yield return new[] { XFS.Path(@"c:\a"), XFS.Path(@"\b"), XFS.Path(@"c:\b") };
yield return new[] { XFS.Path(@"c:\a"), XFS.Path(@"\b\..\c"), XFS.Path(@"c:\c") };
yield return new[] { XFS.Path(@"z:\a"), XFS.Path(@"\b\..\c"), XFS.Path(@"z:\c") };
yield return new[] { XFS.Path(@"z:\a"), XFS.Path(@"\\computer\share\c"), XFS.Path(@"\\computer\share\c") };
yield return new[] { XFS.Path(@"z:\a"), XFS.Path(@"\\computer\share\c\..\d"), XFS.Path(@"\\computer\share\d") };
yield return new[] { XFS.Path(@"z:\a"), XFS.Path(@"\\computer\share\c\..\..\d"), XFS.Path(@"\\computer\share\d") };
}
}

Expand Down Expand Up @@ -274,7 +274,7 @@ public void GetFullPath_WithMultipleDirectorySeparators_ShouldReturnTheNormalize
var mockPath = new MockPath(mockFileSystem);

//Act
var actualFullPath = mockPath.GetFullPath(XFS.Path(@"c:\foo\\//bar\file.dat"));
var actualFullPath = mockPath.GetFullPath(XFS.Path(@"c:\foo\\//bar\file.dat"));

//Assert
Assert.AreEqual(XFS.Path(@"c:\foo\bar\file.dat"), actualFullPath);
Expand Down Expand Up @@ -397,5 +397,61 @@ public void IsPathRooted_PathSentIn_DeterminesPathExists()
//Assert
Assert.AreEqual(true, result);
}

#if FEATURE_ADVANCED_PATH_OPERATIONS
[Test]
public void IsPathFullyQualified_WithAbsolutePath_ReturnsTrue()
{
//Arrange
var mockPath = new MockPath(new MockFileSystem());

//Act
var result = mockPath.IsPathFullyQualified(XFS.Path("C:\\directory\\file.txt"));

//Assert
Assert.IsTrue(result);
}

[Test]
public void IsPathFullyQualified_WithRelativePath_ReturnsFalse()
{
//Arrange
var mockPath = new MockPath(new MockFileSystem());

//Act
var result = mockPath.IsPathRooted(XFS.Path("directory\\file.txt"));

//Assert
Assert.IsFalse(result);
}

[Test]
public void IsPathFullyQualified_WithRelativePathParts_ReturnsFalse()
{
//Arrange
var mockPath = new MockPath(new MockFileSystem());

//Act
var result = mockPath.IsPathRooted(XFS.Path("directory\\..\\file.txt"));

//Assert
Assert.IsFalse(result);
}



[Test]
public void GetRelativePath_Works()
{
//Arrange
var mockPath = new MockPath(new MockFileSystem());

//Act
var result = mockPath.GetRelativePath(XFS.Path("c:\\d"), XFS.Path("c:\\d\\e\\f.txt"));

//Assert
Assert.AreEqual(XFS.Path("e\\f.txt"), result);
}
#endif
}
}
1 change: 0 additions & 1 deletion ...m.IO.Abstractions.TestingHelpers.Tests/System.IO.Abstractions.TestingHelpers.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<RootNamespace>System.IO.Abstractions.TestingHelpers.Tests</RootNamespace>
<IsPackable>false</IsPackable>
<IsTestable>true</IsTestable>
<DefineConstants Condition="'$(TargetFramework)' == 'netcoreapp3.0'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS</DefineConstants>
</PropertyGroup>
<ItemGroup>
<None Remove="TestFiles\SecondTestFile.txt" />
Expand Down
1 change: 0 additions & 1 deletion System.IO.Abstractions.TestingHelpers/System.IO.Abstractions.TestingHelpers.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<PackageProjectUrl>https://github.com/System-IO-Abstractions/System.IO.Abstractions</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageTags>testing</PackageTags>
<DefineConstants Condition="'$(TargetFramework)' == 'netstandard2.1'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS</DefineConstants>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\System.IO.Abstractions\System.IO.Abstractions.csproj" />
Expand Down
8 changes: 8 additions & 0 deletions System.IO.Abstractions/IPath.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,13 @@ public interface IPath
bool HasExtension(string path);
/// <inheritdoc cref="Path.IsPathRooted(string)"/>
bool IsPathRooted(string path);

#if FEATURE_ADVANCED_PATH_OPERATIONS
/// <inheritdoc cref="Path.IsPathFullyQualified(string)"/>
bool IsPathFullyQualified(string path);

/// <inheritdoc cref="Path.GetRelativePath(string,string)"/>
string GetRelativePath(string relativeTo, string path);
#endif
}
}
8 changes: 8 additions & 0 deletions System.IO.Abstractions/PathBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,13 @@ internal PathBase() { }

/// <inheritdoc cref="Path.IsPathRooted(string)"/>
public abstract bool IsPathRooted(string path);

#if FEATURE_ADVANCED_PATH_OPERATIONS
/// <inheritdoc />
public abstract bool IsPathFullyQualified(string path);

/// <inheritdoc />
public abstract string GetRelativePath(string relativeTo, string path);
#endif
}
}
12 changes: 12 additions & 0 deletions System.IO.Abstractions/PathWrapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,18 @@ public override bool HasExtension(string path)
return Path.HasExtension(path);
}

#if FEATURE_ADVANCED_PATH_OPERATIONS
public override bool IsPathFullyQualified(string path)
{
return Path.IsPathFullyQualified(path);
}

public override string GetRelativePath(string relativeTo, string path)
{
return Path.GetRelativePath(relativeTo, path);
}
#endif

public override bool IsPathRooted(string path)
{
return Path.IsPathRooted(path);
Expand Down
2 changes: 1 addition & 1 deletion System.IO.Abstractions/System.IO.Abstractions.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<PackageProjectUrl>https://github.com/System-IO-Abstractions/System.IO.Abstractions</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageTags>testing</PackageTags>
<DefineConstants Condition="'$(TargetFramework)' == 'netstandard2.1'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS</DefineConstants>
<DefineConstants Condition="'$(TargetFramework)' == 'netstandard2.1'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS;FEATURE_ADVANCED_PATH_OPERATIONS</DefineConstants>
</PropertyGroup>
<ItemGroup Condition="'$(TargetFramework)' != 'net461'">
<PackageReference Include="System.IO.FileSystem.AccessControl" Version="4.7.0"/>
Expand Down
2 changes: 1 addition & 1 deletion version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
"version": "8.1",
"version": "9.0",
"assemblyVersion": {
"precision": "major"
},
Expand Down