VersaTul.Pipeline.Infrastructure 1.0.14

VersaTul Pipeline Infrastructure

VersaTul Pipeline Infrastructure is a C# library that provides a generic implementation of the Pipeline pattern. The Pipeline pattern is a useful and neat way to perform a series of filtering or processing steps on an object to transform it into a desired state.

Installation

To use VersaTul Pipeline Infrastructure, first install it using nuget:

PM> NuGet\Install-Package VersaTul.Pipeline.Infrastructure -Version latest

Usage

The library consists of two main components: IStep<TIn, TOut> and Pipeline<TIn, TOut>.

• IStep<TIn, TOut> : A step represents the work to be done on a given input with the given return type. It has a single method:

TOut Execute (TIn input);

• Pipeline<TIn, TOut> : IStep<TIn, TOut> : Represents an accumulative set of steps that can be performed on a given input. It has a single property:

Func<TIn, TOut> Step;

The library also provides a static class PipelineExtensions that contains extension methods for adding steps to objects and pipelines.

TOut AddStep<TIn, TOut> (this TIn input, IStep<T, U> step);

Example

The following code shows how to use nested pipelines to work with different types.

// Using nested pipeline to work with different types.
// Example pipeline with steps setup.
public class CompoundPipeline : Pipeline<int, string>
{
    public CompoundPipeline()
    {
        Step = input => input
            .AddStep(new AnInitialStep())
            .AddStep(new InnerPipeline()) //InnerPipeline used by CompoundPipeline
            .AddStep(new IntToStringStep())
            .AddStep(new DoSomethingWithAStringStep());
    }
}

// A Pipeline that's called by another pipeline.
public class InnerPipeline : Pipeline<string, int>
{
    public InnerPipeline()
    {
        Step = input => input
            .AddStep(new DoSomethingWithAnIntegerStep())
            .AddStep(new SomethingElseWithAnIntegerStep())
            .AddStep(new OptionalStep<int, int>(i => i > 5, new AddOneStep()));
    }
}

License

This project is licensed under the MIT License - see the LICENSE file for details.