Merge pull request #306 from BinaryKits/develop

Merge develop into master

Author: primo-ppcg

.gitattributes

@@ -1,2 +1,3 @@
-# 2011
-src/BinaryKits.Zpl.Label.UnitTest/ZplData/*.txt text eol=lf
+* text=auto
+src/BinaryKits.Zpl.Label.UnitTest/ZplData/*.txt text eol=lf
+*.png binary

.github/workflows/deploy_binarykits-zpl-viewer.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Set up .NET Core
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '6.0.x'
+        dotnet-version: '8.0.x'
 
     - name: Build with dotnet
       working-directory: ./src/BinaryKits.Zpl.Viewer.WebApi

.github/workflows/dotnet - test.yml

@@ -13,10 +13,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 6.0
+    - name: Setup .NET 8.0
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
     - name: Restore dependencies
       working-directory: ./src
       run: dotnet restore
@@ -33,10 +33,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 6.0
+    - name: Setup .NET 8.0
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
     - name: Restore dependencies
       working-directory: ./src
       run: dotnet restore

.github/workflows/dotnet.yml

@@ -13,10 +13,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 6.0
+    - name: Setup .NET 8.0
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
     - name: Restore dependencies
       working-directory: ./src
       run: dotnet restore
@@ -33,10 +33,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 6.0
+    - name: Setup .NET 8.0
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: 6.0.x
+        dotnet-version: 8.0.x
     - name: Restore dependencies
       working-directory: ./src
       run: dotnet restore

README.md

@@ -307,3 +307,4 @@ foreach (var labelInfo in analyzeInfo.LabelInfos)
 | JavaScript | [JSZPL](https://github.com/DanieLeeuwner/JSZPL) |
 | .NET | [sharpzebra](https://github.com/rkone/sharpzebra) |
 | .NET | [PDFtoZPL](https://github.com/sungaila/PDFtoZPL) |
+| .NET | [ZPL2PDF](https://github.com/brunoleocam/ZPL2PDF) |

src/.editorconfig

@@ -28,6 +28,8 @@ csharp_new_line_before_else = true
 csharp_new_line_before_members_in_object_initializers = true
 #require braces to be on a new line for methods, object_collection_array_initializers, control_blocks, and types (also known as "Allman" style)
 csharp_new_line_before_open_brace = methods, object_collection_array_initializers, control_blocks, types
+dotnet_style_allow_multiple_blank_lines_experimental = false:suggestion
+dotnet_style_allow_statement_immediately_after_block_experimental = false:suggestion
 
 #Formatting - organize using options
 
@@ -81,15 +83,16 @@ dotnet_style_predefined_type_for_member_access = true:suggestion
 
 #prefer objects to be initialized using object initializers when possible
 dotnet_style_object_initializer = true:suggestion
+dotnet_style_prefer_collection_expression = when_types_exactly_match
 
 #Style - implicit and explicit types
 
 #prefer var over explicit type in all cases, unless overridden by another code style rule
-csharp_style_var_elsewhere = true:suggestion
+csharp_style_var_elsewhere = false:warning
 #prefer var is used to declare variables with built-in system types such as int
-csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_for_built_in_types = false:warning
 #prefer var when the type is already mentioned on the right-hand side of a declaration expression
-csharp_style_var_when_type_is_apparent = true:suggestion
+csharp_style_var_when_type_is_apparent = false:warning
 
 #Style - language keyword and framework type options
 
@@ -104,7 +107,7 @@ dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggest
 #Style - Modifier preferences
 
 #when this rule is set to a list of modifiers, prefer the specified ordering.
-csharp_preferred_modifier_order = public,private,protected,override,readonly,static,abstract:suggestion
+csharp_preferred_modifier_order = public,private,protected,internal,override,static,abstract,readonly:suggestion
 
 #Style - Pattern matching
 
@@ -113,9 +116,11 @@ csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
 
 #Style - qualification options
 
-#prefer fields not to be prefaced with this. or Me. in Visual Basic
-dotnet_style_qualification_for_field = false:suggestion
+#prefer fields to be prefaced with this. or Me. in Visual Basic
+dotnet_style_qualification_for_field = true:suggestion
 #prefer methods to be prefaced with this. in C# or Me. in Visual Basic
 dotnet_style_qualification_for_method = true:suggestion
 #prefer properties to be prefaced with this. in C# or Me. in Visual Basic
 dotnet_style_qualification_for_property = true:suggestion
+
+csharp_style_prefer_primary_constructors = false:suggestion

src/BinaryKits.Zpl.Label.UnitTest/BarcodeTest.cs

@@ -21,7 +21,7 @@ public void Barcode39()
 
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
-            Assert.AreEqual("^XA\n^LH0,0\n^CI28\n\n^FO100,100\n^BY2,3\n^B3N,N,100,Y,N\n^FD123ABC^FS\n^XZ", output);
+            Assert.AreEqual("^XA\n^LH0,0\n\n^FO100,100\n^BY2,3\n^B3N,N,100,Y,N\n^FD123ABC^FS\n^XZ", output);
         }
 
         [TestMethod]
@@ -37,7 +37,7 @@ public void Barcode93()
 
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
-            Assert.AreEqual("^XA\n^LH0,0\n^CI28\n\n^FO100,300\n^BY2,3\n^BAN,100,Y,N,N\n^FD123ABC^FS\n^XZ", output);
+            Assert.AreEqual("^XA\n^LH0,0\n\n^FO100,300\n^BY2,3\n^BAN,100,Y,N,N\n^FD123ABC^FS\n^XZ", output);
         }
 
         [TestMethod]
@@ -53,7 +53,7 @@ public void Barcode128()
 
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
-            Assert.AreEqual("^XA\n^LH0,0\n^CI28\n\n^FO100,300\n^BY2,3\n^BCN,100,Y,N\n^FD123ABC^FS\n^XZ", output);
+            Assert.AreEqual("^XA\n^LH0,0\n\n^FO100,300\n^BY2,3\n^BCN,100,Y,N\n^FD123ABC^FS\n^XZ", output);
         }
 
         [TestMethod]
@@ -69,7 +69,39 @@ public void BarcodeEan13()
 
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
-            Assert.AreEqual("^XA\n^LH0,0\n^CI28\n\n^FO100,300\n^BY2,3\n^BEN,100,Y,N\n^FD123456^FS\n^XZ", output);
+            Assert.AreEqual("^XA\n^LH0,0\n\n^FO100,300\n^BY2,3\n^BEN,100,Y,N\n^FD123456^FS\n^XZ", output);
+        }
+
+        [TestMethod]
+        public void DataMatrixDefault()
+        {
+            var elements = new List<ZplElementBase>
+            {
+                new ZplDataMatrix("123ABC", 100, 300)
+            };
+
+            var renderEngine = new ZplEngine(elements);
+            var output = renderEngine.ToZplString(new ZplRenderOptions { AddEmptyLineBeforeElementStart = true });
+
+            Debug.WriteLine(output);
+            Assert.IsNotNull(output);
+            Assert.AreEqual("^XA\n^LH0,0\n\n^FO100,300\n^BXN,100,0\n^FD123ABC^FS\n^XZ", output);
+        }
+
+        [TestMethod]
+        public void DataMatrix200()
+        {
+            var elements = new List<ZplElementBase>
+            {
+                new ZplDataMatrix("123ABC", 100, 300, qualityLevel: QualityLevel.ECC200)
+            };
+
+            var renderEngine = new ZplEngine(elements);
+            var output = renderEngine.ToZplString(new ZplRenderOptions { AddEmptyLineBeforeElementStart = true });
+
+            Debug.WriteLine(output);
+            Assert.IsNotNull(output);
+            Assert.AreEqual("^XA\n^LH0,0\n\n^FO100,300\n^BXN,100,200\n^FD123ABC^FS\n^XZ", output);
         }
     }
 }

src/BinaryKits.Zpl.Label.UnitTest/BinaryKits.Zpl.Label.UnitTest.csproj

@@ -1,19 +1,15 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
-
+    <TargetFramework Condition="$([MSBuild]::IsOSPlatform('Linux'))">net8.0</TargetFramework>
+	<TargetFrameworks Condition="$([MSBuild]::IsOSPlatform('Windows'))">net472;net8.0</TargetFrameworks>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
-    <PackageReference Include="MSTest.TestAdapter" Version="2.2.10" />
-    <PackageReference Include="MSTest.TestFramework" Version="2.2.10" />
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.0.0" />
+    <PackageReference Include="MSTest.TestAdapter" Version="4.0.1" />
+    <PackageReference Include="MSTest.TestFramework" Version="4.0.1" />
   </ItemGroup>
 
   <ItemGroup>
@@ -27,6 +23,9 @@
     <None Update="ZplData\DownloadGraphicsB64.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="ZplData\DownloadGraphicsZ64_net472.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="ZplData\DownloadGraphicsZ64.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

src/BinaryKits.Zpl.Label.UnitTest/DownloadTest.cs

@@ -41,6 +41,7 @@ public void DownloadGraphicsACS()
         [TestMethod]
         [DeploymentItem(@"ZplData/Zpl.png")]
         [DeploymentItem(@"ZplData/DownloadGraphicsZ64.txt")]
+        [DeploymentItem(@"ZplData/DownloadGraphicsZ64_net472.txt")]
         public void DownloadGraphicsZ64()
         {
             var imageData = File.ReadAllBytes("Zpl.png");
@@ -63,7 +64,11 @@ public void DownloadGraphicsZ64()
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
 
+#if NET5_0_OR_GREATER
             var zplData = File.ReadAllText("DownloadGraphicsZ64.txt");
+#else
+            var zplData = File.ReadAllText("DownloadGraphicsZ64_net472.txt");
+#endif
             Assert.AreEqual(zplData, output);
         }
         [TestMethod]

src/BinaryKits.Zpl.Label.UnitTest/EngineTest.cs

@@ -54,7 +54,7 @@ public void ChangeDPI()
 
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
-            Assert.AreEqual("^XA\n^LH0,0\n^CI28\n^FO591,1034\n^GB147,147,7,B,0^FS\n^XZ", output);
+            Assert.AreEqual("^XA\n^LH0,0\n^FO591,1034\n^GB147,147,7,B,0^FS\n^XZ", output);
         }
 
         [TestMethod]
@@ -102,9 +102,9 @@ public void TextFieldVariations()
 
             var elements = new List<ZplElementBase>();
             //Specail character is repalced with space
-            elements.Add(new ZplTextField(sampleText, 10, 10, font, useHexadecimalIndicator: false));
+            elements.Add(new ZplTextField(sampleText, 10, 10, font, hexadecimalIndicator: null));
             //Specail character is using Hex value ^FH
-            elements.Add(new ZplTextField(sampleText, 10, 50, font, useHexadecimalIndicator: true));
+            elements.Add(new ZplTextField(sampleText, 10, 50, font, hexadecimalIndicator: '_'));
             //Only the first line is displayed
             elements.Add(new ZplSingleLineFieldBlock(sampleText, 10, 150, 500, font));
             //Max 2 lines, text exceeding the maximum number of lines overwrites the last line.
@@ -132,7 +132,41 @@ public void WithoutAutoElements()
 
             Debug.WriteLine(output);
             Assert.IsNotNull(output);
-            Assert.AreEqual("^CI28\n^FX\n//A important field\n^A0N,30,30\n^FO50,100\n^FH^FDPure element zpl only^FS", output);
+            Assert.AreEqual("^FX\n//A important field\n^A0N,30,30\n^FO50,100\n^FDPure element zpl only^FS", output);
+        }
+
+        [TestMethod]
+        public void ChangeInternationalFont()
+        {
+            var elements = new List<ZplElementBase>() {
+                new ZplChangeInternationalFont(InternationalFont.ZCP1252),
+                new ZplTextField("Straße", 10, 10, ZplConstants.Font.Default, hexadecimalIndicator: '_'),
+            };
+
+            var renderEngine = new ZplEngine(elements);
+            var output = renderEngine.ToZplString(new ZplRenderOptions());
+
+            Debug.WriteLine(output);
+            Assert.IsNotNull(output);
+            //TODO: escape non-ascii characters according to current charset if hexIndicator is given
+            Assert.AreEqual("^XA\n^LH0,0\n^CI27\n^A0N,30,30\n^FO10,10\n^FH^FDStraße^FS\n^XZ", output);
+        }
+
+        [TestMethod]
+        public void FieldTypesetDefaultPosition()
+        {
+            var elements = new List<ZplElementBase>() {
+                new ZplTextField("ACME ", 10, 200, new ZplFont(30, 20, "0"), bottomToTop: true),
+                new ZplTextField("Summer ", 0, 0, new ZplFont(30, 20, "0"), bottomToTop: true, useDefaultPosition: true),
+                new ZplTextField("Clearance ", 0, 0, new ZplFont(60, 50, "0"), bottomToTop: true, useDefaultPosition: true),
+                new ZplTextField("Sale ", 0, 0, new ZplFont(120, 100, "0"), bottomToTop: true, useDefaultPosition: true)
+            };
+
+            var renderEngine = new ZplEngine(elements);
+            var output = renderEngine.ToZplString(new ZplRenderOptions());
+
+            Debug.WriteLine(output);
+            Assert.AreEqual("^XA\n^LH0,0\n^A0N,20,30\n^FT10,200\n^FDACME ^FS\n^A0N,20,30\n^FT\n^FDSummer ^FS\n^A0N,50,60\n^FT\n^FDClearance ^FS\n^A0N,100,120\n^FT\n^FDSale ^FS\n^XZ", output);
         }
     }
 }