com.atlassian.clover.reporters.html.RenderPackageTreeJsonAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of clover Show documentation

Clover is an award winning code coverage and testing tool for Java and Groovy. It integrates easily with Maven, Ant, Grails, Eclipse and IntelliJ IDEA as well as with continuous integration servers such as Bamboo, Jenkins or Hudson. Note: before Clover 4.0 this artifact was named com.cenqua.clover:clover.

The newest version!

package com.atlassian.clover.reporters.html;

import clover.org.apache.velocity.VelocityContext;
import com.atlassian.clover.api.registry.PackageInfo;
import com.atlassian.clover.registry.entities.FullProjectInfo;
import com.atlassian.clover.registry.metrics.HasMetricsSupport;
import com.atlassian.clover.reporters.Current;
import com.atlassian.clover.util.trie.PackagePrefixTree;
import com.atlassian.clover.util.trie.PrefixTree;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Callable;

/**
 * Generate tree of all packages available in the project with compressed empty packages in a JSON format.
 */
public class RenderPackageTreeJsonAction implements Callable {

    private final FullProjectInfo fullProjectInfo; // shared - read only
    private final FullProjectInfo appProjectInfo;  // shared - read only
    private final VelocityContext context; // not shared, read/write
    private final Current reportConfig;
    private final File basePath;


    public RenderPackageTreeJsonAction(VelocityContext ctx, File basePath,
                                       FullProjectInfo fullProjectInfo, FullProjectInfo appProjectInfo,
                                       Current reportConfig) {
        this.basePath = basePath;
        this.fullProjectInfo = fullProjectInfo;
        this.appProjectInfo = appProjectInfo;
        this.context = ctx;
        this.reportConfig = reportConfig;
    }

    @Override
    public Object call() throws Exception {
        final File outfile = insertPackageTreeProperties();
        HtmlReportUtil.mergeTemplateToFile(outfile, context, "package-nodes-tree.vm");
        return null;
    }

    protected File insertPackageTreeProperties() {
        final PrefixTree packageTree = createTreeFromList(collectAllPackagesByName());

        context.put("projectInfo", fullProjectInfo);
        context.put("packageTree", packageTree.getRootNode());

        final String filename = "package-nodes-tree.js";
        return new File(basePath, filename);
    }

    /**
     * list of packages sorted alphabetically (for vertical navigation / bottom-left frame) with an extra attribute
     * wheteher package exists only in test model (for proper page linking)
     */
    protected List collectAllPackagesByName() {
        final List packages = fullProjectInfo.getAllPackages();
        Collections.sort(packages, HasMetricsSupport.LEX_COMP);

        final List packagesExt = new ArrayList<>(packages.size());
        for (PackageInfo packageInfo : packages) {
            packagesExt.add(new PackageInfoExt(
                    packageInfo,
                    appProjectInfo.findPackage(packageInfo.getName()) == null));
        }
        return packagesExt;
    }

    private PrefixTree createTreeFromList(List allPackages) {
        // first, build a prefix tree from a list of packages; tree node contains package name fragment as a key
        PackagePrefixTree trie = new PackagePrefixTree();
        for (PackageInfoExt pkgExt : allPackages) {
            trie.add(pkgExt.getPackageInfo().getName(), pkgExt);
        }
        // next, compress empty nodes
        trie.compressTree();
        return trie;
    }

}