Add possibility to check only public coverage #10
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| package com.manoelcampos.javadoc.coverage.configuration; | ||
|
|
||
| import java.util.*; | ||
|
|
||
| import com.manoelcampos.javadoc.coverage.Utils; | ||
| import com.sun.javadoc.DocErrorReporter; | ||
| import com.sun.tools.doclets.standard.Standard; | ||
|
|
||
| public class Configuration { | ||
|
|
||
| private static final NoValueOption computePublicCoverageOnly = new NoValueOption("-po", "-publicOnly", | ||
| "Indicates if coverage should be computed only for the public parts of a project."); | ||
| private static final StringOption coverageFileName = new StringOption("-o", "-outputName", | ||
| "Set the filename for the created coverage file. If nothing is given, the default is \"javadoc-coverage\".", | ||
| Optional.of("javadoc-coverage")); | ||
|
|
||
| private static final List<Option<?>> ALL_OPTIONS = new ArrayList<>(); | ||
|
|
||
| /** | ||
| * Static constructor for initializing the options list | ||
| */ | ||
| static { | ||
| ALL_OPTIONS.add(computePublicCoverageOnly); | ||
| ALL_OPTIONS.add(coverageFileName); | ||
| } | ||
|
|
||
| /** | ||
| * The raw options which need to be parsed to our configuration | ||
| */ | ||
| private final String[][] rawOptions; | ||
|
|
||
| public Configuration(String[][] rawOptions) { | ||
| this.rawOptions = rawOptions; | ||
| } | ||
|
|
||
| public boolean computePublicCoverageOnly() { | ||
| return isOptionContained(computePublicCoverageOnly); | ||
| } | ||
|
|
||
| public String getCoverageFileName() { | ||
| if (isOptionContained(coverageFileName)) { | ||
| return getOptionValue(coverageFileName); | ||
| } | ||
| return coverageFileName.getDefaultValue(); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the output directory passed as a command line argument to javadoc tool. | ||
| * | ||
| * @return the output directory to export the JavaDocs | ||
| */ | ||
| public String getOutputDirectory() { | ||
| // This is no option of the doclet, but instead of the javadoc tool | ||
| // so we don't declare it as an option here directly) | ||
|
|
||
| for (final String[] option : rawOptions) { | ||
| if (option.length == 2 && option[0].equals("-d")) { | ||
| return Utils.includeTrailingDirSeparator(option[1]); | ||
| } | ||
| } | ||
|
|
||
| return ""; | ||
| } | ||
|
|
||
| private boolean isOptionContained(Option<?> option) { | ||
| for (final String[] opt : rawOptions) { | ||
| if (option.isOption(opt[0])) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private <T> T getOptionValue(Option<T> option) { | ||
| if (!isOptionContained(option) && !option.hasDefaultValue()) { | ||
| throw new IllegalStateException("Option is not contained and has no default value"); | ||
| } | ||
|
|
||
| if (!isOptionContained(option)) { | ||
| return option.getDefaultValue(); | ||
| } | ||
|
|
||
| for (final String[] opt: rawOptions) { | ||
| if (option.isOption(opt[0])) { | ||
| return option.parseValue(opt); | ||
| } | ||
| } | ||
|
|
||
| throw new IllegalStateException("no valid option found although it should be there"); | ||
| } | ||
|
|
||
| /** | ||
| * This method is necessary for validating the doclet parameters, which happens before instantiating the | ||
| * CoverageDoclet and the configuration container. | ||
| * | ||
| * @param option | ||
| * @return the length of the option | ||
| */ | ||
| public static int getOptionLength(final String option) { | ||
| Optional<Option<?>> opt = ALL_OPTIONS.stream().filter(o -> o.isOption(option)).findFirst(); | ||
| if (opt.isPresent()) { | ||
| return opt.get().getLength(); | ||
| } | ||
| return Standard.optionLength(option); | ||
| } | ||
|
There was a problem hiding this comment. Using
|
||
|
|
||
| /** | ||
| * This method is necessary for validating the doclet parameters, which happens before instantiating the | ||
| * CoverageDoclet and the configuration container. | ||
| * | ||
| * @param options | ||
| * @param errorReporter | ||
| * @return indicates if the given options are valid | ||
| */ | ||
| public static boolean areValidOptions(final String[][] options, final DocErrorReporter errorReporter) { | ||
| for (final String[] opt : options) { | ||
| if (ALL_OPTIONS.stream().anyMatch(o -> o.isOption(opt[0]))) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return Standard.validOptions(options, errorReporter); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package com.manoelcampos.javadoc.coverage.configuration; | ||
|
|
||
| import lombok.AllArgsConstructor; | ||
| import lombok.Getter; | ||
|
|
||
| @Getter | ||
| @AllArgsConstructor | ||
| public class CoverageLimits { | ||
|
|
||
| private static final int PACKAGE_INDEX = 1; | ||
| private static final int INTERFACE_INDEX = 2; | ||
| private static final int CLASS_INDEX = 3; | ||
| private static final int METHOD_INDEX = 4; | ||
|
|
||
| private final double minPackageCoverage; | ||
| private final double minInterfaceCoverage; | ||
| private final double minClassCoverage; | ||
| private final double minMethodCoverage; | ||
|
|
||
| public static CoverageLimits noLimits() { | ||
| return new CoverageLimits(0,0,0,0); | ||
| } | ||
|
|
||
| public static CoverageLimits fromOptionsArray(String[] arr) { | ||
| double packageCov = safeParse(arr, PACKAGE_INDEX, "package"); | ||
| double interfaceCov = safeParse(arr, INTERFACE_INDEX, "interface"); | ||
| double classCov = safeParse(arr, CLASS_INDEX, "class"); | ||
| double methodCov = safeParse(arr, METHOD_INDEX, "method"); | ||
|
|
||
| return new CoverageLimits(packageCov, interfaceCov, classCov, methodCov); | ||
| } | ||
|
|
||
| private static double safeParse(String[] arr, int index, String exceptionMessagePrefix) { | ||
| try { | ||
| return Double.parseDouble(arr[index]); | ||
| } catch (NumberFormatException e) { | ||
| throw new IllegalArgumentException(exceptionMessagePrefix + " min coverage number was not a double: " + arr[index]); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really don't like lombok because it uses some JDK internals which may be removed. It also requires IDE plugins for some features. At this time, I prefer to keep dependencies as minimal as possible.