1.8.1: added matcher matchesText(regex)

Author: asolntsev

CHANGELOG.txt

@@ -1,5 +1,8 @@
 == Changelog
 
+=== 1.8.1 (released 17.02.2023)
+* Add matcher `matchesText(regex)`
+
 === 1.8.0 (released 22.12.2022)
 * pdfbox from 2.0.24 to 2.0.27
 * bump hamcrest from 1.3 to 2.2

README.md

@@ -46,14 +46,15 @@ If you use **Maven**, add the following dependency to pom.xml:
   <dependency>
     <groupId>com.codeborne</groupId>
     <artifactId>pdf-test</artifactId>
-    <version>1.8.0</version>
+    <version>1.8.1</version>
+    <scope>test</scope>
   </dependency>
 ```
 
 If you use **Gradle**, add the following dependency to build.gradle:
 
 ```groovy
-  testCompile 'com.codeborne:pdf-test:1.8.0'
+  testImplementation 'com.codeborne:pdf-test:1.8.1'
 ```
 
 ## How to contribute

build.gradle

@@ -13,7 +13,7 @@ plugins {
 
 group = 'com.codeborne'
 archivesBaseName = 'pdf-test'
-version = '1.8.0'
+version = '1.8.1'
 
 defaultTasks 'test', 'install'
 

src/main/java/com/codeborne/pdftest/PDF.java

@@ -5,6 +5,7 @@
 import com.codeborne.pdftest.matchers.ContainsTextCaseInsensitive;
 import com.codeborne.pdftest.matchers.DoesNotContainExactText;
 import com.codeborne.pdftest.matchers.DoesNotContainText;
+import com.codeborne.pdftest.matchers.MatchesText;
 import org.apache.pdfbox.pdmodel.PDDocument;
 import org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature;
 import org.apache.pdfbox.text.PDFTextStripper;
@@ -15,6 +16,7 @@
 import java.net.URL;
 import java.nio.file.Paths;
 import java.util.Calendar;
+import java.util.regex.Pattern;
 
 import static java.nio.file.Files.readAllBytes;
 
@@ -142,4 +144,12 @@ public static Matcher<PDF> doesNotContainExactText(String text) {
   public static Matcher<PDF> containsTextCaseInsensitive(String text) {
     return new ContainsTextCaseInsensitive(text);
   }
+
+  public static Matcher<PDF> matchesText(String regex) {
+    return matchesText(Pattern.compile(regex));
+  }
+  public static Matcher<PDF> matchesText(Pattern regex) {
+    return new MatchesText(regex);
+  }
+
 }

src/main/java/com/codeborne/pdftest/assertj/PdfAssert.java

@@ -6,8 +6,11 @@
 import com.codeborne.pdftest.matchers.ContainsTextCaseInsensitive;
 import com.codeborne.pdftest.matchers.DoesNotContainExactText;
 import com.codeborne.pdftest.matchers.DoesNotContainText;
+import com.codeborne.pdftest.matchers.MatchesText;
 import org.assertj.core.api.AbstractAssert;
 
+import java.util.regex.Pattern;
+
 import static org.hamcrest.MatcherAssert.assertThat;
 
 public class PdfAssert extends AbstractAssert<PdfAssert, PDF> {
@@ -44,4 +47,15 @@ public PdfAssert containsTextCaseInsensitive(String substring) {
     assertThat(actual, new ContainsTextCaseInsensitive(substring));
     return this;
   }
+
+  public PdfAssert matchesText(String regex) {
+    return matchesText(Pattern.compile(regex));
+  }
+
+  public PdfAssert matchesText(Pattern regex) {
+    isNotNull();
+    assertThat(actual, new MatchesText(regex));
+    return this;
+  }
+  
 }

src/main/java/com/codeborne/pdftest/matchers/MatchesText.java

@@ -0,0 +1,34 @@
+package com.codeborne.pdftest.matchers;
+
+import com.codeborne.pdftest.PDF;
+import org.hamcrest.Description;
+
+import java.util.regex.Pattern;
+
+public class MatchesText extends PDFMatcher {
+  private final Pattern expectedText;
+
+  public MatchesText(Pattern expectedText) {
+    this.expectedText = expectedText;
+  }
+
+  @Override
+  protected boolean matchesSafely(PDF item) {
+    String reducedPdfText = reduceSpaces(item.text);
+    return expectedText.matcher(reducedPdfText).matches();
+  }
+
+  @Override
+  protected void describeMismatchSafely(PDF item, Description mismatchDescription) {
+    mismatchDescription.appendText("was \"").appendText(reduceSpaces(item.text)).appendText("\"");
+  }
+
+  @Override
+  public void describeTo(Description description) {
+    description.appendText("a PDF matching ");
+    buildErrorMessage(description, expectedText.toString(), new String[0]);
+  }
+
+
+}
+

src/test/java/com/codeborne/pdftest/CreatePdfTest.java

@@ -12,6 +12,7 @@
 import java.nio.file.Paths;
 
 import static com.codeborne.pdftest.PDF.containsText;
+import static com.codeborne.pdftest.PDF.matchesText;
 import static org.hamcrest.MatcherAssert.assertThat;
 
 public class CreatePdfTest {

src/test/java/com/codeborne/pdftest/MatchRegexTest.java

@@ -0,0 +1,17 @@
+package com.codeborne.pdftest;
+
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URL;
+
+import static com.codeborne.pdftest.PDF.matchesText;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+public class MatchRegexTest {
+  @Test
+  public void verifyTextWithRegex() throws IOException {
+    URL url = getClass().getClassLoader().getResource("50quickideas.pdf");
+    assertThat(new PDF(url), matchesText(".*50 Quick Ideas.+50 Quick Ideas.*"));
+  }
+}

src/test/java/com/codeborne/pdftest/assertj/ContainsTextTest.java

@@ -4,10 +4,8 @@
 import org.junit.Before;
 import org.junit.Test;
 
-import java.io.IOException;
-import java.util.Objects;
-
 import static com.codeborne.pdftest.assertj.Assertions.assertThat;
+import static java.util.Objects.requireNonNull;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 public class ContainsTextTest {
@@ -17,10 +15,8 @@ public class ContainsTextTest {
 
   @Before
   public void setUp() throws Exception {
-    fiftyIdeasPdf = new PDF(
-            Objects.requireNonNull(getClass().getClassLoader().getResource("50quickideas.pdf"))
-    );
-    minimalPdf = new PDF(Objects.requireNonNull(getClass().getClassLoader().getResource("minimal.pdf")));
+    fiftyIdeasPdf = new PDF(requireNonNull(getClass().getClassLoader().getResource("50quickideas.pdf")));
+    minimalPdf = new PDF(requireNonNull(getClass().getClassLoader().getResource("minimal.pdf")));
   }
 
   @Test

src/test/java/com/codeborne/pdftest/assertj/MatchRegexTest.java

@@ -0,0 +1,18 @@
+package com.codeborne.pdftest.assertj;
+
+import com.codeborne.pdftest.PDF;
+import org.junit.Test;
+
+import java.io.IOException;
+
+import static com.codeborne.pdftest.assertj.Assertions.assertThat;
+import static java.util.Objects.requireNonNull;
+
+public class MatchRegexTest {
+  @Test
+  public void verifyTextWithRegex() throws IOException {
+    PDF pdf = new PDF(requireNonNull(getClass().getClassLoader().getResource("50quickideas.pdf")));
+    assertThat(pdf).matchesText(".*50 Quick Ideas.+50 Quick Ideas.*");
+    assertThat(pdf).matchesText("50 Quick Ideas.*Gojko Adzic.*2014-03-25.*©2013 - 2014.*");
+  }
+}