LoginSystem/src/tools/permissions/PermissionsListWriter.java

package permissions;

import utils.ANewMap;
import utils.FileUtils;
import utils.TagReplacer;
import utils.ToolTask;
import utils.ToolsConstants;

import java.util.Map;
import java.util.Scanner;
import java.util.Set;

/**
 * Task responsible for formatting a permissions node list and
 * for writing it to a file if desired.
 */
public class PermissionsListWriter implements ToolTask {

    private static final String PERMISSIONS_OUTPUT_FILE = ToolsConstants.DOCS_FOLDER + "permission_nodes.md";

    @Override
    public String getTaskName() {
        return "writePermissionsList";
    }

    @Override
    public void execute(Scanner scanner) {
        // Ask if result should be written to file
        System.out.println("Include description? [Enter 'n' for no]");
        boolean includeDescription = !matches("n", scanner);

        boolean writeToFile = false;
        if (includeDescription) {
            System.out.println("Write to file? [Enter 'y' for yes]");
            writeToFile = matches("y", scanner);
        }

        if (!includeDescription) {
            outputSimpleList();
        } else if (writeToFile) {
            generateAndWriteFile();
        } else {
            System.out.println(generatePermissionsList());
        }
    }

    private static void generateAndWriteFile() {
        final String permissionsTagValue = generatePermissionsList();

        Map<String, String> tags = ANewMap.with("permissions", permissionsTagValue).build();
        FileUtils.generateFileFromTemplate(
            ToolsConstants.TOOLS_SOURCE_ROOT + "permissions/permission_nodes.tpl.md", PERMISSIONS_OUTPUT_FILE, tags);
        System.out.println("Wrote to '" + PERMISSIONS_OUTPUT_FILE + "'");
        System.out.println("Before committing, please verify the output!");
    }

    private static String generatePermissionsList() {
        PermissionNodesGatherer gatherer = new PermissionNodesGatherer();
        Map<String, String> permissions = gatherer.gatherNodesWithJavaDoc();

        final String template = FileUtils.readFromToolsFile("permissions/permission_node_entry.tpl.md");
        StringBuilder sb = new StringBuilder();

        for (Map.Entry<String, String> entry : permissions.entrySet()) {
            Map<String, String> tags = ANewMap
                .with("node", entry.getKey())
                .and("description", entry.getValue())
                .build();
            sb.append(TagReplacer.applyReplacements(template, tags));
        }
        return sb.toString();
    }

    private static void outputSimpleList() {
        PermissionNodesGatherer gatherer = new PermissionNodesGatherer();
        Set<String> nodes = gatherer.gatherNodes();
        for (String node : nodes) {
            System.out.println(node);
        }
        System.out.println();
        System.out.println("Total: " + nodes.size());
    }

    private static boolean matches(String answer, Scanner sc) {
        String userInput = sc.nextLine();
        return answer.equalsIgnoreCase(userInput);
    }

}