builder:RuleReadmeLoader: added rule documentation fragment loader

builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/DefaultRuleReadmeLoader.java

@@ -0,0 +1,36 @@
+package net.kemitix.checkstyle.ruleset.builder;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.stream.Stream;
+
+/**
+ * Default README fragment loader.
+ *
+ * @author Paul Campbell (paul.campbell@hubio.com)
+ */
+@Slf4j
+@Component
+@RequiredArgsConstructor
+class DefaultRuleReadmeLoader implements RuleReadmeLoader {
+
+    private final TemplateProperties templateProperties;
+
+    @Override
+    public Stream<String> load(final Rule rule) {
+        try {
+            final Path resolve = templateProperties.getReadmeFragments()
+                                                   .resolve(rule.getName() + ".md");
+            log.info("Loading fragment: {}", resolve);
+            return Stream.concat(Stream.of(String.format("%n#### [%s](%s)", rule.getName(), rule.getUri())),
+                                 Files.lines(resolve));
+        } catch (IOException e) {
+            return Stream.empty();
+        }
+    }
+}

builder/src/main/java/net/kemitix/checkstyle/ruleset/builder/RuleReadmeLoader.java

@@ -0,0 +1,21 @@
+package net.kemitix.checkstyle.ruleset.builder;
+
+import java.util.stream.Stream;
+
+/**
+ * Loads README fragment for rule.
+ *
+ * @author Paul Campbell (pcampbell@kemitix.net)
+ */
+@FunctionalInterface
+interface RuleReadmeLoader {
+
+    /**
+     * Loads the README fragment for rule.
+     *
+     * @param rule The Rule.
+     *
+     * @return A Stream of the readme fragment.
+     */
+    Stream<String> load(Rule rule);
+}