DRN.Framework.Utils 0.4.0-preview002

Prefix Reserved
This is a prerelease version of DRN.Framework.Utils.
There is a newer version of this package available.
See the version list below for details.
dotnet add package DRN.Framework.Utils --version 0.4.0-preview002
                    
NuGet\Install-Package DRN.Framework.Utils -Version 0.4.0-preview002
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DRN.Framework.Utils" Version="0.4.0-preview002" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DRN.Framework.Utils" Version="0.4.0-preview002" />
                    
Directory.Packages.props
<PackageReference Include="DRN.Framework.Utils" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DRN.Framework.Utils --version 0.4.0-preview002
                    
#r "nuget: DRN.Framework.Utils, 0.4.0-preview002"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package DRN.Framework.Utils@0.4.0-preview002
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DRN.Framework.Utils&version=0.4.0-preview002&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=DRN.Framework.Utils&version=0.4.0-preview002&prerelease
                    
Install as a Cake Tool

master develop Quality Gate Status

Security Rating Maintainability Rating Reliability Rating Vulnerabilities Bugs Lines of Code Coverage

DRN.Framework.Utils package contains common codes for other DRN.Framework packages and projects developed with DRN.Framework.

Module

DRN.Utils can be added with following module

namespace DRN.Framework.Utils;

public static class UtilsModule
{
    public static IServiceCollection AddDrnUtils(this IServiceCollection collection)
    {
        collection.AddServicesWithAttributes();

        return collection;
    }
}

Dependency Injection with Attributes

Each module should be created in the assembly that will be scanned.

public static class InfraModule
{
    public static IServiceCollection AddSampleInfraServices(this IServiceCollection sc)
    {
        sc.AddServicesWithAttributes();

        return sc;
    }
}

Services resolution for attribute based services can be validated with a single line.

serviceProvider.ValidateServicesAddedByAttributes();

Attribute based dependency injection reduces wiring efforts and helps developer to focus on developing. This approach also improves service resolution validation during startup and integration testing.

    [Theory]
    [DataInlineContext]
    public void Validate_Sample_Dependencies(TestContext context)
    {
        context.ServiceCollection.AddSampleApplicationServices();
        context.ServiceCollection.AddSampleInfraServices();
        context.ValidateServices();
    }

Lifetime Attributes

Example attribute usage:

[Transient<IIndependent>]
public class Independent : IIndependent
{
}

Following attributes marks services with a lifetime and when service collection called with AddServicesWithAttributes method in the assembly marked belong they are automatically added.

namespace DRN.Framework.Utils.DependencyInjection.Attributes;

public class LifetimeAttribute<TService>(ServiceLifetime serviceLifetime, bool tryAdd = true, object? key = null)
    : LifetimeAttribute(serviceLifetime, typeof(TService), tryAdd, key);

public class LifetimeWithKeyAttribute<TService>(ServiceLifetime serviceLifetime, object key, bool tryAdd = true)
    : LifetimeAttribute(serviceLifetime, typeof(TService), tryAdd, key);

public class ScopedAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Scoped, tryAdd);

public class ScopedWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Scoped, key, tryAdd);

public class TransientAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Transient, tryAdd);

public class TransientWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Transient, key, tryAdd);

public class SingletonAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Singleton, tryAdd);

public class SingletonWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Singleton, key, tryAdd);

HasServiceCollectionModuleAttribute

Attributes derived from HasServiceCollectionModuleAttribute can be used to mark custom service collection modules. In the following example HasDrnContextServiceCollectionModuleAttribute marks DrnContext<TContext> and its service collection module. This way dbContexts inherited from DrnContext doesn't need a lifetime attribute and they can be registered by AddServicesWithAttributes with their custom factory.

This offers following flexibility:

  1. ServiceCollectionModule of DrnContexts are defined in DRN.Framework.EntityFramework
  2. Inherited dbContexts are defined in user defined projects and points a module in another project.
  3. AddServicesWithAttributes extension method defined in DRN.Framework.Utils registers them without depending DRN.Framework.EntityFramework project
public class HasDrnContextServiceCollectionModuleAttribute : HasServiceCollectionModuleAttribute
{
    static HasDrnContextServiceCollectionModuleAttribute() =>
        ModuleMethodInfo = typeof(ServiceCollectionExtensions)
            .GetMethod(nameof(ServiceCollectionExtensions.AddDbContextsWithConventions))!;

    public override async Task PostStartupValidationAsync(object service, IServiceProvider serviceProvider)
    {
        var appSettings = serviceProvider.GetRequiredService<IAppSettings>();
        var migrate = appSettings.Configuration.GetValue(DbContextConventions.AutoMigrateDevEnvironmentKey, false);
        if (appSettings.Environment == AppEnvironment.Development && migrate && service is DbContext context)
            await context.Database.MigrateAsync();
    }
}

[HasDrnContextServiceCollectionModule]
public abstract class DrnContext<TContext> : DbContext, IDesignTimeDbContextFactory<TContext>, IDesignTimeServices where TContext : DbContext, new()
{
...

HasServiceCollectionModuleAttribute's PostStartupValidationAsync will be called when,

  • ValidateServicesAddedByAttributes extension method called from service provider if all services resolved successfully.
  • For instance, DrnContext can apply EF migrations after service provider services resolved successfully.

Configurations

Following configuration sources can be used to add configurations from different sources

  • JsonSerializerConfigurationSource converts poco objects to configuration
  • RemoteJsonConfigurationSource fetches remote configuration (experimental and incomplete)

Following MountedSettingsConventions will be added to configuration.

  • /appconfig/json-settings json files will be added to configuration if any exist
  • /appconfig/key-per-file-settings files will be added to configuration if any exist
  • IMountedSettingsConventionsOverride overrides default /appconfig location if added to service collection before host built
namespace DRN.Framework.Utils.Settings.Conventions;

public static class MountedSettingsConventions
{
    public const string DefaultMountDirectory = "/appconfig";
    
    public static string JsonSettingsMountDirectory(string? mountDirectory = null)
        => Path.Combine(mountDirectory ?? DefaultMountDirectory, "json-settings");
    public static string KeyPerFileSettingsMountDirectory(string? mountDirectory = null)
        => Path.Combine(mountDirectory ?? DefaultMountDirectory, "key-per-file-settings");

    public static DirectoryInfo JsonSettingDirectoryInfo(string? mountDirectory = null)
        => new(JsonSettingsMountDirectory(mountDirectory));
}

public interface IMountedSettingsConventionsOverride
{
    string? MountedSettingsDirectory { get; }
}

AppSettings

Following IAppSettings interface is defined and can be used to obtain appsettings. It has utility methods that allow fail fast.

namespace DRN.Framework.Utils.Settings;

public interface IAppSettings
{
    AppEnvironment Environment { get; }
    IConfiguration Configuration { get; }
    bool TryGetConnectionString(string name, out string connectionString);
    string GetRequiredConnectionString(string name);
    bool TryGetSection(string key, out IConfigurationSection section);
    IConfigurationSection GetRequiredSection(string key);
    T? GetValue<T>(string key);
    T? GetValue<T>(string key, T defaultValue);
    T? Get<T>(string key, Action<BinderOptions>? configureOptions = null);
    ConfigurationDebugView GetDebugView();
}

ExtensionMethods

  • ServiceCollectionExtensions
    • ReplaceInstance
    • ReplaceTransient
    • ReplaceScoped
    • ReplaceSingleton
    • GetAllAssignableTo<TService>
  • StringExtensions
    • ToStream
  • TypeExtensions
    • MakeGenericMethod
  • AssemblyExtensions
    • GetTypesAssignableTo

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-05-08 22:32:35 +0300
Hash: 069091e826ac4bed3cfb9db6e2faf9d692231e5e

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DRN.Framework.Utils:

Package Downloads
DRN.Framework.EntityFramework

DRN.Framework.EntityFramework provides DrnContext with conventions to develop rapid and effective domain models. ## Commit Info Author: Duran Serkan KILIÇ Date: 2025-08-10 11:56:31 +0300 Hash: f5a1ef6323b589de341ccec0423e0d755a8be4d2

DRN.Framework.Hosting

DRN.Framework.Hosting ## Commit Info Author: Duran Serkan KILIÇ Date: 2025-08-10 11:56:31 +0300 Hash: f5a1ef6323b589de341ccec0423e0d755a8be4d2

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.7.0-preview031 140 8/10/2025
0.7.0-preview030 64 8/1/2025
0.7.0-preview029 74 8/1/2025
0.7.0-preview028 75 8/1/2025
0.7.0-preview027 111 7/31/2025
0.7.0-preview026 94 7/29/2025
0.7.0-preview025 64 7/27/2025
0.7.0-preview024 87 7/11/2025
0.7.0-preview023 89 7/11/2025
0.7.0-preview022 149 6/29/2025
0.7.0-preview021 148 6/23/2025
0.7.0-preview020 113 5/31/2025
0.7.0-preview019 165 3/23/2025
0.7.0-preview018 113 3/2/2025
0.7.0-preview017 120 2/23/2025
0.7.0-preview016 118 2/22/2025
0.7.0-preview015 96 2/21/2025
0.7.0-preview014 109 2/20/2025
0.7.0-preview013 115 2/9/2025
0.7.0-preview012 112 2/8/2025
0.7.0-preview011 100 2/2/2025
0.7.0-preview010 95 1/20/2025
0.7.0-preview009 101 1/19/2025
0.7.0-preview008 98 1/16/2025
0.7.0-preview007 115 12/29/2024
0.7.0-preview006 104 12/23/2024
0.7.0-preview005 94 11/27/2024
0.7.0-preview004 109 11/23/2024
0.7.0-preview003 121 11/20/2024
0.7.0-preview002 117 11/17/2024
0.7.0-preview001 124 11/14/2024
0.6.0 154 11/10/2024
0.6.0-preview002 102 11/10/2024
0.6.0-preview001 97 11/10/2024
0.5.1-preview002 97 9/30/2024
0.5.1-preview001 101 9/22/2024
0.5.0 159 8/30/2024
0.5.0-preview011 127 8/30/2024
0.5.0-preview010 163 8/25/2024
0.5.0-preview009 148 8/8/2024
0.5.0-preview008 139 8/7/2024
0.5.0-preview007 113 8/2/2024
0.5.0-preview006 103 7/30/2024
0.5.0-preview005 128 7/27/2024
0.5.0-preview004 132 7/15/2024
0.5.0-preview003 157 6/6/2024
0.5.0-preview002 147 6/5/2024
0.5.0-preview001 139 6/4/2024
0.4.0 163 5/19/2024
0.4.0-preview006 129 5/19/2024
0.4.0-preview005 118 5/12/2024
0.4.0-preview004 117 5/12/2024
0.4.0-preview003 122 5/11/2024
0.4.0-preview002 118 5/8/2024
0.4.0-preview001 136 5/5/2024
0.3.1-preview001 128 4/26/2024
0.3.0 151 4/23/2024
0.3.0-preview002 133 4/23/2024
0.3.0-preview001 151 4/23/2024
0.2.2-preview010 149 4/11/2024
0.2.2-preview009 149 3/18/2024
0.2.2-preview008 150 3/18/2024
0.2.2-preview007 141 3/16/2024
0.2.2-preview006 136 3/11/2024
0.2.2-preview005 143 3/10/2024
0.2.2-preview004 137 3/10/2024
0.2.2-preview003 157 1/22/2024
0.2.2-preview002 131 1/18/2024
0.2.2-preview001 151 1/14/2024
0.2.1 249 1/7/2024
0.2.0 182 12/31/2023
0.2.0-preview009 143 12/31/2023
0.2.0-preview008 139 12/30/2023
0.2.0-preview007 155 12/28/2023
0.2.0-preview006 140 12/27/2023
0.2.0-preview005 136 12/25/2023
0.2.0-preview004 150 12/23/2023
0.2.0-preview003 131 12/20/2023
0.2.0-preview002 165 12/19/2023
0.2.0-preview001 159 12/18/2023
0.1.0 199 11/26/2023
0.1.0-preview013 153 11/26/2023
0.1.0-preview012 116 11/20/2023
0.1.0-preview011 147 11/19/2023
0.1.0-preview010 134 10/30/2023
0.1.0-preview009 143 10/29/2023
0.1.0-preview008 156 10/27/2023
0.1.0-preview007 144 10/11/2023
0.1.0-preview006 163 10/9/2023
0.1.0-preview005 158 10/8/2023
0.1.0-preview004 159 10/8/2023
0.1.0-preview003 141 10/3/2023
0.1.0-preview002 158 10/3/2023
0.1.0-preview001 164 10/2/2023

Not every version includes changes, features or bug fixes. This project can increment version to keep consistency with other DRN.Framework projects.  

## Version 0.3.1

### Breaking Changes

* AttributeSpecifiedServiceCollectionModule renamed as AttributeSpecifiedServiceModule
* HasServiceCollectionModuleAttribute renamed as ServiceRegistrationAttribute
* HasDrnContextServiceCollectionModuleAttribute renamed as DrnContextServiceRegistrationAttribute
* ServiceRegistrationAttribute MethodInfo property replaced with ServiceRegistration method to make usage strongly typed and support inheritance

## Version 0.3.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 23 April National Sovereignty and Children's Day.

### New Features
* AppSettings now has GetDebugView() method that returns ConfigurationDebugView
 * ConfigurationDebugView has ToSummary() method that returns human friendly configuration summary model.
* AppSettings now has GetValue<> and Get<> methods to get values from configuration
* MountedSettingsConventions added.
 * /appconfig/json-settings json files will be added to configuration if any exist
 * /appconfig/key-per-file-settings files will be added to configuration if any exist
 * IMountedSettingsConventionsOverride overrides default /appconfig location if added to service collection before host built
* HasServiceCollectionModuleAttribute has PostStartupValidationAsync when,
 * ValidateServicesAddedByAttributes extension method called from service provider,
 * PostStartupValidationAsync will be called if all services resolved successfully.
 * For instance, DrnContext can apply migrations after service provider services resolved successfully.
* ScopedLog and IScopedLog added to aggregate related log within a scope such as a http request.

## Version 0.2.0

### Breaking Changes

* LifetimeContainer renamed as DrnServiceContainer
* Lifetime attributes moved to DRN.Framework.Utils.DependencyInjection.Attributes namespace

### New Features

* JsonSerializerConfigurationSource added to add dotnet objects to configuration
* RemoteJsonConfigurationSource added to remote settings to configuration (experimental)
* ConnectionStringsCollection added as poco model to serialize connection strings
* StringExtensions added
 * ToStream method added to convert strings to in memory stream
* HasServiceCollectionModuleAttribute added

## Version 0.1.0

### Breaking Changes

### New Features

* AppSettings added
* ServiceCollectionExtensions added
 * ReplaceInstance
 * ReplaceTransient
 * ReplaceScoped
 * ReplaceSingleton
* Attribute based dependency injection added
 * ScopedAttribute, TransientAttribute, SingletonAttribute and LifetimeAttribute added
 * ScopedWithKeyAttribute, TransientWithKeyAttribute, SingletonWithKeyAttribute and LifetimeWithKeyAttribute added
 * ServiceCollection AddServicesWithAttributes extension added
 * ServiceProvider ValidateServicesAddedByAttributes extension added

### Bug Fixes

---
**Semper Progredi: Always Progressive**  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-05-08 22:32:35 +0300  
Hash: 069091e826ac4bed3cfb9db6e2faf9d692231e5e