Merge pull request #539 from Shane32/trimmable

codebude · web-flow · commit 8bfcf407f15a · 2024-05-28T22:15:26.000+02:00
Make QRCoder trimmable and add trimming tests
diff --git a/.github/workflows/wf-build-test.yml b/.github/workflows/wf-build-test.yml
@@ -86,7 +86,11 @@ jobs:
     - name: Run test .NET 6.0 Windows
       working-directory: QRCoderTests
       run: dotnet test -c Release -f net6.0-windows --nologo --no-build /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
-    
+
+    - name: Run trim analysis
+      working-directory: QRCoderTrimAnalysis
+      run: dotnet publish -c Release -o bin/publish
+
     - name: Run API approval tests
       working-directory: QRCoderApiTests
       run: dotnet test -c Release --nologo --no-build
diff --git a/QRCoder.sln b/QRCoder.sln
@@ -15,9 +15,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "QRCoderTests", "QRCoderTest
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "QRCoder.Xaml", "QRCoder.Xaml\QRCoder.Xaml.csproj", "{A7A7E073-2504-4BA2-A63B-87AC34174789}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QRCoderApiTests", "QRCoderApiTests\QRCoderApiTests.csproj", "{5FACE5F6-53C9-4B89-91D4-162677893574}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "QRCoderApiTests", "QRCoderApiTests\QRCoderApiTests.csproj", "{5FACE5F6-53C9-4B89-91D4-162677893574}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QRCoderBenchmarks", "QRCoderBenchmarks\QRCoderBenchmarks.csproj", "{C33AB74A-2AB3-4BEA-A67F-EAB578E74E25}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "QRCoderBenchmarks", "QRCoderBenchmarks\QRCoderBenchmarks.csproj", "{C33AB74A-2AB3-4BEA-A67F-EAB578E74E25}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "QRCoderTrimAnalysis", "QRCoderTrimAnalysis\QRCoderTrimAnalysis.csproj", "{F046136A-7BEA-49F3-9415-70CE50AD533B}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -155,6 +157,22 @@ Global
 		{C33AB74A-2AB3-4BEA-A67F-EAB578E74E25}.Release|x64.Build.0 = Release|Any CPU
 		{C33AB74A-2AB3-4BEA-A67F-EAB578E74E25}.Release|x86.ActiveCfg = Release|Any CPU
 		{C33AB74A-2AB3-4BEA-A67F-EAB578E74E25}.Release|x86.Build.0 = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|ARM.ActiveCfg = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|ARM.Build.0 = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|x64.Build.0 = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Debug|x86.Build.0 = Debug|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|ARM.ActiveCfg = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|ARM.Build.0 = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|x64.ActiveCfg = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|x64.Build.0 = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|x86.ActiveCfg = Release|Any CPU
+		{F046136A-7BEA-49F3-9415-70CE50AD533B}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/QRCoder/Extensions/StringValueAttribute.cs b/QRCoder/Extensions/StringValueAttribute.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Reflection;
 using System.Text;
@@ -9,6 +10,7 @@ namespace QRCoder.Extensions
     /// <summary>
     /// Used to represent a string value for a value in an enum
     /// </summary>
+    [Obsolete("This attribute will be removed in a future version of QRCoder.")]
     public class StringValueAttribute : Attribute
     {
 
@@ -31,13 +33,17 @@ public StringValueAttribute(string value)
         }        
     }
 
+    [Obsolete("This class will be removed in a future version of QRCoder.")]
     public static class CustomExtensions
     {
         /// <summary>
         /// Will get the string value for a given enum's value
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>
+#if NET6_0_OR_GREATER
+        [RequiresUnreferencedCode("This method uses reflection to examine the provided enum value.")]
+#endif
         public static string GetStringValue(this Enum value)
         {            
 #if NETSTANDARD1_3
diff --git a/QRCoder/PayloadGenerator.cs b/QRCoder/PayloadGenerator.cs
@@ -4,6 +4,7 @@
 using System.Globalization;
 using System.Text;
 using System.Text.RegularExpressions;
+using System.Diagnostics.CodeAnalysis;
 #if NETSTANDARD1_3
 using System.Reflection;
 #endif
@@ -2477,14 +2478,12 @@ public class RussiaPaymentOrder : Payload
 
             //base
             private CharacterSets characterSet;
-            private MandatoryFields mFields;
-            private OptionalFields oFields;
+            private readonly MandatoryFields mFields = new MandatoryFields();
+            private readonly OptionalFields oFields = new OptionalFields();
             private string separator = "|";
 
             private RussiaPaymentOrder()
             {
-                mFields = new MandatoryFields();
-                oFields = new OptionalFields();
             }
 
             /// <summary>
@@ -2596,7 +2595,7 @@ private string DetermineSeparator()
             private List<string> GetOptionalFieldsAsList()
             {
 #if NETSTANDARD1_3
-                return oFields.GetType().GetRuntimeProperties()
+                return typeof(OptionalFields).GetRuntimeProperties()
                         .Where(field => field.GetValue(oFields) != null)
                         .Select(field => {
                             var objValue = field.GetValue(oFields, null);
@@ -2605,7 +2604,7 @@ private List<string> GetOptionalFieldsAsList()
                         })
                         .ToList();
 #else
-                return oFields.GetType().GetProperties()
+                return typeof(OptionalFields).GetProperties()
                         .Where(field => field.GetValue(oFields, null) != null)
                         .Select(field => {
                             var objValue = field.GetValue(oFields, null);
@@ -2624,7 +2623,7 @@ private List<string> GetOptionalFieldsAsList()
             private List<string> GetMandatoryFieldsAsList()
             {
 #if NETSTANDARD1_3
-                return mFields.GetType().GetRuntimeFields()
+                return typeof(MandatoryFields).GetRuntimeFields()
                         .Where(field => field.GetValue(mFields) != null)
                         .Select(field => {
                             var objValue = field.GetValue(mFields);
@@ -2633,7 +2632,7 @@ private List<string> GetMandatoryFieldsAsList()
                         })
                         .ToList();
 #else
-                return mFields.GetType().GetFields()
+                return typeof(MandatoryFields).GetFields()
                         .Where(field => field.GetValue(mFields) != null)
                         .Select(field => {
                             var objValue = field.GetValue(mFields);
diff --git a/QRCoder/QRCoder.csproj b/QRCoder/QRCoder.csproj
@@ -8,6 +8,7 @@
     <DefineConstants Condition="'$(TargetFramework)' == 'net6.0-windows'">$(DefineConstants);NET6_0_WINDOWS</DefineConstants>
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
     <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder>
+	<IsTrimmable Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))">true</IsTrimmable>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
diff --git a/QRCoder/SvgQRCode.cs b/QRCoder/SvgQRCode.cs
@@ -362,7 +362,7 @@ public MediaType GetMediaType()
             /// <returns></returns>
             public string GetDataUri()
             {
-                return $"data:{_mediaType.GetStringValue()};base64,{_logoData}";
+                return $"data:{GetMimeType(_mediaType)};base64,{_logoData}";
             }
 
             /// <summary>
@@ -388,11 +388,29 @@ public bool FillLogoBackground()
             /// </summary>
             public enum MediaType : int
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 [StringValue("image/png")]
-                PNG = 0, 
+#pragma warning restore CS0618 // Type or member is obsolete
+                PNG = 0,
+#pragma warning disable CS0618 // Type or member is obsolete
                 [StringValue("image/svg+xml")]
+#pragma warning restore CS0618 // Type or member is obsolete
                 SVG = 1
             }
+
+            private string GetMimeType(MediaType type)
+            {
+                switch (type)
+                {
+                    case MediaType.PNG:
+                        return "image/png";
+                    case MediaType.SVG:
+                        return "image/svg+xml";
+                    default:
+                        throw new ArgumentOutOfRangeException(nameof(type));
+                }
+            }
+                
         }
     }
 
diff --git a/QRCoderApiTests/net35+net40+net50+net50-windows+netstandard20/QRCoder.approved.txt b/QRCoderApiTests/net35+net40+net50+net50-windows+netstandard20/QRCoder.approved.txt
@@ -967,10 +967,12 @@ namespace QRCoder.Exceptions
 }
 namespace QRCoder.Extensions
 {
+    [System.Obsolete("This class will be removed in a future version of QRCoder.")]
     public static class CustomExtensions
     {
         public static string GetStringValue(this System.Enum value) { }
     }
+    [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]
     public class StringValueAttribute : System.Attribute
     {
         public StringValueAttribute(string value) { }
diff --git a/QRCoderApiTests/net60-windows/QRCoder.approved.txt b/QRCoderApiTests/net60-windows/QRCoder.approved.txt
@@ -977,10 +977,13 @@ namespace QRCoder.Exceptions
 }
 namespace QRCoder.Extensions
 {
+    [System.Obsolete("This class will be removed in a future version of QRCoder.")]
     public static class CustomExtensions
     {
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("This method uses reflection to examine the provided enum value.")]
         public static string GetStringValue(this System.Enum value) { }
     }
+    [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]
     public class StringValueAttribute : System.Attribute
     {
         public StringValueAttribute(string value) { }
diff --git a/QRCoderApiTests/net60/QRCoder.approved.txt b/QRCoderApiTests/net60/QRCoder.approved.txt
@@ -904,10 +904,13 @@ namespace QRCoder.Exceptions
 }
 namespace QRCoder.Extensions
 {
+    [System.Obsolete("This class will be removed in a future version of QRCoder.")]
     public static class CustomExtensions
     {
+        [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("This method uses reflection to examine the provided enum value.")]
         public static string GetStringValue(this System.Enum value) { }
     }
+    [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]
     public class StringValueAttribute : System.Attribute
     {
         public StringValueAttribute(string value) { }
diff --git a/QRCoderApiTests/netstandard13/QRCoder.approved.txt b/QRCoderApiTests/netstandard13/QRCoder.approved.txt
@@ -831,10 +831,12 @@ namespace QRCoder.Exceptions
 }
 namespace QRCoder.Extensions
 {
+    [System.Obsolete("This class will be removed in a future version of QRCoder.")]
     public static class CustomExtensions
     {
         public static string GetStringValue(this System.Enum value) { }
     }
+    [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]
     public class StringValueAttribute : System.Attribute
     {
         public StringValueAttribute(string value) { }
diff --git a/QRCoderTrimAnalysis/Program.cs b/QRCoderTrimAnalysis/Program.cs
@@ -0,0 +1,2 @@
+﻿// See https://aka.ms/new-console-template for more information
+Console.WriteLine("Hello, World!");
diff --git a/QRCoderTrimAnalysis/QRCoderTrimAnalysis.csproj b/QRCoderTrimAnalysis/QRCoderTrimAnalysis.csproj
@@ -0,0 +1,21 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <!-- This project, when published, verifies that QRCoder is trimmable; see below link for more details. -->
+  <!-- https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/prepare-libraries-for-trimming -->
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+	<PublishTrimmed>true</PublishTrimmed>
+	<TreatWarningsAsErrors>true</TreatWarningsAsErrors><!-- Ensure that trim warnings cause the publish to fail -->
+	<IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\QRCoder\QRCoder.csproj" />
+	<TrimmerRootAssembly Include="QRCoder" />
+  </ItemGroup>
+
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using System.Diagnostics.CodeAnalysis;`
`3`	`4`	`using System.Linq;`
`4`	`5`	`using System.Reflection;`
`5`	`6`	`using System.Text;`
`@@ -9,6 +10,7 @@ namespace QRCoder.Extensions`
`9`	`10`	`/// <summary>`
`10`	`11`	`/// Used to represent a string value for a value in an enum`
`11`	`12`	`/// </summary>`
	`13`	`+ [Obsolete("This attribute will be removed in a future version of QRCoder.")]`
`12`	`14`	`public class StringValueAttribute : Attribute`
`13`	`15`	`{`
`14`	`16`
`@@ -31,13 +33,17 @@ public StringValueAttribute(string value)`
`31`	`33`	`}`
`32`	`34`	`}`
`33`	`35`
	`36`	`+ [Obsolete("This class will be removed in a future version of QRCoder.")]`
`34`	`37`	`public static class CustomExtensions`
`35`	`38`	`{`
`36`	`39`	`/// <summary>`
`37`	`40`	`/// Will get the string value for a given enum's value`
`38`	`41`	`/// </summary>`
`39`	`42`	`/// <param name="value"></param>`
`40`	`43`	`/// <returns></returns>`
	`44`	`+#if NET6_0_OR_GREATER`
	`45`	`+ [RequiresUnreferencedCode("This method uses reflection to examine the provided enum value.")]`
	`46`	`+#endif`
`41`	`47`	`public static string GetStringValue(this Enum value)`
`42`	`48`	`{`
`43`	`49`	`#if NETSTANDARD1_3`
Original file line number	Diff line number	Diff line change
`@@ -967,10 +967,12 @@ namespace QRCoder.Exceptions`
`967`	`967`	`}`
`968`	`968`	`namespace QRCoder.Extensions`
`969`	`969`	`{`
	`970`	`+ [System.Obsolete("This class will be removed in a future version of QRCoder.")]`
`970`	`971`	`public static class CustomExtensions`
`971`	`972`	`{`
`972`	`973`	`public static string GetStringValue(this System.Enum value) { }`
`973`	`974`	`}`
	`975`	`+ [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]`
`974`	`976`	`public class StringValueAttribute : System.Attribute`
`975`	`977`	`{`
`976`	`978`	`public StringValueAttribute(string value) { }`
Original file line number	Diff line number	Diff line change
`@@ -977,10 +977,13 @@ namespace QRCoder.Exceptions`
`977`	`977`	`}`
`978`	`978`	`namespace QRCoder.Extensions`
`979`	`979`	`{`
	`980`	`+ [System.Obsolete("This class will be removed in a future version of QRCoder.")]`
`980`	`981`	`public static class CustomExtensions`
`981`	`982`	`{`
	`983`	`+ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("This method uses reflection to examine the provided enum value.")]`
`982`	`984`	`public static string GetStringValue(this System.Enum value) { }`
`983`	`985`	`}`
	`986`	`+ [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]`
`984`	`987`	`public class StringValueAttribute : System.Attribute`
`985`	`988`	`{`
`986`	`989`	`public StringValueAttribute(string value) { }`
Original file line number	Diff line number	Diff line change
`@@ -904,10 +904,13 @@ namespace QRCoder.Exceptions`
`904`	`904`	`}`
`905`	`905`	`namespace QRCoder.Extensions`
`906`	`906`	`{`
	`907`	`+ [System.Obsolete("This class will be removed in a future version of QRCoder.")]`
`907`	`908`	`public static class CustomExtensions`
`908`	`909`	`{`
	`910`	`+ [System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("This method uses reflection to examine the provided enum value.")]`
`909`	`911`	`public static string GetStringValue(this System.Enum value) { }`
`910`	`912`	`}`
	`913`	`+ [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]`
`911`	`914`	`public class StringValueAttribute : System.Attribute`
`912`	`915`	`{`
`913`	`916`	`public StringValueAttribute(string value) { }`
Original file line number	Diff line number	Diff line change
`@@ -831,10 +831,12 @@ namespace QRCoder.Exceptions`
`831`	`831`	`}`
`832`	`832`	`namespace QRCoder.Extensions`
`833`	`833`	`{`
	`834`	`+ [System.Obsolete("This class will be removed in a future version of QRCoder.")]`
`834`	`835`	`public static class CustomExtensions`
`835`	`836`	`{`
`836`	`837`	`public static string GetStringValue(this System.Enum value) { }`
`837`	`838`	`}`
	`839`	`+ [System.Obsolete("This attribute will be removed in a future version of QRCoder.")]`
`838`	`840`	`public class StringValueAttribute : System.Attribute`
`839`	`841`	`{`
`840`	`842`	`public StringValueAttribute(string value) { }`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// See https://aka.ms/new-console-template for more information`
	`2`	`+Console.WriteLine("Hello, World!");`