Tum4ik.StinimGen 2.2.24230.3

<h1 align="center"> <img src="logo.png" alt="StinimGen" style="width:128px;" /> <br/> StinimGen </h1> <h1 align="center">

</h1>

.NET interface and implementation generator for static members.

This library is useful in case you want to have possibilities to mock static classes or static members in your tests.

Requirements

• .NET 6 and higher

Philosophy

1. Stinim should be associated with the words: static, interface, implementation, Gen - generator.
2. Static (also const) fields are converted to the properties.
3. Static events, properties and methods are converted to the events, properties and methods respectively.
4. All instance (non-static) members are ignored.

How to use

1. Install NuGet package

Use any approach you prefer to install the NuGet package Tum4ik.StinimGen.

2. Declare an interface

Declare your interface for a type you want to make mockable, use IIForAttribute to specify the type to wrap and the name of the wrapper class to be generated.

using Tum4ik.StinimGen.Attributes;

[IIFor(typeof(DateTime), WrapperClassName = "DateTimeWrapper")]
internal partial interface IDateTime
{
}

3. Register

Register the declared interface and the generated wrapper class in the DI container.

container.Register<IDateTime, DateTimeWrapper>();

4. Inject and use

Inject and use your wrapper in any place you need.

internal class MyService
{
  private readonly IDateTime _dateTime;

  public MyService(IDateTime dateTime)
  {
    _dateTime = dateTime;
  }


  public DateTime GetCurrentDateTime()
  {
    return _dateTime.Now;
  }
}

5. Mock and test

Now you are able to mock the functionality as usual.

using Moq;
using Xunit;

public class MyServiceTests
{
  private readonly Mock<IDateTime> _dateTimeMock = new()
  private readonly MyService _testeeService;

  public MyServiceTests()
  {
    _testeeService = new(_dateTimeMock.Object);
  }


  [Fact]
  internal void GetCurrentDateTimeTest()
  {
    var now = DateTime.Now;
    _dateTimeMock.Setup(dt => dt.Now).Returns(now);
    Assert.Equal(now, _testeeService.GetCurrentDateTime());
  }
}

API

Advanced topics

Custom members

It may be possible you want to extend the declared interface with your own members and provide their implementations in the generated wrapper. For that you need to use IsPartial property.

using Tum4ik.StinimGen.Attributes;

[IIFor(typeof(DateTime), WrapperClassName = "DateTimeWrapper", IsPartial = true)]
internal partial interface IDateTime
{
  DateTime Yesterday { get; }
  DateTime Tomorrow { get; }
}

partial class DateTimeWrapper
{
  public DateTime Yesterday => DateTime.Now.Subtract(TimeSpan.FromDays(1));
  public DateTime Tomorrow => DateTime.Now.AddDays(1);
}