feat: jdoc-cucumber (#9)

Author: boolivar

buildSrc/src/main/groovy/java-conventions.gradle

@@ -69,6 +69,7 @@ spotbugs {
 
 repositories {
     mavenCentral()
+    maven { url "https://jitpack.io" }
 }
 
 configurations {
@@ -85,5 +86,6 @@ dependencies {
 
     testImplementation "org.assertj:assertj-core"
     testImplementation "org.junit.jupiter:junit-jupiter"
+    testImplementation "org.junit.platform:junit-platform-suite"
     testImplementation "org.mockito:mockito-junit-jupiter"
 }

buildSrc/src/main/groovy/java-library-jdoc-spock-conventions.gradle

@@ -0,0 +1,16 @@
+plugins {
+    id "java-library-conventions"
+}
+
+tasks.withType(JavaCompile) {
+    options.compilerArgs << "-parameters"
+}
+
+afterEvaluate {
+    test {
+        systemProperties = [
+            "jdoc.spock.test-dirs" : sourceSets.main.java.srcDirs.join(","),
+            "jdoc.spock.classpath" : configurations.testCompileClasspath.files.join(",")
+        ]
+    }
+}

gradle/config/checkstyle/checkstyle.xml

@@ -159,7 +159,9 @@
         <!--<module name="JavadocMethod"/>-->
         <!--<module name="JavadocPackage"/>-->
         <!--<module name="JavadocParagraph"/>-->
-        <module name="JavadocStyle"/>
+        <module name="JavadocStyle">
+            <property name="severity" value="warning"/>
+        </module>
         <!--<module name="JavadocTagContinuationIndentation"/>-->
         <!--<module name="JavadocType"/>-->
         <!--<module name="JavadocVariable"/>-->

jdoc-core/build.gradle

@@ -0,0 +1,13 @@
+plugins {
+    id "java-library-jdoc-spock-conventions"
+}
+
+dependencies {
+    api "org.junit.platform:junit-platform-engine"
+    api "com.github.javaparser:javaparser-core"
+
+    implementation "org.apache.commons:commons-lang3"
+    implementation "org.jsoup:jsoup"
+
+    testRuntimeOnly "com.github.boolivar:jdoc-test"
+}

jdoc-core/src/main/java/org/bool/jdoc/core/ConfigParam.java

@@ -0,0 +1,50 @@
+package org.bool.jdoc.core;
+
+import lombok.AllArgsConstructor;
+import org.apache.commons.lang3.StringUtils;
+import org.junit.platform.engine.ConfigurationParameters;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+
+@AllArgsConstructor
+public abstract class ConfigParam<T> {
+
+    protected final String key;
+
+    public String getKey() {
+        return key;
+    }
+
+    public abstract Optional<T> maybeGet(ConfigurationParameters parameters);
+
+    public static class StringConfigParam extends ConfigParam<String> {
+
+        public StringConfigParam(String key) {
+            super(key);
+        }
+
+        @Override
+        public Optional<String> maybeGet(ConfigurationParameters config) {
+            return config.get(key);
+        }
+    }
+
+    public static class StringListConfigParam extends ConfigParam<List<String>> {
+
+        public StringListConfigParam(String key) {
+            super(key);
+        }
+
+        public List<String> get(ConfigurationParameters config) {
+            return maybeGet(config).orElse(Collections.emptyList());
+        }
+
+        @Override
+        public Optional<List<String>> maybeGet(ConfigurationParameters config) {
+            return config.get(key).map(value -> Arrays.asList(StringUtils.split(value, ',')));
+        }
+    }
+}

…rg/bool/jdoc/spock/DiscoveryRequest.java …org/bool/jdoc/core/DiscoveryRequest.javajdoc-spock/src/main/java/org/bool/jdoc/spock/DiscoveryRequest.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/DiscoveryRequest.java jdoc-spock/src/main/java/org/bool/jdoc/spock/DiscoveryRequest.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/DiscoveryRequest.java

@@ -1,4 +1,4 @@
-package org.bool.jdoc.spock;
+package org.bool.jdoc.core;
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -25,7 +25,7 @@ public class DiscoveryRequest implements EngineDiscoveryRequest {
 
     @NonNull
     @Builder.Default
-    private final List<DiscoveryFilter<?>> filters = Collections.emptyList();
+    private final List<? super DiscoveryFilter<?>> filters = Collections.emptyList();
 
     @NonNull
     @Builder.Default

…/org/bool/jdoc/spock/JavaFileParser.java …a/org/bool/jdoc/core/JavaFileParser.javajdoc-spock/src/main/java/org/bool/jdoc/spock/JavaFileParser.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/JavaFileParser.java jdoc-spock/src/main/java/org/bool/jdoc/spock/JavaFileParser.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/JavaFileParser.java

@@ -1,6 +1,6 @@
-package org.bool.jdoc.spock;
+package org.bool.jdoc.core;
 
-import org.bool.jdoc.spock.exception.SpockEngineException;
+import org.bool.jdoc.core.exception.JdocException;
 
 import com.github.javaparser.JavaParser;
 import com.github.javaparser.ParseResult;
@@ -22,10 +22,10 @@ public class JavaFileParser {
 
     private final JavaParser javaParser;
 
-    private final CodeBlockParser codeBlockParser;
+    private final JdocParser jdocParser;
 
-    public JavaFileParser() {
-        this(new JavaParser(), new CodeBlockParser());
+    public JavaFileParser(String lang) {
+        this(new JavaParser(), new JdocParser(lang));
     }
 
     /**
@@ -34,13 +34,13 @@ public JavaFileParser() {
      * <pre><code lang="spock">
      * def "Parsing result has code from <code></code> blocks"() {
      *   given:
-     *     def parser = new JavaFileParser()
+     *     def parser = new JavaFileParser("spock")
      *   when:
-     *     def result = parser.parse(java.nio.file.Paths.get("src/main/java/org/bool/jdoc/spock/JavaFileParser.java"))
+     *     def result = parser.parse(java.nio.file.Paths.get("src/main/java/org/bool/jdoc/core/JavaFileParser.java"))
      *   then:
      *     result.codeBlocks.size() == 1
      *     result.codeBlocks[0].startsWith('\n def "Parsing result has code from <code></code> blocks"() {')
-     *     result.codeBlocks[0].contains('parser.parse(java.nio.file.Paths.get("src/main/java/org/bool/jdoc/spock/JavaFileParser.java"))')
+     *     result.codeBlocks[0].contains('parser.parse(java.nio.file.Paths.get("src/main/java/org/bool/jdoc/core/JavaFileParser.java"))')
      *     result.codeBlocks[0].contains('infinite recursion ]8D')
      * }
      * </code></pre>
@@ -49,7 +49,7 @@ public JavaFileParser() {
     public SpecSource parse(Path file) {
         ParseResult<CompilationUnit> result = javaParser.parse(file);
         if (!result.isSuccessful()) {
-            throw new SpockEngineException("Error parse file " + file + ": " + result.getProblems());
+            throw new JdocException("Error parse file " + file + ": " + result.getProblems());
         }
         return new SpecSource(result.getResult().get(),
                 result.getCommentsCollection().map(this::parseComments).orElse(Collections.emptyList()));
@@ -58,7 +58,7 @@ public SpecSource parse(Path file) {
     private List<String> parseComments(CommentsCollection comments) {
         return comments.getComments().stream()
             .filter(comment -> JavadocComment.class.isInstance(comment) || BlockComment.class.isInstance(comment))
-            .flatMap(comment -> codeBlockParser.parse(comment.getContent()).stream())
+            .flatMap(comment -> jdocParser.parse(comment.getContent()).stream())
             .filter(StringUtils::isNotBlank)
             .collect(Collectors.toList());
     }

…org/bool/jdoc/spock/CodeBlockParser.java …/java/org/bool/jdoc/core/JdocParser.javajdoc-spock/src/main/java/org/bool/jdoc/spock/CodeBlockParser.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/JdocParser.java jdoc-spock/src/main/java/org/bool/jdoc/spock/CodeBlockParser.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/JdocParser.java

@@ -1,4 +1,4 @@
-package org.bool.jdoc.spock;
+package org.bool.jdoc.core;
 
 import lombok.AllArgsConstructor;
 import lombok.SneakyThrows;
@@ -16,17 +16,17 @@
 import java.util.stream.Stream;
 
 @AllArgsConstructor
-public class CodeBlockParser {
+public class JdocParser {
 
     private final Evaluator codeTag;
 
     private final Function<String, Document> parser;
 
-    public CodeBlockParser() {
-        this(and(new Evaluator.Tag("code"), new Evaluator.AttributeWithValue("lang", "spock")));
+    public JdocParser(String lang) {
+        this(and(new Evaluator.Tag("code"), new Evaluator.AttributeWithValue("lang", lang)));
     }
 
-    public CodeBlockParser(Evaluator codeTag) {
+    public JdocParser(Evaluator codeTag) {
         this(codeTag, content -> Parser.xmlParser().parseInput(content, ""));
     }
 
@@ -36,7 +36,7 @@ public CodeBlockParser(Evaluator codeTag) {
      * <pre><code lang="spock">
      * def "parse text and remove asterisks"() {
      *   given:
-     *     def parser = new CodeBlockParser()
+     *     def parser = new JdocParser("spock")
      *   when:
      *     def result = parser.parse('<code lang="spock"> * some code</code>')
      *   then:

jdoc-core/src/main/java/org/bool/jdoc/core/JdocSpecReader.java

@@ -0,0 +1,56 @@
+package org.bool.jdoc.core;
+
+import lombok.AllArgsConstructor;
+import lombok.SneakyThrows;
+import org.junit.platform.engine.DiscoverySelector;
+import org.junit.platform.engine.discovery.DirectorySelector;
+import org.junit.platform.engine.discovery.FileSelector;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+@AllArgsConstructor
+public class JdocSpecReader {
+
+    private final JavaFileParser parser;
+
+    /**
+     * Collect the specs from selected java files.
+     * 
+     * <pre><code lang="spock">
+     * def "Parse file specified by FileSelector"() {
+     *   given:
+     *     def spec = new SpecSource()
+     *     parser.parse(java.nio.file.Paths.get("File.java")) >> spec
+     *   when:
+     *     def specs = $target.readSpecs([org.junit.platform.engine.discovery.DiscoverySelectors.selectFile("File.java")])
+     *   then:
+     *     specs == [spec]
+     * }
+     * </code></pre>
+     */
+    public JdocSpecReader(String lang) {
+        this(new JavaFileParser(lang));
+    }
+
+    public List<SpecSource> readSpecs(List<DiscoverySelector> selectors) {
+        return selectors.stream()
+                .flatMap(this::streamFiles).distinct()
+                .map(parser::parse).collect(Collectors.toList());
+    }
+
+    @SneakyThrows
+    private Stream<Path> streamFiles(DiscoverySelector selector) {
+        if (selector instanceof DirectorySelector) {
+            return Files.walk(((DirectorySelector) selector).getPath())
+                    .filter(path -> path.getFileName().toString().endsWith(".java"));
+        }
+        if (selector instanceof FileSelector) {
+            return Stream.of(((FileSelector) selector).getPath());
+        }
+        return Stream.empty();
+    }
+}

…java/org/bool/jdoc/spock/SpecSource.java …/java/org/bool/jdoc/core/SpecSource.javajdoc-spock/src/main/java/org/bool/jdoc/spock/SpecSource.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/SpecSource.java jdoc-spock/src/main/java/org/bool/jdoc/spock/SpecSource.java renamed to jdoc-core/src/main/java/org/bool/jdoc/core/SpecSource.java

@@ -1,4 +1,4 @@
-package org.bool.jdoc.spock;
+package org.bool.jdoc.core;
 
 import com.github.javaparser.ast.CompilationUnit;
 import lombok.AllArgsConstructor;