Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix Issue #93: Support columns detail for Clover reports
Introduce a new closure backed configuration element in reports following the columns nested element for clover-report. This is implemented as a dynamic method construct so that the syntax is easier to read. We do not support the expression column since it is rather obsure and would require additional syntax support to work. Migrated several support classes to Java to prepare for the overall Gradle 4 work which will eventually convert most of the production code into Java from Groovy.
- Loading branch information
1 parent
78592c1
commit 310dd2e
Showing
16 changed files
with
425 additions
and
80 deletions.
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
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
47 changes: 0 additions & 47 deletions
47
src/main/groovy/com/bmuschko/gradle/clover/CloverReportHistoricalConvention.groovy
This file was deleted.
Oops, something went wrong.
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
6 changes: 0 additions & 6 deletions
6
src/main/groovy/com/bmuschko/gradle/clover/HistoricalAdded.groovy
This file was deleted.
Oops, something went wrong.
7 changes: 0 additions & 7 deletions
7
src/main/groovy/com/bmuschko/gradle/clover/HistoricalMover.groovy
This file was deleted.
Oops, something went wrong.
134 changes: 134 additions & 0 deletions
134
src/main/java/com/bmuschko/gradle/clover/CloverReportColumn.java
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,134 @@ | ||
| /* | ||
| * Copyright 2017 the original author or authors. | ||
| * | ||
| * Licensed 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 com.bmuschko.gradle.clover; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.gradle.api.InvalidUserDataException; | ||
|
|
||
| public class CloverReportColumn { | ||
| public CloverReportColumn(String column, Map<String, String> attributes) { | ||
| this.column = column; | ||
| this.attributes = new HashMap<>(attributes.size()); | ||
| for (Map.Entry<String, String> entry : attributes.entrySet()) { | ||
| String key = entry.getKey(); | ||
| if (key.equals("format")) { | ||
| assertValidFormat(column, entry.getValue()); | ||
| } else if (key.equals("min") || key.equals("max")) { | ||
| assertValidNumber(entry.getValue()); | ||
| } else if (key.equals("scope")) { | ||
| assertValidScope(entry.getValue()); | ||
| } else { | ||
| throw new InvalidUserDataException("Invalid column attribute name: " + key); | ||
| } | ||
| this.attributes.put(key, entry.getValue()); | ||
| } | ||
| } | ||
|
|
||
| private final String column; | ||
| public String getColumn() { | ||
| return column; | ||
| } | ||
|
|
||
| private final Map<String, String> attributes; | ||
| public Map<String, String> getAttributes() { | ||
| return Collections.unmodifiableMap(attributes); | ||
| } | ||
|
|
||
| private void assertValidFormat(String name, String format) { | ||
| FormatValidator validator = validColumns.get(name); | ||
| if (!validator.valid(format)) { | ||
| throw new InvalidUserDataException("Invalid column format specification: " + format); | ||
| } | ||
| } | ||
|
|
||
| private void assertValidNumber(String value) { | ||
| Integer.parseInt(value, 10); | ||
| } | ||
|
|
||
| private static final Pattern scopeValidator = Pattern.compile("(package|class|method)"); | ||
| private void assertValidScope(String scope) { | ||
| if (!scopeValidator.matcher(scope).matches()) { | ||
| throw new InvalidUserDataException("Invalid column scope specification: " + scope); | ||
| } | ||
| } | ||
|
|
||
| public static boolean validColumn(String column) { | ||
| return validColumns.containsKey(column); | ||
| } | ||
|
|
||
| private static final Map<String, FormatValidator> validColumns; | ||
| static { | ||
| RawFormatValidator raw = new RawFormatValidator(); | ||
| MultiFormatValidator multi = new MultiFormatValidator(); | ||
|
|
||
| validColumns = new HashMap<String, FormatValidator>(); | ||
| validColumns.put("avgClassesPerFile", raw); | ||
| validColumns.put("avgMethodComplexity", raw); | ||
| validColumns.put("avgMethodsPerClass", raw); | ||
| validColumns.put("avgStatementsPerMethod", raw); | ||
| validColumns.put("complexity", raw); | ||
| validColumns.put("complexityDensity", raw); | ||
| validColumns.put("coveredBranches", multi); | ||
| validColumns.put("coveredElements", multi); | ||
| validColumns.put("coveredMethods", multi); | ||
| validColumns.put("coveredStatements", multi); | ||
| //validColumns.put("expression", raw); | ||
| validColumns.put("filteredElements", multi); | ||
| validColumns.put("ncLineCount", raw); | ||
| validColumns.put("lineCount", raw); | ||
| validColumns.put("SUM", raw); | ||
| validColumns.put("percentageCoveredContribution", multi); | ||
| validColumns.put("percentageUncoveredContribution", multi); | ||
| validColumns.put("totalBranches", raw); | ||
| validColumns.put("totalChildren", raw); | ||
| validColumns.put("totalClasses", raw); | ||
| validColumns.put("totalElements", raw); | ||
| validColumns.put("totalFiles", raw); | ||
| validColumns.put("totalMethods", raw); | ||
| validColumns.put("totalPercentageCovered", multi); | ||
| validColumns.put("totalStatements", raw); | ||
| validColumns.put("uncoveredBranches", multi); | ||
| validColumns.put("uncoveredElements", multi); | ||
| validColumns.put("uncoveredMethods", multi); | ||
| validColumns.put("uncoveredStatements", multi); | ||
|
|
||
| validColumns.put("files", raw); | ||
| validColumns.put("methods", raw); | ||
| } | ||
|
|
||
| private interface FormatValidator { | ||
| boolean valid(String format); | ||
| } | ||
|
|
||
| private static class RawFormatValidator implements FormatValidator { | ||
| @Override | ||
| public boolean valid(String format) { | ||
| return "raw".equals(format); | ||
| } | ||
| } | ||
|
|
||
| private static class MultiFormatValidator implements FormatValidator { | ||
| private static final Pattern formatValidator = Pattern.compile("(raw|bar|longbar|%)"); | ||
| @Override | ||
| public boolean valid(String format) { | ||
| return formatValidator.matcher(format).matches(); | ||
| } | ||
| } | ||
| } |
68 changes: 68 additions & 0 deletions
68
src/main/java/com/bmuschko/gradle/clover/CloverReportColumnsConvention.java
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,68 @@ | ||
| /* | ||
| * Copyright 2017 the original author or authors. | ||
| * | ||
| * Licensed 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 com.bmuschko.gradle.clover; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.Map; | ||
|
|
||
| import org.gradle.internal.metaobject.InvokeMethodResult; | ||
| import org.gradle.internal.metaobject.MethodAccess; | ||
| import org.gradle.internal.metaobject.MethodMixIn; | ||
|
|
||
| import groovy.lang.GroovyObjectSupport; | ||
|
|
||
| public class CloverReportColumnsConvention extends GroovyObjectSupport implements MethodMixIn { | ||
| private final Collection<CloverReportColumn> columns; | ||
| private final DynamicMethods dynamicMethods; | ||
|
|
||
| public CloverReportColumnsConvention() { | ||
| columns = new ArrayList<CloverReportColumn>(); | ||
| dynamicMethods = new DynamicMethods(); | ||
| } | ||
|
|
||
| public Collection<CloverReportColumn> getColumns() { | ||
| return Collections.unmodifiableCollection(columns); | ||
| } | ||
|
|
||
| private void add(String column, Map<String, String> attributes) { | ||
| columns.add(new CloverReportColumn(column, attributes)); | ||
| } | ||
|
|
||
| @Override | ||
| public MethodAccess getAdditionalMethods() { | ||
| return dynamicMethods; | ||
| } | ||
|
|
||
| private class DynamicMethods implements MethodAccess { | ||
| @Override | ||
| public boolean hasMethod(String name, Object... arguments) { | ||
| return arguments.length == 1 && arguments[0] instanceof Map && validColumnName(name); | ||
| } | ||
|
|
||
| private boolean validColumnName(String name) { | ||
| return CloverReportColumn.validColumn(name); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| @Override | ||
| public void invokeMethod(String name, InvokeMethodResult result, Object... arguments) { | ||
| CloverReportColumnsConvention.this.add(name, (Map<String, String>) arguments[0]); | ||
| result.result(null); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.