TruePath.TestableIO.System.IO 0.16.1

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

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

For relevant interfaces of the IFileSystem abstraction it will provide extension methods and if possible also provide a convinience method directly on AbsolutePath that allows for a direct way to call it with an optional IFileSystem (if null the default IFileSystem will be used new FileSystem() ).

For instance IFile.WriteAllText will be available as FileIO.WriteAllText(...) For these there will also be a direct method available on AbsolutePath that allows for a direct way to call it. Note that this will live in the TruePath.TestableIO.System.IO namespace and not System.IO.Abstractions

Note that in some cases. For instance the Create method that is available for both IFile and IDirectory the direct method call will be FileCreate and DirectoryCreate

Example

For instance SetLastWriteTime on IFile is available as

FileSetLastWriteTime(this AbsolutePath path, DateTime lastWriteTime, IFileSystem? fileSystem = null)

and

SetLastWriteTime(this IFile file, AbsolutePath path, DateTime lastWriteTime)

It will also be available with ad call to

FileIO.SetLastWriteTime(AbsolutePath.Create(...), .., ...)

Installation

Install the package via NuGet:

dotnet add package TruePath.TestableIO.System.IO

Usage

Basic Example

using System.IO.Abstractions;
using TruePath;

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

fileSystem.File.WriteAllText(myPath, "Hello, world!");
myPath.WriteAllText("Hello world", fileSystem);

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, IFileSystem? fileSystem = null)
{
 fileSystem ??= new FileSystem();
 fileSystem.File.WriteAllText(path, contents);
}

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.