README.md

Common

• Common
  • PropertyUtil
  • PathUtil
  • TempFileStream
  • TransactionScopeHandler

This project contains general, framework independent utilities and abstractions.

PropertyUtil

Utility to get the names and types from property expressions.

Example:

public class RandomClass
{
    public bool Flag { get; set; }
    public string Title { get; set; }
}

PropertyUtil.GetName<RandomClass>(c => c.Flag) //Returns "Flag"
PropertyUtil.GetType<RandomClass>(c => c.Title) //Returns typeof(string)
PropertyUtil.GetName<RandomClass>(c => c.GetType()) //Throws ArgumentException - .GetType() is no valid property expression

PathUtil

Utility for paths. Does not try to replicate System.IO.Path, but adds some helpers that Path doesn't.

Currently this only has methods for removing invalid chars from paths and filenames, as Path.GetInvalidFileNameChars() returns different values based on the OS, while PathUtil uses a fixed set. This may be for example required when generating a filename for a download.

TempFileStream

This creates a temporary file that gets automatically deleted when it is closed. Example:

await using (var fs = new TempFileStream())
{
    // Write content to file
    // Upload file
}
// File was deleted at this point.

TransactionScopeHandler

The TransactionScopeHandler provides an easy way to run code within a transaction. The transaction optios are

IsolationLevel = IsolationLevel.ReadCommitted
Timeout = TransactionManager.MaximumTimeout

Example:

// Runs async method FooMethod in a transaction. An ambient transaction gets used if it exists, otherwise a new one will be created.
await transactionScopeHandler.RunInTransactionScope(FooMethod)

// Runs async method BarMethod in a new transaction.
await transactionScopeHandler.RunInTransactionScope(async () => { await BarMethod(); return 42; }, TransactionScopeOptions.RequiresNew);

// Runs LogMethod and supresses any ambient transaction.
await transactionScopeHandler.RunInTransactionScope(LogMethod, TransactionScopeOptions.Suppress);

// Shortcut for supressing the transaction
await transactionScopeHandler.SuppressTransaction(LogMethod);