ToolsPack.String 2.0.7

Various string utilities:

• Convert Array and Stopwatch object to nice / short string (for log file).
• Compute Signature for a payload with a secret using HMACSHA alogrithm
• Convert generic object to XmlDocument or XDocument
• Generate Random string (as a shorter GUID) ...

ToolsPack.String

ArrayDisplayer

• Know to convert a IEnummerable to string in order do display in a log message

var arr = new string[1000] {"item1".."item1000"};
arr.Display().SeparatedBy("; ").MaxItems(4)

gives

{ item1; item2; item3; item4; ..and 996 (of 1000) more }

• If some items in the array are very long. We should limit the length of individual item with MaxItemLength() so that long items will be displayed with ... ellipsis

var arr = new string[1000] {"Lorem ipsum kidda foom", "item2".."item1000"};
arr.Display().MaxItems(4).MaxItemLength(10)

gives

{ [[Lorem...]], item2, item3, item4, ..and 996 (of 1000) more }

• Fast performance it only iterate neccessary items once (complexity O(N))
• see more functionalities in code and test

StopwatchDisplayer

convert Stopwatch to string

Stopwatch sw;
Console.WriteLine(sw.DisplayMili()); //get the display string in mili seconds "103 ms"
Console.WriteLine(sw.DisplayMicro()); //get the display string in micro seconds "103,000 mcs"
Console.WriteLine(sw.Display()); //automaticly choose a time unit (day, hour, minute, seconde..) to display

Tips

For some serializable object which don't implement ToString(). Newtonsoft.Json can convert them to json. DO NOT use this technique on production. The reflection is bad for Perf..

Newtonsoft.Json.JsonConvert.SerializeObject(someObject);

Ellipsis

ArrayDisplayer.DefaultEllipsis("1234567890", 4, "..."); //gives "1234..."
ArrayDisplayer.WordEllipsis("123 567 90", 5, "..."); //gives "123 567..."

Utf8SealCalculator

string signature = Utf8SealCalculator.HMACSHA256("payload", "secret", Utf8SealCalculator.ToHex);

• Convert the payload string and the secret string to byte[] tables with a Utf-8 encoder
• Use the secret byte[] table to hash the payload byte[] table with the HMACSHA256 algorithm
• the third parameter convert the hash result back to string. You can use for example:
  • Utf8SealCalculator.ToHex: format the hash result from byte[] to hexa value string
  • Convert.ToBase64String: format the hash result from byte[] to a base64 string

The result string is usually used as a seal or a signature to authenticate the payload content.

Other supported hashing algorithms are:

• HMACSHA1 (not secure)
• HMACSHA256
• HMACSHA384
• HMACSHA512
• SHA1 (not secure)
• SHA256
• SHA384
• SHA512

DiacriticsRemover

string message = DiacriticsRemover.RemoveDiacritics("où déjà aperçu la phénomène"); //returns "ou deja apercu la phenomene"

CreateRandomString

string randomString = StringGenerator.CreateRandomString(5, "abcdefghijklmnpqrstuvwxyz0123456789");

Generate a random string of length 5 using random characters in "abcdefghijklmnpqrstuvwxyz0123456789"

Remark:

• A normal C# Guid.NewGuid() generates a length-32 string and up to 32^16 different ids (that is alot)
• The above example generate only a length-5 string (much shorter) but up to 5^35 different ids (x2.4 time bigger than a normal Guid)

SqlServerConnectionStringBuilder

string connectionString = SqlServerConnectionStringBuilder.Build("localhost", "mydb", "root", "secretpassword");

Working with XmlDocument and XDocument

• XDocument is recommended over the old XmlDocument

Serialize a object to a XDocument

XDocument doc = XDocumentFactory.CreateDocFromXmlSerializer(o);
Console.WriteLine(xmlDoc.ToString());

Serialize a object to a XmlDocument

XmlDocument doc = XmlDocumentFactory.Create(o);
Console.WriteLine(doc.OuterXml);

Convert XDocument ⇔ XmlDocument

var xmlDoc = XmlDocumentFactory.Create(o);
var xDoc = XDocumentFactory.CreateDocFromXmlSerializer(o);
Console.WriteLine(xmlDoc.ToXDocument().ToString());
Console.WriteLine(xDoc.ToXmlDocument().OuterXml);