Integrate some StringExtensions function into GitVersionCommon/Extensions

HHobeck · HHobeck · commit fa54904f3115 · 2023-04-04T20:14:55.000+02:00
diff --git a/new-cli/GitVersion.Common/Extensions/StringExtensions.cs b/new-cli/GitVersion.Common/Extensions/StringExtensions.cs
@@ -0,0 +1,18 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace GitVersion.Extensions
+{
+    public static class StringExtensions
+    {
+        public static bool IsEquivalentTo(this string self, string? other) =>
+            string.Equals(self, other, StringComparison.OrdinalIgnoreCase);
+
+        /// <inheritdoc cref="string.IsNullOrEmpty"/>
+        public static bool IsNullOrEmpty([NotNullWhen(false)] this string? value) => string.IsNullOrEmpty(value);
+
+        /// <inheritdoc cref="string.IsNullOrWhiteSpace"/>
+        public static bool IsNullOrWhiteSpace([NotNullWhen(false)] this string? value) => string.IsNullOrWhiteSpace(value);
+
+        public static bool IsEmpty([NotNullWhen(false)] this string? value) => string.Empty.Equals(value);
+    }
+}
diff --git a/src/GitVersion.Core/Git/ReferenceName.cs b/src/GitVersion.Core/Git/ReferenceName.cs
@@ -79,7 +79,9 @@ public static ReferenceName FromBranchName(string branchName)
     public override string ToString() => Friendly;
 
     public bool TryGetSemanticVersion([NotNullWhen(true)] out (SemanticVersion Value, string? Name) result,
-        Regex versionPatternRegex, string? labelPrefix, SemanticVersionFormat format)
+                                      Regex versionPatternRegex,
+                                      string? labelPrefix,
+                                      SemanticVersionFormat format)
     {
         result = default;
 
diff --git a/src/GitVersion.Core/Git/SemanticVersion.cs b/src/GitVersion.Core/Git/SemanticVersion.cs
@@ -28,67 +28,75 @@ public class SemanticVersion : IFormattable, IComparable<SemanticVersion>, IEqua
 
     public SemanticVersionBuildMetaData BuildMetaData { get; init; }
 
-    public bool IsLabeledWith(string value) => PreReleaseTag.HasTag() && string.Equals(PreReleaseTag.Name, value, StringComparison.OrdinalIgnoreCase);
+    public bool IsLabeledWith(string value) => PreReleaseTag.HasTag() && PreReleaseTag.Name.IsEquivalentTo(value);
 
     public bool IsMatchForBranchSpecificLabel(string? value)
         => PreReleaseTag.Name == string.Empty || value is null || IsLabeledWith(value);
 
     public SemanticVersion(long major = 0, long minor = 0, long patch = 0)
     {
-        Major = major;
-        Minor = minor;
-        Patch = patch;
-        PreReleaseTag = new SemanticVersionPreReleaseTag();
-        BuildMetaData = new SemanticVersionBuildMetaData();
+        this.Major = major;
+        this.Minor = minor;
+        this.Patch = patch;
+        this.PreReleaseTag = new SemanticVersionPreReleaseTag();
+        this.BuildMetaData = new SemanticVersionBuildMetaData();
     }
 
     public SemanticVersion(SemanticVersion semanticVersion)
     {
         semanticVersion.NotNull();
 
-        Major = semanticVersion.Major;
-        Minor = semanticVersion.Minor;
-        Patch = semanticVersion.Patch;
+        this.Major = semanticVersion.Major;
+        this.Minor = semanticVersion.Minor;
+        this.Patch = semanticVersion.Patch;
 
-        PreReleaseTag = new SemanticVersionPreReleaseTag(semanticVersion.PreReleaseTag);
-        BuildMetaData = new SemanticVersionBuildMetaData(semanticVersion.BuildMetaData);
+        this.PreReleaseTag = new SemanticVersionPreReleaseTag(semanticVersion.PreReleaseTag);
+        this.BuildMetaData = new SemanticVersionBuildMetaData(semanticVersion.BuildMetaData);
     }
 
     public bool Equals(SemanticVersion? obj)
     {
         if (obj == null)
+        {
             return false;
-        return Major == obj.Major && Minor == obj.Minor && Patch == obj.Patch && PreReleaseTag == obj.PreReleaseTag && BuildMetaData == obj.BuildMetaData;
+        }
+        return this.Major == obj.Major && this.Minor == obj.Minor && this.Patch == obj.Patch && this.PreReleaseTag == obj.PreReleaseTag && this.BuildMetaData == obj.BuildMetaData;
     }
 
     public bool IsEmpty() => Equals(Empty);
 
     public override bool Equals(object? obj)
     {
         if (obj is null)
+        {
             return false;
+        }
         if (ReferenceEquals(this, obj))
+        {
             return true;
+        }
         return obj.GetType() == GetType() && Equals((SemanticVersion)obj);
     }
 
     public override int GetHashCode()
     {
         unchecked
         {
-            var hashCode = Major.GetHashCode();
-            hashCode = hashCode * 397 ^ Minor.GetHashCode();
-            hashCode = hashCode * 397 ^ Patch.GetHashCode();
-            hashCode = hashCode * 397 ^ PreReleaseTag.GetHashCode();
-            hashCode = hashCode * 397 ^ BuildMetaData.GetHashCode();
+            var hashCode = this.Major.GetHashCode();
+            hashCode = (hashCode * 397) ^ this.Minor.GetHashCode();
+            hashCode = (hashCode * 397) ^ this.Patch.GetHashCode();
+            hashCode = (hashCode * 397) ^ this.PreReleaseTag.GetHashCode();
+            hashCode = (hashCode * 397) ^ this.BuildMetaData.GetHashCode();
             return hashCode;
         }
     }
 
     public static bool operator ==(SemanticVersion? v1, SemanticVersion? v2)
     {
         if (v1 is null)
+        {
             return v2 is null;
+        }
         return v1.Equals(v2);
     }
 
@@ -217,29 +225,39 @@ private static bool TryParseLoose(string version, [NotNullWhen(true)] out Semant
     public int CompareTo(SemanticVersion? value, bool includePrerelease)
     {
         if (value == null)
+        {
             return 1;
-        if (Major != value.Major)
+        }
+        if (this.Major != value.Major)
         {
-            if (Major > value.Major)
+            if (this.Major > value.Major)
+            {
                 return 1;
+            }
             return -1;
         }
-        if (Minor != value.Minor)
+        if (this.Minor != value.Minor)
         {
-            if (Minor > value.Minor)
+            if (this.Minor > value.Minor)
+            {
                 return 1;
+            }
             return -1;
         }
-        if (Patch != value.Patch)
+        if (this.Patch != value.Patch)
         {
-            if (Patch > value.Patch)
+            if (this.Patch > value.Patch)
+            {
                 return 1;
+            }
             return -1;
         }
-        if (includePrerelease && PreReleaseTag != value.PreReleaseTag)
+        if (includePrerelease && this.PreReleaseTag != value.PreReleaseTag)
         {
-            if (PreReleaseTag > value.PreReleaseTag)
+            if (this.PreReleaseTag > value.PreReleaseTag)
+            {
                 return 1;
+            }
             return -1;
         }
 
@@ -259,7 +277,7 @@ public int CompareTo(SemanticVersion? value, bool includePrerelease)
     /// </summary>
     public string ToString(string? format, IFormatProvider? formatProvider)
     {
-        if (string.IsNullOrEmpty(format))
+        if (format.IsNullOrEmpty())
             format = "s";
 
         if (formatProvider?.GetFormat(GetType()) is ICustomFormatter formatter)
@@ -270,22 +288,22 @@ public string ToString(string? format, IFormatProvider? formatProvider)
         switch (format)
         {
             case "j":
-                return $"{Major}.{Minor}.{Patch}";
+                return $"{this.Major}.{this.Minor}.{this.Patch}";
             case "s":
-                return PreReleaseTag.HasTag() ? $"{ToString("j")}-{PreReleaseTag}" : ToString("j");
+                return this.PreReleaseTag.HasTag() ? $"{ToString("j")}-{this.PreReleaseTag}" : ToString("j");
             case "t":
-                return PreReleaseTag.HasTag() ? $"{ToString("j")}-{PreReleaseTag.ToString("t")}" : ToString("j");
+                return this.PreReleaseTag.HasTag() ? $"{ToString("j")}-{this.PreReleaseTag.ToString("t")}" : ToString("j");
             case "f":
                 {
-                    var buildMetadata = BuildMetaData.ToString();
+                    var buildMetadata = this.BuildMetaData.ToString();
 
-                    return !string.IsNullOrEmpty(buildMetadata) ? $"{ToString("s")}+{buildMetadata}" : ToString("s");
+                    return !buildMetadata.IsNullOrEmpty() ? $"{ToString("s")}+{buildMetadata}" : ToString("s");
                 }
             case "i":
                 {
-                    var buildMetadata = BuildMetaData.ToString("f");
+                    var buildMetadata = this.BuildMetaData.ToString("f");
 
-                    return !string.IsNullOrEmpty(buildMetadata) ? $"{ToString("s")}+{buildMetadata}" : ToString("s");
+                    return !buildMetadata.IsNullOrEmpty() ? $"{ToString("s")}+{buildMetadata}" : ToString("s");
                 }
             default:
                 throw new FormatException($"Unknown format '{format}'.");
@@ -325,8 +343,10 @@ public SemanticVersion IncrementVersion(VersionField incrementStrategy, string?
         var preReleaseTagNumber = PreReleaseTag.Number;
 
         if (PreReleaseTag.HasTag())
+        {
             preReleaseTagNumber++;
-        else if (!string.IsNullOrEmpty(label))
+        }
+        else if (!label.IsNullOrEmpty())
         {
             preReleaseTagNumber = 1;
             preReleaseTagName = label;
diff --git a/src/GitVersion.Core/Git/SemanticVersionBuildMetaData.cs b/src/GitVersion.Core/Git/SemanticVersionBuildMetaData.cs
@@ -87,15 +87,15 @@ public string ToString(string? format, IFormatProvider? formatProvider)
         if (formatProvider?.GetFormat(GetType()) is ICustomFormatter formatter)
             return formatter.Format(format, this, formatProvider);
 
-        if (string.IsNullOrEmpty(format))
+        if (format.IsNullOrEmpty())
             format = "b";
 
         format = format.ToLower();
         return format.ToLower() switch
         {
             "b" => $"{this.CommitsSinceTag}",
-            "s" => $"{this.CommitsSinceTag}{(string.IsNullOrEmpty(this.Sha) ? null : ".Sha." + this.Sha)}".TrimStart('.'),
-            "f" => $"{this.CommitsSinceTag}{(string.IsNullOrEmpty(this.Branch) ? null : ".Branch." + FormatMetaDataPart(this.Branch))}{(string.IsNullOrEmpty(this.Sha) ? null : ".Sha." + this.Sha)}{(string.IsNullOrEmpty(this.OtherMetaData) ? null : "." + FormatMetaDataPart(this.OtherMetaData))}".TrimStart('.'),
+            "s" => $"{this.CommitsSinceTag}{(this.Sha.IsNullOrEmpty() ? null : ".Sha." + this.Sha)}".TrimStart('.'),
+            "f" => $"{this.CommitsSinceTag}{(this.Branch.IsNullOrEmpty() ? null : ".Branch." + FormatMetaDataPart(this.Branch))}{(this.Sha.IsNullOrEmpty() ? null : ".Sha." + this.Sha)}{(this.OtherMetaData.IsNullOrEmpty() ? null : "." + FormatMetaDataPart(this.OtherMetaData))}".TrimStart('.'),
             _ => throw new FormatException($"Unknown format '{format}'.")
         };
     }
@@ -112,7 +112,7 @@ public string ToString(string? format, IFormatProvider? formatProvider)
 
     public static SemanticVersionBuildMetaData Parse(string? buildMetaData)
     {
-        if (string.IsNullOrEmpty(buildMetaData))
+        if (buildMetaData.IsNullOrEmpty())
             return Empty;
 
         var parsed = ParseRegex.Match(buildMetaData);
@@ -135,7 +135,7 @@ public static SemanticVersionBuildMetaData Parse(string? buildMetaData)
             buildMetaDataSha = parsed.Groups["Sha"].Value;
 
         string? buildMetaDataOtherMetaData = null;
-        if (parsed.Groups["Other"].Success && !string.IsNullOrEmpty(parsed.Groups["Other"].Value))
+        if (parsed.Groups["Other"].Success && !parsed.Groups["Other"].Value.IsNullOrEmpty())
             buildMetaDataOtherMetaData = parsed.Groups["Other"].Value.TrimStart('.');
 
         return new()
@@ -150,7 +150,7 @@ public static SemanticVersionBuildMetaData Parse(string? buildMetaData)
 
     private static string FormatMetaDataPart(string value)
     {
-        if (!string.IsNullOrEmpty(value))
+        if (!value.IsNullOrEmpty())
             value = Regex.Replace(value, "[^0-9A-Za-z-.]", "-");
         return value;
     }
diff --git a/src/GitVersion.Core/Git/SemanticVersionPreReleaseTag.cs b/src/GitVersion.Core/Git/SemanticVersionPreReleaseTag.cs
@@ -70,7 +70,7 @@ public SemanticVersionPreReleaseTag(SemanticVersionPreReleaseTag preReleaseTag)
 
     public static SemanticVersionPreReleaseTag Parse(string? preReleaseTag)
     {
-        if (string.IsNullOrEmpty(preReleaseTag))
+        if (preReleaseTag.IsNullOrEmpty())
         {
             return new SemanticVersionPreReleaseTag();
         }
@@ -118,17 +118,18 @@ public string ToString(string? format, IFormatProvider? formatProvider)
         if (formatProvider?.GetFormat(GetType()) is ICustomFormatter formatter)
             return formatter.Format(format, this, formatProvider);
 
-        if (string.IsNullOrEmpty(format))
+        if (format.IsNullOrEmpty())
             format = "t";
 
         format = format.ToLower();
 
         return format switch
         {
-            "t" => (Number.HasValue ? string.IsNullOrEmpty(Name) ? $"{Number}" : $"{Name}.{Number}" : Name ?? string.Empty),
+            "t" => (Number.HasValue ? Name.IsNullOrEmpty() ? $"{Number}" : $"{Name}.{Number}" : Name ?? string.Empty),
             _ => throw new FormatException($"Unknown format '{format}'.")
         };
     }
 
-    public bool HasTag() => !string.IsNullOrEmpty(Name) || (Number.HasValue && PromotedFromCommits != true);
+    public bool HasTag() =>
+        !Name.IsNullOrEmpty() || (Number.HasValue && PromotedFromCommits != true);
 }

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,9 @@ public static ReferenceName FromBranchName(string branchName)`
`79`	`79`	`public override string ToString() => Friendly;`
`80`	`80`
`81`	`81`	`public bool TryGetSemanticVersion([NotNullWhen(true)] out (SemanticVersion Value, string? Name) result,`
`82`		`- Regex versionPatternRegex, string? labelPrefix, SemanticVersionFormat format)`
	`82`	`+ Regex versionPatternRegex,`
	`83`	`+ string? labelPrefix,`
	`84`	`+ SemanticVersionFormat format)`
`83`	`85`	`{`
`84`	`86`	`result = default;`
`85`	`87`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public SemanticVersionPreReleaseTag(SemanticVersionPreReleaseTag preReleaseTag)`
`70`	`70`
`71`	`71`	`public static SemanticVersionPreReleaseTag Parse(string? preReleaseTag)`
`72`	`72`	`{`
`73`		`- if (string.IsNullOrEmpty(preReleaseTag))`
	`73`	`+ if (preReleaseTag.IsNullOrEmpty())`
`74`	`74`	`{`
`75`	`75`	`return new SemanticVersionPreReleaseTag();`
`76`	`76`	`}`
`@@ -118,17 +118,18 @@ public string ToString(string? format, IFormatProvider? formatProvider)`
`118`	`118`	`if (formatProvider?.GetFormat(GetType()) is ICustomFormatter formatter)`
`119`	`119`	`return formatter.Format(format, this, formatProvider);`
`120`	`120`
`121`		`- if (string.IsNullOrEmpty(format))`
	`121`	`+ if (format.IsNullOrEmpty())`
`122`	`122`	`format = "t";`
`123`	`123`
`124`	`124`	`format = format.ToLower();`
`125`	`125`
`126`	`126`	`return format switch`
`127`	`127`	`{`
`128`		`- "t" => (Number.HasValue ? string.IsNullOrEmpty(Name) ? $"{Number}" : $"{Name}.{Number}" : Name ?? string.Empty),`
	`128`	`+ "t" => (Number.HasValue ? Name.IsNullOrEmpty() ? $"{Number}" : $"{Name}.{Number}" : Name ?? string.Empty),`
`129`	`129`	`_ => throw new FormatException($"Unknown format '{format}'.")`
`130`	`130`	`};`
`131`	`131`	`}`
`132`	`132`
`133`		`- public bool HasTag() => !string.IsNullOrEmpty(Name) \|\| (Number.HasValue && PromotedFromCommits != true);`
	`133`	`+ public bool HasTag() =>`
	`134`	`+ !Name.IsNullOrEmpty() \|\| (Number.HasValue && PromotedFromCommits != true);`
`134`	`135`	`}`