phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implemented metrics capability handling

Browse Source
This commit is contained in:
oowekyala
2017-06-20 13:43:47 +02:00
parent 851c63433a
commit 471c31e16d
9 changed files with 52 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTMethodOrConstructorDeclaration.java
View File

@ -4,11 +4,9 @@
package net.sourceforge.pmd.lang.java.ast;
import net.sourceforge.pmd.lang.ast.Node;
/**
* @author Clément Fournier
*/
public interface ASTMethodOrConstructorDeclaration extends QualifiableNode, Node, AccessNode {
public interface ASTMethodOrConstructorDeclaration extends QualifiableNode, AccessNode, JavaNode {
}

19
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/AbstractMetric.java
View File

@ -8,21 +8,19 @@ import java.util.ArrayList;
import java.util.List;
import net.sourceforge.pmd.lang.java.ast.ASTMethodOrConstructorDeclaration;
import net.sourceforge.pmd.lang.java.ast.AccessNode;
import net.sourceforge.pmd.lang.java.ast.QualifiedName;
import net.sourceforge.pmd.lang.java.oom.api.Metric;
/**
* Base class for metrics. Metric objects encapsulate the computational logic required to compute a metric from a
* PackageStats and node.
* PackageStats and node. They're stateless.
*
* @author Clément Fournier
*/
public abstract class AbstractMetric implements Metric {
// TODO:cf useful?
protected boolean isAbstractHandler = false;
/**
* Gives access to the toplevel package stats to metrics without having to pass them as a parameter to metrics.
*
@ -42,14 +40,15 @@ public abstract class AbstractMetric implements Metric {
}
/**
* Checks if the metric can be computed on that node.
* Default implementation of the supports method, which filters out abstract nodes. Metrics that support abstract
* nodes should override this method.
*
* @param node The node to check for
* @param node The node to check.
*
* @return True if the metric can be computed, false otherwise.
* @return True if the metric can be computed on this node.
*/
// TODO:cf better wrap that around the metrics implementation
protected boolean isSupported(ASTMethodOrConstructorDeclaration node) {
return isAbstractHandler || !node.isAbstract();
@Override
public boolean supports(AccessNode node) {
return !node.isAbstract();
}
}

11
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/Metrics.java
View File

@ -32,8 +32,7 @@ public final class Metrics {
*
* @return The top level package stats.
*/
/* default */
static PackageStats getTopLevelPackageStats() {
/* default */ static PackageStats getTopLevelPackageStats() {
return TOP_LEVEL_PACKAGE;
}
@ -89,6 +88,10 @@ public final class Metrics {
*/
public static double get(ClassMetricKey key, ASTClassOrInterfaceDeclaration node, MetricVersion version,
ResultOption option) {
if (!key.getCalculator().supports(node)) {
return Double.NaN;
}
MetricVersion safeOption = (version == null) ? Version.STANDARD : version;
return TOP_LEVEL_PACKAGE.compute(key, node, false, safeOption, option);
@ -117,6 +120,10 @@ public final class Metrics {
* @return The value of the metric, or {@code Double.NaN} if the value couln't be computed.
*/
public static double get(OperationMetricKey key, ASTMethodOrConstructorDeclaration node, MetricVersion version) {
if (!key.getCalculator().supports(node)) {
return Double.NaN;
}
MetricVersion safeOption = (version == null) ? Version.STANDARD : version;
return TOP_LEVEL_PACKAGE.compute(key, node, false, safeOption);

12
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/api/Metric.java
View File

@ -4,6 +4,8 @@
package net.sourceforge.pmd.lang.java.oom.api;
import net.sourceforge.pmd.lang.java.ast.AccessNode;
/**
* Umbrella marker interface for metrics.
*
@ -11,6 +13,16 @@ package net.sourceforge.pmd.lang.java.oom.api;
*/
public interface Metric {
/**
* Checks if the metric can be computed on the node.
*
* @param node The node to check.
*
* @return True if the metric can be computed.
*/
boolean supports(AccessNode node);
/** Default metric version. */
enum Version implements MetricVersion {
/** Standard option, used as a default. */

1
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/api/OperationMetric.java
View File

@ -23,5 +23,4 @@ public interface OperationMetric extends Metric {
*/
double computeFor(ASTMethodOrConstructorDeclaration node, MetricVersion version);
}

10
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/metrics/AtfdMetric.java
View File

@ -8,6 +8,7 @@ import java.util.List;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMethodOrConstructorDeclaration;
import net.sourceforge.pmd.lang.java.ast.AccessNode;
import net.sourceforge.pmd.lang.java.ast.QualifiedName;
import net.sourceforge.pmd.lang.java.oom.AbstractMetric;
import net.sourceforge.pmd.lang.java.oom.api.ClassMetric;
@ -25,11 +26,14 @@ import net.sourceforge.pmd.lang.java.oom.signature.Signature.Visibility;
*/
public class AtfdMetric extends AbstractMetric implements ClassMetric, OperationMetric {
@Override
public boolean supports(AccessNode node) {
return node instanceof ASTClassOrInterfaceDeclaration
|| node instanceof ASTMethodOrConstructorDeclaration && !node.isAbstract();
}
@Override // TODO:cf
public double computeFor(ASTMethodOrConstructorDeclaration node, MetricVersion version) {
if (!isSupported(node)) {
return Double.NaN;
}
OperationSigMask targetOps = new OperationSigMask();
targetOps.restrictVisibilitiesTo(Visibility.PUBLIC);

2
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/metrics/CycloMetric.java
View File

@ -63,11 +63,13 @@ public class CycloMetric extends AbstractClassAndOperationMetric {
return (double) cyclo.getValue();
}
@Override
public OperationMetricKey getOperationMetricKey() {
return OperationMetricKey.CYCLO;
}
/** Variants of CYCLO. */
public enum Version implements MetricVersion {
/** Do not count the paths in boolean expressions as decision points. */

7
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/metrics/LocMetric.java
View File

@ -6,6 +6,7 @@ package net.sourceforge.pmd.lang.java.oom.metrics;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMethodOrConstructorDeclaration;
import net.sourceforge.pmd.lang.java.ast.AccessNode;
import net.sourceforge.pmd.lang.java.oom.api.MetricVersion;
import net.sourceforge.pmd.lang.java.oom.api.OperationMetricKey;
@ -20,6 +21,12 @@ import net.sourceforge.pmd.lang.java.oom.api.OperationMetricKey;
*/
public class LocMetric extends AbstractClassAndOperationMetric {
@Override
public boolean supports(AccessNode node) {
return true;
}
@Override
protected double computeDefaultResultOption(ASTClassOrInterfaceDeclaration node, MetricVersion version) {
return node.getEndLine() - node.getBeginLine();

5
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/oom/metrics/NcssMetric.java
View File

@ -31,6 +31,7 @@ import net.sourceforge.pmd.lang.java.ast.ASTSwitchStatement;
import net.sourceforge.pmd.lang.java.ast.ASTSynchronizedStatement;
import net.sourceforge.pmd.lang.java.ast.ASTThrowStatement;
import net.sourceforge.pmd.lang.java.ast.ASTWhileStatement;
import net.sourceforge.pmd.lang.java.ast.AccessNode;
import net.sourceforge.pmd.lang.java.ast.JavaParserVisitorAdapter;
import net.sourceforge.pmd.lang.java.oom.api.MetricVersion;
import net.sourceforge.pmd.lang.java.oom.api.OperationMetricKey;
@ -46,6 +47,10 @@ import net.sourceforge.pmd.lang.java.oom.api.OperationMetricKey;
*/
public class NcssMetric extends AbstractClassAndOperationMetric {
@Override
public boolean supports(AccessNode node) {
return true;
}
@Override
protected double computeDefaultResultOption(ASTClassOrInterfaceDeclaration node, MetricVersion version) {