From 2f678791ccee6d0bebf67e7fa12eb985653df2e5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Fournier?= <clement.fournier76@gmail.com>
Date: Sun, 20 Aug 2017 01:40:11 +0200
Subject: [PATCH] ATFD metric

---
 .../lang/java/metrics/impl/AtfdMetric.java    |  32 +--
 .../impl/visitors/AtfdBaseVisitor.java        | 109 ++++++++++
 .../java/metrics/impl/AllMetricsTest.java     |   1 +
 .../lang/java/metrics/impl/AtfdTestRule.java  |  26 +++
 .../lang/java/metrics/impl/xml/AtfdTest.xml   | 186 ++++++++++++++++++
 .../resources/rulesets/java/metrics_test.xml  |   6 +
 6 files changed, 338 insertions(+), 22 deletions(-)
 create mode 100644 pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/visitors/AtfdBaseVisitor.java
 create mode 100644 pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdTestRule.java
 create mode 100644 pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/metrics/impl/xml/AtfdTest.xml

diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdMetric.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdMetric.java
index 9f15a84271..946c13ef78 100644
--- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdMetric.java
+++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdMetric.java
@@ -4,15 +4,15 @@
 
 package net.sourceforge.pmd.lang.java.metrics.impl;
 
-import java.util.List;
+import org.apache.commons.lang3.mutable.MutableInt;
 
 import net.sourceforge.pmd.lang.java.ast.ASTAnyTypeDeclaration;
 import net.sourceforge.pmd.lang.java.ast.ASTMethodOrConstructorDeclaration;
-import net.sourceforge.pmd.lang.java.ast.JavaQualifiedName;
-import net.sourceforge.pmd.lang.java.metrics.signature.JavaOperationSigMask;
-import net.sourceforge.pmd.lang.java.metrics.signature.JavaOperationSignature.Role;
-import net.sourceforge.pmd.lang.java.metrics.signature.JavaSignature.Visibility;
+import net.sourceforge.pmd.lang.java.metrics.JavaMetrics;
+import net.sourceforge.pmd.lang.java.metrics.api.JavaOperationMetricKey;
+import net.sourceforge.pmd.lang.java.metrics.impl.visitors.AtfdBaseVisitor;
 import net.sourceforge.pmd.lang.metrics.MetricOptions;
+import net.sourceforge.pmd.lang.metrics.ResultOption;
 
 /**
  * Access to Foreign Data. Quantifies the number of foreign fields accessed directly or via accessors.
@@ -24,31 +24,19 @@ public final class AtfdMetric {
 
     public static final class AtfdOperationMetric extends AbstractJavaOperationMetric {
 
-        @Override // TODO:cf
+        @Override
         public double computeFor(ASTMethodOrConstructorDeclaration node, MetricOptions options) {
-
-            JavaOperationSigMask targetOps = new JavaOperationSigMask();
-            targetOps.restrictVisibilitiesTo(Visibility.PUBLIC);
-            targetOps.restrictRolesTo(Role.GETTER_OR_SETTER);
-
-            List<JavaQualifiedName> callQNames = findAllCalls(node);
-            int foreignCalls = 0;
-            for (JavaQualifiedName name : callQNames) {
-                if (getSignatureMatcher().hasMatchingSig(name, targetOps)) {
-                    foreignCalls++;
-                }
-            }
-
-            return foreignCalls / callQNames.size();
+            return ((MutableInt) node.jjtAccept(new AtfdBaseVisitor(), new MutableInt(0))).getValue();
         }
+
     }
 
     public static final class AtfdClassMetric extends AbstractJavaClassMetric {
 
         @Override
         public double computeFor(ASTAnyTypeDeclaration node, MetricOptions options) {
-            // TODO:cf
-            return 0;
+            // TODO maybe consider code outside methods
+            return JavaMetrics.get(JavaOperationMetricKey.ATFD, node, options, ResultOption.SUM);
         }
 
 
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/visitors/AtfdBaseVisitor.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/visitors/AtfdBaseVisitor.java
new file mode 100644
index 0000000000..77b32dd102
--- /dev/null
+++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/impl/visitors/AtfdBaseVisitor.java
@@ -0,0 +1,109 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.java.metrics.impl.visitors;
+
+import java.util.List;
+
+import org.apache.commons.lang3.mutable.MutableInt;
+
+import net.sourceforge.pmd.lang.java.ast.ASTAllocationExpression;
+import net.sourceforge.pmd.lang.java.ast.ASTLiteral;
+import net.sourceforge.pmd.lang.java.ast.ASTName;
+import net.sourceforge.pmd.lang.java.ast.ASTPrimaryExpression;
+import net.sourceforge.pmd.lang.java.ast.ASTPrimaryPrefix;
+import net.sourceforge.pmd.lang.java.ast.ASTPrimarySuffix;
+import net.sourceforge.pmd.lang.java.ast.JavaParserVisitorAdapter;
+import net.sourceforge.pmd.util.StringUtil;
+
+/**
+ * Computes Atfd.
+ *
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public class AtfdBaseVisitor extends JavaParserVisitorAdapter {
+
+
+    @Override
+    public Object visit(ASTPrimaryExpression node, Object data) {
+        if (isForeignAttributeOrMethod(node) && (isAttributeAccess(node)
+            || isMethodCall(node) && isForeignGetterSetterCall(node))) {
+
+            ((MutableInt) data).increment();
+        }
+        return super.visit(node, data);
+    }
+
+
+    private boolean isForeignGetterSetterCall(ASTPrimaryExpression node) {
+
+        String methodOrAttributeName = getMethodOrAttributeName(node);
+
+        return methodOrAttributeName != null && StringUtil.startsWithAny(methodOrAttributeName, "get", "is", "set");
+    }
+
+
+    private boolean isMethodCall(ASTPrimaryExpression node) {
+        boolean result = false;
+        List<ASTPrimarySuffix> suffixes = node.findDescendantsOfType(ASTPrimarySuffix.class);
+        if (suffixes.size() == 1) {
+            result = suffixes.get(0).isArguments();
+        }
+        return result;
+    }
+
+
+    private boolean isForeignAttributeOrMethod(ASTPrimaryExpression node) {
+        boolean result;
+        String nameImage = getNameImage(node);
+
+        if (nameImage != null && (!nameImage.contains(".") || nameImage.startsWith("this."))) {
+            result = false;
+        } else if (nameImage == null && node.getFirstDescendantOfType(ASTPrimaryPrefix.class).usesThisModifier()) {
+            result = false;
+        } else if (nameImage == null && node.hasDecendantOfAnyType(ASTLiteral.class, ASTAllocationExpression.class)) {
+            result = false;
+        } else {
+            result = true;
+        }
+
+        return result;
+    }
+
+
+    private String getNameImage(ASTPrimaryExpression node) {
+        ASTPrimaryPrefix prefix = node.getFirstDescendantOfType(ASTPrimaryPrefix.class);
+        ASTName name = prefix.getFirstDescendantOfType(ASTName.class);
+
+        String image = null;
+        if (name != null) {
+            image = name.getImage();
+        }
+        return image;
+    }
+
+
+    private String getMethodOrAttributeName(ASTPrimaryExpression node) {
+        ASTPrimaryPrefix prefix = node.getFirstDescendantOfType(ASTPrimaryPrefix.class);
+        ASTName name = prefix.getFirstDescendantOfType(ASTName.class);
+
+        String methodOrAttributeName = null;
+
+        if (name != null) {
+            int dotIndex = name.getImage().indexOf(".");
+            if (dotIndex > -1) {
+                methodOrAttributeName = name.getImage().substring(dotIndex + 1);
+            }
+        }
+
+        return methodOrAttributeName;
+    }
+
+
+    private boolean isAttributeAccess(ASTPrimaryExpression node) {
+        return node.findDescendantsOfType(ASTPrimarySuffix.class).isEmpty();
+    }
+
+}
diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AllMetricsTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AllMetricsTest.java
index aa7756200b..f5d3b6e2a9 100644
--- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AllMetricsTest.java
+++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AllMetricsTest.java
@@ -37,6 +37,7 @@ public class AllMetricsTest extends SimpleAggregatorTst {
         addRule(RULESET, "NoamTest");
         addRule(RULESET, "WocTest");
         addRule(RULESET, "TccTest");
+        addRule(RULESET, "AtfdTest");
     }
 
 }
diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdTestRule.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdTestRule.java
new file mode 100644
index 0000000000..11a17bb4a4
--- /dev/null
+++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/metrics/impl/AtfdTestRule.java
@@ -0,0 +1,26 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.java.metrics.impl;
+
+import net.sourceforge.pmd.lang.java.metrics.api.JavaClassMetricKey;
+import net.sourceforge.pmd.lang.java.metrics.api.JavaOperationMetricKey;
+
+/**
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public class AtfdTestRule extends AbstractMetricTestRule {
+
+    @Override
+    protected JavaClassMetricKey getClassKey() {
+        return JavaClassMetricKey.ATFD;
+    }
+
+
+    @Override
+    protected JavaOperationMetricKey getOpKey() {
+        return JavaOperationMetricKey.ATFD;
+    }
+}
diff --git a/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/metrics/impl/xml/AtfdTest.xml b/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/metrics/impl/xml/AtfdTest.xml
new file mode 100644
index 0000000000..6a060ba0ce
--- /dev/null
+++ b/pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/metrics/impl/xml/AtfdTest.xml
@@ -0,0 +1,186 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data>
+
+    <code-fragment id="full-example"><![CDATA[
+public class StatementAndBraceFinder extends JavaParserVisitorAdapter {
+    private static final Logger LOGGER = Logger.getLogger(StatementAndBraceFinder.class.getName());
+
+    private final DataFlowHandler dataFlowHandler;
+    private Structure dataFlow;
+
+    public StatementAndBraceFinder(DataFlowHandler dataFlowHandler) {
+        this.dataFlowHandler = dataFlowHandler;
+    }
+
+    public void buildDataFlowFor(JavaNode node) {
+        if (!(node instanceof ASTMethodDeclaration) && !(node instanceof ASTConstructorDeclaration)) {
+            throw new RuntimeException("Can't build a data flow for anything other than a method or a constructor");
+        }
+
+        this.dataFlow = new Structure(dataFlowHandler);
+        this.dataFlow.createStartNode(node.getBeginLine());
+        this.dataFlow.createNewNode(node);
+
+        node.jjtAccept(this, dataFlow);
+
+        this.dataFlow.createEndNode(node.getEndLine());
+        if (LOGGER.isLoggable(Level.FINE)) {
+            // TODO SRT Remove after development
+            LOGGER.fine("DataFlow is " + this.dataFlow.dump());
+        }
+        Linker linker = new Linker(dataFlowHandler, dataFlow.getBraceStack(), dataFlow.getContinueBreakReturnStack());
+        try {
+            linker.computePaths();
+        } catch (SequenceException | LinkerException e) {
+            e.printStackTrace();
+        }
+    }
+
+
+    private void tryToLog(String tag, NodeType type, Node node) {
+        if (LOGGER.isLoggable(Level.FINEST)) {
+            LOGGER.finest("pushOnStack " + tag + " " + type + ": line " + node.getBeginLine()
+                + ", column " + node.getBeginColumn());
+        }
+    }
+
+    private void tryToLog(NodeType type, Node node) {
+        tryToLog("", type, node);
+    }
+
+    @Override
+    public Object visit(ASTStatementExpression node, Object data) {
+        if (!(data instanceof Structure)) {
+            return data;
+        }
+        Structure dataFlow = (Structure) data;
+        if (LOGGER.isLoggable(Level.FINEST)) {
+            LOGGER.finest("createNewNode ASTStatementExpression: line " + node.getBeginLine() + ", column "
+                + node.getBeginColumn());
+        }
+        dataFlow.createNewNode(node);
+        return super.visit(node, data);
+    }
+
+    @Override
+    public Object visit(ASTVariableDeclarator node, Object data) {
+        if (!(data instanceof Structure)) {
+            return data;
+        }
+        Structure dataFlow = (Structure) data;
+        if (LOGGER.isLoggable(Level.FINEST)) {
+            LOGGER.finest("createNewNode ASTVariableDeclarator: line " + node.getBeginLine() + ", column "
+                + node.getBeginColumn());
+        }
+        dataFlow.createNewNode(node);
+        return super.visit(node, data);
+    }
+
+    @Override
+    public Object visit(ASTExpression node, Object data) {
+        if (!(data instanceof Structure)) {
+            return data;
+        }
+        Structure dataFlow = (Structure) data;
+
+        String loggerTag = "parent";
+
+        Node parent = node.jjtGetParent();
+
+        // TODO what about throw stmts?
+        if (parent instanceof ASTIfStatement) {
+            dataFlow.createNewNode(node); // START IF
+            dataFlow.pushOnStack(NodeType.IF_EXPR, dataFlow.getLast());
+            tryToLog(loggerTag, NodeType.IF_EXPR, node);
+        } else if (parent instanceof ASTWhileStatement) {
+            dataFlow.createNewNode(node); // START WHILE
+            dataFlow.pushOnStack(NodeType.WHILE_EXPR, dataFlow.getLast());
+            tryToLog(loggerTag, NodeType.WHILE_EXPR, node);
+        } else if (parent instanceof ASTSwitchStatement) {
+            dataFlow.createNewNode(node); // START SWITCH
+            dataFlow.pushOnStack(NodeType.SWITCH_START, dataFlow.getLast());
+            tryToLog(loggerTag, NodeType.SWITCH_START, node);
+        } else if (parent instanceof ASTForStatement) {
+            dataFlow.createNewNode(node); // FOR EXPR
+            dataFlow.pushOnStack(NodeType.FOR_EXPR, dataFlow.getLast());
+            tryToLog(loggerTag, NodeType.FOR_EXPR, node);
+        } else if (parent instanceof ASTDoStatement) {
+            dataFlow.createNewNode(node); // DO EXPR
+            dataFlow.pushOnStack(NodeType.DO_EXPR, dataFlow.getLast());
+            tryToLog(loggerTag, NodeType.DO_EXPR, node);
+        } else if (parent instanceof ASTAssertStatement) {
+            dataFlow.createNewNode(node);
+            dataFlow.pushOnStack(NodeType.ASSERT_STATEMENT, dataFlow.getLast());
+            tryToLog(loggerTag, NodeType.ASSERT_STATEMENT, node);
+        }
+
+        return super.visit(node, data);
+    }
+
+}
+
+     ]]></code-fragment>
+
+
+    <test-code>
+        <description>Full example</description>
+        <expected-problems>1</expected-problems>
+        <expected-messages>
+            <message>'.StatementAndBraceFinder' has value 10.</message>
+        </expected-messages>
+        <code-ref id="full-example"/>
+    </test-code>
+
+    <test-code>
+        <description>Test empty class</description>
+        <expected-problems>1</expected-problems>
+        <rule-property name="reportClasses">false</rule-property>
+        <expected-messages>
+            <message>'.Foo' has value 0.</message>
+        </expected-messages>
+        <code><![CDATA[
+        public class Foo {
+          void bar() {
+            a.foo();
+          }
+        }
+        ]]></code>
+    </test-code>
+
+    <test-code>
+        <description>Test empty class</description>
+
+        <expected-problems>1</expected-problems>
+        <expected-messages>
+            <message>'.Foo' has value 0.</message>
+        </expected-messages>
+        <code><![CDATA[
+        public class Foo {
+
+
+
+        }
+        ]]></code>
+    </test-code>
+
+    <test-code>
+        <description>NOPA doesn't support enums, interfaces or annotations</description>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+        public interface Foo {
+
+           public final int h;
+
+           enum Bar{
+             FOO;
+             public int bel = 0;
+           }
+
+           @interface Tag {
+              public static final int num = 0;
+           }
+        }
+        ]]></code>
+    </test-code>
+
+</test-data>
\ No newline at end of file
diff --git a/pmd-java/src/test/resources/rulesets/java/metrics_test.xml b/pmd-java/src/test/resources/rulesets/java/metrics_test.xml
index 258f83f764..be4470c5a5 100644
--- a/pmd-java/src/test/resources/rulesets/java/metrics_test.xml
+++ b/pmd-java/src/test/resources/rulesets/java/metrics_test.xml
@@ -63,4 +63,10 @@
           metrics="true">
     </rule>
 
+    <rule name="AtfdTest"
+          message = "''{0}'' has value {1}."
+          class="net.sourceforge.pmd.lang.java.metrics.impl.AtfdTestRule"
+          metrics="true">
+    </rule>
+
 </ruleset>