feat: add implicit operators for VFSDirectoryPath and VFSFilePath

phmatray · phmatray · commit c0a1c1ca2e95 · 2024-11-16T09:39:40.000+01:00
diff --git a/Atypical.VirtualFileSystem.DemoCli/Commands/DemonstrateVFS.cs b/Atypical.VirtualFileSystem.DemoCli/Commands/DemonstrateVFS.cs
@@ -2,6 +2,33 @@
 
 namespace Atypical.VirtualFileSystem.DemoCli.Commands;
 
+public class BugDeleteFolder : Command
+{
+    public override int Execute(CommandContext context)
+    {
+        // Create a virtual file system
+        var factory = new VirtualFileSystemFactory();
+        var vfs = factory.CreateFileSystem();
+
+        // Create folders
+        vfs.CreateDirectory("/Assets");
+        vfs.CreateDirectory("/Assets/New Folder");
+        vfs.CreateDirectory("/Assets/New Folder 1");
+        
+        // Delete folder
+        vfs.DeleteDirectory("/Assets/New Folder 1");
+        
+        var paths = vfs.Index.GetPathsStartingWith("/Assets/New Folder");
+        
+        foreach (var path in paths)
+        {
+            AnsiConsole.MarkupLine($"[red]{path}[/]");
+        }
+        
+        return 0;
+    }
+}
+
 public class DemonstrateVFS : Command
 {
     public override int Execute(CommandContext context)
diff --git a/Atypical.VirtualFileSystem.DemoCli/Program.cs b/Atypical.VirtualFileSystem.DemoCli/Program.cs
@@ -5,7 +5,7 @@
 
 app.Configure(config =>
 {
-    config.AddCommand<DemonstrateVFS>("demo");
+    config.AddCommand<BugDeleteFolder>("demo");
 });
 
 app.Run(args);
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <LangVersion>12</LangVersion>
diff --git a/docs/api/VFSDirectoryPath.implicitoperatorVFSDirectoryPath(string).md b/docs/api/VFSDirectoryPath.implicitoperatorVFSDirectoryPath(string).md
@@ -0,0 +1,22 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath')
+
+## VFSDirectoryPath.implicit operator VFSDirectoryPath(string) Operator
+
+Implicit conversion from string.  
+This allows you to use a string as a [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath').
+
+```csharp
+public static Atypical.VirtualFileSystem.Core.VFSDirectoryPath implicit operator VFSDirectoryPath(string path);
+```
+#### Parameters
+
+<a name='Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_ImplicitAtypical.VirtualFileSystem.Core.VFSDirectoryPath(string).path'></a>
+
+`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The path to convert.
+
+#### Returns
+[VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath')  
+The directory path.
diff --git a/docs/api/VFSDirectoryPath.md b/docs/api/VFSDirectoryPath.md
@@ -29,4 +29,5 @@ Implements [System.IEquatable&lt;](https://docs.microsoft.com/en-us/dotnet/api/S
 
 | Operators | |
 | :--- | :--- |
+| [implicit operator VFSDirectoryPath(string)](VFSDirectoryPath.implicitoperatorVFSDirectoryPath(string).md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_Implicit Atypical.VirtualFileSystem.Core.VFSDirectoryPath(string)') | Implicit conversion from string.<br/>This allows you to use a string as a [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath'). |
 | [implicit operator string(VFSDirectoryPath)](VFSDirectoryPath.implicitoperatorstring(VFSDirectoryPath).md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_Implicit string(Atypical.VirtualFileSystem.Core.VFSDirectoryPath)') | Implicit conversion to string<br/>This allows you to use a [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath') as a string. |
diff --git a/docs/api/VFSFilePath.implicitoperatorVFSFilePath(string).md b/docs/api/VFSFilePath.implicitoperatorVFSFilePath(string).md
@@ -0,0 +1,22 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
+
+## VFSFilePath.implicit operator VFSFilePath(string) Operator
+
+Implicit conversion from string.  
+This allows you to use a string as a [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath').
+
+```csharp
+public static Atypical.VirtualFileSystem.Core.VFSFilePath implicit operator VFSFilePath(string path);
+```
+#### Parameters
+
+<a name='Atypical.VirtualFileSystem.Core.VFSFilePath.op_ImplicitAtypical.VirtualFileSystem.Core.VFSFilePath(string).path'></a>
+
+`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The path to convert.
+
+#### Returns
+[VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')  
+The file path.
diff --git a/docs/api/VFSFilePath.md b/docs/api/VFSFilePath.md
@@ -25,4 +25,5 @@ Implements [System.IEquatable&lt;](https://docs.microsoft.com/en-us/dotnet/api/S
 
 | Operators | |
 | :--- | :--- |
+| [implicit operator VFSFilePath(string)](VFSFilePath.implicitoperatorVFSFilePath(string).md 'Atypical.VirtualFileSystem.Core.VFSFilePath.op_Implicit Atypical.VirtualFileSystem.Core.VFSFilePath(string)') | Implicit conversion from string.<br/>This allows you to use a string as a [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath'). |
 | [implicit operator string(VFSFilePath)](VFSFilePath.implicitoperatorstring(VFSFilePath).md 'Atypical.VirtualFileSystem.Core.VFSFilePath.op_Implicit string(Atypical.VirtualFileSystem.Core.VFSFilePath)') | Implicit conversion to string<br/>This allows you to use a [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') as a string. |
diff --git a/docs/api/VirtualFileSystem.md b/docs/api/VirtualFileSystem.md
@@ -127,6 +127,8 @@
     The file path is relative to the root of the virtual file system.
   - **[ToString()](VFSDirectoryPath.ToString().md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath.ToString()')** `Method` Returns a string that represents the current object.  
     The string representation of the directory path is the path itself.
+  - **[implicit operator VFSDirectoryPath(string)](VFSDirectoryPath.implicitoperatorVFSDirectoryPath(string).md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_Implicit Atypical.VirtualFileSystem.Core.VFSDirectoryPath(string)')** `Operator` Implicit conversion from string.  
+    This allows you to use a string as a [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath').
   - **[implicit operator string(VFSDirectoryPath)](VFSDirectoryPath.implicitoperatorstring(VFSDirectoryPath).md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_Implicit string(Atypical.VirtualFileSystem.Core.VFSDirectoryPath)')** `Operator` Implicit conversion to string  
     This allows you to use a [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath') as a string.
 - **[VFSDirectoryRenamedArgs](VFSDirectoryRenamedArgs.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryRenamedArgs')** `Class` Provides data for the DirectoryRenamed event.
@@ -173,6 +175,8 @@
     The file path is relative to the root of the virtual file system.
   - **[ToString()](VFSFilePath.ToString().md 'Atypical.VirtualFileSystem.Core.VFSFilePath.ToString()')** `Method` Returns a string that represents the current object.  
     The file path is relative to the root of the virtual file system.
+  - **[implicit operator VFSFilePath(string)](VFSFilePath.implicitoperatorVFSFilePath(string).md 'Atypical.VirtualFileSystem.Core.VFSFilePath.op_Implicit Atypical.VirtualFileSystem.Core.VFSFilePath(string)')** `Operator` Implicit conversion from string.  
+    This allows you to use a string as a [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath').
   - **[implicit operator string(VFSFilePath)](VFSFilePath.implicitoperatorstring(VFSFilePath).md 'Atypical.VirtualFileSystem.Core.VFSFilePath.op_Implicit string(Atypical.VirtualFileSystem.Core.VFSFilePath)')** `Operator` Implicit conversion to string  
     This allows you to use a [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') as a string.
 - **[VFSFileRenamedArgs](VFSFileRenamedArgs.md 'Atypical.VirtualFileSystem.Core.VFSFileRenamedArgs')** `Class` Provides data for the FileRenamed event.
diff --git a/docs/links b/docs/links
@@ -34,10 +34,12 @@ T:Atypical.VirtualFileSystem.Core.VFSNode|VFSNode.md|VFSNode
 M:Atypical.VirtualFileSystem.Core.VFSDirectoryPath.#ctor(System.String)|VFSDirectoryPath.VFSDirectoryPath(string).md|VFSDirectoryPath(string)
 M:Atypical.VirtualFileSystem.Core.VFSDirectoryPath.ToString|VFSDirectoryPath.ToString().md|ToString()
 M:Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_Implicit(Atypical.VirtualFileSystem.Core.VFSDirectoryPath)~System.String|VFSDirectoryPath.implicitoperatorstring(VFSDirectoryPath).md|implicit operator string(VFSDirectoryPath)
+M:Atypical.VirtualFileSystem.Core.VFSDirectoryPath.op_Implicit(System.String)~Atypical.VirtualFileSystem.Core.VFSDirectoryPath|VFSDirectoryPath.implicitoperatorVFSDirectoryPath(string).md|implicit operator VFSDirectoryPath(string)
 T:Atypical.VirtualFileSystem.Core.VFSDirectoryPath|VFSDirectoryPath.md|VFSDirectoryPath
 M:Atypical.VirtualFileSystem.Core.VFSFilePath.#ctor(System.String)|VFSFilePath.VFSFilePath(string).md|VFSFilePath(string)
 M:Atypical.VirtualFileSystem.Core.VFSFilePath.ToString|VFSFilePath.ToString().md|ToString()
 M:Atypical.VirtualFileSystem.Core.VFSFilePath.op_Implicit(Atypical.VirtualFileSystem.Core.VFSFilePath)~System.String|VFSFilePath.implicitoperatorstring(VFSFilePath).md|implicit operator string(VFSFilePath)
+M:Atypical.VirtualFileSystem.Core.VFSFilePath.op_Implicit(System.String)~Atypical.VirtualFileSystem.Core.VFSFilePath|VFSFilePath.implicitoperatorVFSFilePath(string).md|implicit operator VFSFilePath(string)
 T:Atypical.VirtualFileSystem.Core.VFSFilePath|VFSFilePath.md|VFSFilePath
 P:Atypical.VirtualFileSystem.Core.VFSPath.Value|VFSPath.Value.md|Value
 P:Atypical.VirtualFileSystem.Core.VFSPath.Parent|VFSPath.Parent.md|Parent
diff --git a/src/Atypical.VirtualFileSystem.Core/Atypical.VirtualFileSystem.Core.csproj b/src/Atypical.VirtualFileSystem.Core/Atypical.VirtualFileSystem.Core.csproj
@@ -39,22 +39,16 @@
         "Virtual File System" is an attempt to solve this problem. Currently, this library is at an early stage of development. If you need additional functionality, I invite you to open an issue to discuss it.
       </Description>
       <PackageTags>virtual filesystem;testing;core;net8</PackageTags>
-      <Copyright>Copyright (c) 2022-2023 Atypical Consulting SRL</Copyright>
+      <Copyright>Copyright (c) 2022-2024 Atypical Consulting SRL</Copyright>
       <PackageProjectUrl>https://github.com/Atypical-Consulting/VirtualFileSystem</PackageProjectUrl>
       <RepositoryUrl>https://github.com/Atypical-Consulting/VirtualFileSystem.git</RepositoryUrl>
       <RepositoryType>git</RepositoryType>
       <RepositoryBranch>main</RepositoryBranch>
       <PackageReleaseNotes>
         ## Changes
 
-        - build(deps): bump JetBrains/qodana-action from 2023.2 to 2023.3 @dependabot (#85)
-        - build(deps): bump actions/setup-dotnet from 3 to 4 @dependabot (#83)
-        - build(deps): bump release-drafter/release-drafter from 5 to 6 @dependabot (#84)
-        - build(deps): bump actions/checkout from 3 to 4 @dependabot (#86)
-        - build(deps): bump actions/cache from 3 to 4 @dependabot (#87)
-        - Features/undo redo @phmatray (#82)
-        - upgrade dependencies @phmatray (#80)
-        - build(deps): bump Spectre.Console from 0.47.0 to 0.48.0 @dependabot (#70)
+        - Add support for .NET 9.0
+        - Drop support for .NET 6.0
       </PackageReleaseNotes>
       <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
       <PackageLanguage>en-US</PackageLanguage>
diff --git a/src/Atypical.VirtualFileSystem.Core/Models/Paths/VFSDirectoryPath.cs b/src/Atypical.VirtualFileSystem.Core/Models/Paths/VFSDirectoryPath.cs
@@ -39,7 +39,21 @@ public VFSDirectoryPath(string path)
     /// </summary>
     /// <param name="path">The path to convert.</param>
     /// <returns>The string representation of the path.</returns>
-    public static implicit operator string(VFSDirectoryPath path) => path.Value;
+    public static implicit operator string(VFSDirectoryPath path)
+    {
+        return path.Value;
+    }
+
+    /// <summary>
+    ///     Implicit conversion from string.
+    ///     This allows you to use a string as a <see cref="VFSDirectoryPath" />.
+    /// </summary>
+    /// <param name="path">The path to convert.</param>
+    /// <returns>The directory path.</returns>
+    public static implicit operator VFSDirectoryPath(string path)
+    {
+        return new VFSDirectoryPath(path);
+    }
     
     [DoesNotReturn]
     private static void ThrowArgumentHasFileExtension(string path)
diff --git a/src/Atypical.VirtualFileSystem.Core/Models/Paths/VFSFilePath.cs b/src/Atypical.VirtualFileSystem.Core/Models/Paths/VFSFilePath.cs
@@ -37,5 +37,18 @@ public override string ToString()
     /// <param name="path">The path to convert.</param>
     /// <returns>The string representation of the path.</returns>
     public static implicit operator string(VFSFilePath path)
-        => path.Value;
+    {
+        return path.Value;
+    }
+    
+    /// <summary>
+    ///     Implicit conversion from string.
+    ///     This allows you to use a string as a <see cref="VFSFilePath" />.
+    /// </summary>
+    /// <param name="path">The path to convert.</param>
+    /// <returns>The file path.</returns>
+    public static implicit operator VFSFilePath(string path)
+    {
+        return new VFSFilePath(path);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`app.Configure(config =>`
`7`	`7`	`{`
`8`		`- config.AddCommand<DemonstrateVFS>("demo");`
	`8`	`+ config.AddCommand<BugDeleteFolder>("demo");`
`9`	`9`	`});`
`10`	`10`
`11`	`11`	`app.Run(args);`