com.manoelcampos.javadoc.coverage.exporter.HtmlExporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javadoc-coverage Show documentation
Doclet to generate coverage reports of JavaDoc documentation.
There is a newer version: 1.1.1
/*
 * Copyright 2017-2017 Manoel Campos da Silva Filho
 *
 * Licensed under the General Public License Version 3 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.gnu.org/licenses/gpl-3.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.manoelcampos.javadoc.coverage.exporter;

import com.manoelcampos.javadoc.coverage.CoverageDoclet;
import com.manoelcampos.javadoc.coverage.Utils;
import com.manoelcampos.javadoc.coverage.stats.ClassDocStats;
import com.manoelcampos.javadoc.coverage.stats.MembersDocStats;
import com.manoelcampos.javadoc.coverage.stats.MethodDocStats;
import com.sun.javadoc.PackageDoc;

import java.io.FileNotFoundException;
import java.util.List;

/**
 * Exports the JavaDoc coverage report to an HTML file.
 *
 * @author Manoel Campos da Silva Filho
 * @since 1.0.0
 */
public class HtmlExporter extends AbstractDataExporter {
    public static final String COLUMNS = "%s%s%s%s%s%s%.2f%%\n";

    public HtmlExporter(final CoverageDoclet doclet) throws FileNotFoundException {
        super(doclet, ".html");
    }

    @Override
    protected void exportProjectDocumentationCoverageSummary() {
        getWriter().printf("" + COLUMNS + "", "Project Documentation Coverage", "", "", "", "", "", getStats().getDocumentedMembersPercent());
    }

    @Override
    protected void header() {
        getWriter().println("\n");
        getWriter().println("");
        getWriter().println("    JavaDoc Coverage Report");
        getWriter().println("    ");
        getWriter().println("    ");
        getWriter().println("    \n");
        getWriter().println("    \n");
        getWriter().println("");
        getWriter().println("");
        getWriter().println(" ");
        getWriter().println("JavaDoc Coverage Report");
        getWriter().println("");
        getWriter().println("");
        getWriter().println("");
        getWriter().println("");
        getWriter().println("");
        getWriter().println("");
        getWriter().println("");
    }

    @Override
    protected void footer() {
        getWriter().println("");
        getWriter().println("Element Type Name Package Documentable Members Undocumented Documented Documented Percent
");
        getWriter().println("");
        getWriter().println("");
    }

    @Override
    protected void exportPackagesDocStats() {
        exportMembersDocStatsSummary(getStats().getPackagesDocStats());
        for (final PackageDoc doc : getStats().getPackagesDocStats().getPackagesDoc()) {
            getWriter().println("");
            final Boolean documented = Utils.isNotStringEmpty(doc.getRawCommentText());
            final double coverage = Utils.boolToInt(documented)*100;
            exportLine(2, "Package", doc.name(), "", "", "", documented.toString(), coverage);
        }
    }

    @Override
    protected void exportClassesDocStats() {
        exportMembersDocStatsSummary(getStats().getClassesDocStats());
        for (final ClassDocStats classDocStats : getStats().getClassesDocStats().getClassesList()) {
            exportMembersDocStatsSummary(classDocStats, 2, classDocStats.getName(), classDocStats.getPackageName());
            exportMembersDocStatsSummary(classDocStats.getFieldsStats(), 3);
            exportMethodsDocStats(classDocStats.getConstructorsStats());
            exportMethodsDocStats(classDocStats.getMethodsStats());
        }
    }

    private void exportMethodsDocStats(final List methods) {
        for (MethodDocStats m : methods) {
            exportMembersDocStatsSummary(m, 4, m.getMethodName(), "");
            exportMembersDocStatsSummary(m.getParamsStats(), 5);
            exportMembersDocStatsSummary(m.getThrownExceptions(), 5);
        }
    }

    private void exportMembersDocStatsSummary(final MembersDocStats membersDocStats, final int indentLevel) {
        exportMembersDocStatsSummary(membersDocStats, indentLevel, "","");
    }

    private void exportMembersDocStatsSummary(final MembersDocStats membersDocStats) {
        exportMembersDocStatsSummary(membersDocStats, 1, "","");
    }

    private void exportMembersDocStatsSummary(final MembersDocStats membersDocStats, final int indentLevel, final String name, final String pkg) {
        if(!membersDocStats.isPrintIfNoMembers() && membersDocStats.getMembersNumber() == 0){
            return;
        }

        exportLine(
                indentLevel, membersDocStats.getType(), name, pkg,
                membersDocStats.getMembersNumber(),
                membersDocStats.getUndocumentedMembers(),
                membersDocStats.getDocumentedMembers(),
                membersDocStats.getDocumentedMembersPercent());
    }

    private void exportLine(int indentLevel, String memberType, String name, String pkg, Long members, Long undocumented, Long documented, double documentedPercent){
        exportLine(indentLevel, memberType, name, pkg, members.toString(), undocumented.toString(), documented.toString(), documentedPercent);
    }

    private void exportLine(int indentLevel, String memberType, String name, String pkg, String members, String undocumented, String documented, double documentedPercent){
        getWriter().println("");
        final String type = getIndentation(indentLevel) + memberType;
        getWriter().printf(COLUMNS, type, name, pkg, members, undocumented, documented, documentedPercent);
        getWriter().println("");
    }

    private String getIndentation(final int indentLevel) {
        final int len = indentLevel*4 - 3;
        return String.format("%"+len+"s", "").replace(" ", " ");
    }

    @Override
    public void afterBuild() {
        System.out.printf("\nJavaDoc Coverage report saved to %s\n", getFile().getAbsolutePath());
    }
}