search

BryanWilhite / SonghayCore

core reusable, opinionated concerns for *all* 🧐 of my C# projects
http://songhayblog.azurewebsites.net/
MIT License
1 stars 0 forks source link
c-sharp csharp linq mstestv2 newtonsoft-json nuget-packages tavis xunit

readme

SonghayCore

Build Status

The Core code to install as a NuGet package for all of my studio Solutions. Anyone who may be reading this 👀 is free to do the same. This package is based on a project file that supports multi-targeting, declaring support for net6.0.

NuGet package 📦: SonghayCore

documentation 📚: SonghayCore API

coverlet test coverage 🔬☔: [report]

core reusable, opinionated concerns

Songhay.Hosting

One of the most important additions to .NET came in .NET 6.0 (circa 2021): the .NET Generic Host [📖 docs]. This host concept from Microsoft allows developers to not have to reinvent:

All ASP.NET developers expect to get these things “for free” and, finally, Microsoft is basically letting all .NET developers get these things for free. This Core recognizes the .NET Generic Host, stating with the DefaultHostedService class (see Songhay.Extensions below for more details).

Songhay.Diagnostics

This Core is concerned with tracing as well as logging. Logging concerns should be logically above this Core. TraceSources and TraceSourceExtensions define how tracing should be implemented with a bias toward using all source levels. When tracing is not configured for this Core then it will be ignored without throwing exceptions.

For a review of the organizational difference between tracing and logging, see “Tracing vs Logging vs Monitoring: What’s the Difference?” by Chrissy Kidd.

Documentation 📚: Songhay.Diagnostics

Songhay.Extensions

The Songhay System uses imperative C# code with a view to make it more functional in an effort to control complexity and enhance maintainability.

The preference for extension methods encourages stateless, reusable routines (many of them are “pure” functions).

Notable extensions:

There is support for URI templates (to be used with RestApiMetadata) in the form of extension methods, running on top of Tavis.UriTemplates.

Documentation 📚: Songhay.Extensions

Songhay.Models

The Core models of the Songhay System define types for MIME, XHTML, OPML, REST, the Repository, the Display Item (for WPF and other MVVM solutions), etc.

The Core models are “anemic” by design (there are very few abstract classes)—any logic would be found first in an Extension Method.

Notable models:

Documentation 📚: Songhay.Models

Songhay.Xml

The “core” of the Core is concern for XML. The Songhay System started out as utilities around XPathDocument and grew into LINQ for XML—over XDocument.

Documentation 📚: Songhay.Xml

satellite packages

SonghayCore.xUnit

Defines reusable class definitions for xUnit. Featured is the ProjectFileDataAttribute, allowing test data files to be loaded from a relative path.

NuGet package 📦: SonghayCore.xUnit

Documentation 📚: Songhay.Tests

SonghayCore.Newtonsoft

Core reusable, opinionated Newtonsoft concerns for my C# projects.

GitHub repo: https://github.com/BryanWilhite/SonghayCore.Newtonsoft

NuGet package 📦: SonghayCore.Newtonsoft

Studio packages dependent on SonghayCore

graph BT
    netstandard2[.NET Standard 2.0]
    net6[.NET 6.0]

    1[`SonghayCore`]
    2[`SonghayCore.Newtonsoft`]

    net6-->1
    netstandard2-->2
    2-..->|optional addition|1

    1-->3[`SonghayCore.xUnit`]
    1-->4[`Songhay.DataAccess`]
    1-->5[`Songhay.Feeds`]
    1-->6[`Songhay.Publications`]
    1-->7[`Songhay.Social`]

@BryanWilhite