Address review suggestions

ballerina-platform · Mar 19, 2024 · 4fdfe79 · 4fdfe79
1 parent 49d586f
commit 4fdfe79
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/...ina-shell/modules/shell-core/src/main/java/io/ballerina/shell/parser/ParserConstants.java b/...ina-shell/modules/shell-core/src/main/java/io/ballerina/shell/parser/ParserConstants.java
@@ -35,8 +35,8 @@ public class ParserConstants {
     /**
      * Checks if the given function name is restricted.
      *
-     * @param functionName Function name to check.
-     * @return True if the function name is restricted.
+     * @param functionName function name to check
+     * @return <code>true</code> if the function name is restricted. <code>false</code> otherwise
      */
     public static boolean isFunctionNameRestricted(String functionName) {
         return RESTRICTED_FUNCTION_NAMES.contains(functionName) || functionName.startsWith(WRAPPER_PREFIX);

diff --git a/...ules/shell-core/src/main/java/io/ballerina/shell/snippet/factory/BasicSnippetFactory.java b/...ules/shell-core/src/main/java/io/ballerina/shell/snippet/factory/BasicSnippetFactory.java
@@ -171,22 +171,22 @@ public List<VariableDeclarationSnippet> createVariableDeclarationSnippets(Node n
 
                 // Check if the type descriptor of the variable is 'var' as it is not yet supported.
                 if (typeDescriptorNode.kind() == SyntaxKind.VAR_TYPE_DESC) {
-                    addErrorDiagnostic("Actions not allowed with a 'var' TypeDescriptor");
+                    addErrorDiagnostic("'var' type is not yet supported for actions. Please specify the exact type.");
                     return null;
                 }
 
-                boolean hasCheck = nodeKind == SyntaxKind.CHECK_ACTION;
-                String functionBody = varInitNode.toSourceCode();
-                String functionDefinition = (hasCheck ? "function() returns error|" :
+                boolean isCheckAction = nodeKind == SyntaxKind.CHECK_ACTION;
+                String initAction = varInitNode.toSourceCode();
+                String functionTypeDesc = (isCheckAction ? "function() returns error|" :
                         "function() returns ") + typeDescriptorNode;
                 String functionName = ParserConstants.WRAPPER_PREFIX + varFunctionCount;
-                String functionString = String.format("%s %s = %s {%s %s = %s; return %s;};", functionDefinition,
-                        functionName, functionDefinition, typeDescriptorNode, bindingPatternNode, functionBody,
+                String functionVarDecl = String.format("%s %s = %s {%s %s = %s; return %s;};", functionTypeDesc,
+                        functionName, functionTypeDesc, typeDescriptorNode, bindingPatternNode, initAction,
                         bindingPatternNode);
-                varNode = (VariableDeclarationNode) NodeParser.parseStatement(functionString);
+                varNode = (VariableDeclarationNode) NodeParser.parseStatement(functionVarDecl);
                 newNode = (VariableDeclarationNode) NodeParser.parseStatement(
                         String.format("%s %s = %s %s();", typeDescriptorNode, bindingPatternNode,
-                                (hasCheck ? "check " : ""), functionName));
+                                (isCheckAction ? "check " : ""), functionName));
             }
 
             varFunctionCount += 1;

diff --git a/...les/shell-core/src/test/java/io/ballerina/shell/test/evaluator/AbstractEvaluatorTest.java b/...les/shell-core/src/test/java/io/ballerina/shell/test/evaluator/AbstractEvaluatorTest.java
@@ -84,7 +84,7 @@ protected void testEvaluate(String fileName) throws BallerinaShellException {
                 ShellCompilation shellCompilation = evaluator.getCompilation(testCase.getCode());
                 Optional<PackageCompilation> compilation = shellCompilation.getPackageCompilation();
 
-                if (compilation.isEmpty() && testCase.getStderr().size() > 0) {
+                if (compilation.isEmpty() && !testCase.getStderr().isEmpty()) {
                     for (int i = 0; i < testCase.getStderr().size(); i++) {
                         Assert.assertEquals(evaluator.diagnostics().get(i).toString(), testCase.getStderr().get(i));
                     }

diff --git a/...dules/shell-core/src/test/java/io/ballerina/shell/test/evaluator/ActionEvaluatorTest.java b/...dules/shell-core/src/test/java/io/ballerina/shell/test/evaluator/ActionEvaluatorTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, WSO2 LLC. (http://wso2.com) All Rights Reserved.
+ * Copyright (c) 2024, WSO2 LLC. (http://wso2.com)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.