Calculate overlapping according to the overlap ratio glyph by glyph

DEVSIX-8773

Author: vitali-pr

src/main/java/com/itextpdf/pdfcleanup/PdfCleanUpFilter.java

@@ -226,21 +226,24 @@ private boolean checkIfIntersectionOccurs(Paths paths, Point[] rect1, boolean is
     FilterResult<PdfArray> filterText(TextRenderInfo text) {
         PdfTextArray textArray = new PdfTextArray();
 
-        if (isTextNotToBeCleaned(text)) {
+        // Overlap ratio should not be taken into account when we check the whole text not to be cleaned up
+        if (properties.getOverlapRatio() == null && isTextNotToBeCleaned(text)) {
             return new FilterResult<>(false, new PdfArray(text.getPdfString()));
         }
 
+        boolean isModified = false;
         for (TextRenderInfo ri : text.getCharacterRenderInfos()) {
             if (isTextNotToBeCleaned(ri)) {
                 textArray.add(ri.getPdfString());
             } else {
+                isModified = true;
                 textArray.add(new PdfNumber(FontProgram.convertGlyphSpaceToTextSpace(-ri.getUnscaledWidth()) /
                         (text.getFontSize() * text.getHorizontalScaling() / FontProgram.HORIZONTAL_SCALING_FACTOR)
                 ));
             }
         }
 
-        return new FilterResult<PdfArray>(true, textArray);
+        return new FilterResult<PdfArray>(isModified, textArray);
     }
 
     /**

src/test/java/com/itextpdf/pdfcleanup/OverlapRatioTest.java

@@ -22,13 +22,16 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.pdfcleanup;
 
+import com.itextpdf.io.util.DecimalFormatUtil;
 import com.itextpdf.kernel.colors.ColorConstants;
 import com.itextpdf.kernel.pdf.PdfDocument;
 import com.itextpdf.kernel.pdf.PdfReader;
 import com.itextpdf.kernel.pdf.PdfWriter;
 import com.itextpdf.kernel.geom.Rectangle;
+import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
 import com.itextpdf.kernel.utils.CompareTool;
 import com.itextpdf.test.ExtendedITextTest;
+
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.BeforeAll;
@@ -127,11 +130,10 @@ public void extractionWithSettingOverlapRatio1() throws IOException, Interrupted
 
         PdfDocument pdfDoc = new PdfDocument(new PdfReader(inputFile), new PdfWriter(targetFile));
 
-
         CleanUpProperties properties = new CleanUpProperties();
         properties.setOverlapRatio(1d);
 
-        List<PdfCleanUpLocation> cleanUpLocations = new ArrayList<>(); // convertCleanupLocations();
+        List<PdfCleanUpLocation> cleanUpLocations = new ArrayList<>();
         cleanUpLocations.add(new PdfCleanUpLocation(1, new Rectangle(20, 690, 263.75f, 40), ColorConstants.YELLOW));
         PdfCleaner.cleanUp(pdfDoc, cleanUpLocations, properties);
         pdfDoc.close();
@@ -141,6 +143,39 @@ public void extractionWithSettingOverlapRatio1() throws IOException, Interrupted
         Assertions.assertNull(errorMessage);
     }
 
+    @Test
+    public void differentTextRenderInfo() throws IOException, InterruptedException {
+        final String inputFile = inputPath + "differentTextRenderInfo.pdf";
+        final Double[] ratioArray = new Double[] {0d, 0.001, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1d};
+        final Rectangle r = new Rectangle(110, 700, 400, 130);
+
+        List<PdfCleanUpLocation> cleanUpLocations = new ArrayList<PdfCleanUpLocation>();
+        PdfCleanUpLocation location = new PdfCleanUpLocation(1, r);
+        cleanUpLocations.add(location);
+        CleanUpProperties cleanUpProperties = new CleanUpProperties();
+
+        for (Double ratio : ratioArray) {
+            final String targetFile = outputPath + "differentTextRenderInfo_" +
+                    DecimalFormatUtil.formatNumber(ratio.doubleValue(), "#.000#") + "_redact.pdf";
+            final String cmpFile = inputPath + "cmp_differentTextRenderInfo_" +
+                    DecimalFormatUtil.formatNumber(ratio.doubleValue(), "#.000#") + "_redact.pdf";
+
+            try (PdfDocument pdfDoc = new PdfDocument(new PdfReader(inputFile), new PdfWriter(targetFile))) {
+                if (ratio == 0d) {
+                    cleanUpProperties.setOverlapRatio(null);
+                } else {
+                    cleanUpProperties.setOverlapRatio(ratio);
+                }
+                PdfCleaner.cleanUp(pdfDoc, cleanUpLocations, cleanUpProperties);
+
+                // Draw a rectangle to visualize the cleanup
+                PdfCanvas pdfCanvas = new PdfCanvas(pdfDoc.getPage(1));
+                pdfCanvas.setStrokeColor(ColorConstants.RED).rectangle(r).stroke();
+            }
+
+            Assertions.assertNull(new CompareTool().compareByContent(targetFile, cmpFile, outputPath, "diff_"));
+        }
+    }
 
     private static List<PdfCleanUpLocation> convertCleanupLocations() {
         List<PdfCleanUpLocation> cleanUpLocations = new ArrayList<>();