YamatoDaiwa.CSharpExtensions 0.9.0

Yamato Daiwa CS(harp) extensions

The extensions of the standard classes

DateOnly

• DateOnly CreateDateOnlyFromISO8601_String(string ISO8601_String)
• string ToISO8601_String()

DateTime

• DateOnly CreateDateOnlyFromISO8601_String(string ISO8601_String)
• string ToISO8601_String()

EmailAddress

Public static fields

Contains the regular expression of the valid email address according w3resource.com.

Public static methods

• bool IsValid(string potentialEmail)

Array

• TElement[] LogEachElement<TElement>(Action<TElement>? logger = null)

Content

• System.Threading.Tasks.Task<ResponseData> ReadExpectedToBeNonEmptyFromJsonAsync<ResponseData>(this System.Net.Http.HttpContent self)

Dictionary

• Dictionary<TKey, TValue> SetPair(TKey key, TValue value)
• Dictionary<TKey, TValue> SetPairs(Dictionary<TKey, TValue> pairs)
• Dictionary<TKey, TValue> SetPairIfValueIsNotNull(TKey key, TValue? value)
• SetPairIf
  • Dictionary<TKey, TValue> SetPairIf<TKey, TValue>(TKey key, TValue value, bool condition) where TKey : notnull
  • Dictionary<TKey, TValue> SetPairIf<TKey, TValue>(TKey key, TValue value, Func<TKey, TValue, bool> condition) where TKey : notnull
• DeletingOfOnePairByKey.Result<TKey, TValue> DeleteOnePairByKey(TKey key)
• DeletingOfOnePairByKey.Result<TKey, TValue> DeleteOnePairFromSwallowCopy(TKey key)

List

• List<TElement> AddElementsToStart<TElement> (params TElement[] newElements)
• List<TElement> AddElementsToEnd<TElement> (params TElement[] newElements)
• List<TElement?> AddElementToEndIfNotNull<TElement>(TElement? newElement)
• AddElementToEndIf
  • List<TElement> AddElementToEndIf<TElement>(TElement newElement, bool condition)
  • List<TElement> AddElementToEndIf<TElement>(TElement newElement, Func<TElement?, bool> condition)
• StringifyEachElementAndJoin<TElement>(string separator)
• ReplaceArrayElementsByPredicate
  • List<TElement> ReplaceArrayElementsByPredicate<TElement>(Func<TElement, bool> predicate, TElement newElement, bool mustReplaceOnlyFirstOne)
  • List<TElement> ReplaceArrayElementsByPredicate<TElement>(Func<TElement, bool> predicate, Func<TElement, TElement> replacer, bool mustReplaceOnlyFirstOne)
• List<TElement> LogEachElement<TElement>(Action<TElement>? logger = null)

Number

• bool IsValueOfAnyNumericType(object value)

String

• bool IsNonEmpty()
• string ToUpperCamelCase()
• string ToLowerCamelCase()
• string RemoveAllSpecifiedCharacters(char[] charactersToRemove)

System.Text.Json.Nodes.JsonObject

• JsonObject SetProperty(string dotSeparatedPath, object value)
• JsonObject SetProperties(Dictionary<string, object> dotSeparatedPathsAndValues)

Random values generators (RandomValuesGenerator class)

• bool GetRandomBoolean()
• byte GetRandomByte(byte minimalValue = Byte.MinValue, byte maximalValue = Byte.MaxValue)
• ushort GetRandomUShort(ushort minimalValue = ushort.MinValue, ushort maximalValue = ushort.MaxValue)
• TArrayElement GetRandomArrayElement<TArrayElement>(TArrayElement[] targetArray)
• DateOnly GetRandomDate(DateOnly earliestDate, DateOnly latestDate)
• DateTime GetRandomDateTime(DateOnly earliestDate, DateOnly latestDate)

RegexExtensions

ReplaceMatchesWithRegularExpressionToDynamicValue method

Replaces matches in a string using a regular expression and a dynamic replacer delegate. This method is particularly useful when the replacement string depends on the content of capturing groups or the position of the match.

Example 1: Using named capturing groups

This example demonstrates how to convert Markdown-style links into HTML anchor tags using named capturing groups.

const string sample = "Meta description is [very important](https://www.orange-sha.co.jp/blog/web01_description/) for SEO.";

string result = RegexExtensions.ReplaceMatchesWithRegularExpressionToDynamicValue(new RegexExtensions.ReplacingOfMatchesWithRegularExpressionToDynamicValue.CompoundParameter
{
  targetString = sample,
  regularExpressionWithCapturingGroups = new Regex(@"\[(?<anchorText>.+?)\]\((?<URI>.+?)\)"),
  replacer = matching => $"<a href=\"{ matching.namedCapturingGroups["URI"] }\">{ matching.namedCapturingGroups["anchorText"] }</a>"
});

// Result: Meta description is <a href="https://www.orange-sha.co.jp/blog/web01_description/">very important</a> for SEO.

Example 2: Using numbered capturing groups

This example shows how to use index-based capturing groups to reformat text.

const string sample = "Item 1: 100, Item 2: 200";

string result = RegexExtensions.ReplaceMatchesWithRegularExpressionToDynamicValue(new RegexExtensions.ReplacingOfMatchesWithRegularExpressionToDynamicValue.CompoundParameter
{
  targetString = sample,
  regularExpressionWithCapturingGroups = new Regex(@"Item (\d+): (\d+)"),
  replacer = matching => $"({matching.numeratedCapturingGroups[1]})={matching.numeratedCapturingGroups[2]}"
});

// Result: (1)=100, (2)=200

Associated Records and Delegates

CompoundParameter record

Encapsulates the input data for the replacement operation.

Replacer delegate

A function that takes a Matching object and returns a string?. If it returns null, the original match is preserved.

public delegate string? Replacer(Matching matching);

Matching record

Provides detailed information about a specific match.

Data mocking

DataMocking class

NullablePropertiesDecisionStrategies enumeration

DecideOptionalValue static method and NullablePropertiesDecisionSourceDataAndOptions structure

TValueType? DecideOptionalValue<TValueType>(NullablePropertiesDecisionSourceDataAndOptions<TValueType> sourceDataAndOptions)

struct NullablePropertiesDecisionSourceDataAndOptions<TPropertyType>
{
  public required NullablePropertiesDecisionStrategies Strategy { get; init; }
  public required Func<TPropertyType> RandomValueGenerator? { get; init; }
  public TPropertyType? PreDefinedValue { get; init; }
}

Decides, will nullable (optional) value be available or no, and if yes, returns this value. Intended to be used when generating the properties for the class / structure.

The decision will depend mainly on specified nullable property decision strategy:

Errors classes

DataRetrievingFailedException

• Constructor
  • DataRetrievingFailedException(string message)
  • DataRetrievingFailedException(string message, Exception innerException)
  • DataRetrievingFailedException(string messageSpecificPart, HttpResponseMessage response, object? responseData)
• Public static Methods
  • async Task<object?> TryToExtractResponseDataForLogging(HttpResponseMessage response)

MockGatewayHelper class

When mock the asynchronous data transactions, takes care about such routines as

1. Randomizing of the pending interval
2. Simulation of the error
3. Logging

Public static methods

SetLogger

void SetLogger(Log log)
    
delegate void Log(string message) 

Adds the logging method which will be invoked if the logging will be demanded in other methods.

SimulateDataRetrieving

Task<TResponseData> SimulateDataRetrieving<TRequestParameters, TResponseData>(
  TRequestParameters requestParameters,
  Func<TResponseData> getResponseData,
  SimulationOptions options
)

where the SimulationOptions is the associated structure will be described below.

SimulateDataSubmitting

Task<TResponseData> SimulateDataSubmitting<TRequestData, TResponseData>(
  TRequestData requestData,
  Func<TResponseData> getResponseData,
  SimulationOptions options
)

It's behaviour is almost even with SimulateDataRetrieving, but there are some differences:

• The logging
• DataSubmittingFailedException will be thrown instead of DataRetrievingFailedException when error simulation mode is enabled.

Associated structure SimulationOptions

public struct SimulationOptions
{
  public ushort? MinimalPendingPeriod__Seconds { get; init; }
  public ushort? MaximalPendingPeriod__Seconds { get; init; }
  public bool MustSimulateError { get; init; }
  public bool MustLogResponseData { get; init; }
  public required string GatewayName { get; init; }
  public required string TransactionName { get; init; }
}

MinimalPendingPeriod__Seconds

MaximalPendingPeriod__Seconds

MustSimulateError

MustSimulateError

MustLogResponseData

GatewayName

TransactionName

URI_Builder

Provides a simple way to construct URIs with query parameters.

Build method

public static string Build(URI_Builder.SourceData sourceData)

Constructs a URI string based on the provided SourceData.

Example 1: Origin and path with query parameters

string result = URI_Builder.Build(new URI_Builder.SourceData
{
  origin = "https://example.com",
  path = "/search",
  queryParameters = new Dictionary<string, object>
  {
    { "q", "dotnet" },
    { "lang", "en" }
  }
});

// Result: https://example.com/search?q=dotnet&lang=en

Example 2: Origin only

string result = URI_Builder.Build(new URI_Builder.SourceData
{
  origin = "https://example.com"
});

// Result: https://example.com

Example 3: Numeric and Boolean query parameters

string result = URI_Builder.Build(new URI_Builder.SourceData
{
  origin = "https://example.com",
  queryParameters = new Dictionary<string, object>
  {
    { "id", 123 },
    { "active", true },
    { "deleted", false }
  }
});

// Result: https://example.com?id=123&active=true
// Note: Currently, only 'true' boolean values are included in the query string.

Associated record SourceData

public record SourceData
{
  public string? origin { get; init; }
  public string? path { get; init; }
  public Dictionary<string, object>? queryParameters { get; init; }
}

origin

The base part of the URI (e.g., https://example.com).

path

The path part of the URI (e.g., /api/v1/users).

queryParameters

A dictionary containing query parameters. Supported value types are string, numeric types, Enum, and true boolean.