AntOption.java
/*
* 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.documentation.options;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import org.apache.commons.cli.Option;
import org.apache.rat.ui.UIOption;
import org.apache.rat.ui.UIOptionCollection;
import org.apache.rat.utils.CasedString;
import static java.lang.String.format;
/**
* A class that wraps the CLI option and provides Ant specific values.
*/
public final class AntOption extends UIOption<AntOption> {
/**
* Constructor.
*
* @param builder the AntOptionBuilder
*/
private AntOption(final AntOptionBuilder builder) {
super(builder);
}
/**
* Returns {@code true} if the option should be an attribute of the <rat:report> element.
*
* @return {@code true} if the option should be an attribute of the <rat:report> element.
*/
public boolean isAttribute() {
return getAntCollection().isAttribute(this);
}
@Override
public String toString() {
return getName();
}
/**
* Returns {@code true} if the option should be a child element of the <rat:report> element.
*
* @return {@code true} if the option should be a child element of the <rat:report> element.
*/
public boolean isElement() {
return !isAttribute();
}
/**
* If this option is converted to another option return that option otherwise
* return this option.
* @return the converted option.
*/
public AntOption getActualAntOption() {
return getAntCollection().getActualAntOption(this);
}
/**
* Gets the set of options that are mapped to this option. This is used to allow one implementation to answer for
* multiple options.
* @return the set of options that are mapped to this option.
*/
public Set<AntOption> convertedFrom() {
return getAntCollection().convertedFrom(this);
}
@Override
public String getText() {
return cleanupName(option);
}
@Override
protected String cleanupName(final Option option) {
AntOption antOption;
if (getOption().equals(option)) {
antOption = this;
} else {
Optional<AntOption> optAntOption = getOptionCollection().getMappedOption(option);
if (optAntOption.isPresent()) {
antOption = optAntOption.get();
} else {
return "";
}
}
return antOption.cleanupName();
}
/**
* Cleans up the name of this AntOption. Used in documentation.
* Returns either {@code <name>} or {@code name attribute}.
* @return the cleaned up name.
*/
public String cleanupName() {
String fmt = isAttribute() ? "%s attribute" : "<%s>";
return format(fmt, name);
}
/**
* Gets the AntOptionCollection this AntOption is associated with.
* @return the AntOptionCollection this AntOption is associated with.
*/
AntOptionCollection getAntCollection() {
return getOptionCollection();
}
/**
* Gets the Ant build type for this option.
* @return the Ant build type for this option.
*/
public AntOptionCollection.BuildType buildType() {
return getAntCollection().buildType(this.getArgType());
}
@Override
public String getExample() {
return new ExampleGenerator().getExample();
}
/**
* An example code generator for this AntOption.
*/
public class ExampleGenerator {
/**
* The constructor.
*/
public ExampleGenerator() {
}
/**
* Gets an example Ant XML report call using ant option.
* @return the example of this ant option.
*/
String getExample() {
return getExample("data", getAntCollection().getRequiredAttributes(getName()), null);
}
/**
* Gets an example Ant XML report call using ant option with the specified attributes and child elements.
* @param data the data value for this option.
* @param attributes a map of attribute keys and values.
* @param childElements a list of child elements for the example
* @return example Ant XML report call using Ant option with the specified attributes and child elements.
*/
public String getExample(final String data, final Map<String, String> attributes, final List<String> childElements) {
return "<rat:report" +
getExampleAttributes(data, attributes) +
"> \n" +
getChildElements(data, childElements) +
"</rat:report>\n";
}
/**
* Creates a string comprising the attributes for the Ant XML report call.
* @param data the data value for this option.
* @param attributes a map of attribute keys and values.
* @return a string comprising all the attribute keys and values for the Ant XML report element.
*/
public String getExampleAttributes(final String data, final Map<String, String> attributes) {
AntOption actualOption = getActualAntOption();
StringBuilder result = new StringBuilder();
if (attributes != null) {
attributes.forEach((k, v) -> result.append(format(" %s=\"%s\"", k, v)));
}
if (actualOption.isAttribute()) {
result.append(format(" %s=\"%s\"", actualOption.getName(), actualOption.hasArg() ? data : "true"));
}
return result.toString();
}
/**
* Creates a string comprising the child elements for the Ant XML report call.
* @param data the data for this option.
* @param childElements additional child elements.
* @return A string comprising the child elements for the Ant XML report call.
*/
public String getChildElements(final String data, final List<String> childElements) {
AntOption baseOption = AntOption.this;
AntOption actualOption = getActualAntOption();
StringBuilder result = new StringBuilder();
if (!actualOption.isAttribute()) {
String inner = getAntCollection().buildType(getArgType()).getXml(actualOption, baseOption, data);
result.append(inner);
}
if (childElements != null) {
childElements.forEach(x -> result.append(x).append("\n"));
}
return result.toString();
}
}
/**
* The Builder for AntOptions.
*/
public static class AntOptionBuilder extends UIOption.Builder<AntOption, AntOptionBuilder> {
public AntOptionBuilder() {
super();
}
/**
* returns the function to convert an Option to its Ant based cased name.
* @return the function to convert an Option to its Ant based cased name.
*/
protected Function<Option, CasedString> getNameFactory() {
return this::createName;
}
@Override
public AntOptionBuilder optionCollection(final UIOptionCollection<AntOption> optionCollection) {
if (optionCollection instanceof AntOptionCollection) {
return super.optionCollection(optionCollection);
}
throw new IllegalArgumentException("Option collection must be instance of AntOptionCollection");
}
@Override
protected AntOption doBuild() {
return new AntOption(this);
}
/**
* Creates the name for the option based on rules for conversion of Option names.
* Ant names are in PASCAL format.
* @param option the standard option.
* @return a new CasedString comprising the name of the AntOption.
* @see CasedString.StringCase#PASCAL
*/
CasedString createName(final Option option) {
List<String> pluralEndings = List.of("approved", "denied");
String name = optionCollection().rename(option);
CasedString casedName = new CasedString(CasedString.StringCase.KEBAB, name);
String[] segments = casedName.getSegments();
String lastSegment = segments[segments.length - 1];
if (option.hasArgs() && !lastSegment.endsWith("s") && !pluralEndings.contains(lastSegment)) {
segments[segments.length - 1] += "s";
casedName = new CasedString(CasedString.StringCase.KEBAB, segments);
}
return casedName.as(CasedString.StringCase.PASCAL);
}
}
}