Update package Cysharp.ZString to v2.5.1 (#368)

Author: axunonb

src/SmartFormat.ZString/SmartFormat.ZString.csproj

@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <TargetFrameworks>netstandard2.0;netstandard2.1;net461</TargetFrameworks>
-        <!-- Current Cysharp.ZString release version is 2.5.0 -->
+        <!-- Current Cysharp.ZString release version is 2.5.1 -->
         <RootNamespace>SmartFormat.ZString</RootNamespace>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>

src/SmartFormat.ZString/repo/.github/workflows/build-debug.yml

@@ -26,25 +26,23 @@ jobs:
     strategy:
       matrix:
         unity: ["2021.3.11f1"]
-        include:
-          - unity: 2021.3.11f1
-            license: UNITY_LICENSE_2021
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
       - uses: actions/checkout@v3
       # Execute scripts: Export Package
       # /opt/Unity/Editor/Unity -quit -batchmode -nographics -silent-crashes -logFile -projectPath . -executeMethod PackageExporter.Export
-      - name: Export unitypackage
-        uses: game-ci/unity-builder@v2
+      - name: Build Unity (.unitypacakge)
+        uses: Cysharp/Actions/.github/actions/unity-builder@main
         env:
-          UNITY_LICENSE: ${{ secrets[matrix.license] }}
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+          UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
         with:
           projectPath: src/ZString.Unity
           unityVersion: ${{ matrix.unity }}
           targetPlatform: StandaloneLinux64
           buildMethod: PackageExporter.Export
-          versioning: None
 
       - uses: Cysharp/Actions/.github/actions/check-metas@main # check meta files
         with:

src/SmartFormat.ZString/repo/.github/workflows/build-release.yml

@@ -52,9 +52,6 @@ jobs:
     strategy:
       matrix:
         unity: ["2021.3.11f1"]
-        include:
-          - unity: 2021.3.11f1
-            license: UNITY_LICENSE_2021
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
@@ -63,17 +60,18 @@ jobs:
           ref: ${{ needs.update-packagejson.outputs.sha }}
       # Execute scripts: Export Package
       # /opt/Unity/Editor/Unity -quit -batchmode -nographics -silent-crashes -logFile -projectPath . -executeMethod PackageExporter.Export
-      - name: Export unitypackage
-        uses: game-ci/unity-builder@v2
+      - name: Build Unity (.unitypacakge)
+        uses: Cysharp/Actions/.github/actions/unity-builder@main
         env:
-          UNITY_LICENSE: ${{ secrets[matrix.license] }}
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+          UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
           UNITY_PACKAGE_VERSION: ${{ env.GIT_TAG }}
         with:
           projectPath: src/ZString.Unity
           unityVersion: ${{ matrix.unity }}
           targetPlatform: StandaloneLinux64
           buildMethod: PackageExporter.Export
-          versioning: None
 
       - uses: Cysharp/Actions/.github/actions/check-metas@main # check meta files
         with:

src/SmartFormat.ZString/repo/.github/workflows/prevent-github-change.yml

@@ -0,0 +1,10 @@
+name: Prevent github change
+on:
+  pull_request:
+    paths:
+      - ".github/**/*.yaml"
+      - ".github/**/*.yml"
+
+jobs:
+  detect:
+    uses: Cysharp/Actions/.github/workflows/prevent-github-change.yaml@main

src/SmartFormat.ZString/repo/README.md

@@ -40,7 +40,6 @@ Related project for loggin using with ZString, [Cysharp/ZLogger](https://github.
 - [Getting Started](#getting-started)
 - [Reference](#reference)
 - [Unity](#unity)
-  - [Install via git URL](#install-via-git-url)
 - [Advanced Tips](#advanced-tips)
 - [License](#license)
 
@@ -197,29 +196,15 @@ It's important to make sure the writer is always properly disposed.
 
 Unity
 ---
-In Unity, if you encount the following error 
+Install via UPM git URL package or asset package(ZString...*.unitypackage) available in [ZString/releases](https://github.com/Cysharp/ZString/releases) page.
 
-```
-The type 'Unsafe' exists in both 'System.Runtime.CompilerServices.Unsafe, Version=4.0.6.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' and 'System.Runtime.CompilerServices.Unsafe, Version=4.0.4.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'
-```
-
-This is caused from dll conflict, for example `Unity Collections` package includes `System.Runtime.CompilerServices.Unsafe.dll` but ZString provides `System.Runtime.CompilerServices.Unsafe.dll` to `Plugins`.
-
-Detail of issue in Unity Forum - [[Bug 1214643][2019.3.0f5] System.Runtime.CompilerServices.Unsafe clashes with imported dll](https://forum.unity.com/threads/bug-1214643-2019-3-0f5-system-runtime-compilerservices-unsafe-clashes-with-imported-dll.816426/)
-
-Workround:
-- Copy Collections from Library/PackageCache to %Project Folder%/Packages
-- Remove CompilerServices.Unsafe dll from said folder
-
-### Install via git URL
-
-You can add `https://github.com/Cysharp/ZString.git?path=src/ZString.Unity/Assets/Scripts/ZString` to Package Manager.
+* `https://github.com/Cysharp/ZString.git?path=src/ZString.Unity/Assets/Scripts/ZString`
 
-You can install managed DLL from package mangers's samples Import button.
+If you want to set a target version, ZString uses the `*.*.*` release tag so you can specify a version like #2.4.0. For example `https://github.com/Cysharp/ZString.git?path=src/ZString.Unity/Assets/Scripts/ZString#2.4.0`.
 
-![image](https://user-images.githubusercontent.com/46207/113681776-56145f00-96fd-11eb-8227-560da9c1a092.png)
+Supporting minimum Unity version is 2021.3. The dependency managed DLL `System.Runtime.CompilerServices.Unsafe/6.0.0` is included with unitypackage. For git references, you will need to add them in another way as they are not included to avoid unnecessary dependencies; either extract the dll from unitypackage or download it from the [NuGet page](https://www.nuget.org/packages/System.Runtime.CompilerServices.Unsafe/6.0.0).
 
-If you want to set a target version, ZString uses the *.*.* release tag so you can specify a version like #2.4.0. For example https://github.com/Cysharp/ZString.git?path=src/ZString.Unity/Assets/Scripts/ZString#2.4.0.
+TextMeshPro support is automatically enabled when importing the `com.unity.textmeshpro` package from package manager. (If you do not use the package manager, define the scripting define symbol `ZSTRING_TEXTMESHPRO_SUPPORT` to enable it.)
 
 Advanced Tips
 ---

src/SmartFormat.ZString/repo/sandbox/ConsoleApp/ConsoleApp.csproj

@@ -2,15 +2,18 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFramework>net6.0</TargetFramework>
+		<TargetFramework>net7.0</TargetFramework>
 		<SignAssembly>true</SignAssembly>
 		<AssemblyOriginatorKeyFile>../../opensource.snk</AssemblyOriginatorKeyFile>
 		<IsPackable>false</IsPackable>
 	</PropertyGroup>
 
 	<ItemGroup>
+		<PackageReference Include="BenchmarkDotNet" Version="0.12.1" />
 		<PackageReference Include="System.Text.Json" Version="4.7.1" />
-		<ProjectReference Include="..\..\src\ZString\ZString.csproj" />
+		<ProjectReference Include="..\..\src\ZString\ZString.csproj">
+			<SetTargetFramework>TargetFramework=netstandard2.1</SetTargetFramework>
+		</ProjectReference>
 	</ItemGroup>
 
 </Project>

src/SmartFormat.ZString/repo/sandbox/ConsoleApp/Program.cs

@@ -1,13 +1,8 @@
 using Cysharp.Text;
 using System;
-using System.Buffers;
-using System.Collections.Concurrent;
-using System.Linq;
 using System.Text;
-// using System.Text.Formatting;
-using System.Text.Json;
-using System.Threading;
-using System.Threading.Tasks;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Running;
 
 namespace ConsoleApp
 {
@@ -20,19 +15,34 @@ class Program
     {
         static void Main(string[] args)
         {
+            // BenchmarkRunner.Run<JoinBenchmark>();
             Run();
         }
 
         static void Run()
         {
+            ZString.Join(",", "a", "b");
             TimeSpan span = new TimeSpan(12, 34, 56);
             Console.WriteLine($"string.Format: {string.Format(@"{0:h\,h\:mm\:ss}", span)}");
-
-
             Console.WriteLine($"ZString.Format: {ZString.Format(@"{0:h\,h\:mm\:ss}", span)}");
+        }
+    }
+    
+    public class JoinBenchmark
+    {
+        public string[] Source = new []{ "111", "222", "333"};
+        public const string Sp = ",";
 
+        [Benchmark]
+        public string StringJoin()
+        {
+            return string.Join(Sp, Source);
+        }
 
-
+        [Benchmark]
+        public string ZStringJoin() 
+        {
+            return ZString.Join(Sp, Source);
         }
     }
 

src/SmartFormat.ZString/repo/src/ZString.Unity/Assets/Scripts/ZString/EnumUtil.cs

@@ -16,7 +16,12 @@ internal static class EnumUtil<T>
         static EnumUtil()
         {
             var enumNames = Enum.GetNames(typeof(T));
-            var values = Enum.GetValues(typeof(T));
+            var values =
+#if NET7_0_OR_GREATER
+                Enum.GetValuesAsUnderlyingType(typeof(T));
+#else
+                Enum.GetValues(typeof(T));
+#endif
             names = new Dictionary<T, string>(enumNames.Length);
             utf8names = new Dictionary<T, byte[]>(enumNames.Length);
             for (int i = 0; i < enumNames.Length; i++)

src/SmartFormat.ZString/repo/src/ZString.Unity/Assets/Scripts/ZString/Unity/TextMeshProExtensions.SetStringBuilder.cs

@@ -1,4 +1,5 @@
-using System;
+#if ZSTRING_TEXTMESHPRO_SUPPORT
+using System;
 using TMPro;
 
 namespace Cysharp.Text
@@ -12,3 +13,4 @@ public static void SetText(this TMP_Text text, Utf16ValueStringBuilder stringBui
         }
     }
 }
+#endif

src/SmartFormat.ZString/repo/src/ZString.Unity/Assets/Scripts/ZString/Unity/TextMeshProExtensions.cs

@@ -1,4 +1,5 @@
-using System;
+#if ZSTRING_TEXTMESHPRO_SUPPORT
+using System;
 using TMPro;
 
 namespace Cysharp.Text
@@ -193,3 +194,4 @@ public static void SetTextFormat<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T1
 
     }
 }
+#endif