Dependency.Shelf 2.1.0

Install-Package Dependency.Shelf -Version 2.1.0
dotnet add package Dependency.Shelf --version 2.1.0
<PackageReference Include="Dependency.Shelf" Version="2.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Dependency.Shelf --version 2.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Dependency.Shelf, 2.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Dependency.Shelf as a Cake Addin
#addin nuget:?package=Dependency.Shelf&version=2.1.0

// Install Dependency.Shelf as a Cake Tool
#tool nuget:?package=Dependency.Shelf&version=2.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Dependency Shelf

Simple static dependency injection, NOT a framework!

Methods

ShelveInstance<T>(T instance)

Attempts to put the instance passed on the shelf, if there is an instance of the same interface already shelved then the new instance is NOT shelved and the existing shelved instance persists. If T is not an interface; OnlyInterfacesExpectedException will be thrown. If the instance passed is null then; CanNotShelveNullException will be thrown.

IsShelved<T>()

Returns a bool, true if an instance of interface T is shelved, false if there is not.

RetrieveInstance<T>()

Returns the shelved instance of T, if there is not a shelved instance null is returned.

ClearInstance<T>()

Returns a bool, true if there was no instance to remove or the instance was cleared successfully, false if there is an instance but removal failed.

Clear()

Clears all instances, of any type, on the shelf.

ClearExceptions()

Clears all exceptions from the Exceptions Log.

IEnumerable<Exception> ExceptionLog()

Returns all caught exceptions held in the exceptions log.

Example

The following is an example of an injected internal class being used by another class library. The "Shelf" is global within the application domain.

ExampleGateway (Library containing common Interface)

IInjectedDependency.cs

namespace ExampleGateway
{
    public interface IInjectedDependency
    {
        void DoSomething();
    }
}

ExampleUsage (Library with a call to dependency)

ExampleUsingShelf.cs

using ExampleGateway;
using static Dependency.Shelf;
namespace ExampleUsage
{
    public class ExampleUsingShelf
    {
        private static IInjectedDependency InjectedDependency => RetrieveInstance<IInjectedDependency>();
        public static void RunSomeDependentCode()
        {
            InjectedDependency.DoSomething();
        }
    }
}

ShelfExample (Console App)

Program.cs

using ExampleUsage;
using static Dependency.Shelf;
namespace ShelfExample
{
    class Program
    {
        static void Main(string[] args)
        {
            ShelveInstance<IInjectedDependency>(new RuntimeDependency());
            ExampleUsingShelf.RunSomeDependentCode();
        }
    }
}

RuntimeDependency.cs

using System;
namespace ShelfExample
{
    internal class RuntimeDependency : IInjectedDependency
    {
        public void DoSomething() => Console.WriteLine("Done Something!");
    }
}

You can find a better example of usage here on github.

Usage is also featured in this Narcolepsy Pumpkin video (https://youtu.be/Sas78ILNyfU)

  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0 17 12/5/2021
2.0.0 151 6/18/2021
1.0.0 133 3/28/2021

New: Calls Dispose for any Disposable objects when cleared from the shelf.
New: Exception Log for any caught exceptions raised during usage, includes .ClearExceptions() method