DependencyReporter.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 java.util.*;
  36. import java.io.*;

  38. import javax.xml.parsers.*;

  40. import org.xml.sax.*;

  42. import com.jeantessier.commandline.*;
  43. import com.jeantessier.dependency.*;
  44. import com.jeantessier.dependency.Printer;
  45. import com.jeantessier.dependency.TextPrinter;
  46. import com.jeantessier.dependency.Visitor;

  48. public class DependencyReporter extends DependencyGraphCommand {
  49.     protected void populateCommandLineSwitches() {
  50.         super.populateCommandLineSwitches();
  51.         populateCommandLineSwitchesForXMLOutput(XMLPrinter.DEFAULT_ENCODING, XMLPrinter.DEFAULT_DTD_PREFIX, XMLPrinter.DEFAULT_INDENT_TEXT);

  53.         populateCommandLineSwitchesForScoping();
  54.         populateCommandLineSwitchesForFiltering();

  56.         getCommandLine().addAliasSwitch("p2p", "package-scope", "package-filter");
  57.         getCommandLine().addAliasSwitch("c2p", "class-scope", "package-filter");
  58.         getCommandLine().addAliasSwitch("c2c", "class-scope", "class-filter");
  59.         getCommandLine().addAliasSwitch("f2f", "feature-scope", "feature-filter");
  60.         getCommandLine().addAliasSwitch("includes", "scope-includes", "filter-includes");
  61.         getCommandLine().addAliasSwitch("excludes", "scope-excludes", "filter-excludes");

  63.         getCommandLine().addToggleSwitch("show-inbounds");
  64.         getCommandLine().addToggleSwitch("show-outbounds");
  65.         getCommandLine().addToggleSwitch("show-empty-nodes");

  67.         getCommandLine().addToggleSwitch("html");
  68.         getCommandLine().addToggleSwitch("json");
  69.         getCommandLine().addToggleSwitch("text");
  70.         getCommandLine().addToggleSwitch("txt");
  71.         getCommandLine().addToggleSwitch("xml");
  72.         getCommandLine().addToggleSwitch("yaml");
  73.         getCommandLine().addToggleSwitch("yml");

  75.         getCommandLine().addToggleSwitch("minimize");
  76.         getCommandLine().addToggleSwitch("maximize");
  77.         getCommandLine().addToggleSwitch("copy-only");
  78.         getCommandLine().addToggleSwitch("include-filter-nodes");

  80.         getCommandLine().addSingleValueSwitch("url-format", HTMLPrinter.DEFAULT_URL_FORMAT);
  81.     }

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

  86.         exceptions.addAll(validateCommandLineForScoping());
  87.         exceptions.addAll(validateCommandLineForFiltering());

  89.         if (getCommandLine().getToggleSwitch("maximize") && getCommandLine().getToggleSwitch("minimize")) {
  90.             exceptions.add(new CommandLineException("Only one of -maximize or -minimize is allowed"));
  91.         }

  93.         int modeSwitch = 0;

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

  120.         return exceptions;
  121.     }

  123.     protected void doProcessing() throws Exception {
  124.         SelectionCriteria scopeCriteria = getScopeCriteria();
  125.         SelectionCriteria filterCriteria = getFilterCriteria();

  127.         GraphCopier copier;
  128.         if (getCommandLine().getToggleSwitch("copy-only") || getCommandLine().getToggleSwitch("maximize")) {
  129.             copier = new GraphCopier(new SelectiveTraversalStrategy(scopeCriteria, filterCriteria));
  130.         } else {
  131.             copier = new GraphSummarizer(scopeCriteria, filterCriteria);
  132.         }
  133.         copyGraph(copier);

  135.         getVerboseListener().print("Printing the graph ...");

  137.         Printer printer;
  138.         if (getCommandLine().isPresent("html")) {
  139.             printer = new HTMLPrinter(getOut(), getCommandLine().getSingleSwitch("url-format"));
  140.         } else if (getCommandLine().isPresent("json")) {
  141.             printer = new JSONPrinter(getOut());
  142.         } else if (getCommandLine().isPresent("xml")) {
  143.             printer = new XMLPrinter(getOut(), getCommandLine().getSingleSwitch("encoding"), getCommandLine().getSingleSwitch("dtd-prefix"));
  144.         } else if (getCommandLine().isPresent("yaml") || getCommandLine().isPresent("yml")) {
  145.             printer = new YAMLPrinter(getOut());
  146.         } else {
  147.             printer = new TextPrinter(getOut());
  148.         }

  150.         if (getCommandLine().isPresent("indent-text")) {
  151.             printer.setIndentText(getCommandLine().getSingleSwitch("indent-text"));
  152.         }

  154.         if (getCommandLine().isPresent("show-inbounds") || getCommandLine().isPresent("show-outbounds") || getCommandLine().isPresent("show-empty-nodes")) {
  155.             printer.setShowInbounds(getCommandLine().isPresent("show-inbounds"));
  156.             printer.setShowOutbounds(getCommandLine().isPresent("show-outbounds"));
  157.             printer.setShowEmptyNodes(getCommandLine().isPresent("show-empty-nodes"));
  158.         }

  160.         var packages = copier.getScopeFactory().getPackages().values();

  162.         if (getCommandLine().isPresent("include-filter-nodes")) {
  163.             var nodeFactory = new NodeFactory();
  164.             new GraphCopier(nodeFactory).traverseNodes(packages);
  165.             packages = nodeFactory.getPackages().values();
  166.         }

  168.         printer.traverseNodes(packages);
  169.     }

  171.     private void copyGraph(Visitor copier) throws IOException, SAXException, ParserConfigurationException {
  172.         if (getCommandLine().getParameters().isEmpty()) {
  173.             copyGraphFromSystemIn(copier);
  174.         } else {
  175.             copyGraphFromFiles(copier);
  176.         }
  177.     }

  179.     private void copyGraphFromSystemIn(Visitor copier) throws IOException, ParserConfigurationException, SAXException {
  180.         copyGraph(copier, loadGraphFromSystemIn());
  181.     }

  183.     private void copyGraphFromFiles(Visitor copier) throws IOException, SAXException, ParserConfigurationException {
  184.         for (String filename : getCommandLine().getParameters()) {
  185.             if (filename.endsWith(".xml")) {
  186.                 copyGraph(copier, loadGraphFromFile(filename));
  187.             } else {
  188.                 getVerboseListener().print("Skipping \"" + filename + "\".");
  189.             }

  191.         }
  192.     }

  194.     private void copyGraph(Visitor copier, Collection<PackageNode> packages) {
  195.         if (getCommandLine().getToggleSwitch("maximize")) {
  196.             new LinkMaximizer().traverseNodes(packages);
  197.         } else if (getCommandLine().getToggleSwitch("minimize")) {
  198.             new LinkMinimizer().traverseNodes(packages);
  199.         }

  201.         copier.traverseNodes(packages);
  202.     }

  204.     private Collection<PackageNode> loadGraphFromSystemIn() throws IOException, SAXException, ParserConfigurationException {
  205.         Collection<PackageNode> packages;

  207.         getVerboseListener().print("Reading from standard input");

  209.         NodeLoader loader = new NodeLoader(getCommandLine().getToggleSwitch("validate"));
  210.         loader.addDependencyListener(getVerboseListener());
  211.         packages = loader.load(System.in).getPackages().values();

  213.         getVerboseListener().print("Read from standard input.");

  215.         return packages;
  216.     }

  218.     private Collection<PackageNode> loadGraphFromFile(String filename) throws IOException, SAXException, ParserConfigurationException {
  219.         Collection<PackageNode> packages;

  221.         getVerboseListener().print("Reading " + filename);

  223.         NodeLoader loader = new NodeLoader(getCommandLine().getToggleSwitch("validate"));
  224.         loader.addDependencyListener(getVerboseListener());
  225.         packages = loader.load(filename).getPackages().values();

  227.         getVerboseListener().print("Read \"" + filename + "\".");

  229.         return packages;
  230.     }

  232.     public static void main(String[] args) throws Exception {
  233.         new DependencyReporter().run(args);
  234.     }
  235. }
Created with JaCoCo 0.8.12.202403310830