Merge pull request #36 from Atypical-Consulting/vfsexception

Refactor VFSException and add unit tests

Author: phmatray

docs/api/VFSException.VFSException().md

@@ -0,0 +1,10 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core.Exceptions](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Exceptions 'Atypical.VirtualFileSystem.Core.Exceptions').[VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException')
+
+## VFSException() Constructor
+
+Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class.
+
+```csharp
+public VFSException();
+```

docs/api/VFSException.VFSException(SerializationInfo,StreamingContext).md

@@ -0,0 +1,24 @@
+#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
+### [Atypical.VirtualFileSystem.Core.Exceptions](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Exceptions 'Atypical.VirtualFileSystem.Core.Exceptions').[VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException')
+
+## VFSException(SerializationInfo, StreamingContext) Constructor
+
+Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a specified error message and a reference to the  
+inner exception that is the cause of this exception.
+
+```csharp
+protected VFSException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);
+```
+#### Parameters
+
+<a name='Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext).info'></a>
+
+`info` [System.Runtime.Serialization.SerializationInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.Serialization.SerializationInfo 'System.Runtime.Serialization.SerializationInfo')
+
+The [System.Runtime.Serialization.SerializationInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.Serialization.SerializationInfo 'System.Runtime.Serialization.SerializationInfo') that holds the serialized object data about the exception being thrown.
+
+<a name='Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext).context'></a>
+
+`context` [System.Runtime.Serialization.StreamingContext](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.Serialization.StreamingContext 'System.Runtime.Serialization.StreamingContext')
+
+The [System.Runtime.Serialization.StreamingContext](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.Serialization.StreamingContext 'System.Runtime.Serialization.StreamingContext') that contains contextual information about the source or destination.

docs/api/VFSException.md

@@ -13,5 +13,7 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
 
 | Constructors | |
 | :--- | :--- |
+| [VFSException()](VFSException.VFSException().md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException()') | Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class. |
 | [VFSException(string, Exception)](VFSException.VFSException(string,Exception).md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(string, System.Exception)') | Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a message and an inner exception that is the cause<br/>of this exception. |
 | [VFSException(string)](VFSException.VFSException(string).md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(string)') | Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a message that describes the error. |
+| [VFSException(SerializationInfo, StreamingContext)](VFSException.VFSException(SerializationInfo,StreamingContext).md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)') | Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a specified error message and a reference to the<br/>inner exception that is the cause of this exception. |

docs/api/VirtualFileSystem.md

@@ -214,9 +214,12 @@
 
 ## Atypical.VirtualFileSystem.Core.Exceptions Namespace
 - **[VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException')** `Class` Exception thrown by the VFS.
+  - **[VFSException()](VFSException.VFSException().md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException()')** `Constructor` Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class.
   - **[VFSException(string, Exception)](VFSException.VFSException(string,Exception).md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(string, System.Exception)')** `Constructor` Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a message and an inner exception that is the cause  
     of this exception.
   - **[VFSException(string)](VFSException.VFSException(string).md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(string)')** `Constructor` Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a message that describes the error.
+  - **[VFSException(SerializationInfo, StreamingContext)](VFSException.VFSException(SerializationInfo,StreamingContext).md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException.VFSException(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)')** `Constructor` Initializes a new instance of the [VFSException](VFSException.md 'Atypical.VirtualFileSystem.Core.Exceptions.VFSException') class with a specified error message and a reference to the  
+    inner exception that is the cause of this exception.
 
 <a name='Atypical.VirtualFileSystem.Core.Models'></a>
 

docs/links

@@ -78,8 +78,10 @@ T:Atypical.VirtualFileSystem.Core.Models.FileNode|FileNode.md|FileNode
 M:Atypical.VirtualFileSystem.Core.Models.RootNode.#ctor|RootNode.RootNode().md|RootNode()
 M:Atypical.VirtualFileSystem.Core.Models.RootNode.ToString|RootNode.ToString().md|ToString()
 T:Atypical.VirtualFileSystem.Core.Models.RootNode|RootNode.md|RootNode
+M:Atypical.VirtualFileSystem.Core.Exceptions.VFSException.#ctor|VFSException.VFSException().md|VFSException()
 M:Atypical.VirtualFileSystem.Core.Exceptions.VFSException.#ctor(System.String)|VFSException.VFSException(string).md|VFSException(string)
 M:Atypical.VirtualFileSystem.Core.Exceptions.VFSException.#ctor(System.String,System.Exception)|VFSException.VFSException(string,Exception).md|VFSException(string, Exception)
+M:Atypical.VirtualFileSystem.Core.Exceptions.VFSException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)|VFSException.VFSException(SerializationInfo,StreamingContext).md|VFSException(SerializationInfo, StreamingContext)
 N:Atypical.VirtualFileSystem.Core.Exceptions|VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Exceptions|Atypical.VirtualFileSystem.Core.Exceptions
 T:Atypical.VirtualFileSystem.Core.Exceptions.VFSException|VFSException.md|VFSException
 P:Atypical.VirtualFileSystem.Core.Contracts.IDirectoryNode.Directories|IDirectoryNode.Directories.md|Directories

src/Atypical.VirtualFileSystem.Core/Exceptions/VFSException.cs

@@ -4,13 +4,23 @@
 // This source code is licensed under the BSD-style license found in the
 // LICENSE file in the root directory of this source tree. 
 
+using System.Runtime.Serialization;
+
 namespace Atypical.VirtualFileSystem.Core.Exceptions;
 
 /// <summary>
 ///     Exception thrown by the VFS.
 /// </summary>
+[Serializable]
 public class VFSException : Exception
 {
+    /// <summary>
+    ///     Initializes a new instance of the <see cref="VFSException"/> class.
+    /// </summary>
+    public VFSException()
+    {
+    }
+
     /// <summary>
     ///     Initializes a new instance of the <see cref="VFSException"/> class with a message that describes the error.
     /// </summary>
@@ -33,4 +43,16 @@ public VFSException(string message, Exception innerException)
         : base(message, innerException)
     {
     }
-}
+
+    /// <summary>
+    ///     Initializes a new instance of the <see cref="VFSException"/> class with a specified error message and a reference to the
+    ///     inner exception that is the cause of this exception.
+    /// </summary>
+    /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+    /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
+    protected VFSException(SerializationInfo info, StreamingContext context)
+        : base(info, context)
+    {
+    }
+}
+    

tests/Atypical.VirtualFileSystem.UnitTests/Exceptions/VFSExceptionTests.cs

@@ -0,0 +1,59 @@
+namespace VirtualFileSystem.UnitTests.Exceptions;
+
+public class VFSExceptionTests
+{
+    public class Constructor
+    {
+        [Fact]
+        public void Constructor_Creates_VFSException_With_Message()
+        {
+            // Arrange
+            const string message = "Test message.";
+
+            // Act
+            var exception = new VFSException(message);
+
+            // Assert
+            exception.Message.Should().Be(message);
+        }
+
+        [Fact]
+        public void Constructor_Creates_VFSException_With_Message_And_InnerException()
+        {
+            // Arrange
+            const string message = "Test message.";
+            var innerException = new InvalidOperationException("Inner exception message.");
+
+            // Act
+            var exception = new VFSException(message, innerException);
+
+            // Assert
+            exception.Message.Should().Be(message);
+            exception.InnerException.Should().Be(innerException);
+        }
+
+        [Fact]
+        public void Constructor_Creates_VFSException_With_InnerException()
+        {
+            // Arrange
+            var innerException = new InvalidOperationException("Inner exception message.");
+
+            // Act
+            var exception = new VFSException(null!, innerException);
+
+            // Assert
+            exception.InnerException.Should().Be(innerException);
+        }
+
+        [Fact]
+        public void Constructor_Creates_VFSException_Without_Arguments()
+        {
+            // Act
+            var exception = new VFSException();
+
+            // Assert
+            exception.Message.Should().NotBeNull();
+            exception.InnerException.Should().BeNull();
+        }
+    }
+}