correction from copilot review

Author: dedece35

IA_description.md

@@ -52,12 +52,12 @@ Each unit test class checking rule implementation class has the same template of
   - usage of "CheckVerifier.verifyNoIssues" to check there is no issues raised
 - each call to "CheckVerifier" needs a test resource file : this one is the resource code file for the simulated analysis
 
-each test resource file is in the "test/resources/checks" directory (or sub-directories).
+each test resource file is in the "src/test/files" directory (or sub-directories).
 each test resource file contains compliuant code or / and non compliant code.
-If there is no compliant code on which Sonarqube analysis should raise an issue, the line with the issue has a comment at the end of the line with the following template : 
-"# Noncompliant {{ERROR_MESSAGE_TO_DISPLAY}}"
+If there is non compliant code on which Sonarqube analysis should raise an issue, the line with the issue has a comment at the end of the line with the following template : 
+"// Noncompliant {{ERROR_MESSAGE_TO_DISPLAY}}"
     - the "ERROR_MESSAGE_TO_DISPLAY" in the previous template is replaced by the real error message.
-    - this comment give the information to "CheckVerifier", the simulation tool, that an error is expected at this line
+    - this comment gives the information to "CheckVerifier", the simulation tool, that an error is expected at this line
 
 Integration Tests Implementation Structure
 ---

IA_rule.md

@@ -13,20 +13,20 @@ Use the TDD (Test-Driven Development) methodology to implement a rule in an effi
   - Non-compliant code
   - Code with elements that should not be analyzed
 - Location of test resource files:
-    - Files for unit tests: in "test/resources/checks" or subdirectories
+    - Files for unit tests: in "src/test/files" or subdirectories
     - Files for integration tests: in "src/it/test-projects" or subdirectories
 - Create the rule implementation class in the package "org.greencodeinitiative.creedengo.java.checks"
     - Add the "Rule" annotation with the correct rule id (the rule is previously defined in another maven component named "creedengo-rules-specifications")
     - Extend the "IssuableSubscriptionVisitor" class
-    - Implement the "initialize" method which will be used to declare the AST node types to analyze in depth but leave it empty for now
+    - Override the "nodesToVisit", "visitNode" and (optionally) "leaveNode" methods, which will be used respectively to declare the AST node types to analyze in depth and to implement the analysis logic, but leave their bodies empty for now
 - Create the rule unit test class in the package "org.greencodeinitiative.creedengo.java.checks"
 - Verify that unit tests fail with non-compliant test resources
 
 ## STEP 2: Implement the rule + unit test validation
 - Implement the rule in the implementation class created in step 1
-- Implement the "initialize" method to declare the AST node types to analyze in depth
+- Implement the "nodesToVisit" method to declare the AST node types to analyze in depth and implement the "visitNode" and, if needed, "leaveNode" methods to perform the analysis on those nodes
 - Implement private methods to analyze in depth the declared AST nodes and raise issues if needed
-- Verify that unit tests pass with both compliant and non-compliant test resources
+- Verify that unit tests pass with both compliant and non-compliant test resources, and call them from "visitNode"/"leaveNode"
 
 ## STEP 3: Implement integration tests
 - Add a test method in the integration class "GCIRulesIT" for the implemented rule using the same pattern as other existing test methods

src/it/java/org/greencodeinitiative/creedengo/java/integration/tests/GCIRulesIT.java

@@ -408,7 +408,7 @@ void testGCI76_good() {
     void testGCI79() {
         String filePath = "src/main/java/org/greencodeinitiative/creedengo/java/checks/FreeResourcesOfAutoCloseableInterface.java";
         String ruleId = "creedengo-java:GCI79";
-        String ruleMsg = "try-with-resources Statement needs to be implemented for any object that implements the AutoClosable interface.";
+        String ruleMsg = "try-with-resources Statement needs to be implemented for any object that implements the AutoCloseable interface.";
         int[] startLines = new int[]{23};
         int[] endLines = new int[]{36};
 

src/it/test-projects/creedengo-java-plugin-test-project/src/main/java/org/greencodeinitiative/creedengo/java/checks/FreeResourcesOfAutoCloseableInterface.java

@@ -37,7 +37,7 @@ public void foo2() throws IOException {
     }
 
     /**
-     * The first methods adds a "try" in the stack used to follow if the code is in a try
+     * The first method adds a "try" in the stack used to follow if the code is in a try
      */
     public void callingMethodWithTheTry() throws IOException {
         try { // Compliant
@@ -48,7 +48,7 @@ public void callingMethodWithTheTry() throws IOException {
     }
 
     /**
-     * The "try" should have been poped from the stack before entering here
+     * The "try" should have been popped from the stack before entering here
      */
     private void calledMethodWithoutTry() throws IOException {
         FileWriter myWriter = new FileWriter("somefilepath");

src/main/java/org/greencodeinitiative/creedengo/java/checks/FreeResourcesOfAutoCloseableInterface.java

@@ -56,7 +56,7 @@ public class FreeResourcesOfAutoCloseableInterface extends IssuableSubscriptionV
     private final Deque<TryStatementContext> tryStack = new ArrayDeque<>();
 
     private static final String JAVA_LANG_AUTOCLOSEABLE = "java.lang.AutoCloseable";
-    protected static final String MESSAGE_RULE = "try-with-resources Statement needs to be implemented for any object that implements the AutoClosable interface.";
+    protected static final String MESSAGE_RULE = "try-with-resources Statement needs to be implemented for any object that implements the AutoCloseable interface.";
 
     @Override
     @ParametersAreNonnullByDefault

src/test/files/FreeResourcesOfAutoCloseableInterface.java

@@ -35,7 +35,7 @@ public void foo1() {
 
     public void foo2() {
         String fileName = "./FreeResourcesOfAutoCloseableInterface.java";
-        try { // Noncompliant {{try-with-resources Statement needs to be implemented for any object that implements the AutoClosable interface.}}
+        try { // Noncompliant {{try-with-resources Statement needs to be implemented for any object that implements the AutoCloseable interface.}}
             FileReader fr = new FileReader(fileName);
             BufferedReader br = new BufferedReader(fr);
             System.out.printl(br.readLine());
@@ -52,7 +52,7 @@ public void foo2() {
     }
 
     /**
-     * The first methods adds a "try" in the stack used to follow if the code is in a try
+     * The first method adds a "try" in the stack used to follow if the code is in a try
      */
     public void callingMethodWithTheTry() throws IOException {
         try { // Compliant
@@ -63,7 +63,7 @@ public void callingMethodWithTheTry() throws IOException {
     }
 
     /**
-     * The "try" should have been poped from the stack before entering here
+     * The "try" should have been popped from the stack before entering here
      */
     private void calledMethodWithoutTry() throws IOException {
         FileWriter myWriter = new FileWriter("somefilepath");