ottlinger commented on code in PR #233: URL: https://github.com/apache/creadur-rat/pull/233#discussion_r1555612574
########## apache-rat-core/src/main/java/org/apache/rat/Documentation.java: ########## @@ -0,0 +1,152 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.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 org.apache.rat; + +import java.io.IOException; +import java.io.Writer; +import java.lang.reflect.InvocationTargetException; +import java.util.Map; + +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.cli.Options; +import org.apache.rat.config.parameters.Description; +import org.apache.rat.config.parameters.DescriptionBuilder; +import org.apache.rat.configuration.MatcherBuilderTracker; +import org.apache.rat.configuration.builders.AbstractBuilder; +import org.apache.rat.license.ILicense; +import org.apache.rat.license.ILicenseFamily; +import org.apache.rat.license.LicenseSetFactory.LicenseFilter; + +/** + * Generates text based documentation for Licenses, LicenceFamilies, and Matchers. + * + * Utilizes the same command line as the CLI based Report client so that additional licenses, etc. can be added. + * + */ +public class Documentation { + + private static final String INDENT = " "; + + private Documentation() { + } + + /** + * Output the ReportConfiguration to a writer. + * @param cfg The configuration to write. + * @param writer the writer to write to. + * @throws IOException on error. + */ + public static void output(ReportConfiguration cfg, Writer writer) throws IOException { + writer.write(String.format("%n>>>> LICENSES <<<<%n%n")); + for (ILicense l : cfg.getLicenses(LicenseFilter.all)) { + printLicense(l, writer); + } + + writer.write(String.format("%n>>>> MATCHERS (Datatype IHeaderMatcher) <<<<%n%n")); + for (Class<? extends AbstractBuilder> mClazz : MatcherBuilderTracker.INSTANCE.getClasses()) { + try { + AbstractBuilder builder = mClazz.getConstructor().newInstance(); + printMatcher(DescriptionBuilder.buildMap(builder.builtClass()), writer); + } catch (NoSuchMethodException | SecurityException | InstantiationException | IllegalAccessException + | IllegalArgumentException | InvocationTargetException e) { + throw new ConfigurationException( + String.format("Can not instantiate matcher builder %s ", mClazz.getName()), e); + } + } + + writer.write(String.format("%n>>>> FAMILIES (Datatype ILicenseFamily) <<<<%n%n")); + for (ILicenseFamily family : cfg.getLicenseFamilies(LicenseFilter.all)) { + printFamily(family, writer); + } + } + + private static void printFamily(ILicenseFamily family, Writer writer) throws IOException { + writer.write(String.format("'%s' - %s%n", family.getFamilyCategory().trim(), family.getFamilyName())); + } + + private static void printMatcher(Description matcher, Writer writer) throws IOException { + writer.write(String.format("'%s' - %s%n", matcher.getCommonName(), matcher.getDescription())); + printChildren(1, matcher.getChildren(), writer); + + } + + private static void printLicense(ILicense license, Writer writer) throws IOException { + Description dLicense = license.getDescription(); + writer.write(String.format("'%s' - %s %n", dLicense.getCommonName(), dLicense.getDescription())); + printChildren(1, dLicense.getChildren(), writer); + } + + private static void writeIndent(int indent, Writer writer) throws IOException { + for (int i = 0; i < indent; i++) { + writer.write(INDENT); + } + } + + private static void printChildren(int indent, Map<String, Description> children, Writer writer) throws IOException { + for (Description d : children.values()) { + writeIndent(indent, writer); + switch (d.getType()) { + case Parameter: + case BuilderParam: + writer.write(String.format("'%s' %s (Datatype: %s%s)%n", d.getCommonName(), d.getDescription(), + d.isCollection() ? "Collection of " : "", d.getChildType().getSimpleName())); + break; + case Unlabeled: + writer.write(String.format("'%s name' %s (Datatype: %s%s)%n", d.getCommonName(), d.getDescription(), + d.isCollection() ? "Collection of " : "", d.getChildType().getSimpleName())); + break; + case License: + // do noting + break; + case Matcher: + writeIndent(indent + 1, writer); + writer.write(String.format("%s %s %n", d.isCollection() ? "Collection of " : "A ", + d.getChildType().getSimpleName())); + printChildren(indent + 2, d.getChildren(), writer); + break; + } + } + } + + /** + * Creates the documentation. Writes to the outpus specified by the -o or --out option. Defaults to System.out. Review Comment: Typo: output -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
