Move nameFromExpression method to TreeUtils

guillaume-dequenne · guillaume-dequenne · commit abcd79390f2d · 2020-08-20T19:29:33.000+02:00
diff --git a/python-checks/src/main/java/org/sonar/python/checks/ConfusingTypeCheckingCheck.java b/python-checks/src/main/java/org/sonar/python/checks/ConfusingTypeCheckingCheck.java
@@ -31,14 +31,14 @@
 import org.sonar.plugins.python.api.symbols.Symbol;
 import org.sonar.plugins.python.api.tree.Expression;
 import org.sonar.plugins.python.api.tree.IsExpression;
-import org.sonar.plugins.python.api.tree.Name;
 import org.sonar.plugins.python.api.tree.RaiseStatement;
 import org.sonar.plugins.python.api.tree.Token;
 import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.plugins.python.api.types.InferredType;
 import org.sonar.python.types.InferredTypes;
 import org.sonar.python.types.TypeShed;
 
+import static org.sonar.python.tree.TreeUtils.nameFromExpression;
 import static org.sonar.python.types.InferredTypes.containsDeclaredType;
 import static org.sonar.python.types.InferredTypes.typeClassLocation;
 import static org.sonar.python.types.InferredTypes.typeName;
@@ -168,13 +168,6 @@ private static void checkIncorrectExceptionType(SubscriptionContext ctx) {
     }
   }
 
-  private static String nameFromExpression(Expression expression) {
-    if (expression.is(Tree.Kind.NAME)) {
-      return ((Name) expression).name();
-    }
-    return null;
-  }
-
   private static class SillyEqualityCheck extends SillyEquality {
 
     @Override
diff --git a/python-checks/src/main/java/org/sonar/python/checks/ItemOperationsType.java b/python-checks/src/main/java/org/sonar/python/checks/ItemOperationsType.java
@@ -34,6 +34,8 @@
 import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.python.tree.TreeUtils;
 
+import static org.sonar.python.tree.TreeUtils.nameFromExpression;
+
 public abstract class ItemOperationsType extends PythonSubscriptionCheck {
 
   @Override
@@ -90,13 +92,6 @@ private void reportIssue(SubscriptionExpression subscriptionExpression, Expressi
     secondaries.stream().filter(Objects::nonNull).forEach(locationInFile -> preciseIssue.secondary(locationInFile, null));
   }
 
-  private static String nameFromExpression(Expression expression) {
-    if (expression.is(Tree.Kind.NAME)) {
-      return ((Name) expression).name();
-    }
-    return null;
-  }
-
   public abstract boolean isValidSubscription(Expression subscriptionObject, String requiredMethod, @Nullable String classRequiredMethod, List<LocationInFile> secondaries);
   public abstract String message(@Nullable String name, String missingMethod);
 }
diff --git a/python-checks/src/main/java/org/sonar/python/checks/NonCallableCalled.java b/python-checks/src/main/java/org/sonar/python/checks/NonCallableCalled.java
@@ -24,11 +24,11 @@
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
 import org.sonar.plugins.python.api.tree.CallExpression;
 import org.sonar.plugins.python.api.tree.Expression;
-import org.sonar.plugins.python.api.tree.Name;
 import org.sonar.plugins.python.api.tree.Tree;
 import org.sonar.plugins.python.api.types.InferredType;
 import org.sonar.python.types.InferredTypes;
 
+import static org.sonar.python.tree.TreeUtils.nameFromExpression;
 import static org.sonar.python.types.InferredTypes.typeClassLocation;
 
 public abstract class NonCallableCalled extends PythonSubscriptionCheck {
@@ -49,13 +49,6 @@ public void initialize(Context context) {
     });
   }
 
-  private static String nameFromExpression(Expression expression) {
-    if (expression.is(Tree.Kind.NAME)) {
-      return ((Name) expression).name();
-    }
-    return null;
-  }
-
   protected static String addTypeName(InferredType type) {
     String typeName = InferredTypes.typeName(type);
     if (typeName != null) {
diff --git a/python-frontend/src/main/java/org/sonar/python/tree/TreeUtils.java b/python-frontend/src/main/java/org/sonar/python/tree/TreeUtils.java
@@ -266,6 +266,13 @@ public static boolean isBooleanLiteral(Tree tree) {
     return false;
   }
 
+  public static String nameFromExpression(Expression expression) {
+    if (expression.is(Tree.Kind.NAME)) {
+      return ((Name) expression).name();
+    }
+    return null;
+  }
+
   @CheckForNull
   public static LocationInFile locationInFile(Tree tree, @Nullable String fileId) {
     if (fileId == null) {
diff --git a/python-frontend/src/test/java/org/sonar/python/tree/TreeUtilsTest.java b/python-frontend/src/test/java/org/sonar/python/tree/TreeUtilsTest.java
@@ -327,6 +327,14 @@ public void test_isBooleanLiteral() {
     assertThat(TreeUtils.isBooleanLiteral(lastExpression("foo()"))).isFalse();
   }
 
+  @Test
+  public void test_nameFromExpression() {
+    assertThat(TreeUtils.nameFromExpression(lastExpression("my_var"))).isEqualTo("my_var");
+    assertThat(TreeUtils.nameFromExpression(lastExpression("self.my_var"))).isNullOrEmpty();
+    assertThat(TreeUtils.nameFromExpression(lastExpression("my_call()"))).isNullOrEmpty();
+    assertThat(TreeUtils.nameFromExpression(lastExpression("a == b"))).isNullOrEmpty();
+  }
+
   private static boolean isOuterFunction(Tree tree) {
     return tree.is(Kind.FUNCDEF) && ((FunctionDef) tree).name().name().equals("outer");
   }

Original file line number	Diff line number	Diff line change
`@@ -327,6 +327,14 @@ public void test_isBooleanLiteral() {`
`327`	`327`	`assertThat(TreeUtils.isBooleanLiteral(lastExpression("foo()"))).isFalse();`
`328`	`328`	`}`
`329`	`329`
	`330`	`+ @Test`
	`331`	`+ public void test_nameFromExpression() {`
	`332`	`+ assertThat(TreeUtils.nameFromExpression(lastExpression("my_var"))).isEqualTo("my_var");`
	`333`	`+ assertThat(TreeUtils.nameFromExpression(lastExpression("self.my_var"))).isNullOrEmpty();`
	`334`	`+ assertThat(TreeUtils.nameFromExpression(lastExpression("my_call()"))).isNullOrEmpty();`
	`335`	`+ assertThat(TreeUtils.nameFromExpression(lastExpression("a == b"))).isNullOrEmpty();`
	`336`	`+ }`
	`337`	`+`
`330`	`338`	`private static boolean isOuterFunction(Tree tree) {`
`331`	`339`	`return tree.is(Kind.FUNCDEF) && ((FunctionDef) tree).name().name().equals("outer");`
`332`	`340`	`}`