Plinth.Common 1.6.3

Prefix Reserved
dotnet add package Plinth.Common --version 1.6.3                
NuGet\Install-Package Plinth.Common -Version 1.6.3                
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="Plinth.Common" Version="1.6.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Plinth.Common --version 1.6.3                
#r "nuget: Plinth.Common, 1.6.3"                
#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.
// Install Plinth.Common as a Cake Addin
#addin nuget:?package=Plinth.Common&version=1.6.3

// Install Plinth.Common as a Cake Tool
#tool nuget:?package=Plinth.Common&version=1.6.3                

README

Plinth.Common

A set of generic utilities, extensions, and enhancements for dotnet applications

Cache

Extensions for atomic GetOrCreate on Microsoft.Extensions.Caching.Memory memory caches Example:

IMemoryCache memCache = MemoryCacheUtil.Create();
await memCache.GetOrCreateAtomicMaxDurationAsync(
	"key", TimeSpan.FromMinutes(2), async () => await LoadValue());

👉 MemoryCacheUtil.Create() is a shorthand method for creating a new IMemoryCache.

Collections

  • Case Insensitive Dictionary and HashSet
  • Default Dictionary that will supply a default value for a key when requested
  • Examples:
// values are case insensitive
var set = new CaseInsensitiveHashSet<string>() { "abc", "ABC" };
set.Contains("aBc"); // true

// LINQ extension
var set = items.Where(...).Select(...).ToCaseInsensitiveHashSet();

// keys are case insensitive
var dict = new CaseInsensitiveDictionary<string, int>() { ["abc"] = 5 };
dict["ABC"]; // 5
dict.ContainsKey("aBc"); // true

// LINQ extension
var dict = items.Where(...).Select(...).ToCaseInsensitiveDictionary(v => v.ID);

// default dictionary, easy counting
var dict = new DefaultDictionary<string, int>(0);
dict["a"]++; // dict["a"] now is 1

// default dictionary, easy multi maps
var dict = new DefaultDictionary<string, ISet<int>>(() => new HashSet<int>());
dict["a"].Add(7); // "a" has a set with (7) in it

Constants

Handy constants for Content Types ContentTypes.ApplicationJson"application/json; charset=utf-8"

Exceptions

Logical exceptions for common API return values. Allows for separation between logic and api projects

  • LogicalBadRequestException
  • LogicalConflictException
  • LogicalForbiddenException
  • LogicalNotFoundException
  • LogicalPreconditionFailedException

Extensions

A variety of useful extensions to common classes

  • For manipulating DataRow
  • IDictionary .GetValueOrDefault()
  • IEnumerable .IsNullOrEmpty() and .Many()
  • Enum extensions for converting between enums by name (not by integer value)
  • ILogger extensions for logging code durations
using (log.LogExecTiming("some code"))
{
	... some code ...
	log.Debug("action");
}
// logs
[CTX-6540F] : Starting some code #52400089
[CTX-6540F] : action
[CTX-6540F] : some code #52400089 Took: 00.00.00.274472
  • Sensitive data extensions for masking secure items like passwords, SSNs, and credit card numbers.
  • Stream extensions .ToBytes() and .ToBytesAsync()
  • String extensions for converting strings to various types, .ChangeType<T>() as various .To{Type}OrNull()

Logging

  • Extensions and enhancements to Microsoft.Extensions.ILogger for better tracing when using the Plinth ecosystem
  • Provides StaticLogManager.GetLogger() to retrieve a static logger for the current class
  • Provides RequestTraceId and RequestTraceProperties singletons for passing data through the entire call stack (including across HTTP boundaries)
  • Adds shorthand calls for shorter log function names.
    • LogTraceTrace
    • LogDebugDebug
    • LogInformationInfo
    • LogWarningWarn
    • LogErrorError
    • LogCriticalCritical or Fatal

Mapping

An enhanced version of Omu.ValueInjecter for easy object to object mapping Allows for deeply nested Field to Field mapping (including Lists, Sets, and Dictionaries)

Utils

A set of static utilities

  • AsyncUtil: Some async utilities, mostly obsolete as of .NET 6
  • DateTimeUtil: Utilities for truncating date times, UTC/TZ conversions, and some date comparison functions
  • HexUtil: Conversion of hex strings to bytes and vice versa. E.g. "1a5b" <=> new byte[] { 0x1a, 0x5b }
  • RuntimeUtil: Provides FindExecutableHome() which can find your project root at runtime
  • TimeUtil: Provides log timing (used by ILogger extension noted above)
  • UriUtil: Provides a Join() method similar to Path.Combine()
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (18)

Showing the top 5 NuGet packages that depend on Plinth.Common:

Package Downloads
Plinth.Serialization

JSON/XML/etc object serialization

Plinth.Security

Security, Cryptography, and Token Utilities

Plinth.HttpApiClient

HTTP Api Client framework built on MS HttpClient

Plinth.HttpApiClient.Common

Shared objects for HTTP Api Client frameworks

Plinth.AspNetCore

Plinth ASP.NET Core Services Utilities

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.6.3 780 5/15/2024
1.6.2 1,002 2/16/2024
1.6.1 3,502 1/5/2024
1.6.0 637 11/30/2023
1.5.10-b186.aca976b4 62 11/30/2023
1.5.9 456 11/29/2023
1.5.9-b174.64153841 141 11/23/2023
1.5.9-b172.dfc6e7bd 71 11/17/2023
1.5.9-b171.4e2b92e2 107 11/4/2023
1.5.8 1,561 10/23/2023
1.5.7 4,460 7/31/2023
1.5.6 8,427 7/13/2023
1.5.5 690 6/29/2023
1.5.4 2,364 3/7/2023
1.5.3 1,542 3/3/2023
1.5.2 2,513 1/11/2023
1.5.2-b92.7c961f5f 109 1/11/2023
1.5.0 2,834 11/9/2022
1.5.0-b88.7a7c20cd 101 11/9/2022
1.4.7 10,479 10/20/2022
1.4.6 5,933 10/17/2022
1.4.5 6,335 10/1/2022
1.4.4 11,169 8/16/2022
1.4.3 6,697 8/2/2022
1.4.2 6,474 7/19/2022
1.4.2-b80.7fdbfd04 125 7/19/2022
1.4.2-b74.acaf86f5 176 6/15/2022
1.4.1 6,584 6/13/2022
1.4.0 6,379 6/6/2022
1.3.8 8,571 4/12/2022
1.3.7 6,484 3/21/2022
1.3.6 6,433 3/17/2022
1.3.6-b67.ca5053f3 143 3/16/2022
1.3.6-b66.4a9683e6 129 3/16/2022
1.3.5 6,325 2/23/2022
1.3.4 6,803 1/20/2022
1.3.3 3,038 12/29/2021
1.3.2 2,997 12/11/2021
1.3.1 3,152 11/12/2021
1.3.0 3,260 11/8/2021
1.2.3 4,591 9/22/2021
1.2.2 3,727 8/20/2021
1.2.1 4,089 8/5/2021
1.2.0 13,061 8/1/2021
1.2.0-b37.a54030b9 158 6/24/2021
1.1.6 11,469 3/22/2021
1.1.5 3,754 3/9/2021
1.1.4 4,768 2/27/2021
1.1.3 3,321 2/17/2021
1.1.2 3,303 2/12/2021
1.1.1 3,558 2/1/2021
1.1.0 3,296 12/16/2020
1.1.0-b27.b66c309b 279 11/15/2020
1.0.12 5,696 10/18/2020
1.0.11 3,427 10/6/2020
1.0.10 3,518 9/30/2020
1.0.9 3,343 9/29/2020
1.0.8 3,367 9/26/2020
1.0.7 3,365 9/19/2020
1.0.6 3,282 9/3/2020
1.0.5 3,473 9/2/2020
1.0.4 3,576 9/1/2020
1.0.3 3,196 9/1/2020
1.0.2 3,240 8/29/2020
1.0.1 3,251 8/29/2020
1.0.0 3,274 8/29/2020
1.0.0-b1.c22f563d 237 8/28/2020

net8.0 support