added AssertJ matchers

Author: asolntsev

CHANGELOG.txt

@@ -1,5 +1,8 @@
 == Changelog
 
+=== 1.6.1 (released 26.02.2021)
+* added AssertJ matchers
+
 === 1.6.0 (released 21.01.2021)
 * #4 add methods to search within given pages of PDF
 * added method doesNotContainText() and doesNotContainExactText

README.md

@@ -7,7 +7,7 @@ PDF testing library
 
 Be sure that your code generates correct PDF!
 
-## How to use
+## How to use (Hamcrest)
 
 ```java
 import com.codeborne.pdftest.PDF;
@@ -23,6 +23,21 @@ public class PDFContainsTextTest {
 }
 ```
 
+## How to use (AssertJ)
+
+```java
+import com.codeborne.pdftest.PDF;
+import static com.codeborne.pdftest.assertj.Assertions.assertThat;
+
+public class PDFContainsTextTest {
+  @Test
+  public void canAssertThatPdfContainsText() {
+    PDF pdf = new PDF(new File("src/test/resources/50quickideas.pdf"));
+    assertThat(pdf).containsExactText("50 Quick Ideas to Improve your User Stories");
+  }
+}
+```
+
 
 ## How to start
 
@@ -32,14 +47,14 @@ If you use **Maven**, add the following dependency to pom.xml:
   <dependency>
     <groupId>com.codeborne</groupId>
     <artifactId>pdf-test</artifactId>
-    <version>1.5.2</version>
+    <version>1.6.1</version>
   </dependency>
 ```
 
 If you use **Gradle**, add the following dependency to build.gradle:
 
 ```groovy
-  testCompile 'com.codeborne:pdf-test:1.5.2'
+  testCompile 'com.codeborne:pdf-test:1.6.1'
 ```
 
 ## How to contribute

build.gradle

@@ -15,7 +15,7 @@ apply plugin: 'com.github.kt3k.coveralls'
 
 group='com.codeborne'
 archivesBaseName = 'pdf-test'
-version='1.6.0'
+version='1.6.1'
 
 [compileJava, compileTestJava]*.options.collect {options -> options.encoding = 'UTF-8'}
 [compileJava, compileTestJava]*.options.collect {options -> options.debug = true}
@@ -31,6 +31,7 @@ dependencies {
   implementation group: 'org.hamcrest', name: 'hamcrest-core', version: '1.3', transitive: false
   testImplementation group: 'junit', name: 'junit', version: '4.13.2', transitive: false
   testImplementation group: 'org.hamcrest', name: 'hamcrest-all', version: '1.3', transitive: false
+  implementation group: 'org.assertj', name: 'assertj-core', version: '3.19.0', transitive: false
 }
 
 repositories{

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

@@ -0,0 +1,9 @@
+package com.codeborne.pdftest.assertj;
+
+import com.codeborne.pdftest.PDF;
+
+public class Assertions extends org.assertj.core.api.Assertions {
+  public static PdfAssert assertThat(PDF actual) {
+    return new PdfAssert(actual);
+  }
+}

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

@@ -0,0 +1,47 @@
+package com.codeborne.pdftest.assertj;
+
+import com.codeborne.pdftest.PDF;
+import com.codeborne.pdftest.matchers.ContainsExactText;
+import com.codeborne.pdftest.matchers.ContainsText;
+import com.codeborne.pdftest.matchers.ContainsTextCaseInsensitive;
+import com.codeborne.pdftest.matchers.DoesNotContainExactText;
+import com.codeborne.pdftest.matchers.DoesNotContainText;
+import org.assertj.core.api.AbstractAssert;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+
+public class PdfAssert extends AbstractAssert<PdfAssert, PDF> {
+  public PdfAssert(PDF actual) {
+    super(actual, PdfAssert.class);
+  }
+
+  public PdfAssert containsText(String substring) {
+    isNotNull();
+    assertThat(actual, new ContainsText(substring));
+    return this;
+  }
+
+  public PdfAssert doesNotContainText(String substring) {
+    isNotNull();
+    assertThat(actual, new DoesNotContainText(substring));
+    return this;
+  }
+
+  public PdfAssert containsExactText(String substring) {
+    isNotNull();
+    assertThat(actual, new ContainsExactText(substring));
+    return this;
+  }
+
+  public PdfAssert doesNotContainExactText(String substring) {
+    isNotNull();
+    assertThat(actual, new DoesNotContainExactText(substring));
+    return this;
+  }
+
+  public PdfAssert containsTextCaseInsensitive(String substring) {
+    isNotNull();
+    assertThat(actual, new ContainsTextCaseInsensitive(substring));
+    return this;
+  }
+}

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

@@ -0,0 +1,43 @@
+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 org.assertj.core.api.Assertions.assertThatThrownBy;
+
+public class ContainsExactTextTest {
+  @Test
+  public void canAssertThatPdfContainsText() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).containsExactText("50 Quick Ideas to Improve your User Stories");
+  }
+
+  @Test
+  public void shouldBeCaseSensitive() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).doesNotContainExactText("50 quick ideas");
+  }
+
+  @Test
+  public void shouldNotIgnoreWhitespaces() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).containsExactText("Gojko Adzic");
+    assertThat(pdf).doesNotContainExactText("Gojko       Adzic");
+    assertThat(pdf).doesNotContainExactText("\tGojko \t Adzic\n");
+    assertThat(pdf).doesNotContainExactText("Gojko \u00a0 Adzic\r\n");
+  }
+
+  @Test
+  public void errorDescription() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("minimal.pdf"));
+
+    assertThatThrownBy(() -> {
+      assertThat(pdf).containsExactText("Goodbye word");
+    })
+        .isInstanceOf(AssertionError.class)
+        .hasMessage("\nExpected: a PDF containing \"Goodbye word\"\n     but: was \"Hello World\n\"");
+  }
+}

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

@@ -0,0 +1,35 @@
+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 org.assertj.core.api.Assertions.assertThatThrownBy;
+
+
+public class ContainsTextCaseInsensitiveTest {
+  @Test
+  public void canAssertThatPdfContainsTextIgnoringCase() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).containsTextCaseInsensitive("50 quick ideas to improve your user stories");
+    assertThat(pdf).containsTextCaseInsensitive("50 quick IDEAS to improve YOUR user STORIES");
+  }
+
+  @Test
+  public void shouldIgnoreWhitespaces() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).containsTextCaseInsensitive("\n\tgOJKO     aDZIC  \u00a0  ");
+  }
+
+  @Test
+  public void errorDescription() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("minimal.pdf"));
+    assertThatThrownBy(() -> {
+      assertThat(pdf).containsTextCaseInsensitive("Goodbye word");
+    })
+        .isInstanceOf(AssertionError.class)
+        .hasMessage("\nExpected: a PDF containing \"Goodbye word\"\n     but: was \"Hello World\"");
+  }
+}

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

@@ -0,0 +1,48 @@
+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 org.assertj.core.api.Assertions.assertThatThrownBy;
+
+public class ContainsTextTest {
+  @Test
+  public void canAssertThatPdfContainsText() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).containsText("50 Quick Ideas to Improve your User Stories");
+    assertThat(pdf).containsText("Gojko Adzic");
+    assertThat(pdf).containsText("©2013 - 2014 Gojko Adzic");
+    assertThat(pdf).containsText("#50quickideas");
+    assertThat(pdf).containsText("https://twitter.com/search?q=#50quickideas");
+  }
+
+  @Test
+  public void shouldBeCaseSensitive() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).doesNotContainText("50 quick ideas");
+  }
+
+  @Test
+  public void shouldIgnoreWhitespaces() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("50quickideas.pdf"));
+    assertThat(pdf).containsText("Gojko       Adzic");
+    assertThat(pdf).containsText("\tGojko \t Adzic\t");
+    assertThat(pdf).containsText("Gojko \n Adzic\t\n");
+    assertThat(pdf).containsText("Gojko \n Adzic\n");
+    assertThat(pdf).containsText("Gojko\r\n Adzic\r\n");
+    assertThat(pdf).containsText("Gojko \u00a0 Adzic\r\n");
+  }
+
+  @Test
+  public void errorDescription() throws IOException {
+    PDF pdf = new PDF(getClass().getClassLoader().getResource("minimal.pdf"));
+    assertThatThrownBy(() -> {
+      assertThat(pdf).containsText("Goodbye word");
+    })
+        .isInstanceOf(AssertionError.class)
+        .hasMessage("\nExpected: a PDF containing \"Goodbye word\"\n     but: was \"Hello World\"");
+  }
+}