Updating to newest release

LinkDotNet Bot · LinkDotNet Bot · commit e313cd679c6e · 2025-01-12T15:02:22.000Z
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -24,11 +24,9 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4.2.2
 
-      - uses: actions/setup-dotnet@v4.1.0
+      - uses: actions/setup-dotnet@v4.2.0
         with:
           dotnet-version: | 
-            6.0.x
-            7.0.x
             8.0.x
             9.0.x
 
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -34,11 +34,9 @@ jobs:
         path: ./CHANGELOG.md
 
     - name: Setup dotnet
-      uses: actions/setup-dotnet@v4.1.0
+      uses: actions/setup-dotnet@v4.2.0
       with:
         dotnet-version: | 
-          6.0.x
-          7.0.x
           8.0.x
           9.0.x
 
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -15,11 +15,9 @@ jobs:
     - uses: actions/checkout@v4.2.2
 
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4.1.0
+      uses: actions/setup-dotnet@v4.2.0
       with:
         dotnet-version: | 
-          6.0.x
-          7.0.x
           8.0.x
           9.0.x
 
diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml
@@ -14,11 +14,9 @@ jobs:
     steps:
     - uses: actions/checkout@v4.2.2
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4.1.0
+      uses: actions/setup-dotnet@v4.2.0
       with:
         dotnet-version: | 
-          6.0.x
-          7.0.x
           8.0.x
           9.0.x
           
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,26 @@ All notable changes to **ValueStringBuilder** will be documented in this file. T
 
 ## [Unreleased]
 
+## [2.0.0] - 2025-01-12
+
+This is the `v2` release of the **ValueStringBuilder**. There aren't any noticeable breaking changes. Only old framework versions were removed to make further development easier. The API is the same (with new additions) as in `v1`.
+
+### Added
+
+- Added `Append(Rune)` overload
+- Added `AppendJoin(Rune, IEnumerable<string?>)` overload
+- Added `AppendJoin<T>(Rune, IEnumerable<T>)` overload
+
+### Removed
+
+- Support for `net6.0` and `net7.0` was removed.
+
+### Changed
+
+- Added `OverloadResolutionPriority` for `Span` overload for the ctor to keep the current behavior. Reported by [@nsentinel])(<https://github.com/nsentinel>) in [#210](https://github.com/linkdotnet/StringBuilder/issues/210).
+- Optimised `AppendLine(scoped ReadOnlySpan<char>)` by avoiding allocating a new string
+- Removed erroneous null check in `AppendJoin<T>(ReadOnlySpan<char>, IEnumerable<T>)`
+
 ## [1.22.0] - 2024-12-18
 
 ### Added
@@ -418,7 +438,8 @@ This release brings extensions to the `ValueStringBuilder` API. For `v1.0` the `
 
 - Initial release
 
-[unreleased]: https://github.com/linkdotnet/StringBuilder/compare/1.22.0...HEAD
+[unreleased]: https://github.com/linkdotnet/StringBuilder/compare/2.0.0...HEAD
+[2.0.0]: https://github.com/linkdotnet/StringBuilder/compare/1.22.0...2.0.0
 [1.22.0]: https://github.com/linkdotnet/StringBuilder/compare/1.21.1...1.22.0
 [1.21.1]: https://github.com/linkdotnet/StringBuilder/compare/1.21.0...1.21.1
 [1.21.0]: https://github.com/linkdotnet/StringBuilder/compare/1.20.0...1.21.0
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 	<ItemGroup>
-      <PackageReference Include="SonarAnalyzer.CSharp" Version="10.3.0.106239">
+      <PackageReference Include="SonarAnalyzer.CSharp" Version="10.4.0.108396">
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
diff --git a/README.md b/README.md
@@ -74,3 +74,11 @@ Another benchmark shows that this `ValueStringBuilder` uses less memory when it
 ```
 
 Checkout the [Benchmark](tests/LinkDotNet.StringBuilder.Benchmarks) for a more detailed comparison and setup.
+
+## Support & Contributing
+
+Thanks to all [contributors](https://github.com/linkdotnet/StringBuilder/graphs/contributors) and people that are creating bug-reports and valuable input:
+
+<a href="https://github.com/linkdotnet/StringBuilder/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=linkdotnet/StringBuilder" alt="Supporters" />
+</a>
diff --git a/src/LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj b/src/LinkDotNet.StringBuilder/LinkDotNet.StringBuilder.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
@@ -37,10 +37,11 @@
 		<EnableNETAnalyzers>true</EnableNETAnalyzers>
 		<AnalysisLevel>8</AnalysisLevel>
 		<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 	</PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Meziantou.Analyzer" Version="2.0.182">
+      <PackageReference Include="Meziantou.Analyzer" Version="2.0.184">
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
diff --git a/src/LinkDotNet.StringBuilder/StringSyntaxAttribute.cs b/src/LinkDotNet.StringBuilder/StringSyntaxAttribute.cs
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.Append.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.Append.cs
@@ -1,5 +1,6 @@
 ﻿using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
+using System.Text;
 
 namespace LinkDotNet.StringBuilder;
 
@@ -117,6 +118,20 @@ public void Append(char value)
         bufferPosition++;
     }
 
+    /// <summary>
+    /// Appends a single rune to the string builder.
+    /// </summary>
+    /// <param name="value">Rune to add.</param>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void Append(Rune value)
+    {
+        Span<char> valueChars = stackalloc char[2];
+        int valueCharsWritten = value.EncodeToUtf16(valueChars);
+        ReadOnlySpan<char> valueCharsReadOnly = valueChars[..valueCharsWritten];
+
+        Append(valueCharsReadOnly);
+    }
+
     /// <summary>
     /// Adds the default new line separator.
     /// </summary>
@@ -129,11 +144,12 @@ public void AppendLine()
     /// <summary>
     /// Does the same as <see cref="Append(char)"/> but adds a newline at the end.
     /// </summary>
-    /// <param name="str">String, which will be added to this builder.</param>
+    /// <param name="str">String to be added to this builder.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendLine(scoped ReadOnlySpan<char> str)
     {
-        Append(string.Concat(str, Environment.NewLine));
+        Append(str);
+        Append(Environment.NewLine);
     }
 
     /// <summary>
@@ -144,7 +160,7 @@ public void AppendLine(scoped ReadOnlySpan<char> str)
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public Span<char> AppendSpan(int length)
     {
-        int origPos = bufferPosition;
+        var origPos = bufferPosition;
         if (origPos > buffer.Length - length)
         {
             Grow(length);
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.AppendJoin.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.AppendJoin.cs
@@ -1,4 +1,5 @@
 using System.Runtime.CompilerServices;
+using System.Text;
 
 namespace LinkDotNet.StringBuilder;
 
@@ -8,7 +9,7 @@ public ref partial struct ValueStringBuilder
     /// Concatenates and appends all values with the given separator between each entry at the end of the string.
     /// </summary>
     /// <param name="separator">String used as separator between the entries.</param>
-    /// <param name="values">Array of strings, which will be concatenated.</param>
+    /// <param name="values">Enumerable of strings to be concatenated.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendJoin(ReadOnlySpan<char> separator, IEnumerable<string?> values)
         => AppendJoinInternalString(separator, values);
@@ -17,17 +18,26 @@ public void AppendJoin(ReadOnlySpan<char> separator, IEnumerable<string?> values
     /// Concatenates and appends all values with the given separator between each entry at the end of the string.
     /// </summary>
     /// <param name="separator">Character used as separator between the entries.</param>
-    /// <param name="values">Array of strings, which will be concatenated.</param>
+    /// <param name="values">Enumerable of strings to be concatenated.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendJoin(char separator, IEnumerable<string?> values)
         => AppendJoinInternalChar(separator, values);
 
+    /// <summary>
+    /// Concatenates and appends all values with the given separator between each entry at the end of the string.
+    /// </summary>
+    /// <param name="separator">Rune used as separator between the entries.</param>
+    /// <param name="values">Enumerable of strings to be concatenated.</param>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void AppendJoin(Rune separator, IEnumerable<string?> values)
+        => AppendJoinInternalRune(separator, values);
+
     /// <summary>
     /// Concatenates and appends all values with the given separator between each entry at the end of the string.
     /// </summary>
     /// <param name="separator">String used as separator between the entries.</param>
-    /// <param name="values">Array of strings, which will be concatenated.</param>
-    /// <typeparam name="T">Type of the given array.</typeparam>
+    /// <param name="values">Enumerable to be concatenated.</param>
+    /// <typeparam name="T">Type of the given enumerable.</typeparam>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendJoin<T>(ReadOnlySpan<char> separator, IEnumerable<T> values)
         => AppendJoinInternalString(separator, values);
@@ -36,12 +46,22 @@ public void AppendJoin<T>(ReadOnlySpan<char> separator, IEnumerable<T> values)
     /// Concatenates and appends all values with the given separator between each entry at the end of the string.
     /// </summary>
     /// <param name="separator">Character used as separator between the entries.</param>
-    /// <param name="values">Array of strings, which will be concatenated.</param>
-    /// <typeparam name="T">Type of the given array.</typeparam>
+    /// <param name="values">Enumerable to be concatenated.</param>
+    /// <typeparam name="T">Type of the given enumerable.</typeparam>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public void AppendJoin<T>(char separator, IEnumerable<T> values)
         => AppendJoinInternalChar(separator, values);
 
+    /// <summary>
+    /// Concatenates and appends all values with the given separator between each entry at the end of the string.
+    /// </summary>
+    /// <param name="separator">Rune used as separator between the entries.</param>
+    /// <param name="values">Enumerable to be concatenated.</param>
+    /// <typeparam name="T">Type of the given enumerable.</typeparam>
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    public void AppendJoin<T>(Rune separator, IEnumerable<T> values)
+        => AppendJoinInternalRune(separator, values);
+
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     private void AppendJoinInternalString<T>(ReadOnlySpan<char> separator, IEnumerable<T> values)
     {
@@ -55,10 +75,7 @@ private void AppendJoinInternalString<T>(ReadOnlySpan<char> separator, IEnumerab
         }
 
         var current = enumerator.Current;
-        if (current is not null)
-        {
-            AppendInternal(current);
-        }
+        AppendInternal(current);
 
         while (enumerator.MoveNext())
         {
@@ -91,6 +108,29 @@ private void AppendJoinInternalChar<T>(char separator, IEnumerable<T> values)
         }
     }
 
+    [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    private void AppendJoinInternalRune<T>(Rune separator, IEnumerable<T> values)
+    {
+        ArgumentNullException.ThrowIfNull(values);
+
+        using var enumerator = values.GetEnumerator();
+
+        if (!enumerator.MoveNext())
+        {
+            return;
+        }
+
+        var current = enumerator.Current;
+        AppendInternal(current);
+
+        while (enumerator.MoveNext())
+        {
+            Append(separator);
+            current = enumerator.Current;
+            AppendInternal(current);
+        }
+    }
+
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     private void AppendInternal<T>(T value)
     {
diff --git a/src/LinkDotNet.StringBuilder/ValueStringBuilder.cs b/src/LinkDotNet.StringBuilder/ValueStringBuilder.cs
@@ -36,6 +36,9 @@ public ValueStringBuilder()
     /// </summary>
     /// <param name="initialBuffer">Initial buffer for the string builder to begin with.</param>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
+#if NET9_0_OR_GREATER
+    [OverloadResolutionPriority(1)]
+#endif
     public ValueStringBuilder(Span<char> initialBuffer)
     {
         bufferPosition = 0;
diff --git a/tests/LinkDotNet.StringBuilder.Benchmarks/LinkDotNet.StringBuilder.Benchmarks.csproj b/tests/LinkDotNet.StringBuilder.Benchmarks/LinkDotNet.StringBuilder.Benchmarks.csproj
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <IsPackable>false</IsPackable>
diff --git a/tests/LinkDotNet.StringBuilder.UnitTests/LinkDotNet.StringBuilder.UnitTests.csproj b/tests/LinkDotNet.StringBuilder.UnitTests/LinkDotNet.StringBuilder.UnitTests.csproj
@@ -1,21 +1,21 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
         <Nullable>enable</Nullable>
         <IsPackable>false</IsPackable>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="FluentAssertions" Version="6.12.2" />
+        <PackageReference Include="FluentAssertions" Version="7.0.0" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
-        <PackageReference Include="xunit" Version="2.9.2" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
+        <PackageReference Include="xunit.v3" Version="1.0.0" />
+        <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
-        <PackageReference Include="coverlet.collector" Version="6.0.2">
+        <PackageReference Include="coverlet.collector" Version="6.0.3">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>
