Deprecate duplicate methods

Mark methods that had their duplicated logic consolidated inside a super-class
Add extra test for SQ coverage

DEVSIX-2864

Author: Samuel Huylebroeck

kernel/src/test/java/com/itextpdf/kernel/pdf/PdfCanvasTest.java

@@ -1952,4 +1952,21 @@ private void setColorTest(String pdfName, boolean pattern) throws IOException, I
 
         Assert.assertNull(new CompareTool().compareByContent(destFile, cmpFile, destinationFolder, "diff_"));
     }
+
+    @Test
+    public void endPathNewPathTest(){
+        ByteArrayOutputStream boasEndPath = new ByteArrayOutputStream();
+        PdfDocument pdfDocEndPath = new PdfDocument(new PdfWriter(boasEndPath));
+        pdfDocEndPath.addNewPage();
+
+        PdfCanvas endPathCanvas = new PdfCanvas(pdfDocEndPath.getPage(1));
+        endPathCanvas.endPath();
+
+        ByteArrayOutputStream boasNewPath = new ByteArrayOutputStream();
+        PdfDocument pdfDocNewPath = new PdfDocument(new PdfWriter(boasNewPath));
+        pdfDocNewPath.addNewPage();
+        PdfCanvas newPathCanvas = new PdfCanvas(pdfDocNewPath.getPage(1));
+        newPathCanvas.newPath();
+        Assert.assertArrayEquals(boasNewPath.toByteArray(),boasEndPath.toByteArray());
+    }
 }

layout/src/main/java/com/itextpdf/layout/borders/DashedBorder.java

@@ -110,7 +110,7 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, Side
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
 
-        float adjustedGap = getDotsGap(borderLength, initialGap + dash);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap + dash);
         if (adjustedGap > dash) {
             adjustedGap -= dash;
         }
@@ -144,7 +144,7 @@ public void drawCellBorder(PdfCanvas canvas, float x1, float y1, float x2, float
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
 
-        float adjustedGap = getDotsGap(borderLength, initialGap + dash);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap + dash);
         if (adjustedGap > dash) {
             adjustedGap -= dash;
         }
@@ -170,7 +170,7 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float
         float dx = x2 - x1;
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
-        float adjustedGap = getDotsGap(borderLength, initialGap + dash);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap + dash);
         if (adjustedGap > dash) {
             adjustedGap -= dash;
         }
@@ -194,7 +194,9 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float
      * @param distance   the {@link Border border} length
      * @param initialGap the initial size of the gap
      * @return the adjusted size of the gap
+     * @deprecated logic moved to super-class
      */
+    @Deprecated
     protected float getDotsGap(double distance, float initialGap) {
         return super.getDotsGap(distance, initialGap);
     }

layout/src/main/java/com/itextpdf/layout/borders/DottedBorder.java

@@ -106,7 +106,7 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, Side
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
 
-        float adjustedGap = getDotsGap(borderLength, initialGap + width);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap + width);
         if (adjustedGap > width) {
             adjustedGap -= width;
         }
@@ -139,7 +139,7 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float
         float dx = x2 - x1;
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
-        float adjustedGap = getDotsGap(borderLength, initialGap);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap);
         if (adjustedGap > width) {
             adjustedGap -= width;
         }
@@ -168,7 +168,7 @@ public void drawCellBorder(PdfCanvas canvas, float x1, float y1, float x2, float
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
 
-        float adjustedGap = getDotsGap(borderLength, initialGap + width);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap + width);
         if (adjustedGap > width) {
             adjustedGap -= width;
         }
@@ -192,7 +192,9 @@ public void drawCellBorder(PdfCanvas canvas, float x1, float y1, float x2, float
      * @param distance   the {@link Border border} length
      * @param initialGap the initial size of the gap
      * @return the adjusted size of the gap
+     * @deprecated logic moved to super-class
      */
+    @Deprecated
     protected float getDotsGap(double distance, float initialGap) {
         return super.getDotsGap(distance, initialGap);
     }

layout/src/main/java/com/itextpdf/layout/borders/RoundDotsBorder.java

@@ -105,7 +105,7 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, Side
         float dx = x2 - x1;
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
-        float adjustedGap = getDotsGap(borderLength, initialGap);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap);
 
         float[] startingPoints = getStartingPointsForBorderSide(x1, y1, x2, y2, defaultSide);
         x1 = startingPoints[0];
@@ -133,7 +133,7 @@ public void drawCellBorder(PdfCanvas canvas, float x1, float y1, float x2, float
         float dx = x2 - x1;
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
-        float adjustedGap = getDotsGap(borderLength, initialGap);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap);
         boolean isHorizontal = false;
         if (Math.abs(y2 - y1) < 0.0005f) {
             isHorizontal = true;
@@ -163,7 +163,7 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float
         float dx = x2 - x1;
         float dy = y2 - y1;
         double borderLength = Math.sqrt(dx * dx + dy * dy);
-        float adjustedGap = getDotsGap(borderLength, initialGap);
+        float adjustedGap = super.getDotsGap(borderLength, initialGap);
 
         canvas
                 .saveState()
@@ -187,7 +187,9 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float
      * @param distance   the {@link Border border} length
      * @param initialGap the initial size of the gap
      * @return the adjusted size of the gap
+     * @deprecated logic moved to super-class
      */
+    @Deprecated
     protected float getDotsGap(double distance, float initialGap) {
         return super.getDotsGap(distance, initialGap);
     }

layout/src/test/java/com/itextpdf/layout/BorderTest.java

@@ -325,4 +325,52 @@ private void closeDocumentAndCompareOutputs(Document document) throws IOExceptio
             Assert.fail(compareResult);
         }
     }
+
+
+    //When 7.2 release is in progress, remove the underlying code. It's here to pass A SQ line coverage quality gate and tests deprecated protected methods
+    public class TestDashedBorder extends DashedBorder {
+        public TestDashedBorder(float width) {
+            super(width);
+        }
+        public float publicGetDotsGap(double distance,float initialGap){
+            return getDotsGap(distance, initialGap);
+        }
+    }
+
+    public class TestDottedBorder extends DottedBorder {
+        public TestDottedBorder(float width) {
+            super(width);
+        }
+        public float publicGetDotsGap(double distance,float initialGap){
+            return getDotsGap(distance, initialGap);
+        }
+    }
+
+    public class TestRoundDotsBorder extends RoundDotsBorder {
+        public TestRoundDotsBorder(float width) {
+            super(width);
+        }
+        public float publicGetDotsGap(double distance,float initialGap){
+            return getDotsGap(distance, initialGap);
+        }
+    }
+
+    @Test
+    public void getDotsGapTest(){
+        float expected = 0.2f;
+        double distance = 0.2;
+        float initialGap = 0.2f;
+
+        TestDashedBorder db = new TestDashedBorder(1f);
+        TestDottedBorder dotb = new TestDottedBorder(1f);
+        TestRoundDotsBorder rdb = new TestRoundDotsBorder(1f);
+
+        float dbActual = db.publicGetDotsGap(distance,initialGap);
+        float dotbActual = dotb.publicGetDotsGap(distance,initialGap);
+        float rdbActual = rdb.publicGetDotsGap(distance,initialGap);
+
+        Assert.assertEquals(expected,dbActual,0.0001f);
+        Assert.assertEquals(expected,dotbActual,0.0001f);
+        Assert.assertEquals(expected,rdbActual,0.0001f);
+    }
 }

layout/src/test/java/com/itextpdf/layout/TableTest.java

@@ -52,6 +52,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.pdf.xobject.PdfImageXObject;
 import com.itextpdf.kernel.utils.CompareTool;
 import com.itextpdf.layout.borders.Border;
+import com.itextpdf.layout.borders.DashedBorder;
+import com.itextpdf.layout.borders.DottedBorder;
+import com.itextpdf.layout.borders.RoundDotsBorder;
 import com.itextpdf.layout.borders.SolidBorder;
 import com.itextpdf.layout.element.AreaBreak;
 import com.itextpdf.layout.element.Cell;
@@ -2636,6 +2639,29 @@ public void captionedTableOfOnePageWithCollapsedBordersTest01() throws IOExcepti
         Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, testName + "_diff"));
     }
 
+    @Test
+    public void tableWithDifferentStylesOfCollapsedBordersTest() throws IOException, InterruptedException {
+        String testName = "tableWithDifferentStylesOfCollapsedBordersTest.pdf";
+        String outFileName = destinationFolder + testName;
+        String cmpFileName = sourceFolder + "cmp_" + testName;
+
+        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(outFileName));
+        Document doc = new Document(pdfDoc);
+
+        Table table = createTestTable(2, 10, 2, 2, (UnitValue) null, BorderCollapsePropertyValue.COLLAPSE,
+                new Style().setBorder(new DashedBorder(ColorConstants.RED, 10)));
+        table.getHeader().setBorder(new DottedBorder(ColorConstants.ORANGE, 5f));
+        table.getFooter().setBorder(new RoundDotsBorder(ColorConstants.ORANGE, 5f));
+
+        // no caption
+        addTable(table, true, true, doc);
+
+        doc.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, testName + "_diff"));
+
+    }
+
     @Test
     public void captionedTableOfOnePageWithSeparatedBordersTest01() throws IOException, InterruptedException {
         String testName = "captionedTableOfOnePageWithSeparatedBordersTest01.pdf";