lunch-pail

lunch-pail is a .NET Standard compliant Unit of Work implementation for ADO.NET. The UoW is the workhorse of the data context, so the project was dubbed "lunch pail" as a reference to blue collar athletes.

I decided to package this into an assembly because I got tired of copying it from project to project.

Getting Started

1. Register the context within your IoC container (.NET Core shown below using SQL Server):

//startup.cs
public void ConfigureServices(IServiceCollection services)
{
  //rest of code...
  
  //context
  services.AddTransient<IDbConnectionFactory>(options =>
  {
    var builder = new SqlConnectionStringBuilder(Configuration.GetConnectionString("DefaultConnection"));

    return new DbConnectionFactory(() =>
    {
      var conn = new SqlConnection(builder.ConnectionString);

      conn.Open();
      return conn;
    });
  });
  services.AddScoped<IDbContext, DbContext>();

  //repositories (we'll add this later)  
}

2. Create a domain class to represents your database object.

public class Product
{
  public int Id { get; set; }
  public string Name { get; set; }
}

3. Create a repository with a dependency on IDbContext

public interface IProductRepository 
{
  Task<Product> Read (int id);
}

public class ProductRepository
{
  private readonly IDbContext dbContext;
  
  public ProductRepository(IDbContext dbContext)
  {
    this.dbContext = dbContext;
  }

  private IDbConnection Connection =>
      dbContext.UnitOfWork.Transaction.Connection;

    private IDbTransaction Transaction =>
      dbContext.UnitOfWork.Transaction;

  public Product Read(int id)
  {
    return Connection.QuerySingleOrDefault<Product>("select * from dbo.Product where Id = @id", new { id }, transaction: Transaction);
  }
}

4. Register the repository with your IoC container (.NET Core shown below):

//startup.cs
public void ConfigureServices(IServiceCollection services)
{
  //repositories
  services.AddScoped<IProductRepository, ProductRepository>();
}

5. With the context and repository registered, you're free to inject this into your controller or service layer.

public class ProductService 
{
  private readonly IDbContext dbContext;
  private readonly IProductRepository productRepository;

  public ProductService (
    IDbContext dbContext,
    IProductRepository productRepository)
  {
    this.dbContext = dbContext;
    this.productRepository = productRepository;
  }

  public Product Read(int id)
  {
    var product = productRepository.Read(id);
    dbContext.Commit();

    return product;
  }
}

Built with ♥ by Pim Brouwers in Toronto, ON.