Merge pull request #35 from Atypical-Consulting/tostring

Get a summary from the ToString method

Author: phmatray

docs/api/IVirtualFileSystem.GetTree().md

@@ -0,0 +1,14 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core.Contracts](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Contracts 'Atypical.VirtualFileSystem.Core.Contracts').[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
+
+## IVirtualFileSystem.GetTree() Method
+
+Gets the tree of the file system.
+
+```csharp
+string GetTree();
+```
+
+#### Returns
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')  
+The tree of the file system.

docs/api/IVirtualFileSystem.md

@@ -38,6 +38,7 @@ Derived
 | [GetFile(VFSFilePath)](IVirtualFileSystem.GetFile(VFSFilePath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetFile(Atypical.VirtualFileSystem.Core.ValueObjects.VFSFilePath)') | Gets a file node by its path.<br/>The path must be absolute. |
 | [GetFile(string)](IVirtualFileSystem.GetFile(string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetFile(string)') | Gets a file node by its path.<br/>The path must be absolute. |
 | [GetRootPath()](IVirtualFileSystem.GetRootPath().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetRootPath()') | Gets the path of the root directory. |
+| [GetTree()](IVirtualFileSystem.GetTree().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetTree()') | Gets the tree of the file system. |
 | [IsEmpty()](IVirtualFileSystem.IsEmpty().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.IsEmpty()') | Indicates whether the file system is empty.<br/>This is the case if the root directory is empty. |
 | [SelectDirectories(Func&lt;IDirectoryNode,bool&gt;)](IVirtualFileSystem.SelectDirectories(Func_IDirectoryNode,bool_).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.SelectDirectories(System.Func<Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode,bool>)') | Finds all directory nodes that match the specified predicate. |
 | [TryGetDirectory(VFSDirectoryPath, IDirectoryNode)](IVirtualFileSystem.TryGetDirectory(VFSDirectoryPath,IDirectoryNode).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.TryGetDirectory(Atypical.VirtualFileSystem.Core.ValueObjects.VFSDirectoryPath, Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode)') | Try to get a directory node by its path.<br/>The path must be absolute.<br/>If the directory node does not exist, this method returns `false`<br/>and [directory](IVirtualFileSystem.TryGetDirectory(VFSDirectoryPath,IDirectoryNode).md#Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.TryGetDirectory(Atypical.VirtualFileSystem.Core.ValueObjects.VFSDirectoryPath,Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode).directory 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.TryGetDirectory(Atypical.VirtualFileSystem.Core.ValueObjects.VFSDirectoryPath, Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode).directory') is set to `null`. |

docs/api/VFS.GetTree().md

@@ -0,0 +1,16 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS')
+
+## VFS.GetTree() Method
+
+Gets the tree of the file system.
+
+```csharp
+public string GetTree();
+```
+
+Implements [GetTree()](IVirtualFileSystem.GetTree().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetTree()')
+
+#### Returns
+[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')  
+The tree of the file system.

docs/api/VFS.md

@@ -44,6 +44,7 @@ Implements [IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSyste
 | [GetFile(VFSFilePath)](VFS.GetFile(VFSFilePath).md 'Atypical.VirtualFileSystem.Core.VFS.GetFile(Atypical.VirtualFileSystem.Core.ValueObjects.VFSFilePath)') | Gets a file node by its path.<br/>The path must be absolute. |
 | [GetFile(string)](VFS.GetFile(string).md 'Atypical.VirtualFileSystem.Core.VFS.GetFile(string)') | Gets a file node by its path.<br/>The path must be absolute. |
 | [GetRootPath()](VFS.GetRootPath().md 'Atypical.VirtualFileSystem.Core.VFS.GetRootPath()') | Gets the path of the root directory. |
+| [GetTree()](VFS.GetTree().md 'Atypical.VirtualFileSystem.Core.VFS.GetTree()') | Gets the tree of the file system. |
 | [IsEmpty()](VFS.IsEmpty().md 'Atypical.VirtualFileSystem.Core.VFS.IsEmpty()') | Indicates whether the file system is empty.<br/>This is the case if the root directory is empty. |
 | [SelectDirectories(Func&lt;IDirectoryNode,bool&gt;)](VFS.SelectDirectories(Func_IDirectoryNode,bool_).md 'Atypical.VirtualFileSystem.Core.VFS.SelectDirectories(System.Func<Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode,bool>)') | Finds all directory nodes that match the specified predicate. |
 | [ToString()](VFS.ToString().md 'Atypical.VirtualFileSystem.Core.VFS.ToString()') | Returns the index as an ASCII tree. |

docs/api/VirtualFileSystem.md

@@ -44,6 +44,7 @@
   - **[GetFile(string)](VFS.GetFile(string).md 'Atypical.VirtualFileSystem.Core.VFS.GetFile(string)')** `Method` Gets a file node by its path.  
     The path must be absolute.
   - **[GetRootPath()](VFS.GetRootPath().md 'Atypical.VirtualFileSystem.Core.VFS.GetRootPath()')** `Method` Gets the path of the root directory.
+  - **[GetTree()](VFS.GetTree().md 'Atypical.VirtualFileSystem.Core.VFS.GetTree()')** `Method` Gets the tree of the file system.
   - **[IsEmpty()](VFS.IsEmpty().md 'Atypical.VirtualFileSystem.Core.VFS.IsEmpty()')** `Method` Indicates whether the file system is empty.  
     This is the case if the root directory is empty.
   - **[SelectDirectories(Func&lt;IDirectoryNode,bool&gt;)](VFS.SelectDirectories(Func_IDirectoryNode,bool_).md 'Atypical.VirtualFileSystem.Core.VFS.SelectDirectories(System.Func<Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode,bool>)')** `Method` Finds all directory nodes that match the specified predicate.
@@ -174,6 +175,7 @@
   - **[GetFile(string)](IVirtualFileSystem.GetFile(string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetFile(string)')** `Method` Gets a file node by its path.  
     The path must be absolute.
   - **[GetRootPath()](IVirtualFileSystem.GetRootPath().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetRootPath()')** `Method` Gets the path of the root directory.
+  - **[GetTree()](IVirtualFileSystem.GetTree().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetTree()')** `Method` Gets the tree of the file system.
   - **[IsEmpty()](IVirtualFileSystem.IsEmpty().md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.IsEmpty()')** `Method` Indicates whether the file system is empty.  
     This is the case if the root directory is empty.
   - **[SelectDirectories(Func&lt;IDirectoryNode,bool&gt;)](IVirtualFileSystem.SelectDirectories(Func_IDirectoryNode,bool_).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.SelectDirectories(System.Func<Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode,bool>)')** `Method` Finds all directory nodes that match the specified predicate.

docs/links

@@ -26,6 +26,7 @@ M:Atypical.VirtualFileSystem.Core.VFS.TryGetFile(Atypical.VirtualFileSystem.Core
 M:Atypical.VirtualFileSystem.Core.VFS.TryGetFile(System.String,Atypical.VirtualFileSystem.Core.Contracts.IFileNode@)|VFS.TryGetFile(string,IFileNode).md|TryGetFile(string, IFileNode)
 M:Atypical.VirtualFileSystem.Core.VFS.FindFiles|VFS.FindFiles().md|FindFiles()
 M:Atypical.VirtualFileSystem.Core.VFS.FindFiles(System.Text.RegularExpressions.Regex)|VFS.FindFiles(Regex).md|FindFiles(Regex)
+M:Atypical.VirtualFileSystem.Core.VFS.GetTree|VFS.GetTree().md|GetTree()
 N:Atypical.VirtualFileSystem.Core|VirtualFileSystem.md#Atypical.VirtualFileSystem.Core|Atypical.VirtualFileSystem.Core
 T:Atypical.VirtualFileSystem.Core.VFS|VFS.md|VFS
 F:Atypical.VirtualFileSystem.Core.VFSConstants.ROOT_PATH|VFSConstants.ROOT_PATH.md|ROOT_PATH
@@ -115,6 +116,7 @@ M:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.DeleteFile(Atypic
 M:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.DeleteFile(System.String)|IVirtualFileSystem.DeleteFile(string).md|DeleteFile(string)
 M:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.FindFiles|IVirtualFileSystem.FindFiles().md|FindFiles()
 M:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.FindFiles(System.Text.RegularExpressions.Regex)|IVirtualFileSystem.FindFiles(Regex).md|FindFiles(Regex)
+M:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.GetTree|IVirtualFileSystem.GetTree().md|GetTree()
 T:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem|IVirtualFileSystem.md|IVirtualFileSystem
 M:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemFactory.CreateFileSystem|IVirtualFileSystemFactory.CreateFileSystem().md|CreateFileSystem()
 T:Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemFactory|IVirtualFileSystemFactory.md|IVirtualFileSystemFactory

src/Atypical.VirtualFileSystem.Core/Contracts/IVirtualFileSystem.cs

@@ -210,4 +210,11 @@ IEnumerable<IDirectoryNode> SelectDirectories(
     /// <param name="regexPattern">The regular expression pattern.</param>
     /// <returns>The file nodes.</returns>
     IEnumerable<IFileNode> FindFiles(Regex regexPattern);
+    
+    // GetTree
+    /// <summary>
+    ///     Gets the tree of the file system.
+    /// </summary>
+    /// <returns>The tree of the file system.</returns>
+    string GetTree();
 }

src/Atypical.VirtualFileSystem.Core/VFS.Queries.cs

@@ -91,6 +91,7 @@ public IEnumerable<IFileNode> FindFiles()
     public IEnumerable<IFileNode> FindFiles(Regex regexPattern)
         => FindFiles().Where(f => regexPattern.IsMatch(f.Path.Value));
 
+    /// <inheritdoc cref="IVirtualFileSystem.GetTree()" />
     public string GetTree()
     {
         var sb = new StringBuilder();

src/Atypical.VirtualFileSystem.Core/VFS.cs

@@ -38,7 +38,15 @@ public VFS()
     /// </returns>
     public override string ToString()
     {
-        return GetTree();
+        var files = Index.Values.Count(x => x.IsFile);
+        var directories = Index.Values.Count(x => x.IsDirectory);
+
+        return new StringBuilder()
+            .Append("VFS:")
+            .Append($" {files} files")
+            .Append(',')
+            .Append($" {directories} directories")
+            .ToString();
     }
 
     internal void AddToIndex(IVirtualFileSystemNode node)

tests/Atypical.VirtualFileSystem.UnitTests/Models/VirtualFileSystemTests.cs

@@ -575,23 +575,23 @@ public void FindFiles_with_valid_data_returns_a_list_of_files_with_content_and_n
         }
     }
 
-    public class MethodToString
+    public class MethodGetTree
     {
         [Fact]
-        public void ToString_returns_root_directory()
+        public void GetTree_returns_root_directory()
         {
             // Arrange
             IVirtualFileSystem vfs = new VFS();
 
             // Act
-            var result = vfs.ToString();
+            var result = vfs.GetTree();
 
             // Assert
             result.Should().Be("vfs://");
         }
 
         [Fact]
-        public void ToString_returns_3_files_as_ASCII_tree()
+        public void GetTree_returns_3_files_as_ASCII_tree()
         {
             // Arrange
             var expected = """
@@ -607,14 +607,14 @@ public void ToString_returns_3_files_as_ASCII_tree()
                 .CreateFile("file3.txt");
 
             // Act
-            var result = vfs.ToString();
+            var result = vfs.GetTree();
 
             // Assert
             result.Should().Be(expected);
         }
 
         [Fact]
-        public void ToString_returns_3_directories_as_ASCII_tree()
+        public void GetTree_returns_3_directories_as_ASCII_tree()
         {
             // Arrange
             var expected = """
@@ -630,14 +630,14 @@ public void ToString_returns_3_directories_as_ASCII_tree()
                 .CreateDirectory("dir3");
 
             // Act
-            var result = vfs.ToString();
+            var result = vfs.GetTree();
 
             // Assert
             result.Should().Be(expected);
         }
 
         [Fact]
-        public void ToString_returns_3_files_and_3_directories_as_ASCII_tree()
+        public void GetTree_returns_3_files_and_3_directories_as_ASCII_tree()
         {
             // Arrange
             var expected = """
@@ -668,14 +668,14 @@ public void ToString_returns_3_files_and_3_directories_as_ASCII_tree()
                 .CreateFile("dir3/file3.txt");
 
             // Act
-            var result = vfs.ToString();
+            var result = vfs.GetTree();
 
             // Assert
             result.Should().Be(expected);
         }
 
         [Fact]
-        public void ToString_returns_a_complex_tree()
+        public void GetTree_returns_a_complex_tree()
         {
             // Arrange
             var expected = """
@@ -726,6 +726,30 @@ public void ToString_returns_a_complex_tree()
                 .CreateFile("dir3/file2.txt")
                 .CreateFile("dir3/file3.txt");
 
+            // Act
+            var result = vfs.GetTree();
+
+            // Assert
+            result.Should().Be(expected);
+        }
+    }
+
+    public class MethodToString
+    {
+        [Fact]
+        public void ToString_returns_a_summary_of_the_VFS()
+        {
+            // Arrange
+            const string expected = "VFS: 3 files, 3 directories";
+
+            var vfs = new VFS()
+                .CreateFile("file1.txt")
+                .CreateFile("file2.txt")
+                .CreateFile("file3.txt")
+                .CreateDirectory("dir1")
+                .CreateDirectory("dir2")
+                .CreateDirectory("dir3");
+
             // Act
             var result = vfs.ToString();