OOMetrics.java

  1. /*
  2.  *  Copyright (c) 2001-2024, Jean Tessier
  3.  *  All rights reserved.
  4.  *  
  5.  *  Redistribution and use in source and binary forms, with or without
  6.  *  modification, are permitted provided that the following conditions
  7.  *  are met:
  8.  *  
  9.  *      * Redistributions of source code must retain the above copyright
  10.  *        notice, this list of conditions and the following disclaimer.
  11.  *  
  12.  *      * Redistributions in binary form must reproduce the above copyright
  13.  *        notice, this list of conditions and the following disclaimer in the
  14.  *        documentation and/or other materials provided with the distribution.
  15.  *  
  16.  *      * Neither the name of Jean Tessier nor the names of his contributors
  17.  *        may be used to endorse or promote products derived from this software
  18.  *        without specific prior written permission.
  19.  *  
  20.  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21.  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22.  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23.  *  A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
  24.  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25.  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26.  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27.  *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28.  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29.  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30.  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31.  */

  33. package com.jeantessier.dependencyfinder.cli;

  35. import com.jeantessier.classreader.AggregatingClassfileLoader;
  36. import com.jeantessier.classreader.ClassfileLoader;
  37. import com.jeantessier.classreader.LoadListenerVisitorAdapter;
  38. import com.jeantessier.classreader.TransientClassfileLoader;
  39. import com.jeantessier.commandline.CommandLineException;
  40. import com.jeantessier.metrics.*;
  41. import org.apache.logging.log4j.*;

  43. import java.io.*;
  44. import java.lang.reflect.*;
  45. import java.nio.file.*;
  46. import java.util.*;

  48. public class OOMetrics extends DirectoryExplorerCommand {
  49.     public static final String DEFAULT_PROJECT_NAME = "Project";
  50.     public static final String DEFAULT_SORT = "name";

  52.     protected void populateCommandLineSwitches() {
  53.         super.populateCommandLineSwitches();
  54.         populateCommandLineSwitchesForXMLOutput(XMLPrinter.DEFAULT_ENCODING, XMLPrinter.DEFAULT_DTD_PREFIX, XMLPrinter.DEFAULT_INDENT_TEXT);

  56.         getCommandLine().addSingleValueSwitch("project-name", DEFAULT_PROJECT_NAME);
  57.         getCommandLine().addSingleValueSwitch("default-configuration", true);
  58.         getCommandLine().addSingleValueSwitch("configuration");
  59.         getCommandLine().addToggleSwitch("csv");
  60.         getCommandLine().addToggleSwitch("json");
  61.         getCommandLine().addToggleSwitch("text");
  62.         getCommandLine().addToggleSwitch("txt");
  63.         getCommandLine().addToggleSwitch("xml");
  64.         getCommandLine().addToggleSwitch("yaml");
  65.         getCommandLine().addToggleSwitch("yml");
  66.         getCommandLine().addToggleSwitch("validate");
  67.         getCommandLine().addToggleSwitch("project");
  68.         getCommandLine().addToggleSwitch("groups");
  69.         getCommandLine().addToggleSwitch("classes");
  70.         getCommandLine().addToggleSwitch("methods");
  71.         getCommandLine().addMultipleValuesSwitch("scope-includes-list");
  72.         getCommandLine().addMultipleValuesSwitch("scope-excludes-list");
  73.         getCommandLine().addMultipleValuesSwitch("filter-includes-list");
  74.         getCommandLine().addMultipleValuesSwitch("filter-excludes-list");
  75.         getCommandLine().addToggleSwitch("show-all-metrics");
  76.         getCommandLine().addToggleSwitch("show-empty-metrics");
  77.         getCommandLine().addToggleSwitch("show-hidden-measurements");
  78.         getCommandLine().addSingleValueSwitch("sort", DEFAULT_SORT);
  79.         getCommandLine().addToggleSwitch("expand");
  80.         getCommandLine().addToggleSwitch("reverse");
  81.         getCommandLine().addToggleSwitch("enable-cross-class-measurements");
  82.     }

  84.     protected Collection<CommandLineException> parseCommandLine(String[] args) {
  85.         Collection<CommandLineException> exceptions = super.parseCommandLine(args);

  87.         if (!getCommandLine().isPresent("project") && !getCommandLine().isPresent("groups") && !getCommandLine().isPresent("classes") && !getCommandLine().isPresent("methods")) {
  88.             getCommandLine().getSwitch("project").setValue(true);
  89.             getCommandLine().getSwitch("groups").setValue(true);
  90.             getCommandLine().getSwitch("classes").setValue(true);
  91.             getCommandLine().getSwitch("methods").setValue(true);
  92.         }

  94.         int modeSwitch = 0;

  96.         if (getCommandLine().getToggleSwitch("csv")) {
  97.             modeSwitch++;
  98.         }
  99.         if (getCommandLine().getToggleSwitch("txt")) {
  100.             modeSwitch++;
  101.         }
  102.         if (getCommandLine().getToggleSwitch("text")) {
  103.             modeSwitch++;
  104.         }
  105.         if (getCommandLine().getToggleSwitch("xml")) {
  106.             modeSwitch++;
  107.         }
  108.         if (getCommandLine().getToggleSwitch("json")) {
  109.             modeSwitch++;
  110.         }
  111.         if (getCommandLine().getToggleSwitch("yaml")) {
  112.             modeSwitch++;
  113.         }
  114.         if (getCommandLine().getToggleSwitch("yml")) {
  115.             modeSwitch++;
  116.         }
  117.         if (modeSwitch != 1) {
  118.             exceptions.add(new CommandLineException("Must have one and only one of -csv, -json, -text, -txt, -xml, -yml, or -yaml"));
  119.         }

  121.         return exceptions;
  122.     }

  124.     protected void doProcessing() throws Exception {
  125.         LogManager.getLogger(OOMetrics.class).debug("Reading configuration ...");
  126.         getVerboseListener().print("Reading configuration ...");

  128.         String projectName = getCommandLine().getSingleSwitch("project-name");

  130.         MetricsFactory factory;
  131.         if (getCommandLine().isPresent("configuration")) {
  132.             factory = new MetricsFactory(projectName, new MetricsConfigurationLoader(getCommandLine().getToggleSwitch("validate")).load(getCommandLine().getSingleSwitch("configuration")));
  133.         } else {
  134.             factory = new MetricsFactory(projectName, new MetricsConfigurationLoader(getCommandLine().getToggleSwitch("validate")).load(getCommandLine().getSingleSwitch("default-configuration")));
  135.         }

  137.         MetricsGatherer gatherer = new MetricsGatherer(factory);
  138.         if (getCommandLine().isPresent("scope-includes-list") || getCommandLine().isPresent("scope-excludes-list")) {
  139.             gatherer.setScopeIncludes(createCollection(getCommandLine().getMultipleSwitch("scope-includes-list"), getCommandLine().getMultipleSwitch("scope-excludes-list")));
  140.         }
  141.         if (getCommandLine().isPresent("filter-includes-list") || getCommandLine().isPresent("filter-excludes-list")) {
  142.             gatherer.setFilterIncludes(createCollection(getCommandLine().getMultipleSwitch("filter-includes-list"), getCommandLine().getMultipleSwitch("filter-excludes-list")));
  143.         }
  144.         gatherer.addMetricsListener(getVerboseListener());

  146.         if (getCommandLine().isPresent("enable-cross-class-measurements")) {
  147.             LogManager.getLogger(OOMetrics.class).debug("Reading in all classes ...");
  148.             getVerboseListener().print("Reading in all classes ...");
  149.             ClassfileLoader loader = new AggregatingClassfileLoader();
  150.             loader.addLoadListener(getVerboseListener());
  151.             loader.load(getCommandLine().getParameters());

  153.             LogManager.getLogger(OOMetrics.class).debug("Computing metrics ...");
  154.             getVerboseListener().print("Computing metrics ...");
  155.             gatherer.visitClassfiles(loader.getAllClassfiles());
  156.         } else {
  157.             ClassfileLoader loader = new TransientClassfileLoader();
  158.             loader.addLoadListener(getVerboseListener());
  159.             loader.addLoadListener(new LoadListenerVisitorAdapter(gatherer));

  161.             LogManager.getLogger(OOMetrics.class).debug("Reading classes and computing metrics as we go ...");
  162.             getVerboseListener().print("Reading classes and computing metrics as we go ...");
  163.             loader.load(getCommandLine().getParameters());
  164.         }

  166.         if (getCommandLine().isPresent("show-all-metrics")) {
  167.             gatherer.getMetricsFactory().getAllClassMetrics().forEach(metrics -> gatherer.getMetricsFactory().includeClassMetrics(metrics));
  168.             gatherer.getMetricsFactory().getAllMethodMetrics().forEach(metrics -> gatherer.getMetricsFactory().includeMethodMetrics(metrics));
  169.         }

  171.         LogManager.getLogger(OOMetrics.class).debug("Printing results ...");
  172.         getVerboseListener().print("Printing results ...");

  174.         if (getCommandLine().isPresent("csv")) {
  175.             printCSVFiles(gatherer.getMetricsFactory());
  176.         } else if (getCommandLine().isPresent("json")) {
  177.             printJSONFile(gatherer.getMetricsFactory());
  178.         } else if (getCommandLine().isPresent("text") || getCommandLine().isPresent("txt")) {
  179.             printTextFile(gatherer.getMetricsFactory());
  180.         } else if (getCommandLine().isPresent("xml")) {
  181.             printXMLFile(gatherer.getMetricsFactory());
  182.         } else if (getCommandLine().isPresent("yaml") || getCommandLine().isPresent("yml")) {
  183.             printYAMLFile(gatherer.getMetricsFactory());
  184.         }

  186.         LogManager.getLogger(OOMetrics.class).debug("Done.");
  187.     }

  189.     private static Collection<String> createCollection(Collection<String> includes, Collection<String> excludes) throws IOException {
  190.         Collection<String> result = new HashSet<>();

  192.         for (String include : includes) {
  193.             result.addAll(Files.readAllLines(Paths.get(include)));
  194.         }

  196.         for (String exclude : excludes) {
  197.             result.removeAll(Files.readAllLines(Paths.get(exclude)));
  198.         }

  200.         return result;
  201.     }

  203.     private void printCSVFiles(MetricsFactory factory) throws IOException {
  204.         printCSVFile("project", "Project", factory.getConfiguration().getProjectMeasurements(), factory.getProjectMetrics());
  205.         printCSVFile("groups",  "Groups",  factory.getConfiguration().getGroupMeasurements(),   factory.getGroupMetrics());
  206.         printCSVFile("classes", "Classes", factory.getConfiguration().getClassMeasurements(),   factory.getClassMetrics());
  207.         printCSVFile("methods", "Methods", factory.getConfiguration().getMethodMeasurements(),  factory.getMethodMetrics());
  208.     }

  210.     private void printCSVFile(String name, String label, List<MeasurementDescriptor> descriptors, Collection<Metrics> metrics) throws IOException {
  211.         if (getCommandLine().getToggleSwitch(name)) {
  212.             if (getCommandLine().isPresent("out")) {
  213.                 setOut(new PrintWriter(new FileWriter(getCommandLine().getSingleSwitch("out") + "_" + name + ".csv")));
  214.             } else {
  215.                 getOut().print(label);
  216.                 getOut().println(":");
  217.             }

  219.             printMetrics(descriptors, metrics, CSVPrinter.class);

  221.             if (getCommandLine().isPresent("out")) {
  222.                 getOut().close();
  223.             }
  224.         }
  225.     }

  227.     private void printJSONFile(MetricsFactory factory) throws IOException {
  228.         printMetrics(factory.getProjectMetrics(), new JSONPrinter(getOut(), factory.getConfiguration()));
  229.         getOut().close();
  230.     }

  232.     private void printTextFile(MetricsFactory factory) throws IOException {
  233.         printTextFile("project", "Project metrics", factory.getConfiguration().getProjectMeasurements(), factory.getProjectMetrics());
  234.         printTextFile("groups",  "Group metrics",   factory.getConfiguration().getGroupMeasurements(),   factory.getGroupMetrics());
  235.         printTextFile("classes", "Class metrics",   factory.getConfiguration().getClassMeasurements(),   factory.getClassMetrics());
  236.         printTextFile("methods", "Method metrics",  factory.getConfiguration().getMethodMeasurements(),  factory.getMethodMetrics());
  237.         getOut().close();
  238.     }

  240.     private void printTextFile(String name, String label, List<MeasurementDescriptor> descriptors, Collection<Metrics> metrics) throws IOException {
  241.         if (getCommandLine().getToggleSwitch(name)) {
  242.             getOut().println(label);
  243.             getOut().println(label.replaceAll(".", "-"));
  244.             printMetrics(descriptors, metrics, TextPrinter.class);
  245.             getOut().println();
  246.         }
  247.     }

  249.     private void printXMLFile(MetricsFactory factory) throws IOException {
  250.         printMetrics(factory.getProjectMetrics(), new XMLPrinter(getOut(), factory.getConfiguration(), getCommandLine().getSingleSwitch("encoding"), getCommandLine().getSingleSwitch("dtd-prefix")));
  251.         getOut().close();
  252.     }

  254.     private void printYAMLFile(MetricsFactory factory) throws IOException {
  255.         printMetrics(factory.getProjectMetrics(), new YAMLPrinter(getOut(), factory.getConfiguration()));
  256.         getOut().close();
  257.     }

  259.     private void printMetrics(List<MeasurementDescriptor> descriptors, Collection<Metrics> metrics, Class<? extends Printer> clazz) throws IOException {
  260.         try {
  261.             printMetrics(metrics, clazz.getConstructor(PrintWriter.class, List.class).newInstance(getOut(), descriptors));
  262.         } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException ex) {
  263.             throw new RuntimeException(ex);
  264.         }
  265.     }

  267.     private void printMetrics(Collection<Metrics> metrics, Printer printer) {
  268.         printer.setExpandCollectionMeasurements(getCommandLine().getToggleSwitch("expand"));
  269.         printer.setShowEmptyMetrics(getCommandLine().isPresent("show-empty-metrics"));
  270.         printer.setShowHiddenMeasurements(getCommandLine().isPresent("show-hidden-measurements"));
  271.         if (getCommandLine().isPresent("indent-text")) {
  272.             printer.setIndentText(getCommandLine().getSingleSwitch("indent-text"));
  273.         }

  275.         var comparator = new MetricsComparator(getCommandLine().getSingleSwitch("sort"));
  276.         if (getCommandLine().getToggleSwitch("reverse")) {
  277.             comparator.reverse();
  278.         }
  279.         printer.setComparator(comparator);

  281.         printer.visitMetrics(metrics);
  282.     }

  284.     public static void main(String[] args) throws Exception {
  285.         new OOMetrics().run(args);
  286.     }
  287. }
Created with JaCoCo 0.8.12.202403310830