public RichTextReport generateReport()

in reports/src/main/java/nl/obren/sokrates/reports/generators/statichtml/ControlsReportGenerator.java [18:57]
35 lines of code
2 McCabe index (conditional complexity)

    public RichTextReport generateReport(CodeAnalysisResults codeAnalysisResults, RichTextReport metricsReport) {
        this.report = metricsReport;

        report.startSection("Intro", "");
        report.startUnorderedList();
        report.addListItem("Controls enable you to set alarms for any of the <a href='Metrics.html'>Sokrates metrics</a>. An alarm is defined with a desired range and tolerance.");
        report.endUnorderedList();

        report.startShowMoreBlock("Learn more...");
        report.startUnorderedList();
        report.addListItem("For more insights in the value of trend analysis, Sokrates recommends reading the section \"Explicitly link metrics to goals\" in the article <a href='https://martinfowler.com/articles/useOfMetrics.html#ExplicitlyLinkMetricsToGoals' target='_blank'>An Appropriate Use of Metrics</a>, (MartinFowler.com), e.g.:");
        report.startUnorderedList();
        report.addListItem("<i>\"We would like our code to be less complex and easier to change. Therefore we should aim to write short methods (less than 15 lines) with a low conditional complexity (less than 20 is good). We should also aim to have a small handful of parameters (up to four) so that methods remain as focused as possible.\"</i>");
        report.endUnorderedList();
        report.endUnorderedList();
        report.endShowMoreBlock();
        report.endSection();

        List<GoalsAnalysisResults> goals = codeAnalysisResults.getControlResults().getGoalsAnalysisResults();
        if (goals.size() == 0) {
            report.addParagraph("No goals have been defined.");
            return report;
        }

        goals.forEach(goalsAnalysisResults -> {
            report.startSection(goalsAnalysisResults.getMetricsWithGoal().getGoal(),
                    goalsAnalysisResults.getMetricsWithGoal().getDescription());
            report.startDiv("width: 100%; overflow-x: auto");
            report.startTable();
            report.addTableHeader("", "Status", "Metric", "Desired Range<br/>[from - to] ±tolerance", "Current Value", "Description");
            goalsAnalysisResults.getControlStatuses().forEach(controlResult -> {
                addRow(controlResult);
            });
            report.endTable();
            report.endDiv();
            report.endSection();
        });

        return metricsReport;
    }