#405 implemented. (#460)

cflint · Aug 21, 2017 · c0e66aa · c0e66aa
1 parent 0b9befa
commit c0e66aa
Show file tree

Hide file tree

Showing 5 changed files with 98 additions and 6 deletions.
diff --git a/src/main/java/com/cflint/plugins/core/StructKeyChecker.java b/src/main/java/com/cflint/plugins/core/StructKeyChecker.java
@@ -1,10 +1,14 @@
 package com.cflint.plugins.core;
 
+import java.util.List;
+
 import com.cflint.BugList;
 import com.cflint.plugins.CFLintScannerAdapter;
 import com.cflint.plugins.Context;
 
 import cfml.parsing.cfscript.CFExpression;
+import cfml.parsing.cfscript.CFFullVarExpression;
+import cfml.parsing.cfscript.CFIdentifier;
 import cfml.parsing.cfscript.CFStructElementExpression;
 import cfml.parsing.cfscript.CFStructExpression;
 
@@ -13,7 +17,14 @@ public class StructKeyChecker extends CFLintScannerAdapter {
     @Override
     public void expression(final CFExpression expression, final Context context, final BugList bugs) {
 
-        if (expression instanceof CFStructExpression) {
+        if (context.isInAssignmentExpression() && expression instanceof CFFullVarExpression) {
+            final List<CFExpression> subExpressions = expression.decomposeExpression();
+            if (subExpressions != null && subExpressions.size() > 1
+                    && subExpressions.get(subExpressions.size() - 1) instanceof CFIdentifier) {
+                context.addMessage("STRUCT_ARRAY_NOTATION", subExpressions.get(subExpressions.size() - 1).Decompile(0));
+            }
+        }
+        else if (expression instanceof CFStructExpression) {
             CFStructExpression structExpression = (CFStructExpression) expression;
             for (Object element : structExpression.getElements()) {
                 CFStructElementExpression structKeyExpression = (CFStructElementExpression) element;

diff --git a/src/main/resources/cflint.definition.json b/src/main/resources/cflint.definition.json
@@ -877,6 +877,11 @@
           "code": "UNQUOTED_STRUCT_KEY",
           "messageText": "Unquoted struct key ${variable} is not case-sensitive.  Quoting it is recommended.",
           "severity": "WARNING"
+        },
+        {
+          "code": "STRUCT_ARRAY_NOTATION",
+          "messageText": "Unquoted struct key ${variable} is not case-sensitive.  Using array notation is recommended.",
+          "severity": "WARNING"
         }
       ],
       "parameter": []
@@ -1003,6 +1008,7 @@
     	"UNUSED_LOCAL_VARIABLE",
     	"UNUSED_METHOD_ARGUMENT",
     	"UNQUOTED_STRUCT_KEY",
+    	"STRUCT_ARRAY_NOTATION",
     	"USE_DISPLAY_NAME"
     ]
   }, {

diff --git a/src/test/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/.cflintrc b/src/test/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/.cflintrc
@@ -2,11 +2,9 @@
   "output" : [ ],
   "rule" : [ ],
   "excludes" : [ ],
-  "includes" : [ {
-    "code" : "UNQUOTED_STRUCT_KEY",
-    "messageText" : null,
-    "severity" : null
-  } ],
+  "includes" : [ {"code" : "UNQUOTED_STRUCT_KEY"},
+    {"code" : "STRUCT_ARRAY_NOTATION"}
+    ],
   "inheritParent" : false,
   "inheritPlugins" : true
 }
diff --git a/...st/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.cfc b/...st/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.cfc
@@ -0,0 +1,12 @@
+// not compliant
+component{
+	function x(){
+		sampleStruct.yetAnotherKey = "yetAnotherValue";
+		//repeat
+		sampleStruct.yetAnotherKey = "yetAnotherValue";
+		sampleStruct.foo["abc"] = "yetAnotherValue";
+		sampleStruct.foo().xyzzy["abc"] = "yetAnotherValue";
+		sampleStruct.foo().bar = "yetAnotherValue";
+		sampleStruct.foo() = "yetAnotherValue";
+	}
+}
diff --git a/...ces/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.expected.txt b/...ces/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.expected.txt
@@ -0,0 +1,65 @@
+{
+  "version" : "",
+  "timestamp" : 0,
+  "issues" : [ {
+    "severity" : "WARNING",
+    "id" : "STRUCT_ARRAY_NOTATION",
+    "message" : "STRUCT_ARRAY_NOTATION",
+    "category" : "CFLINT",
+    "abbrev" : "SA",
+    "locations" : [ {
+      "file" : "src/test/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.cfc",
+      "fileName" : "dotNotation_405.cfc",
+      "function" : "x",
+      "column" : 3,
+      "line" : 4,
+      "message" : "Unquoted struct key yetAnotherKey is not case-sensitive.  Using array notation is recommended.",
+      "variable" : "yetAnotherKey",
+      "expression" : "sampleStruct.yetAnotherKey"
+    } ]
+  }, {
+    "severity" : "WARNING",
+    "id" : "STRUCT_ARRAY_NOTATION",
+    "message" : "STRUCT_ARRAY_NOTATION",
+    "category" : "CFLINT",
+    "abbrev" : "SA",
+    "locations" : [ {
+      "file" : "src/test/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.cfc",
+      "fileName" : "dotNotation_405.cfc",
+      "function" : "x",
+      "column" : 3,
+      "line" : 6,
+      "message" : "Unquoted struct key yetAnotherKey is not case-sensitive.  Using array notation is recommended.",
+      "variable" : "yetAnotherKey",
+      "expression" : "sampleStruct.yetAnotherKey"
+    } ]
+  }, {
+    "severity" : "WARNING",
+    "id" : "STRUCT_ARRAY_NOTATION",
+    "message" : "STRUCT_ARRAY_NOTATION",
+    "category" : "CFLINT",
+    "abbrev" : "SA",
+    "locations" : [ {
+      "file" : "src/test/resources/com/cflint/tests/TooManyFunctionsChecker/StructKeyQuoted/dotNotation_405.cfc",
+      "fileName" : "dotNotation_405.cfc",
+      "function" : "x",
+      "column" : 3,
+      "line" : 9,
+      "message" : "Unquoted struct key bar is not case-sensitive.  Using array notation is recommended.",
+      "variable" : "bar",
+      "expression" : "sampleStruct.foo().bar"
+    } ]
+  } ],
+  "counts" : {
+    "totalFiles" : 0,
+    "totalLines" : 0,
+    "countByCode" : [ {
+      "code" : "STRUCT_ARRAY_NOTATION",
+      "count" : 3
+    } ],
+    "countBySeverity" : [ {
+      "severity" : "WARNING",
+      "count" : 3
+    } ]
+  }
+}