[kate.shared] Created FormatHelper

Author: ktwrd

kate.shared/Helpers/FormatHelper.cs

@@ -0,0 +1,122 @@
+using System;
+using System.Collections.Generic;
+
+namespace kate.shared.Helpers
+{
+    /// <summary>
+    /// Helper class for formatting things
+    /// </summary>
+    public static class FormatHelper
+    {
+        public const string SqlServerDateTimeFormat = "yyyy-MM-dd HH:mm:ss.fff";
+
+        /// <summary>
+        /// Format a TimeSpan to either one of the following;
+        /// <list type="bullet">
+        /// <item><c>0d 0h 0m 0s</c></item>
+        /// <item><c>0h 0m 0s</c></item>
+        /// <item><c>0m 0s</c></item>
+        /// <item><c>0s</c></item>
+        /// <item><c>0d 0h 0m 0.000s</c></item>
+        /// <item><c>0h 0m 0.000s</c></item>
+        /// <item><c>0m 0.000s</c></item>
+        /// <item><c>0.000s</c></item>
+        /// <item><c>0ms</c> (when <see cref="TimeSpan.TotalMilliseconds"/> is less than <c>2000</c>)</item>
+        /// </list>
+        /// </summary>
+        public static string Duration(TimeSpan span)
+        {
+            if (span.TotalMilliseconds < 2000)
+            {
+                return span.TotalMilliseconds.ToString() + "ms";
+            }
+            var result = new List<string>();
+
+            if (span.Milliseconds > 10)
+            {
+                result.Add(string.Format("{0}.{1}",
+                    span.Seconds,
+                    span.Milliseconds.ToString().PadLeft(3, '0')));
+            }
+            else
+            {
+                result.Add(span.Seconds.ToString() + 's');
+            }
+
+            if (span.Minutes > 0)
+            {
+                result.Insert(0,
+                    string.Format("{0}m", span.Minutes));
+            }
+            if (span.Hours > 0)
+            {
+                result.Insert(0,
+                    string.Format("{0}h", span.Hours));
+            }
+            if (span.Days > 0)
+            {
+                result.Insert(0,
+                    string.Format("{0}d", span.Days));
+            }
+            return string.Join(" ", result);
+        }
+
+        /// <summary>
+        /// Format the duration between <paramref name="start"/> and the current date (using <see cref="DateTimeOffset.UtcNow"/>)
+        /// with <see cref="Duration(TimeSpan)"/>
+        /// </summary>
+        public static string DurationToUtcNow(DateTimeOffset start)
+        {
+            var end = DateTimeOffset.UtcNow;
+            var diff = end - start;
+
+            return Duration(diff);
+        }
+        
+        /// <summary>
+        /// Format the duration between <paramref name="start"/> and the current date (using <see cref="DateTime.UtcNow"/>)
+        /// with <see cref="Duration(TimeSpan)"/>
+        /// </summary>
+        public static string DurationToUtcNow(DateTime start)
+        {
+            var end = DateTime.UtcNow;
+            var diff = end - start;
+
+            return Duration(diff);
+        }
+        
+        /// <summary>
+        /// Format the duration between <paramref name="start"/> and the current date (using <see cref="DateTimeOffset.Now"/>)
+        /// with <see cref="Duration(TimeSpan)"/>
+        /// </summary>
+        public static string DurationToNow(DateTimeOffset start)
+        {
+            var end = DateTimeOffset.Now;
+            var diff = end - start;
+
+            return Duration(diff);
+        }
+
+        /// <summary>
+        /// Format the duration between <paramref name="start"/> and the current date (using <see cref="DateTime.Now"/>)
+        /// with <see cref="Duration(TimeSpan)"/>
+        /// </summary>
+        public static string DurationToNow(DateTime start)
+        {
+            var end = DateTime.Now;
+            var diff = end - start;
+
+            return Duration(diff);
+        }
+        public static string DurationMilliseconds(long value)
+        {
+            return Duration(TimeSpan.FromMilliseconds(value));
+        }
+#if NET8_0_OR_GREATER
+        public static string DurationMicroseconds(long value)
+        {
+            return Duration(TimeSpan.FromMicroseconds(value));
+        }
+#endif
+    }
+}

kate.shared/Helpers/GeneralHelper.cs

@@ -18,6 +18,7 @@ public static class GeneralHelper
         /// Format the duration between <paramref name="start"/> and the current date (using <see cref="DateTimeOffset.UtcNow"/>
         /// </summary>
         /// <returns><see cref="FormatDuration(TimeSpan)"/></returns>
+        [Obsolete("Use kate.shared.Helpers.FormatHelper.DurationToUtcNow(DateTimeOffset)")]
         public static string GenerateTaskDuration(DateTimeOffset start)
         {
             var end = DateTimeOffset.UtcNow;
@@ -28,6 +29,7 @@ public static string GenerateTaskDuration(DateTimeOffset start)
         /// <summary>
         /// Will format a timespan to `HH:MM:ss.sss` or `ss.sss seconds`.
         /// </summary>
+        [Obsolete("Use kate.shared.Helpers.FormatHelper.Duration(TimeSpan)")]
         public static string FormatDuration(TimeSpan duration)
         {
             var st = new List<string>();