YamatoDaiwaCS_Extensions 0.3.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)

Dictionary

• Dictionary<TKey, TValue> SetPairIfValueNotIsNull<TKey, TValue>
• 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

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

• void SetProperty(this JsonObject targetObject, string dotSeparatedPath, object value)

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)

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

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