Formatting and Java 11 refactors (#657)

* Removed custom 'map()' constructors * Several minor refactors * Add unit testing for AsciidoctorHelper * Removed 'public' modifiers from tests * Deleted unused class AsciidoctorConversionException * Removed unused 'sourceDirectory' from MemoryLogHandler
asciidoctor · Jun 17, 2023 · 192c1c2 · 192c1c2
1 parent bbbd28a
commit 192c1c2
Show file tree

Hide file tree

Showing 53 changed files with 398 additions and 464 deletions.
diff --git a/...oxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java b/...oxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java
@@ -90,7 +90,7 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
 
     private MemoryLogHandler asciidoctorLoggingSetup(Asciidoctor asciidoctor, LogHandler logHandler, File siteDirectory) {
 
-        final MemoryLogHandler memoryLogHandler = new MemoryLogHandler(logHandler.getOutputToConsole(), siteDirectory,
+        final MemoryLogHandler memoryLogHandler = new MemoryLogHandler(logHandler.getOutputToConsole(),
                 logRecord -> getLog().info(LogRecordFormatter.format(logRecord, siteDirectory)));
         asciidoctor.registerLogHandler(memoryLogHandler);
         // disable default console output of AsciidoctorJ

diff --git a/...-module/src/test/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParserTest.java b/...-module/src/test/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParserTest.java
@@ -17,12 +17,12 @@
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.when;
 
-public class AsciidoctorConverterDoxiaParserTest {
+class AsciidoctorConverterDoxiaParserTest {
 
     private static final String TEST_DOCS_PATH = "src/test/resources/";
 
     @Test
-    public void should_convert_html_without_any_configuration() throws FileNotFoundException, ParseException {
+    void should_convert_html_without_any_configuration() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "sample.asciidoc");
         final Sink sink = createSinkMock();
 
@@ -39,7 +39,7 @@ public void should_convert_html_without_any_configuration() throws FileNotFoundE
     }
 
     @Test
-    public void should_convert_html_with_an_attribute() throws FileNotFoundException, ParseException {
+    void should_convert_html_with_an_attribute() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "sample.asciidoc");
         Reader reader = new FileReader(srcAsciidoc);
 
@@ -60,7 +60,7 @@ public void should_convert_html_with_an_attribute() throws FileNotFoundException
     }
 
     @Test
-    public void should_convert_html_with_baseDir_option() throws FileNotFoundException, ParseException {
+    void should_convert_html_with_baseDir_option() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "main-document.adoc");
         final Sink sink = createSinkMock();
 
@@ -80,7 +80,7 @@ public void should_convert_html_with_baseDir_option() throws FileNotFoundExcepti
     }
 
     @Test
-    public void should_convert_html_with_relative_baseDir_option() throws FileNotFoundException, ParseException {
+    void should_convert_html_with_relative_baseDir_option() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "main-document.adoc");
         final Sink sink = createSinkMock();
 
@@ -100,7 +100,7 @@ public void should_convert_html_with_relative_baseDir_option() throws FileNotFou
     }
 
     @Test
-    public void should_convert_html_with_templateDir_option() throws FileNotFoundException, ParseException {
+    void should_convert_html_with_templateDir_option() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "sample.asciidoc");
         final Sink sink = createSinkMock();
 
@@ -121,7 +121,7 @@ public void should_convert_html_with_templateDir_option() throws FileNotFoundExc
     }
 
     @Test
-    public void should_convert_html_with_attributes_and_baseDir_option() throws FileNotFoundException, ParseException {
+    void should_convert_html_with_attributes_and_baseDir_option() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "main-document.adoc");
         final Sink sink = createSinkMock();
 
@@ -149,7 +149,7 @@ public void should_convert_html_with_attributes_and_baseDir_option() throws File
     }
 
     @Test
-    public void should_process_empty_selfclosing_XML_attributes() throws FileNotFoundException, ParseException {
+    void should_process_empty_selfclosing_XML_attributes() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "sample.asciidoc");
         final Sink sink = createSinkMock();
 
@@ -170,7 +170,7 @@ public void should_process_empty_selfclosing_XML_attributes() throws FileNotFoun
     }
 
     @Test
-    public void should_process_empty_value_XML_attributes() throws FileNotFoundException, ParseException {
+    void should_process_empty_value_XML_attributes() throws FileNotFoundException, ParseException {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "sample.asciidoc");
         final Sink sink = createSinkMock();
 
@@ -191,7 +191,7 @@ public void should_process_empty_value_XML_attributes() throws FileNotFoundExcep
     }
 
     @Test
-    public void should_fail_when_logHandler_failIf_is_WARNING() {
+    void should_fail_when_logHandler_failIf_is_WARNING() {
         final File srcAsciidoc = new File(TEST_DOCS_PATH, "errors/document-with-missing-include.adoc");
         final Sink sink = createSinkMock();
 
@@ -243,7 +243,7 @@ private Sink createSinkMock() {
     }
 
     class TextProviderSink extends AbstractTextSink {
-        public String text;
+        String text;
 
         @Override
         public void rawText(String text) {

diff --git a/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/commons/AsciidoctorHelper.java b/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/commons/AsciidoctorHelper.java
@@ -66,5 +66,4 @@ else if (value instanceof Boolean) {
             attributesBuilder.attribute(attribute, value);
         }
     }
-
 }
diff --git a/...maven-commons/src/main/java/org/asciidoctor/maven/log/AsciidoctorConversionException.java b/...maven-commons/src/main/java/org/asciidoctor/maven/log/AsciidoctorConversionException.java
diff --git a/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/MemoryLogHandler.java b/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/MemoryLogHandler.java
@@ -4,10 +4,10 @@
 import org.asciidoctor.log.LogRecord;
 import org.asciidoctor.log.Severity;
 
-import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.function.Consumer;
+import java.util.stream.Collectors;
 
 
 /**
@@ -20,12 +20,10 @@ public class MemoryLogHandler implements LogHandler {
     final List<LogRecord> records = new ArrayList<>();
 
     private final Boolean outputToConsole;
-    private final File sourceDirectory;
     private final Consumer<LogRecord> recordConsumer;
 
-    public MemoryLogHandler(Boolean outputToConsole, File sourceDirectory, Consumer<LogRecord> recordConsumer) {
+    public MemoryLogHandler(Boolean outputToConsole, Consumer<LogRecord> recordConsumer) {
         this.outputToConsole = outputToConsole == null ? Boolean.FALSE : outputToConsole;
-        this.sourceDirectory = sourceDirectory;
         this.recordConsumer = recordConsumer;
     }
 
@@ -43,17 +41,13 @@ public void clear() {
     /**
      * Returns LogRecords that are equal or above the severity level.
      *
-     * @param severity Asciidoctor severity level
+     * @param severity Asciidoctor's severity level
      * @return list of filtered logRecords
      */
     public List<LogRecord> filter(Severity severity) {
-        // FIXME: find better name or replace with stream
-        final List<LogRecord> records = new ArrayList<>();
-        for (LogRecord record : this.records) {
-            if (record.getSeverity().ordinal() >= severity.ordinal())
-                records.add(record);
-        }
-        return records;
+        return this.records.stream()
+                .filter(record -> severityIsHigher(record, severity))
+                .collect(Collectors.toList());
     }
 
     /**
@@ -63,28 +57,29 @@ public List<LogRecord> filter(Severity severity) {
      * @return list of filtered logRecords
      */
     public List<LogRecord> filter(String text) {
-        final List<LogRecord> records = new ArrayList<>();
-        for (LogRecord record : this.records) {
-            if (record.getMessage().contains(text))
-                records.add(record);
-        }
-        return records;
+        return this.records.stream()
+                .filter(record -> messageContains(record, text))
+                .collect(Collectors.toList());
     }
 
     /**
      * Returns LogRecords that are equal or above the severity level and whose message contains text.
      *
-     * @param severity Asciidoctor severity level
+     * @param severity Asciidoctor's severity level
      * @param text     text to search for in the LogRecords
      * @return list of filtered logRecords
      */
     public List<LogRecord> filter(Severity severity, String text) {
-        final List<LogRecord> records = new ArrayList<>();
-        for (LogRecord record : this.records) {
-            if (record.getSeverity().ordinal() >= severity.ordinal() && record.getMessage().contains(text))
-                records.add(record);
-        }
-        return records;
+        return this.records.stream()
+                .filter(record -> severityIsHigher(record, severity) && messageContains(record, text))
+                .collect(Collectors.toList());
     }
 
+    private static boolean severityIsHigher(LogRecord record, Severity severity) {
+        return record.getSeverity().ordinal() >= severity.ordinal();
+    }
+
+    private static boolean messageContains(LogRecord record, String text) {
+        return record.getMessage().contains(text);
+    }
 }
diff --git a/...ctor-maven-commons/src/test/java/org/asciidoctor/maven/commons/AsciidoctorHelperTest.java b/...ctor-maven-commons/src/test/java/org/asciidoctor/maven/commons/AsciidoctorHelperTest.java
@@ -0,0 +1,43 @@
+package org.asciidoctor.maven.commons;
+
+import org.asciidoctor.Attributes;
+import org.asciidoctor.AttributesBuilder;
+import org.assertj.core.data.MapEntry;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.stream.Stream;
+
+import static org.asciidoctor.maven.commons.AsciidoctorHelper.addAttributes;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class AsciidoctorHelperTest {
+
+    @ParameterizedTest
+    @MethodSource("specialAttributes")
+    void should_add_attributes_with_special_values(Object actual, String expected) {
+        final Map<String, Object> attributes = new HashMap<>();
+        attributes.put("toc", actual);
+        final AttributesBuilder attributesBuilder = Attributes.builder();
+
+        addAttributes(attributes, attributesBuilder);
+
+        var attributesAsMap = attributesBuilder.build().map();
+        assertThat(attributesAsMap)
+                .containsExactly(MapEntry.entry("toc", expected));
+    }
+
+    private static Stream<Arguments> specialAttributes() {
+        return Stream.of(
+                Arguments.of(null, ""),
+                Arguments.of("", ""),
+                Arguments.of("true", ""),
+                Arguments.of("false", null),
+                Arguments.of(true, ""),
+                Arguments.of(false, null)
+        );
+    }
+}
diff --git a/asciidoctor-maven-commons/src/test/java/org/asciidoctor/maven/commons/StringUtilsTest.java b/asciidoctor-maven-commons/src/test/java/org/asciidoctor/maven/commons/StringUtilsTest.java
@@ -7,7 +7,7 @@
 import static org.asciidoctor.maven.commons.StringUtils.isBlank;
 import static org.assertj.core.api.Assertions.assertThat;
 
-public class StringUtilsTest {
+class StringUtilsTest {
 
     @Test
     void should_detect_null_as_blank_string() {

diff --git a/...idoctor-maven-commons/src/test/java/org/asciidoctor/maven/log/LogRecordFormatterTest.java b/...idoctor-maven-commons/src/test/java/org/asciidoctor/maven/log/LogRecordFormatterTest.java
@@ -12,12 +12,12 @@
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 
-public class LogRecordFormatterTest {
+class LogRecordFormatterTest {
 
     private static final String PROJECT_NAME = "asciidoctor-maven-commons";
 
     @Test
-    public void should_apply_full_format_logRecord_with_all_data() {
+    void should_apply_full_format_logRecord_with_all_data() {
         // given
         final Cursor cursor = new TestCursor(new File("file.adoc").getAbsolutePath(), 3, "path", "dir");
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
@@ -29,7 +29,7 @@ public void should_apply_full_format_logRecord_with_all_data() {
     }
 
     @Test
-    public void should_apply_simple_format_when_cursor_is_null() {
+    void should_apply_simple_format_when_cursor_is_null() {
         // given
         final LogRecord logRecord = new LogRecord(Severity.INFO, null, "a message");
         // when
@@ -39,7 +39,7 @@ public void should_apply_simple_format_when_cursor_is_null() {
     }
 
     @Test
-    public void should_apply_simple_format_when_cursor_is_empty() {
+    void should_apply_simple_format_when_cursor_is_empty() {
         // given
         final Cursor cursor = new TestCursor(null, 0, null, null);
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
@@ -50,7 +50,7 @@ public void should_apply_simple_format_when_cursor_is_empty() {
     }
 
     @Test
-    public void should_format_full_logRecord_with_file_absolute_path_when_sourceDir_is_not_valid() throws IOException {
+    void should_format_full_logRecord_with_file_absolute_path_when_sourceDir_is_not_valid() throws IOException {
         // given
         final Cursor cursor = new TestCursor(new File("file.adoc").getAbsolutePath(), 3, "path", "dir");
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
@@ -63,7 +63,7 @@ public void should_format_full_logRecord_with_file_absolute_path_when_sourceDir_
     }
 
     @Test
-    public void should_format_logRecords_with_empty_lineNumber_absolute_path_when_sourceDir_is_not_valid() throws IOException {
+    void should_format_logRecords_with_empty_lineNumber_absolute_path_when_sourceDir_is_not_valid() throws IOException {
         // given
         final Cursor cursor = new TestCursor(new File("file.adoc").getAbsolutePath(), 0, "path", "dir");
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
@@ -76,7 +76,7 @@ public void should_format_logRecords_with_empty_lineNumber_absolute_path_when_so
     }
 
     @Test
-    public void should_format_logRecords_when_source_is_not_under_sourceDir() {
+    void should_format_logRecords_when_source_is_not_under_sourceDir() {
         // given
         final Cursor cursor = new TestCursor(new File("..", "../file.adoc").toString(), 2, "path", "dir");
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
@@ -88,7 +88,7 @@ public void should_format_logRecords_when_source_is_not_under_sourceDir() {
     }
 
     @Test
-    public void should_format_full_logRecord_when_cursor_is_http_source() {
+    void should_format_full_logRecord_when_cursor_is_http_source() {
         // given
         final TestCursor cursor = new TestCursor("http://something/source.adoc", 3, "path", "dir");
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
@@ -99,7 +99,7 @@ public void should_format_full_logRecord_when_cursor_is_http_source() {
     }
 
     @Test
-    public void should_format_full_logRecord_when_cursor_is_https_source() {
+    void should_format_full_logRecord_when_cursor_is_https_source() {
         // given
         final TestCursor cursor = new TestCursor("https://something/source.adoc", 3, "path", "dir");
         final LogRecord logRecord = new LogRecord(Severity.INFO, cursor, "a message");
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,5 +66,4 @@ else if (value instanceof Boolean) { @@
                 attributesBuilder.attribute(attribute, value);
             }
         }
     }