Franz.Common 2.2.7

Franz.Common

A foundational library in the Franz Framework designed to provide core utilities, dependency injection abstractions, and common extensions for .NET applications. This library is part of the private Franz Framework ecosystem, versioned as 1.2.65, and hosted on a private Azure NuGet feed.

-Current Version: v2.2.7

Features

Dependency Injection Interfaces

• IScopedDependency: Marker interface for services with a scoped lifetime.
• ISingletonDependency: Marker interface for services with a singleton lifetime.

Important: Any service interface must inherit from either IScopedDependency or ISingletonDependency. Services that do not implement one of these interfaces will not be registered properly in the dependency injection system.

Data Seeding

• ISeeder: Interface for implementing database seeding logic.
  • Includes:
    • Order: Determines the execution order of seeders.
    • SeedAsync(): Defines the asynchronous method for data initialization.

Extensions

• CollectionExtensions:
  • Includes methods for manipulating and interacting with collections:
    • AddIfNotContains
    • AddRange
    • IsNullOrEmpty
• EnumerableExtensions:
  • Enhances LINQ functionality with methods such as ForEach.
• HostEnvironmentExtensions:
  • Helps determine the current environment:
    • IsIntegration
    • IsValidation
    • IsPreProduction

Core Utilities

• Company: Provides foundational business logic for managing company-related data.
• ProductGeneration: Handles logic for generating product-related data.

Version Information

• Current Version: 1.6.10
• Part of the private Franz Framework suite, hosted on a private Azure NuGet feed.

Installation

Step 1: Add the Private Azure Feed

Configure your NuGet client to access the private Azure feed:

dotnet nuget add source "https://your-private-feed-url" \
 --name "AzurePrivateFeed" \
 --username "YourAzureUsername" \
 --password "YourAzurePassword" \
 --store-password-in-clear-text

Step 2: Install the Package

Use the .NET CLI to install:

dotnet add package Franz.Common 

Usage

1. Dependency Injection

Use IScopedDependency and ISingletonDependency to simplify service registrations. Ensure that your service interfaces implement one of these dependencies.

Scoped Service Example:

public interface IScopedExampleService : IScopedDependency
{
 void PerformScopedOperation();
}

public class ScopedExampleService : IScopedExampleService
{
 public void PerformScopedOperation()
 {
 Console.WriteLine("Scoped operation executed.");
 }
}

// Registration
services.AddScoped<IScopedExampleService, ScopedExampleService>();

Singleton Service Example:

public interface ISingletonExampleService : ISingletonDependency
{
 string GetConfigValue();
}

public class SingletonExampleService : ISingletonExampleService
{
 public string GetConfigValue() => "Singleton Config";
}

// Registration
services.AddSingleton<ISingletonExampleService, SingletonExampleService>();

2. Database Seeding

Implement the ISeeder interface for database initialization:

public class ExampleSeeder : ISeeder
{
 public int Order => 1;

 public async Task SeedAsync()
 {
 Console.WriteLine("Seeding database...");
 // Add your data seeding logic here
 await Task.CompletedTask;
 }
}

// Example usage
var seeders = serviceProvider.GetServices<ISeeder>()
 .OrderBy(seeder => seeder.Order);

foreach (var seeder in seeders)
{
 await seeder.SeedAsync();
}

3. Extensions

Collection Extensions:

var list = new List<int> { 1, 2, 3 };

// Check if list is null or empty
if (!list.IsNullOrEmpty())
{
 Console.WriteLine("List contains elements.");
}

// Add an item if it doesn't exist
list.AddIfNotContains(4); // Adds 4
list.AddIfNotContains(1); // Does nothing

// Add a range of items
list.AddRange(new[] { 5, 6 });

Enumerable Extensions:

var numbers = Enumerable.Range(1, 5);

// Perform an action for each element
numbers.ForEach(x => Console.WriteLine($"Processing {x}"));

Host Environment Extensions:

if (hostEnvironment.IsIntegration())
{
 Console.WriteLine("Running in the integration environment.");
}
else if (hostEnvironment.IsValidation())
{
 Console.WriteLine("Running in the validation environment.");
}
else if (hostEnvironment.IsPreProduction())
{
 Console.WriteLine("Running in the pre-production environment.");
}

Dependencies

This library is fully self-contained and serves as a core building block for the private Franz Framework.

Development Notes

This library is part of the private Franz Framework and is not publicly available. It is distributed exclusively through a private Azure NuGet feed.

Contributing

Contributions are restricted to the Franz Framework development team. If you are authorized to contribute:

1. Clone the repository. @ https://github.com/bestacio89/Franz.Common/
2. Create a feature branch.
3. Submit a pull request with a detailed explanation of your changes.

License

This library is private and governed by the Franz Framework's internal licensing terms. For licensing inquiries, please contact the framework's maintainers.

Changelog

Version 1.3

• Upgraded to .NET 9.0.8
• Added new features and improvements
• Separated business concepts from mediator concepts
• Now compatible with both the in-house mediator and MediatR

Version 1.6.20

• Updated to .NET 10.0