WinstonPuckett.Fan 1.0.0

Summary

This package provides an easy way to pipe an input to a list of functions and get back the results.

Use

To use Fan, call .Fan() on an input and pass the needed methods to it. All methods passed to .Fan() must accept the type of the input and return the same output type (even if that type is void).

When you pass an array of methods which return void, .Fan() will return the input variable. When you pass an array of methods with a non-void return type, .Fan() will return an IEnumerable of the return type of the functions.

For instance:

// Each validation method does not return anything, so .Fan() will return the "order" variable.
public SalesOrder Validate(SalesOrder order)
    // Notice order.Fan() with the methods passed in.
    => order.Fan(
        QuantityGreaterThanMinimumAllowed,
        CustomerRelatedToFactory,
        ItemIsOnPriceList,
        OrderIncrementMet,
        PriceIsQuantityTimesOrderIncrement);
        
// In this case, each validation method returns a string, so .Fan() will return an IEnumerable<string>.
public IEnumerable<string> Validate(SalesOrder order)
    // Notice order.Fan() with the methods passed in.
    => order.Fan(
        QuantityGreaterThanMinimumAllowed,
        CustomerRelatedToFactory,
        ItemIsOnPriceList,
        OrderIncrementMet,
        PriceIsQuantityTimesOrderIncrement);

We can also call the functions in parallel:

public SalesOrder ValidateParallel(SalesOrder order)
    => order.FanParallel(
        QuantityGreaterThanMinimumAllowed,
        CustomerRelatedToFactory,
        ItemIsOnPriceList,
        OrderIncrementMet,
        PriceIsQuantityTimesOrderIncrement);

Or asynchronously:

public async Task ValidateAsync(SalesOrder order)
    => await order.FanAsync(
        QuantityGreaterThanMinimumAllowedAsync,
        CustomerRelatedToFactoryAsync,
        ItemIsOnPriceListAsync,
        OrderIncrementMetAsync,
        PriceIsQuantityTimesOrderIncrementAsync);

Note about async: Because of the C# type system, if one method is asynchronous, every method must be asynchronous. You can always make a non-asynchronous method async like so:

// Non-asynchronous version
private void Add(int num, int num2)
    => num + num2;
    
// Asynchronous version, just stick operation inside: "await Task.Run(() => YOUR_CODE);"
private async Task AddAsync(int num, int num2)
    => await Task.Run(() => num + num2);