TruePath.TestableIO.System.IO 0.11.2

TruePath.TestableIO.System.IO

Bridges TruePath and TestableIO.System.IO.Abstractions.

This library provides extension methods for TestableIO.System.IO.Abstractions interfaces (like IFile, IDirectory, etc.) that accept AbsolutePath from TruePath instead of raw strings. This combines the strongly-typed path safety of TruePath with the testability of System.IO.Abstractions.

Features

• Strongly-typed Paths: Use AbsolutePath for all file system operations.
• Testability: Full support for IFileSystem abstractions, allowing easy mocking in unit tests.
• Comprehensive API: Covers IFile, IDirectory, IFileInfo, IDirectoryInfo, and IDriveInfo.
• Modern .NET Support: Targets net8.0 and net10.0.

Installation

Install the package via NuGet:

dotnet add package TruePath.TestableIO.System.IO

Usage

Basic Example

Instead of using strings, you can use AbsolutePath with your IFileSystem:

using System.IO.Abstractions;
using TruePath;

IFileSystem fileSystem = new FileSystem();
var myPath = new AbsolutePath("/var/log/app.log");

// Extension method on IFile that takes AbsolutePath
fileSystem.File.WriteAllText(myPath, "Hello, TruePath!");

// Where possible there will also be direct extensions methods against an AbsolutePath
// So the above could also be achieved with:
myPath.WriteAllText("Hello");

// This method supports adding the fileSystem so this would also be possible
myPath.WriteAllText("Hello", fileSystem);

// Note that the fileSystem will default to null. In case of nulls a new instance of FileSystem will be created by the method

if (fileSystem.File.Exists(myPath))
{
    var content = fileSystem.File.ReadAllText(myPath);
}

Extension example

In the example above. There will be the following extensions methods. Note that this pattern as general rule is followed by other extensions methods.

There are some variations. For instance Exists will be DirectoryExists on the extension of an AbsolutePath

public static void WriteAllText(this IFile file, AbsolutePath path, ReadOnlySpan<char> contents)
{
    file.WriteAllText(path.Value, contents);
}

public static void WriteAllText(this AbsolutePath path, ReadOnlySpan<char> contents, FileSystem? fileSystem = null)
{
    fileSystem ??= new FileSystem();
    fileSystem.File.WriteAllText(path, contents);
}

Working with Directories

var workDir = new AbsolutePath("/tmp/my-work-dir");

fileSystem.Directory.CreateDirectory(workDir);
var files = fileSystem.Directory.GetFiles(workDir); 
// Returns AbsolutePath[] instead of string[]

Bugs or things missing

Feel free to create an issue or submit a pull request.

Note on use of AI

AI has been used for generating documentation of code samples and for simple parts of the development.

However the generation of the actual extensions methods has been done by writing and actual tool to cloning https://github.com/Testably/Testably.Abstractions and analysing the code with Roslyn and generating the code. These parts have not been autogenerated by AI.